Gets user access details in a batch request.
This action polls data from the tasks that are kicked off by the StartUserAccessTasks action.
Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application.
" + }, + "CreateAppAuthorization":{ + "name":"CreateAppAuthorization", + "http":{ + "method":"POST", + "requestUri":"/appbundles/{appBundleIdentifier}/appauthorizations", + "responseCode":201 + }, + "input":{"shape":"CreateAppAuthorizationRequest"}, + "output":{"shape":"CreateAppAuthorizationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates an app authorization within an app bundle, which allows AppFabric to connect to an application.
", + "idempotent":true + }, + "CreateAppBundle":{ + "name":"CreateAppBundle", + "http":{ + "method":"POST", + "requestUri":"/appbundles", + "responseCode":201 + }, + "input":{"shape":"CreateAppBundleRequest"}, + "output":{"shape":"CreateAppBundleResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates an app bundle to collect data from an application using AppFabric.
", + "idempotent":true + }, + "CreateIngestion":{ + "name":"CreateIngestion", + "http":{ + "method":"POST", + "requestUri":"/appbundles/{appBundleIdentifier}/ingestions", + "responseCode":201 + }, + "input":{"shape":"CreateIngestionRequest"}, + "output":{"shape":"CreateIngestionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a data ingestion for an application.
", + "idempotent":true + }, + "CreateIngestionDestination":{ + "name":"CreateIngestionDestination", + "http":{ + "method":"POST", + "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/ingestiondestinations", + "responseCode":201 + }, + "input":{"shape":"CreateIngestionDestinationRequest"}, + "output":{"shape":"CreateIngestionDestinationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.
", + "idempotent":true + }, + "DeleteAppAuthorization":{ + "name":"DeleteAppAuthorization", + "http":{ + "method":"DELETE", + "requestUri":"/appbundles/{appBundleIdentifier}/appauthorizations/{appAuthorizationIdentifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteAppAuthorizationRequest"}, + "output":{"shape":"DeleteAppAuthorizationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes an app authorization. You must delete the associated ingestion before you can delete an app authorization.
", + "idempotent":true + }, + "DeleteAppBundle":{ + "name":"DeleteAppBundle", + "http":{ + "method":"DELETE", + "requestUri":"/appbundles/{appBundleIdentifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteAppBundleRequest"}, + "output":{"shape":"DeleteAppBundleResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes an app bundle. You must delete all associated app authorizations before you can delete an app bundle.
", + "idempotent":true + }, + "DeleteIngestion":{ + "name":"DeleteIngestion", + "http":{ + "method":"DELETE", + "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteIngestionRequest"}, + "output":{"shape":"DeleteIngestionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes an ingestion. You must stop (disable) the ingestion and you must delete all associated ingestion destinations before you can delete an app ingestion.
", + "idempotent":true + }, + "DeleteIngestionDestination":{ + "name":"DeleteIngestionDestination", + "http":{ + "method":"DELETE", + "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/ingestiondestinations/{ingestionDestinationIdentifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteIngestionDestinationRequest"}, + "output":{"shape":"DeleteIngestionDestinationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes an ingestion destination.
This deletes the association between an ingestion and it's destination. It doesn't delete previously ingested data or the storage destination, such as the Amazon S3 bucket where the data is delivered. If the ingestion destination is deleted while the associated ingestion is enabled, the ingestion will fail and is eventually disabled.
", + "idempotent":true + }, + "GetAppAuthorization":{ + "name":"GetAppAuthorization", + "http":{ + "method":"GET", + "requestUri":"/appbundles/{appBundleIdentifier}/appauthorizations/{appAuthorizationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetAppAuthorizationRequest"}, + "output":{"shape":"GetAppAuthorizationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about an app authorization.
" + }, + "GetAppBundle":{ + "name":"GetAppBundle", + "http":{ + "method":"GET", + "requestUri":"/appbundles/{appBundleIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetAppBundleRequest"}, + "output":{"shape":"GetAppBundleResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about an app bundle.
" + }, + "GetIngestion":{ + "name":"GetIngestion", + "http":{ + "method":"GET", + "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetIngestionRequest"}, + "output":{"shape":"GetIngestionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about an ingestion.
" + }, + "GetIngestionDestination":{ + "name":"GetIngestionDestination", + "http":{ + "method":"GET", + "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/ingestiondestinations/{ingestionDestinationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetIngestionDestinationRequest"}, + "output":{"shape":"GetIngestionDestinationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about an ingestion destination.
" + }, + "ListAppAuthorizations":{ + "name":"ListAppAuthorizations", + "http":{ + "method":"GET", + "requestUri":"/appbundles/{appBundleIdentifier}/appauthorizations", + "responseCode":200 + }, + "input":{"shape":"ListAppAuthorizationsRequest"}, + "output":{"shape":"ListAppAuthorizationsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a list of all app authorizations configured for an app bundle.
" + }, + "ListAppBundles":{ + "name":"ListAppBundles", + "http":{ + "method":"GET", + "requestUri":"/appbundles", + "responseCode":200 + }, + "input":{"shape":"ListAppBundlesRequest"}, + "output":{"shape":"ListAppBundlesResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a list of app bundles.
" + }, + "ListIngestionDestinations":{ + "name":"ListIngestionDestinations", + "http":{ + "method":"GET", + "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/ingestiondestinations", + "responseCode":200 + }, + "input":{"shape":"ListIngestionDestinationsRequest"}, + "output":{"shape":"ListIngestionDestinationsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a list of all ingestion destinations configured for an ingestion.
" + }, + "ListIngestions":{ + "name":"ListIngestions", + "http":{ + "method":"GET", + "requestUri":"/appbundles/{appBundleIdentifier}/ingestions", + "responseCode":200 + }, + "input":{"shape":"ListIngestionsRequest"}, + "output":{"shape":"ListIngestionsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a list of all ingestions configured for an app bundle.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a list of tags for a resource.
" + }, + "StartIngestion":{ + "name":"StartIngestion", + "http":{ + "method":"POST", + "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/start", + "responseCode":200 + }, + "input":{"shape":"StartIngestionRequest"}, + "output":{"shape":"StartIngestionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Starts (enables) an ingestion, which collects data from an application.
" + }, + "StartUserAccessTasks":{ + "name":"StartUserAccessTasks", + "http":{ + "method":"POST", + "requestUri":"/useraccess/start", + "responseCode":201 + }, + "input":{"shape":"StartUserAccessTasksRequest"}, + "output":{"shape":"StartUserAccessTasksResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Starts the tasks to search user access status for a specific email address.
The tasks are stopped when the user access status data is found. The tasks are terminated when the API calls to the application time out.
" + }, + "StopIngestion":{ + "name":"StopIngestion", + "http":{ + "method":"POST", + "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/stop", + "responseCode":200 + }, + "input":{"shape":"StopIngestionRequest"}, + "output":{"shape":"StopIngestionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Stops (disables) an ingestion.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Assigns one or more tags (key-value pairs) to the specified resource.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Removes a tag or tags from a resource.
", + "idempotent":true + }, + "UpdateAppAuthorization":{ + "name":"UpdateAppAuthorization", + "http":{ + "method":"PATCH", + "requestUri":"/appbundles/{appBundleIdentifier}/appauthorizations/{appAuthorizationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateAppAuthorizationRequest"}, + "output":{"shape":"UpdateAppAuthorizationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates an app authorization within an app bundle, which allows AppFabric to connect to an application.
If the app authorization was in a connected state, updating the app authorization will set it back to a PendingConnect state.
Updates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"You are not authorized to perform this operation.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "ApiKeyCredential":{ + "type":"structure", + "required":["apiKey"], + "members":{ + "apiKey":{ + "shape":"SensitiveString2048", + "documentation":"An API key for an application.
" + } + }, + "documentation":"Contains API key credential information.
" + }, + "AppAuthorization":{ + "type":"structure", + "required":[ + "appAuthorizationArn", + "appBundleArn", + "app", + "tenant", + "authType", + "status", + "createdAt", + "updatedAt" + ], + "members":{ + "appAuthorizationArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the app authorization.
" + }, + "appBundleArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the app bundle for the app authorization.
" + }, + "app":{ + "shape":"String255", + "documentation":"The name of the application.
" + }, + "tenant":{ + "shape":"Tenant", + "documentation":"Contains information about an application tenant, such as the application display name and identifier.
" + }, + "authType":{ + "shape":"AuthType", + "documentation":"The authorization type.
" + }, + "status":{ + "shape":"AppAuthorizationStatus", + "documentation":"The state of the app authorization.
The following states are possible:
PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.
Connected: The app authorization is connected to the application, and is ready to be used.
ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.
TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.
The timestamp of when the app authorization was created.
" + }, + "updatedAt":{ + "shape":"DateTime", + "documentation":"The timestamp of when the app authorization was last updated.
" + }, + "persona":{ + "shape":"Persona", + "documentation":"The user persona of the app authorization.
This field should always be admin.
The application URL for the OAuth flow.
" + } + }, + "documentation":"Contains information about an app authorization.
" + }, + "AppAuthorizationStatus":{ + "type":"string", + "enum":[ + "PendingConnect", + "Connected", + "ConnectionValidationFailed", + "TokenAutoRotationFailed" + ] + }, + "AppAuthorizationSummary":{ + "type":"structure", + "required":[ + "appAuthorizationArn", + "appBundleArn", + "app", + "tenant", + "status", + "updatedAt" + ], + "members":{ + "appAuthorizationArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the app authorization.
" + }, + "appBundleArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the app bundle for the app authorization.
" + }, + "app":{ + "shape":"String255", + "documentation":"The name of the application.
" + }, + "tenant":{ + "shape":"Tenant", + "documentation":"Contains information about an application tenant, such as the application display name and identifier.
" + }, + "status":{ + "shape":"AppAuthorizationStatus", + "documentation":"The state of the app authorization.
The following states are possible:
PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.
Connected: The app authorization is connected to the application, and is ready to be used.
ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.
TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.
Timestamp for when the app authorization was last updated.
" + } + }, + "documentation":"Contains a summary of an app authorization.
" + }, + "AppAuthorizationSummaryList":{ + "type":"list", + "member":{"shape":"AppAuthorizationSummary"} + }, + "AppBundle":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the app bundle.
" + }, + "customerManagedKeyArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the application data.
" + } + }, + "documentation":"Contains information about an app bundle.
" + }, + "AppBundleSummary":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the app bundle.
" + } + }, + "documentation":"Contains a summary of an app bundle.
" + }, + "AppBundleSummaryList":{ + "type":"list", + "member":{"shape":"AppBundleSummary"} + }, + "Arn":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"arn:.+" + }, + "AuditLogDestinationConfiguration":{ + "type":"structure", + "required":["destination"], + "members":{ + "destination":{ + "shape":"Destination", + "documentation":"Contains information about an audit log destination.
" + } + }, + "documentation":"Contains information about an audit log destination configuration.
" + }, + "AuditLogProcessingConfiguration":{ + "type":"structure", + "required":[ + "schema", + "format" + ], + "members":{ + "schema":{ + "shape":"Schema", + "documentation":"The event schema in which the audit logs need to be formatted.
" + }, + "format":{ + "shape":"Format", + "documentation":"The format in which the audit logs need to be formatted.
" + } + }, + "documentation":"Contains information about an audit log processing configuration.
" + }, + "AuthRequest":{ + "type":"structure", + "required":[ + "redirectUri", + "code" + ], + "members":{ + "redirectUri":{ + "shape":"RedirectUri", + "documentation":"The redirect URL that is specified in the AuthURL and the application client.
" + }, + "code":{ + "shape":"SensitiveString2048", + "documentation":"The authorization code returned by the application after permission is granted in the application OAuth page (after clicking on the AuthURL).
" + } + }, + "documentation":"Contains authorization request information, which is required for Amazon Web Services AppFabric to get the OAuth2 access token for an application.
" + }, + "AuthType":{ + "type":"string", + "enum":[ + "oauth2", + "apiKey" + ] + }, + "BatchGetUserAccessTasksRequest":{ + "type":"structure", + "required":[ + "appBundleIdentifier", + "taskIdList" + ], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
" + }, + "taskIdList":{ + "shape":"TaskIdList", + "documentation":"The tasks IDs to use for the request.
" + } + } + }, + "BatchGetUserAccessTasksResponse":{ + "type":"structure", + "members":{ + "userAccessResultsList":{ + "shape":"UserAccessResultsList", + "documentation":"Contains a list of user access results.
" + } + } + }, + "ConflictException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{"shape":"String"}, + "resourceId":{ + "shape":"String", + "documentation":"The resource ID.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The resource type.
" + } + }, + "documentation":"The request has created a conflict. Check the request parameters and try again.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ConnectAppAuthorizationRequest":{ + "type":"structure", + "required":[ + "appBundleIdentifier", + "appAuthorizationIdentifier" + ], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle that contains the app authorization to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + }, + "appAuthorizationIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
", + "location":"uri", + "locationName":"appAuthorizationIdentifier" + }, + "authRequest":{ + "shape":"AuthRequest", + "documentation":"Contains OAuth2 authorization information.
This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.
Contains a summary of the app authorization.
" + } + } + }, + "CreateAppAuthorizationRequest":{ + "type":"structure", + "required":[ + "appBundleIdentifier", + "app", + "credential", + "tenant", + "authType" + ], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + }, + "app":{ + "shape":"String255", + "documentation":"The name of the application.
Valid values are:
SLACK
ASANA
JIRA
M365
M365AUDITLOGS
ZOOM
ZENDESK
OKTA
GOOGLE
DROPBOX
SMARTSHEET
CISCO
Contains credentials for the application, such as an API key or OAuth2 client ID and secret.
Specify credentials that match the authorization type for your request. For example, if the authorization type for your request is OAuth2 (oauth2), then you should provide only the OAuth2 credentials.
Contains information about an application tenant, such as the application display name and identifier.
" + }, + "authType":{ + "shape":"AuthType", + "documentation":"The authorization type for the app authorization.
" + }, + "clientToken":{ + "shape":"UUID", + "documentation":"Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
A map of the key-value pairs of the tag or tags to assign to the resource.
" + } + } + }, + "CreateAppAuthorizationResponse":{ + "type":"structure", + "required":["appAuthorization"], + "members":{ + "appAuthorization":{ + "shape":"AppAuthorization", + "documentation":"Contains information about an app authorization.
" + } + } + }, + "CreateAppBundleRequest":{ + "type":"structure", + "members":{ + "clientToken":{ + "shape":"UUID", + "documentation":"Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use to encrypt the application data. If this is not specified, an Amazon Web Services owned key is used for encryption.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"A map of the key-value pairs of the tag or tags to assign to the resource.
" + } + } + }, + "CreateAppBundleResponse":{ + "type":"structure", + "required":["appBundle"], + "members":{ + "appBundle":{ + "shape":"AppBundle", + "documentation":"Contains information about an app bundle.
" + } + } + }, + "CreateIngestionDestinationRequest":{ + "type":"structure", + "required":[ + "appBundleIdentifier", + "ingestionIdentifier", + "processingConfiguration", + "destinationConfiguration" + ], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + }, + "ingestionIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
", + "location":"uri", + "locationName":"ingestionIdentifier" + }, + "processingConfiguration":{ + "shape":"ProcessingConfiguration", + "documentation":"Contains information about how ingested data is processed.
" + }, + "destinationConfiguration":{ + "shape":"DestinationConfiguration", + "documentation":"Contains information about the destination of ingested data.
" + }, + "clientToken":{ + "shape":"UUID", + "documentation":"Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
A map of the key-value pairs of the tag or tags to assign to the resource.
" + } + } + }, + "CreateIngestionDestinationResponse":{ + "type":"structure", + "required":["ingestionDestination"], + "members":{ + "ingestionDestination":{ + "shape":"IngestionDestination", + "documentation":"Contains information about an ingestion destination.
" + } + } + }, + "CreateIngestionRequest":{ + "type":"structure", + "required":[ + "appBundleIdentifier", + "app", + "tenantId", + "ingestionType" + ], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + }, + "app":{ + "shape":"String255", + "documentation":"The name of the application.
Valid values are:
SLACK
ASANA
JIRA
M365
M365AUDITLOGS
ZOOM
ZENDESK
OKTA
GOOGLE
DROPBOX
SMARTSHEET
CISCO
The ID of the application tenant.
" + }, + "ingestionType":{ + "shape":"IngestionType", + "documentation":"The ingestion type.
" + }, + "clientToken":{ + "shape":"UUID", + "documentation":"Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
A map of the key-value pairs of the tag or tags to assign to the resource.
" + } + } + }, + "CreateIngestionResponse":{ + "type":"structure", + "required":["ingestion"], + "members":{ + "ingestion":{ + "shape":"Ingestion", + "documentation":"Contains information about an ingestion.
" + } + } + }, + "Credential":{ + "type":"structure", + "members":{ + "oauth2Credential":{ + "shape":"Oauth2Credential", + "documentation":"Contains OAuth2 client credential information.
" + }, + "apiKeyCredential":{ + "shape":"ApiKeyCredential", + "documentation":"Contains API key credential information.
" + } + }, + "documentation":"Contains credential information for an application.
", + "union":true + }, + "DateTime":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "DeleteAppAuthorizationRequest":{ + "type":"structure", + "required":[ + "appBundleIdentifier", + "appAuthorizationIdentifier" + ], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + }, + "appAuthorizationIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
", + "location":"uri", + "locationName":"appAuthorizationIdentifier" + } + } + }, + "DeleteAppAuthorizationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteAppBundleRequest":{ + "type":"structure", + "required":["appBundleIdentifier"], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The ID or Amazon Resource Name (ARN) of the app bundle that needs to be deleted.
", + "location":"uri", + "locationName":"appBundleIdentifier" + } + } + }, + "DeleteAppBundleResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteIngestionDestinationRequest":{ + "type":"structure", + "required":[ + "appBundleIdentifier", + "ingestionIdentifier", + "ingestionDestinationIdentifier" + ], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + }, + "ingestionIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
", + "location":"uri", + "locationName":"ingestionIdentifier" + }, + "ingestionDestinationIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.
", + "location":"uri", + "locationName":"ingestionDestinationIdentifier" + } + } + }, + "DeleteIngestionDestinationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteIngestionRequest":{ + "type":"structure", + "required":[ + "appBundleIdentifier", + "ingestionIdentifier" + ], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + }, + "ingestionIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
", + "location":"uri", + "locationName":"ingestionIdentifier" + } + } + }, + "DeleteIngestionResponse":{ + "type":"structure", + "members":{ + } + }, + "Destination":{ + "type":"structure", + "members":{ + "s3Bucket":{ + "shape":"S3Bucket", + "documentation":"Contains information about an Amazon S3 bucket.
" + }, + "firehoseStream":{ + "shape":"FirehoseStream", + "documentation":"Contains information about an Amazon Kinesis Data Firehose delivery stream.
" + } + }, + "documentation":"Contains information about an audit log destination.
", + "union":true + }, + "DestinationConfiguration":{ + "type":"structure", + "members":{ + "auditLog":{ + "shape":"AuditLogDestinationConfiguration", + "documentation":"Contains information about an audit log destination configuration.
" + } + }, + "documentation":"Contains information about the destination of ingested data.
", + "union":true + }, + "Email":{ + "type":"string", + "max":320, + "min":0, + "pattern":"[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*", + "sensitive":true + }, + "FirehoseStream":{ + "type":"structure", + "required":["streamName"], + "members":{ + "streamName":{ + "shape":"String64", + "documentation":"The name of the Amazon Kinesis Data Firehose delivery stream.
" + } + }, + "documentation":"Contains information about an Amazon Kinesis Data Firehose delivery stream.
" + }, + "Format":{ + "type":"string", + "enum":[ + "json", + "parquet" + ] + }, + "GetAppAuthorizationRequest":{ + "type":"structure", + "required":[ + "appBundleIdentifier", + "appAuthorizationIdentifier" + ], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + }, + "appAuthorizationIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
", + "location":"uri", + "locationName":"appAuthorizationIdentifier" + } + } + }, + "GetAppAuthorizationResponse":{ + "type":"structure", + "required":["appAuthorization"], + "members":{ + "appAuthorization":{ + "shape":"AppAuthorization", + "documentation":"Contains information about an app authorization.
" + } + } + }, + "GetAppBundleRequest":{ + "type":"structure", + "required":["appBundleIdentifier"], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + } + } + }, + "GetAppBundleResponse":{ + "type":"structure", + "required":["appBundle"], + "members":{ + "appBundle":{ + "shape":"AppBundle", + "documentation":"Contains information about an app bundle.
" + } + } + }, + "GetIngestionDestinationRequest":{ + "type":"structure", + "required":[ + "appBundleIdentifier", + "ingestionIdentifier", + "ingestionDestinationIdentifier" + ], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + }, + "ingestionIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
", + "location":"uri", + "locationName":"ingestionIdentifier" + }, + "ingestionDestinationIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.
", + "location":"uri", + "locationName":"ingestionDestinationIdentifier" + } + } + }, + "GetIngestionDestinationResponse":{ + "type":"structure", + "required":["ingestionDestination"], + "members":{ + "ingestionDestination":{ + "shape":"IngestionDestination", + "documentation":"Contains information about an ingestion destination.
" + } + } + }, + "GetIngestionRequest":{ + "type":"structure", + "required":[ + "appBundleIdentifier", + "ingestionIdentifier" + ], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + }, + "ingestionIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
", + "location":"uri", + "locationName":"ingestionIdentifier" + } + } + }, + "GetIngestionResponse":{ + "type":"structure", + "required":["ingestion"], + "members":{ + "ingestion":{ + "shape":"Ingestion", + "documentation":"Contains information about an ingestion.
" + } + } + }, + "Identifier":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"arn:.+$|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" + }, + "Ingestion":{ + "type":"structure", + "required":[ + "arn", + "appBundleArn", + "app", + "tenantId", + "createdAt", + "updatedAt", + "state", + "ingestionType" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the ingestion.
" + }, + "appBundleArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the app bundle for the ingestion.
" + }, + "app":{ + "shape":"String255", + "documentation":"The name of the application.
" + }, + "tenantId":{ + "shape":"TenantIdentifier", + "documentation":"The ID of the application tenant.
" + }, + "createdAt":{ + "shape":"DateTime", + "documentation":"The timestamp of when the ingestion was created.
" + }, + "updatedAt":{ + "shape":"DateTime", + "documentation":"The timestamp of when the ingestion was last updated.
" + }, + "state":{ + "shape":"IngestionState", + "documentation":"The status of the ingestion.
" + }, + "ingestionType":{ + "shape":"IngestionType", + "documentation":"The type of the ingestion.
" + } + }, + "documentation":"Contains information about an ingestion.
" + }, + "IngestionDestination":{ + "type":"structure", + "required":[ + "arn", + "ingestionArn", + "processingConfiguration", + "destinationConfiguration" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the ingestion destination.
" + }, + "ingestionArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the ingestion.
" + }, + "processingConfiguration":{ + "shape":"ProcessingConfiguration", + "documentation":"Contains information about how ingested data is processed.
" + }, + "destinationConfiguration":{ + "shape":"DestinationConfiguration", + "documentation":"Contains information about the destination of ingested data.
" + }, + "status":{ + "shape":"IngestionDestinationStatus", + "documentation":"The state of the ingestion destination.
The following states are possible:
Active: The ingestion destination is active and is ready to be used.
Failed: The ingestion destination has failed. If the ingestion destination is in this state, you should verify the ingestion destination configuration and try again.
The reason for the current status of the ingestion destination.
Only present when the status of ingestion destination is Failed.
The timestamp of when the ingestion destination was created.
" + }, + "updatedAt":{ + "shape":"DateTime", + "documentation":"The timestamp of when the ingestion destination was last updated.
" + } + }, + "documentation":"Contains information about an ingestion destination.
" + }, + "IngestionDestinationList":{ + "type":"list", + "member":{"shape":"IngestionDestinationSummary"} + }, + "IngestionDestinationStatus":{ + "type":"string", + "enum":[ + "Active", + "Failed" + ] + }, + "IngestionDestinationSummary":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the ingestion destination.
" + } + }, + "documentation":"Contains a summary of an ingestion destination.
" + }, + "IngestionList":{ + "type":"list", + "member":{"shape":"IngestionSummary"} + }, + "IngestionState":{ + "type":"string", + "enum":[ + "enabled", + "disabled" + ] + }, + "IngestionSummary":{ + "type":"structure", + "required":[ + "arn", + "app", + "tenantId", + "state" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the ingestion.
" + }, + "app":{ + "shape":"String255", + "documentation":"The name of the application.
" + }, + "tenantId":{ + "shape":"TenantIdentifier", + "documentation":"The ID of the application tenant.
" + }, + "state":{ + "shape":"IngestionState", + "documentation":"The status of the ingestion.
" + } + }, + "documentation":"Contains a summary of an ingestion.
" + }, + "IngestionType":{ + "type":"string", + "enum":["auditLog"] + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "retryAfterSeconds":{ + "shape":"Integer", + "documentation":"The period of time after which you should retry your request.
", + "location":"header", + "locationName":"Retry-After" + } + }, + "documentation":"The request processing has failed because of an unknown error, exception, or failure with an internal server.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "ListAppAuthorizationsRequest":{ + "type":"structure", + "required":["appBundleIdentifier"], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"String2048", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Contains a list of app authorization summaries.
" + }, + "nextToken":{ + "shape":"String2048", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"String2048", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Contains a list of app bundle summaries.
" + }, + "nextToken":{ + "shape":"String2048", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + }, + "ingestionIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
", + "location":"uri", + "locationName":"ingestionIdentifier" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"String", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Contains a list of ingestion destination summaries.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"String", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Contains a list of ingestion summaries.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"A map of the key-value pairs for the tag or tags assigned to the specified resource.
" + } + } + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "Oauth2Credential":{ + "type":"structure", + "required":[ + "clientId", + "clientSecret" + ], + "members":{ + "clientId":{ + "shape":"String2048", + "documentation":"The client ID of the client application.
" + }, + "clientSecret":{ + "shape":"SensitiveString2048", + "documentation":"The client secret of the client application.
" + } + }, + "documentation":"Contains OAuth2 client credential information.
" + }, + "Persona":{ + "type":"string", + "enum":[ + "admin", + "endUser" + ] + }, + "ProcessingConfiguration":{ + "type":"structure", + "members":{ + "auditLog":{ + "shape":"AuditLogProcessingConfiguration", + "documentation":"Contains information about an audit log processing configuration.
" + } + }, + "documentation":"Contains information about how ingested data is processed.
", + "union":true + }, + "RedirectUri":{ + "type":"string", + "max":1024, + "min":0, + "pattern":"https://[-a-zA-Z0-9-._~:/?#@!$&'()*+,;=]+" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{"shape":"String"}, + "resourceId":{ + "shape":"String", + "documentation":"The resource ID.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The resource type.
" + } + }, + "documentation":"The specified resource does not exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResultStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "COMPLETED", + "FAILED", + "EXPIRED" + ] + }, + "S3Bucket":{ + "type":"structure", + "required":["bucketName"], + "members":{ + "bucketName":{ + "shape":"String63", + "documentation":"The name of the Amazon S3 bucket.
" + }, + "prefix":{ + "shape":"String120", + "documentation":"The object key to use.
" + } + }, + "documentation":"Contains information about an Amazon S3 bucket.
" + }, + "Schema":{ + "type":"string", + "enum":[ + "ocsf", + "raw" + ] + }, + "SensitiveString2048":{ + "type":"string", + "max":2048, + "min":1, + "sensitive":true + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType", + "serviceCode", + "quotaCode" + ], + "members":{ + "message":{"shape":"String"}, + "resourceId":{ + "shape":"String", + "documentation":"The resource ID.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The resource type.
" + }, + "serviceCode":{ + "shape":"String", + "documentation":"The code of the service.
" + }, + "quotaCode":{ + "shape":"String", + "documentation":"The code for the quota exceeded.
" + } + }, + "documentation":"The request exceeds a service quota.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "StartIngestionRequest":{ + "type":"structure", + "required":[ + "ingestionIdentifier", + "appBundleIdentifier" + ], + "members":{ + "ingestionIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
", + "location":"uri", + "locationName":"ingestionIdentifier" + }, + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + } + } + }, + "StartIngestionResponse":{ + "type":"structure", + "members":{ + } + }, + "StartUserAccessTasksRequest":{ + "type":"structure", + "required":[ + "appBundleIdentifier", + "email" + ], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
" + }, + "email":{ + "shape":"Email", + "documentation":"The email address of the target user.
" + } + } + }, + "StartUserAccessTasksResponse":{ + "type":"structure", + "members":{ + "userAccessTasksList":{ + "shape":"UserAccessTasksList", + "documentation":"Contains a list of user access task information.
" + } + } + }, + "StopIngestionRequest":{ + "type":"structure", + "required":[ + "ingestionIdentifier", + "appBundleIdentifier" + ], + "members":{ + "ingestionIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
", + "location":"uri", + "locationName":"ingestionIdentifier" + }, + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + } + } + }, + "StopIngestionResponse":{ + "type":"structure", + "members":{ + } + }, + "String":{"type":"string"}, + "String120":{ + "type":"string", + "max":120, + "min":1 + }, + "String2048":{ + "type":"string", + "max":2048, + "min":1 + }, + "String255":{ + "type":"string", + "max":255, + "min":1 + }, + "String63":{ + "type":"string", + "max":63, + "min":3 + }, + "String64":{ + "type":"string", + "max":64, + "min":3 + }, + "Tag":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"Tag key.
" + }, + "value":{ + "shape":"TagValue", + "documentation":"Tag value.
" + } + }, + "documentation":"The key or keys of the key-value pairs for the tag or tags assigned to a resource.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource that you want to tag.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagList", + "documentation":"A map of the key-value pairs of the tag or tags to assign to the resource.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TaskError":{ + "type":"structure", + "members":{ + "errorCode":{ + "shape":"String", + "documentation":"The code of the error.
" + }, + "errorMessage":{ + "shape":"String", + "documentation":"The message of the error.
" + } + }, + "documentation":"Contains information about an error returned from a user access task.
" + }, + "TaskIdList":{ + "type":"list", + "member":{"shape":"UUID"}, + "max":50, + "min":1 + }, + "Tenant":{ + "type":"structure", + "required":[ + "tenantIdentifier", + "tenantDisplayName" + ], + "members":{ + "tenantIdentifier":{ + "shape":"TenantIdentifier", + "documentation":"The ID of the application tenant.
" + }, + "tenantDisplayName":{ + "shape":"String2048", + "documentation":"The display name of the tenant.
" + } + }, + "documentation":"Contains information about an application tenant.
" + }, + "TenantIdentifier":{ + "type":"string", + "max":1024, + "min":1 + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "serviceCode":{ + "shape":"String", + "documentation":"The code of the service.
" + }, + "quotaCode":{ + "shape":"String", + "documentation":"The code for the quota exceeded.
" + }, + "retryAfterSeconds":{ + "shape":"Integer", + "documentation":"The period of time after which you should retry your request.
", + "location":"header", + "locationName":"Retry-After" + } + }, + "documentation":"The request rate exceeds the limit.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":true} + }, + "UUID":{ + "type":"string", + "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource that you want to untag.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateAppAuthorizationRequest":{ + "type":"structure", + "required":[ + "appBundleIdentifier", + "appAuthorizationIdentifier" + ], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + }, + "appAuthorizationIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
", + "location":"uri", + "locationName":"appAuthorizationIdentifier" + }, + "credential":{ + "shape":"Credential", + "documentation":"Contains credentials for the application, such as an API key or OAuth2 client ID and secret.
Specify credentials that match the authorization type of the app authorization to update. For example, if the authorization type of the app authorization is OAuth2 (oauth2), then you should provide only the OAuth2 credentials.
Contains information about an application tenant, such as the application display name and identifier.
" + } + } + }, + "UpdateAppAuthorizationResponse":{ + "type":"structure", + "required":["appAuthorization"], + "members":{ + "appAuthorization":{ + "shape":"AppAuthorization", + "documentation":"Contains information about an app authorization.
" + } + } + }, + "UpdateIngestionDestinationRequest":{ + "type":"structure", + "required":[ + "appBundleIdentifier", + "ingestionIdentifier", + "ingestionDestinationIdentifier", + "destinationConfiguration" + ], + "members":{ + "appBundleIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
", + "location":"uri", + "locationName":"appBundleIdentifier" + }, + "ingestionIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
", + "location":"uri", + "locationName":"ingestionIdentifier" + }, + "ingestionDestinationIdentifier":{ + "shape":"Identifier", + "documentation":"The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.
", + "location":"uri", + "locationName":"ingestionDestinationIdentifier" + }, + "destinationConfiguration":{ + "shape":"DestinationConfiguration", + "documentation":"Contains information about the destination of ingested data.
" + } + } + }, + "UpdateIngestionDestinationResponse":{ + "type":"structure", + "required":["ingestionDestination"], + "members":{ + "ingestionDestination":{ + "shape":"IngestionDestination", + "documentation":"Contains information about an ingestion destination.
" + } + } + }, + "UserAccessResultItem":{ + "type":"structure", + "members":{ + "app":{ + "shape":"String255", + "documentation":"The name of the application.
" + }, + "tenantId":{ + "shape":"TenantIdentifier", + "documentation":"The ID of the application tenant.
" + }, + "tenantDisplayName":{ + "shape":"String2048", + "documentation":"The display name of the tenant.
" + }, + "taskId":{ + "shape":"UUID", + "documentation":"The unique ID of the task.
" + }, + "resultStatus":{ + "shape":"ResultStatus", + "documentation":"The status of the user access result item.
The following states are possible:
IN_PROGRESS: The user access task is in progress.
COMPLETED: The user access task completed successfully.
FAILED: The user access task failed.
EXPIRED: The user access task expired.
The email address of the target user.
" + }, + "userId":{ + "shape":"SensitiveString2048", + "documentation":"The unique ID of user.
" + }, + "userFullName":{ + "shape":"SensitiveString2048", + "documentation":"The full name of the user.
" + }, + "userFirstName":{ + "shape":"SensitiveString2048", + "documentation":"The first name of the user.
" + }, + "userLastName":{ + "shape":"SensitiveString2048", + "documentation":"The last name of the user.
" + }, + "userStatus":{ + "shape":"String", + "documentation":"The status of the user returned by the application.
" + }, + "taskError":{ + "shape":"TaskError", + "documentation":"Contains information about an error returned from a user access task.
" + } + }, + "documentation":"Contains information about a user's access to an application.
" + }, + "UserAccessResultsList":{ + "type":"list", + "member":{"shape":"UserAccessResultItem"} + }, + "UserAccessTaskItem":{ + "type":"structure", + "required":[ + "app", + "tenantId" + ], + "members":{ + "app":{ + "shape":"String255", + "documentation":"The name of the application.
" + }, + "tenantId":{ + "shape":"TenantIdentifier", + "documentation":"The ID of the application tenant.
" + }, + "taskId":{ + "shape":"UUID", + "documentation":"The unique ID of the task.
" + }, + "error":{ + "shape":"TaskError", + "documentation":"Error from the task, if any.
" + } + }, + "documentation":"Contains information about a user access task.
" + }, + "UserAccessTasksList":{ + "type":"list", + "member":{"shape":"UserAccessTaskItem"} + }, + "ValidationException":{ + "type":"structure", + "required":[ + "message", + "reason" + ], + "members":{ + "message":{"shape":"String"}, + "reason":{ + "shape":"ValidationExceptionReason", + "documentation":"The reason for the exception.
" + }, + "fieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"The field list.
" + } + }, + "documentation":"The request has invalid or missing parameters.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "name", + "message" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"The field name where the invalid entry was detected.
" + }, + "message":{ + "shape":"String", + "documentation":"A message about the validation exception.
" + } + }, + "documentation":"The input failed to meet the constraints specified by the Amazon Web Services service in a specified field.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "unknownOperation", + "cannotParse", + "fieldValidationFailed", + "other" + ] + } + }, + "documentation":"Amazon Web Services AppFabric quickly connects software as a service (SaaS) applications across your organization. This allows IT and security teams to easily manage and secure applications using a standard schema, and employees can complete everyday tasks faster using generative artificial intelligence (AI). You can use these APIs to complete AppFabric tasks, such as setting up audit log ingestions or viewing user access. For more information about AppFabric, including the required permissions to use the service, see the Amazon Web Services AppFabric Administration Guide. For more information about using the Command Line Interface (CLI) to manage your AppFabric resources, see the AppFabric section of the CLI Reference.
" +} diff --git a/testbed/boto__botocore/botocore/data/appfabric/2023-05-19/waiters-2.json b/testbed/boto__botocore/botocore/data/appfabric/2023-05-19/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..13f60ee66be6a3d75208653e2bd7b563561adacc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/appfabric/2023-05-19/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/testbed/boto__botocore/botocore/data/application-signals/2024-04-15/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/application-signals/2024-04-15/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..7ec23c86b67fc3b7adc48fd2f3a71db104efc458 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/application-signals/2024-04-15/endpoint-rule-set-1.json @@ -0,0 +1,137 @@ +{ + "version": "1.0", + "parameters": { + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + }, + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://application-signals-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://application-signals.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/application-signals/2024-04-15/paginators-1.sdk-extras.json b/testbed/boto__botocore/botocore/data/application-signals/2024-04-15/paginators-1.sdk-extras.json new file mode 100644 index 0000000000000000000000000000000000000000..d6fcd51478dd47f902aed040472d4e59ce9ca643 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/application-signals/2024-04-15/paginators-1.sdk-extras.json @@ -0,0 +1,31 @@ +{ + "version": 1.0, + "merge": { + "pagination": { + "ListServiceDependencies": { + "non_aggregate_keys": [ + "StartTime", + "EndTime" + ] + }, + "ListServiceDependents": { + "non_aggregate_keys": [ + "StartTime", + "EndTime" + ] + }, + "ListServiceOperations": { + "non_aggregate_keys": [ + "StartTime", + "EndTime" + ] + }, + "ListServices": { + "non_aggregate_keys": [ + "StartTime", + "EndTime" + ] + } + } + } + } diff --git a/testbed/boto__botocore/botocore/data/application-signals/2024-04-15/service-2.json b/testbed/boto__botocore/botocore/data/application-signals/2024-04-15/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..1d944fe2a187c528ff5bdd249c3553bcf9559c37 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/application-signals/2024-04-15/service-2.json @@ -0,0 +1,1975 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2024-04-15", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"application-signals", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"Amazon CloudWatch Application Signals", + "serviceId":"Application Signals", + "signatureVersion":"v4", + "signingName":"application-signals", + "uid":"application-signals-2024-04-15" + }, + "operations":{ + "BatchGetServiceLevelObjectiveBudgetReport":{ + "name":"BatchGetServiceLevelObjectiveBudgetReport", + "http":{ + "method":"POST", + "requestUri":"/budget-report", + "responseCode":200 + }, + "input":{"shape":"BatchGetServiceLevelObjectiveBudgetReportInput"}, + "output":{"shape":"BatchGetServiceLevelObjectiveBudgetReportOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Use this operation to retrieve one or more service level objective (SLO) budget reports.
An error budget is the amount of time or requests in an unhealthy state that your service can accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be unmet. For example, an SLO with a threshold of 99.95% and a monthly interval translates to an error budget of 21.9 minutes of downtime in a 30-day month.
Budget reports include a health indicator, the attainment value, and remaining budget.
For more information about SLO error budgets, see SLO concepts.
" + }, + "CreateServiceLevelObjective":{ + "name":"CreateServiceLevelObjective", + "http":{ + "method":"POST", + "requestUri":"/slo", + "responseCode":200 + }, + "input":{"shape":"CreateServiceLevelObjectiveInput"}, + "output":{"shape":"CreateServiceLevelObjectiveOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"} + ], + "documentation":"Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations. Use SLOs to set and track specific target levels for the reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to calculate whether the application is performing at the level that you want.
Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch measures this target frequently you can find whether it has been breached.
The target performance quality that is defined for an SLO is the attainment goal.
You can set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability. You can also set SLOs against any CloudWatch metric or math expression that produces a time series.
When you create an SLO, you specify whether it is a period-based SLO or a request-based SLO. Each type of SLO has a different way of evaluating your application's performance against its attainment goal.
A period-based SLO uses defined periods of time within a specified total time interval. For each period of time, Application Signals determines whether the application met its goal. The attainment rate is calculated as the number of good periods/number of total periods.
For example, for a period-based SLO, meeting an attainment goal of 99.9% means that within your interval, your application must meet its performance goal during at least 99.9% of the time periods.
A request-based SLO doesn't use pre-defined periods of time. Instead, the SLO measures number of good requests/number of total requests during the interval. At any time, you can find the ratio of good requests to total requests for the interval up to the time stamp that you specify, and measure that ratio against the goal set in your SLO.
After you have created an SLO, you can retrieve error budget reports for it. An error budget is the amount of time or amount of requests that your application can be non-compliant with the SLO's goal, and still have your application meet the goal.
For a period-based SLO, the error budget starts at a number defined by the highest number of periods that can fail to meet the threshold, while still meeting the overall goal. The remaining error budget decreases with every failed period that is recorded. The error budget within one interval can never increase.
For example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month translates to an error budget of 21.9 minutes of downtime per month.
For a request-based SLO, the remaining error budget is dynamic and can increase or decrease, depending on the ratio of good requests to total requests.
For more information about SLOs, see Service level objectives (SLOs).
When you perform a CreateServiceLevelObjective operation, Application Signals creates the AWSServiceRoleForCloudWatchApplicationSignals service-linked role, if it doesn't already exist in your account. This service- linked role has the following permissions:
xray:GetServiceGraph
logs:StartQuery
logs:GetQueryResults
cloudwatch:GetMetricData
cloudwatch:ListMetrics
tag:GetResources
autoscaling:DescribeAutoScalingGroups
Deletes the specified service level objective.
", + "idempotent":true + }, + "GetService":{ + "name":"GetService", + "http":{ + "method":"POST", + "requestUri":"/service", + "responseCode":200 + }, + "input":{"shape":"GetServiceInput"}, + "output":{"shape":"GetServiceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns information about a service discovered by Application Signals.
" + }, + "GetServiceLevelObjective":{ + "name":"GetServiceLevelObjective", + "http":{ + "method":"GET", + "requestUri":"/slo/{Id}", + "responseCode":200 + }, + "input":{"shape":"GetServiceLevelObjectiveInput"}, + "output":{"shape":"GetServiceLevelObjectiveOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns information about one SLO created in the account.
" + }, + "ListServiceDependencies":{ + "name":"ListServiceDependencies", + "http":{ + "method":"POST", + "requestUri":"/service-dependencies", + "responseCode":200 + }, + "input":{"shape":"ListServiceDependenciesInput"}, + "output":{"shape":"ListServiceDependenciesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a list of service dependencies of the service that you specify. A dependency is an infrastructure component that an operation of this service connects with. Dependencies can include Amazon Web Services services, Amazon Web Services resources, and third-party services.
" + }, + "ListServiceDependents":{ + "name":"ListServiceDependents", + "http":{ + "method":"POST", + "requestUri":"/service-dependents", + "responseCode":200 + }, + "input":{"shape":"ListServiceDependentsInput"}, + "output":{"shape":"ListServiceDependentsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns the list of dependents that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.
" + }, + "ListServiceLevelObjectives":{ + "name":"ListServiceLevelObjectives", + "http":{ + "method":"POST", + "requestUri":"/slos", + "responseCode":200 + }, + "input":{"shape":"ListServiceLevelObjectivesInput"}, + "output":{"shape":"ListServiceLevelObjectivesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a list of SLOs created in this account.
" + }, + "ListServiceOperations":{ + "name":"ListServiceOperations", + "http":{ + "method":"POST", + "requestUri":"/service-operations", + "responseCode":200 + }, + "input":{"shape":"ListServiceOperationsInput"}, + "output":{"shape":"ListServiceOperationsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a list of the operations of this service that have been discovered by Application Signals. Only the operations that were invoked during the specified time range are returned.
" + }, + "ListServices":{ + "name":"ListServices", + "http":{ + "method":"GET", + "requestUri":"/services", + "responseCode":200 + }, + "input":{"shape":"ListServicesInput"}, + "output":{"shape":"ListServicesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a list of services that have been discovered by Application Signals. A service represents a minimum logical and transactional unit that completes a business function. Services are discovered through Application Signals instrumentation.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Displays the tags associated with a CloudWatch resource. Tags can be assigned to service level objectives.
" + }, + "StartDiscovery":{ + "name":"StartDiscovery", + "http":{ + "method":"POST", + "requestUri":"/start-discovery", + "responseCode":200 + }, + "input":{"shape":"StartDiscoveryInput"}, + "output":{"shape":"StartDiscoveryOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role. This service- linked role has the following permissions:
xray:GetServiceGraph
logs:StartQuery
logs:GetQueryResults
cloudwatch:GetMetricData
cloudwatch:ListMetrics
tag:GetResources
autoscaling:DescribeAutoScalingGroups
After completing this step, you still need to instrument your Java and Python applications to send data to Application Signals. For more information, see Enabling Application Signals.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tag-resource", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a CloudWatch resource.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/untag-resource", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Removes one or more tags from the specified resource.
" + }, + "UpdateServiceLevelObjective":{ + "name":"UpdateServiceLevelObjective", + "http":{ + "method":"PATCH", + "requestUri":"/slo/{Id}", + "responseCode":200 + }, + "input":{"shape":"UpdateServiceLevelObjectiveInput"}, + "output":{"shape":"UpdateServiceLevelObjectiveOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Updates an existing service level objective (SLO). If you omit parameters, the previous values of those parameters are retained.
You cannot change from a period-based SLO to a request-based SLO, or change from a request-based SLO to a period-based SLO.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ServiceErrorMessage"} + }, + "documentation":"You don't have sufficient permissions to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccountId":{ + "type":"string", + "max":255, + "min":1 + }, + "AmazonResourceName":{ + "type":"string", + "max":1024, + "min":1 + }, + "Attainment":{ + "type":"double", + "box":true + }, + "AttainmentGoal":{ + "type":"double", + "box":true + }, + "AttributeMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "AttributeMaps":{ + "type":"list", + "member":{"shape":"AttributeMap"} + }, + "Attributes":{ + "type":"map", + "key":{"shape":"KeyAttributeName"}, + "value":{"shape":"KeyAttributeValue"}, + "max":3, + "min":1 + }, + "BatchGetServiceLevelObjectiveBudgetReportInput":{ + "type":"structure", + "required":[ + "Timestamp", + "SloIds" + ], + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"The date and time that you want the report to be for. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
" + }, + "SloIds":{ + "shape":"ServiceLevelObjectiveIds", + "documentation":"An array containing the IDs of the service level objectives that you want to include in the report.
" + } + } + }, + "BatchGetServiceLevelObjectiveBudgetReportOutput":{ + "type":"structure", + "required":[ + "Timestamp", + "Reports", + "Errors" + ], + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"The date and time that the report is for. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
" + }, + "Reports":{ + "shape":"ServiceLevelObjectiveBudgetReports", + "documentation":"An array of structures, where each structure is one budget report.
" + }, + "Errors":{ + "shape":"ServiceLevelObjectiveBudgetReportErrors", + "documentation":"An array of structures, where each structure includes an error indicating that one of the requests in the array was not valid.
" + } + } + }, + "BudgetRequestsRemaining":{ + "type":"integer", + "box":true + }, + "BudgetSecondsRemaining":{ + "type":"integer", + "box":true + }, + "CalendarInterval":{ + "type":"structure", + "required":[ + "StartTime", + "DurationUnit", + "Duration" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"The date and time when you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.
When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
As soon as one calendar interval ends, another automatically begins.
" + }, + "DurationUnit":{ + "shape":"DurationUnit", + "documentation":"Specifies the calendar interval unit.
" + }, + "Duration":{ + "shape":"CalendarIntervalDuration", + "documentation":"Specifies the duration of each calendar interval. For example, if Duration is 1 and DurationUnit is MONTH, each interval is one month, aligned with the calendar.
If the interval for this service level objective is a calendar interval, this structure contains the interval specifications.
" + }, + "CalendarIntervalDuration":{ + "type":"integer", + "box":true, + "min":1 + }, + "ConflictException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"This operation attempted to create a resource that already exists.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateServiceLevelObjectiveInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"ServiceLevelObjectiveName", + "documentation":"A name for this SLO.
" + }, + "Description":{ + "shape":"ServiceLevelObjectiveDescription", + "documentation":"An optional description for this SLO.
" + }, + "SliConfig":{ + "shape":"ServiceLevelIndicatorConfig", + "documentation":"If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.
You can't specify both RequestBasedSliConfig and SliConfig in the same operation.
If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.
You can't specify both RequestBasedSliConfig and SliConfig in the same operation.
This structure contains the attributes that determine the goal of the SLO.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO. To be able to associate tags with the SLO when you create the SLO, you must have the cloudwatch:TagResource permission.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
" + } + } + }, + "CreateServiceLevelObjectiveOutput":{ + "type":"structure", + "required":["Slo"], + "members":{ + "Slo":{ + "shape":"ServiceLevelObjective", + "documentation":"A structure that contains information about the SLO that you just created.
" + } + } + }, + "DeleteServiceLevelObjectiveInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ServiceLevelObjectiveId", + "documentation":"The ARN or name of the service level objective to delete.
", + "location":"uri", + "locationName":"Id" + } + } + }, + "DeleteServiceLevelObjectiveOutput":{ + "type":"structure", + "members":{ + } + }, + "Dimension":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"DimensionName", + "documentation":"The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.
" + } + }, + "documentation":"A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
" + }, + "DimensionName":{ + "type":"string", + "max":255, + "min":1 + }, + "DimensionValue":{ + "type":"string", + "max":1024, + "min":1 + }, + "Dimensions":{ + "type":"list", + "member":{"shape":"Dimension"}, + "max":30, + "min":0 + }, + "DurationUnit":{ + "type":"string", + "enum":[ + "MINUTE", + "HOUR", + "DAY", + "MONTH" + ] + }, + "EvaluationType":{ + "type":"string", + "enum":[ + "PeriodBased", + "RequestBased" + ] + }, + "FaultDescription":{"type":"string"}, + "GetServiceInput":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime", + "KeyAttributes" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
Your requested start time will be rounded to the nearest hour.
", + "location":"querystring", + "locationName":"StartTime" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
Your requested start time will be rounded to the nearest hour.
", + "location":"querystring", + "locationName":"EndTime" + }, + "KeyAttributes":{ + "shape":"Attributes", + "documentation":"Use this field to specify which service you want to retrieve information for. 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.
The ARN or name of the SLO that you want to retrieve information about. You can find the ARNs of SLOs by using the ListServiceLevelObjectives operation.
", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetServiceLevelObjectiveOutput":{ + "type":"structure", + "required":["Slo"], + "members":{ + "Slo":{ + "shape":"ServiceLevelObjective", + "documentation":"A structure containing the information about the SLO.
" + } + } + }, + "GetServiceOutput":{ + "type":"structure", + "required":[ + "Service", + "StartTime", + "EndTime" + ], + "members":{ + "Service":{ + "shape":"Service", + "documentation":"A structure containing information about the service.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057.
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057.
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
" + }, + "LogGroupReferences":{ + "shape":"LogGroupReferences", + "documentation":"An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:
\"Type\": \"AWS::Resource\"
\"ResourceType\": \"AWS::Logs::LogGroup\"
\"Identifier\": \"name-of-log-group\"
The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.
If you omit this parameter, a rolling interval of 7 days is used.
" + }, + "AttainmentGoal":{ + "shape":"AttainmentGoal", + "documentation":"The threshold that determines if the goal is being met.
If this is a period-based SLO, the attainment goal is the percentage of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.
If this is a request-based SLO, the attainment goal is the percentage of requests that must be successful to meet the attainment goal.
If you omit this parameter, 99 is used to represent 99% as the attainment goal.
" + }, + "WarningThreshold":{ + "shape":"WarningThreshold", + "documentation":"The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used.
" + } + }, + "documentation":"This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.
" + }, + "Interval":{ + "type":"structure", + "members":{ + "RollingInterval":{ + "shape":"RollingInterval", + "documentation":"If the interval is a rolling interval, this structure contains the interval specifications.
" + }, + "CalendarInterval":{ + "shape":"CalendarInterval", + "documentation":"If the interval is a calendar interval, this structure contains the interval specifications.
" + } + }, + "documentation":"The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.
", + "union":true + }, + "KeyAttributeName":{ + "type":"string", + "pattern":"[a-zA-Z]{1,50}" + }, + "KeyAttributeValue":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[ -~]*[!-~]+[ -~]*" + }, + "ListServiceDependenciesInput":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime", + "KeyAttributes" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
Your requested start time will be rounded to the nearest hour.
", + "location":"querystring", + "locationName":"StartTime" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
Your requested end time will be rounded to the nearest hour.
", + "location":"querystring", + "locationName":"EndTime" + }, + "KeyAttributes":{ + "shape":"Attributes", + "documentation":"Use this field to specify which service you want to retrieve information for. 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.
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Include this value, if it was returned by the previous operation, to get the next set of service dependencies.
", + "location":"querystring", + "locationName":"NextToken" + } + } + }, + "ListServiceDependenciesMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListServiceDependenciesOutput":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime", + "ServiceDependencies" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
" + }, + "ServiceDependencies":{ + "shape":"ServiceDependencies", + "documentation":"An array, where each object in the array contains information about one of the dependencies of this service.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Include this value in your next use of this API to get next set of service dependencies.
" + } + } + }, + "ListServiceDependentsInput":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime", + "KeyAttributes" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
Your requested start time will be rounded to the nearest hour.
", + "location":"querystring", + "locationName":"StartTime" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
Your requested start time will be rounded to the nearest hour.
", + "location":"querystring", + "locationName":"EndTime" + }, + "KeyAttributes":{ + "shape":"Attributes", + "documentation":"Use this field to specify which service you want to retrieve information for. 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.
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Include this value, if it was returned by the previous operation, to get the next set of service dependents.
", + "location":"querystring", + "locationName":"NextToken" + } + } + }, + "ListServiceDependentsMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListServiceDependentsOutput":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime", + "ServiceDependents" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
" + }, + "ServiceDependents":{ + "shape":"ServiceDependents", + "documentation":"An array, where each object in the array contains information about one of the dependents of this service.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Include this value in your next use of this API to get next set of service dependents.
" + } + } + }, + "ListServiceLevelObjectivesInput":{ + "type":"structure", + "members":{ + "KeyAttributes":{ + "shape":"Attributes", + "documentation":"You can use this optional field to specify which services you want to retrieve SLO information for.
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.
The name of the operation that this SLO is associated with.
", + "location":"querystring", + "locationName":"OperationName" + }, + "MaxResults":{ + "shape":"ListServiceLevelObjectivesMaxResults", + "documentation":"The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Include this value, if it was returned by the previous operation, to get the next set of service level objectives.
", + "location":"querystring", + "locationName":"NextToken" + } + } + }, + "ListServiceLevelObjectivesMaxResults":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "ListServiceLevelObjectivesOutput":{ + "type":"structure", + "members":{ + "SloSummaries":{ + "shape":"ServiceLevelObjectiveSummaries", + "documentation":"An array of structures, where each structure contains information about one SLO.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Include this value in your next use of this API to get next set of service level objectives.
" + } + } + }, + "ListServiceOperationMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListServiceOperationsInput":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime", + "KeyAttributes" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
Your requested start time will be rounded to the nearest hour.
", + "location":"querystring", + "locationName":"StartTime" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
Your requested end time will be rounded to the nearest hour.
", + "location":"querystring", + "locationName":"EndTime" + }, + "KeyAttributes":{ + "shape":"Attributes", + "documentation":"Use this field to specify which service you want to retrieve information for. 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.
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Include this value, if it was returned by the previous operation, to get the next set of service operations.
", + "location":"querystring", + "locationName":"NextToken" + } + } + }, + "ListServiceOperationsOutput":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime", + "ServiceOperations" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
" + }, + "ServiceOperations":{ + "shape":"ServiceOperations", + "documentation":"An array of structures that each contain information about one operation of this service.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Include this value in your next use of this API to get next set of service operations.
" + } + } + }, + "ListServicesInput":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
Your requested start time will be rounded to the nearest hour.
", + "location":"querystring", + "locationName":"StartTime" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
Your requested start time will be rounded to the nearest hour.
", + "location":"querystring", + "locationName":"EndTime" + }, + "MaxResults":{ + "shape":"ListServicesMaxResults", + "documentation":"The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Include this value, if it was returned by the previous operation, to get the next set of services.
", + "location":"querystring", + "locationName":"NextToken" + } + } + }, + "ListServicesMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListServicesOutput":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime", + "ServiceSummaries" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
" + }, + "ServiceSummaries":{ + "shape":"ServiceSummaries", + "documentation":"An array of structures, where each structure contains some information about a service. To get complete information about a service, use GetService.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Include this value in your next use of this API to get next set of services.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the CloudWatch resource that you want to view tags for.
The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
", + "location":"querystring", + "locationName":"ResourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"The list of tag keys and values associated with the resource you specified.
" + } + } + }, + "LogGroupReferences":{ + "type":"list", + "member":{"shape":"Attributes"} + }, + "Metric":{ + "type":"structure", + "members":{ + "Namespace":{ + "shape":"Namespace", + "documentation":"The namespace of the metric. For more information, see Namespaces.
" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"The name of the metric to use.
" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
" + } + }, + "documentation":"This structure defines the metric used for a service level indicator, including the metric name, namespace, and dimensions
" + }, + "MetricDataQueries":{ + "type":"list", + "member":{"shape":"MetricDataQuery"} + }, + "MetricDataQuery":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"MetricId", + "documentation":"A short name used to tie this object to the results in the response. This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.
A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
" + }, + "ReturnData":{ + "shape":"ReturnData", + "documentation":"Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.
The granularity, in seconds, of the returned data points for this metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
The ID of the account where this metric is located. If you are performing this operation in a monitoring account, use this to specify which source account to retrieve this metric from.
" + } + }, + "documentation":"Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
The namespace of the metric. For more information, see CloudWatchNamespaces.
" + }, + "MetricType":{ + "shape":"MetricType", + "documentation":"Used to display the appropriate statistics in the CloudWatch console.
" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"An array of one or more dimensions that further define the metric. For more information, see CloudWatchDimensions.
" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"The name of the metric.
" + } + }, + "documentation":"This structure contains information about one CloudWatch metric associated with this entity discovered by Application Signals.
" + }, + "MetricReferences":{ + "type":"list", + "member":{"shape":"MetricReference"} + }, + "MetricStat":{ + "type":"structure", + "required":[ + "Metric", + "Period", + "Stat" + ], + "members":{ + "Metric":{ + "shape":"Metric", + "documentation":"The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
" + }, + "Period":{ + "shape":"Period", + "documentation":"The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
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.
" + }, + "Unit":{ + "shape":"StandardUnit", + "documentation":"If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
This structure defines the metric to be used as the service level indicator, along with the statistics, period, and unit.
" + }, + "MetricType":{ + "type":"string", + "pattern":"[A-Za-z0-9 -]+" + }, + "MonitoredRequestCountMetricDataQueries":{ + "type":"structure", + "members":{ + "GoodCountMetric":{ + "shape":"MetricDataQueries", + "documentation":"If you want to count \"good requests\" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as \"good requests\" in this structure.
" + }, + "BadCountMetric":{ + "shape":"MetricDataQueries", + "documentation":"If you want to count \"bad requests\" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as \"bad requests\" in this structure.
" + } + }, + "documentation":"This structure defines the metric that is used as the \"good request\" or \"bad request\" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric is divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.
A structure that contains information about the metric that the SLO monitors.
" + }, + "MetricThreshold":{ + "shape":"ServiceLevelIndicatorMetricThreshold", + "documentation":"This value is the threshold that the observed metric values of the SLI metric are compared to.
" + }, + "ComparisonOperator":{ + "shape":"ServiceLevelIndicatorComparisonOperator", + "documentation":"The arithmetic operation used when comparing the specified metric to the threshold.
" + } + }, + "documentation":"This structure contains information about the performance metric that a request-based SLO monitors.
" + }, + "RequestBasedServiceLevelIndicatorConfig":{ + "type":"structure", + "required":["RequestBasedSliMetricConfig"], + "members":{ + "RequestBasedSliMetricConfig":{ + "shape":"RequestBasedServiceLevelIndicatorMetricConfig", + "documentation":"Use this structure to specify the metric to be used for the SLO.
" + }, + "MetricThreshold":{ + "shape":"ServiceLevelIndicatorMetricThreshold", + "documentation":"The value that the SLI metric is compared to. This parameter is required if this SLO is tracking the Latency metric.
The arithmetic operation to use when comparing the specified metric to the threshold. This parameter is required if this SLO is tracking the Latency metric.
This structure specifies the information about the service and the performance metric that a request-based SLO is to monitor.
" + }, + "RequestBasedServiceLevelIndicatorMetric":{ + "type":"structure", + "required":[ + "TotalRequestCountMetric", + "MonitoredRequestCountMetric" + ], + "members":{ + "KeyAttributes":{ + "shape":"Attributes", + "documentation":"This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.
Type designates the type of object that this SLO is related to.
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.
If the SLO monitors a specific operation of the service, this field displays that operation name.
" + }, + "MetricType":{ + "shape":"ServiceLevelIndicatorMetricType", + "documentation":"If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.
This structure defines the metric that is used as the \"total requests\" number for a request-based SLO. The number observed for this metric is divided by the number of \"good requests\" or \"bad requests\" that is observed for the metric defined in MonitoredRequestCountMetric.
This structure defines the metric that is used as the \"good request\" or \"bad request\" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric is divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.
This structure contains the information about the metric that is used for a request-based SLO.
" + }, + "RequestBasedServiceLevelIndicatorMetricConfig":{ + "type":"structure", + "members":{ + "KeyAttributes":{ + "shape":"Attributes", + "documentation":"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.
If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.
" + }, + "MetricType":{ + "shape":"ServiceLevelIndicatorMetricType", + "documentation":"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.
Use this structure to define the metric that you want to use as the \"total requests\" number for a request-based SLO. This result will be divided by the \"good request\" or \"bad request\" value defined in MonitoredRequestCountMetric.
Use this structure to define the metric that you want to use as the \"good request\" or \"bad request\" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric will be divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.
Use this structure to specify the information for the metric that a period-based SLO will monitor.
" + }, + "ResourceId":{"type":"string"}, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceId", + "Message" + ], + "members":{ + "ResourceType":{ + "shape":"ResourceType", + "documentation":"The resource type is not valid.
" + }, + "ResourceId":{ + "shape":"ResourceId", + "documentation":"Can't find the resource id.
" + }, + "Message":{"shape":"FaultDescription"} + }, + "documentation":"Resource not found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceType":{"type":"string"}, + "ReturnData":{ + "type":"boolean", + "box":true + }, + "RollingInterval":{ + "type":"structure", + "required":[ + "DurationUnit", + "Duration" + ], + "members":{ + "DurationUnit":{ + "shape":"DurationUnit", + "documentation":"Specifies the rolling interval unit.
" + }, + "Duration":{ + "shape":"RollingIntervalDuration", + "documentation":"Specifies the duration of each rolling interval. For example, if Duration is 7 and DurationUnit is DAY, each rolling interval is seven days.
If the interval for this SLO is a rolling interval, this structure contains the interval specifications.
" + }, + "RollingIntervalDuration":{ + "type":"integer", + "box":true, + "min":1 + }, + "SLIPeriodSeconds":{ + "type":"integer", + "box":true, + "max":900, + "min":60 + }, + "Service":{ + "type":"structure", + "required":[ + "KeyAttributes", + "MetricReferences" + ], + "members":{ + "KeyAttributes":{ + "shape":"Attributes", + "documentation":"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.
This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.
Platform attributes contain information the service's platform.
PlatformType defines the hosted-in platform.
EKS.Cluster is the name of the Amazon EKS cluster.
K8s.Cluster is the name of the self-hosted Kubernetes cluster.
K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.
K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.
K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.
K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.
EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.
EC2.InstanceId is the ID of the Amazon EC2 instance.
Host is the name of the host, for all platform types.
Application attributes contain information about the application.
AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.
AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
Telemetry attributes contain telemetry information.
Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.
Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.
Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.
An array of structures that each contain information about one metric associated with this service.
" + }, + "LogGroupReferences":{ + "shape":"LogGroupReferences", + "documentation":"An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:
\"Type\": \"AWS::Resource\"
\"ResourceType\": \"AWS::Logs::LogGroup\"
\"Identifier\": \"name-of-log-group\"
This structure contains information about one of your services that was discovered by Application Signals.
" + }, + "ServiceDependencies":{ + "type":"list", + "member":{"shape":"ServiceDependency"}, + "max":100, + "min":0 + }, + "ServiceDependency":{ + "type":"structure", + "required":[ + "OperationName", + "DependencyKeyAttributes", + "DependencyOperationName", + "MetricReferences" + ], + "members":{ + "OperationName":{ + "shape":"OperationName", + "documentation":"The name of the operation in this service that calls the dependency.
" + }, + "DependencyKeyAttributes":{ + "shape":"Attributes", + "documentation":"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.
The name of the called operation in the dependency.
" + }, + "MetricReferences":{ + "shape":"MetricReferences", + "documentation":"An array of structures that each contain information about one metric associated with this service dependency that was discovered by Application Signals.
" + } + }, + "documentation":"This structure contains information about one dependency of this service.
" + }, + "ServiceDependent":{ + "type":"structure", + "required":[ + "DependentKeyAttributes", + "MetricReferences" + ], + "members":{ + "OperationName":{ + "shape":"OperationName", + "documentation":"If the invoked entity is an operation on an entity, the name of that dependent operation is displayed here.
" + }, + "DependentKeyAttributes":{ + "shape":"Attributes", + "documentation":"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.
If the dependent invoker was a service that invoked it from an operation, the name of that dependent operation is displayed here.
" + }, + "MetricReferences":{ + "shape":"MetricReferences", + "documentation":"An array of structures that each contain information about one metric associated with this service dependent that was discovered by Application Signals.
" + } + }, + "documentation":"This structure contains information about a service dependent that was discovered by Application Signals. A dependent is an entity that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.
" + }, + "ServiceDependents":{ + "type":"list", + "member":{"shape":"ServiceDependent"}, + "max":100, + "min":0 + }, + "ServiceErrorMessage":{"type":"string"}, + "ServiceLevelIndicator":{ + "type":"structure", + "required":[ + "SliMetric", + "MetricThreshold", + "ComparisonOperator" + ], + "members":{ + "SliMetric":{ + "shape":"ServiceLevelIndicatorMetric", + "documentation":"A structure that contains information about the metric that the SLO monitors.
" + }, + "MetricThreshold":{ + "shape":"ServiceLevelIndicatorMetricThreshold", + "documentation":"The value that the SLI metric is compared to.
" + }, + "ComparisonOperator":{ + "shape":"ServiceLevelIndicatorComparisonOperator", + "documentation":"The arithmetic operation used when comparing the specified metric to the threshold.
" + } + }, + "documentation":"This structure contains information about the performance metric that a period-based SLO monitors.
" + }, + "ServiceLevelIndicatorComparisonOperator":{ + "type":"string", + "enum":[ + "GreaterThanOrEqualTo", + "GreaterThan", + "LessThan", + "LessThanOrEqualTo" + ] + }, + "ServiceLevelIndicatorConfig":{ + "type":"structure", + "required":[ + "SliMetricConfig", + "MetricThreshold", + "ComparisonOperator" + ], + "members":{ + "SliMetricConfig":{ + "shape":"ServiceLevelIndicatorMetricConfig", + "documentation":"Use this structure to specify the metric to be used for the SLO.
" + }, + "MetricThreshold":{ + "shape":"ServiceLevelIndicatorMetricThreshold", + "documentation":"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.
The arithmetic operation to use when comparing the specified metric to the threshold.
" + } + }, + "documentation":"This structure specifies the information about the service and the performance metric that a period-based SLO is to monitor.
" + }, + "ServiceLevelIndicatorMetric":{ + "type":"structure", + "required":["MetricDataQueries"], + "members":{ + "KeyAttributes":{ + "shape":"Attributes", + "documentation":"This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.
Type designates the type of object that this SLO is related to.
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.
If the SLO monitors a specific operation of the service, this field displays that operation name.
" + }, + "MetricType":{ + "shape":"ServiceLevelIndicatorMetricType", + "documentation":"If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.
If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure includes the information about that metric or expression.
" + } + }, + "documentation":"This structure contains the information about the metric that is used for a period-based SLO.
" + }, + "ServiceLevelIndicatorMetricConfig":{ + "type":"structure", + "members":{ + "KeyAttributes":{ + "shape":"Attributes", + "documentation":"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.
If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.
" + }, + "MetricType":{ + "shape":"ServiceLevelIndicatorMetricType", + "documentation":"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.
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":{ + "shape":"SLIPeriodSeconds", + "documentation":"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.
" + }, + "MetricDataQueries":{ + "shape":"MetricDataQueries", + "documentation":"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.
" + } + }, + "documentation":"Use this structure to specify the information for the metric that a period-based SLO will monitor.
" + }, + "ServiceLevelIndicatorMetricThreshold":{ + "type":"double", + "box":true + }, + "ServiceLevelIndicatorMetricType":{ + "type":"string", + "enum":[ + "LATENCY", + "AVAILABILITY" + ] + }, + "ServiceLevelIndicatorStatistic":{ + "type":"string", + "max":20, + "min":1, + "pattern":"[a-zA-Z0-9.]+" + }, + "ServiceLevelObjective":{ + "type":"structure", + "required":[ + "Arn", + "Name", + "CreatedTime", + "LastUpdatedTime", + "Goal" + ], + "members":{ + "Arn":{ + "shape":"ServiceLevelObjectiveArn", + "documentation":"The ARN of this SLO.
" + }, + "Name":{ + "shape":"ServiceLevelObjectiveName", + "documentation":"The name of this SLO.
" + }, + "Description":{ + "shape":"ServiceLevelObjectiveDescription", + "documentation":"The description that you created for this SLO.
" + }, + "CreatedTime":{ + "shape":"Timestamp", + "documentation":"The date and time that this SLO was created. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
The time that this SLO was most recently updated. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.
" + }, + "RequestBasedSli":{ + "shape":"RequestBasedServiceLevelIndicator", + "documentation":"A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.
" + }, + "EvaluationType":{ + "shape":"EvaluationType", + "documentation":"Displays whether this is a period-based SLO or a request-based SLO.
" + }, + "Goal":{"shape":"Goal"} + }, + "documentation":"A structure containing information about one service level objective (SLO) that has been created in Application Signals. Creating SLOs can help you ensure your services are performing to the level that you expect. SLOs help you set and track a specific target level for the reliability and availability of your applications and services. Each SLO uses a service level indicator (SLI), which is a key performance metric, to calculate how much underperformance can be tolerated before the goal that you set for the SLO is not achieved.
" + }, + "ServiceLevelObjectiveArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:aws:application-signals:[^:]*:[^:]*:slo/[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]" + }, + "ServiceLevelObjectiveBudgetReport":{ + "type":"structure", + "required":[ + "Arn", + "Name", + "BudgetStatus" + ], + "members":{ + "Arn":{ + "shape":"ServiceLevelObjectiveArn", + "documentation":"The ARN of the SLO that this report is for.
" + }, + "Name":{ + "shape":"ServiceLevelObjectiveName", + "documentation":"The name of the SLO that this report is for.
" + }, + "EvaluationType":{ + "shape":"EvaluationType", + "documentation":"Displays whether this budget report is for a period-based SLO or a request-based SLO.
" + }, + "BudgetStatus":{ + "shape":"ServiceLevelObjectiveBudgetStatus", + "documentation":"The status of this SLO, as it relates to the error budget for the entire time interval.
OK means that the SLO had remaining budget above the warning threshold, as of the time that you specified in TimeStamp.
WARNING means that the SLO's remaining budget was below the warning threshold, as of the time that you specified in TimeStamp.
BREACHED means that the SLO's budget was exhausted, as of the time that you specified in TimeStamp.
INSUFFICIENT_DATA means that the specified start and end times were before the SLO was created, or that attainment data is missing.
A number between 0 and 100 that represents the success percentage of your application compared to the goal set by the SLO.
If this is a period-based SLO, the number is the percentage of time periods that the service has attained the SLO's attainment goal, as of the time of the request.
If this is a request-based SLO, the number is the number of successful requests divided by the number of total requests, multiplied by 100, during the time range that you specified in your request.
" + }, + "TotalBudgetSeconds":{ + "shape":"TotalBudgetSeconds", + "documentation":"The total number of seconds in the error budget for the interval. This field is included only if the SLO is a period-based SLO.
" + }, + "BudgetSecondsRemaining":{ + "shape":"BudgetSecondsRemaining", + "documentation":"The budget amount remaining before the SLO status becomes BREACHING, at the time specified in the Timestemp parameter of the request. If this value is negative, then the SLO is already in BREACHING status.
This field is included only if the SLO is a period-based SLO.
" + }, + "TotalBudgetRequests":{ + "shape":"TotalBudgetRequests", + "documentation":"This field is displayed only for request-based SLOs. It displays the total number of failed requests that can be tolerated during the time range between the start of the interval and the time stamp supplied in the budget report request. It is based on the total number of requests that occurred, and the percentage specified in the attainment goal. If the number of failed requests matches this number or is higher, then this SLO is currently breaching.
This number can go up and down between reports with different time stamps, based on both how many total requests occur.
" + }, + "BudgetRequestsRemaining":{ + "shape":"BudgetRequestsRemaining", + "documentation":"This field is displayed only for request-based SLOs. It displays the number of failed requests that can be tolerated before any more successful requests occur, and still have the application meet its SLO goal.
This number can go up and down between different reports, based on both how many successful requests and how many failed requests occur in that time.
" + }, + "Sli":{ + "shape":"ServiceLevelIndicator", + "documentation":"A structure that contains information about the performance metric that this SLO monitors.
" + }, + "RequestBasedSli":{"shape":"RequestBasedServiceLevelIndicator"}, + "Goal":{"shape":"Goal"} + }, + "documentation":"A structure containing an SLO budget report that you have requested.
" + }, + "ServiceLevelObjectiveBudgetReportError":{ + "type":"structure", + "required":[ + "Name", + "Arn", + "ErrorCode", + "ErrorMessage" + ], + "members":{ + "Name":{ + "shape":"ServiceLevelObjectiveName", + "documentation":"The name of the SLO that this error is related to.
" + }, + "Arn":{ + "shape":"ServiceLevelObjectiveArn", + "documentation":"The ARN of the SLO that this error is related to.
" + }, + "ErrorCode":{ + "shape":"ServiceLevelObjectiveBudgetReportErrorCode", + "documentation":"The error code for this error.
" + }, + "ErrorMessage":{ + "shape":"ServiceLevelObjectiveBudgetReportErrorMessage", + "documentation":"The message for this error.
" + } + }, + "documentation":"A structure containing information about one error that occurred during a BatchGetServiceLevelObjectiveBudgetReport operation.
" + }, + "ServiceLevelObjectiveBudgetReportErrorCode":{"type":"string"}, + "ServiceLevelObjectiveBudgetReportErrorMessage":{"type":"string"}, + "ServiceLevelObjectiveBudgetReportErrors":{ + "type":"list", + "member":{"shape":"ServiceLevelObjectiveBudgetReportError"}, + "max":50, + "min":0 + }, + "ServiceLevelObjectiveBudgetReports":{ + "type":"list", + "member":{"shape":"ServiceLevelObjectiveBudgetReport"}, + "max":50, + "min":0 + }, + "ServiceLevelObjectiveBudgetStatus":{ + "type":"string", + "enum":[ + "OK", + "WARNING", + "BREACHED", + "INSUFFICIENT_DATA" + ] + }, + "ServiceLevelObjectiveDescription":{ + "type":"string", + "max":1024, + "min":1 + }, + "ServiceLevelObjectiveId":{ + "type":"string", + "pattern":"[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$|^arn:aws:application-signals:[^:]*:[^:]*:slo/[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]" + }, + "ServiceLevelObjectiveIds":{ + "type":"list", + "member":{"shape":"String"}, + "max":50, + "min":1 + }, + "ServiceLevelObjectiveName":{ + "type":"string", + "pattern":"[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]" + }, + "ServiceLevelObjectiveSummaries":{ + "type":"list", + "member":{"shape":"ServiceLevelObjectiveSummary"} + }, + "ServiceLevelObjectiveSummary":{ + "type":"structure", + "required":[ + "Arn", + "Name" + ], + "members":{ + "Arn":{ + "shape":"ServiceLevelObjectiveArn", + "documentation":"The ARN of this service level objective.
" + }, + "Name":{ + "shape":"ServiceLevelObjectiveName", + "documentation":"The name of the service level objective.
" + }, + "KeyAttributes":{ + "shape":"Attributes", + "documentation":"This is a string-to-string map. It can include the following fields.
Type designates the type of object this service level objective is for.
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.
If this service level objective is specific to a single operation, this field displays the name of that operation.
" + }, + "CreatedTime":{ + "shape":"Timestamp", + "documentation":"The date and time that this service level objective was created. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
" + } + }, + "documentation":"A structure that contains information about one service level objective (SLO) created in Application Signals.
" + }, + "ServiceOperation":{ + "type":"structure", + "required":[ + "Name", + "MetricReferences" + ], + "members":{ + "Name":{ + "shape":"OperationName", + "documentation":"The name of the operation, discovered by Application Signals.
" + }, + "MetricReferences":{ + "shape":"MetricReferences", + "documentation":"An array of structures that each contain information about one metric associated with this service operation that was discovered by Application Signals.
" + } + }, + "documentation":"This structure contains information about an operation discovered by Application Signals. An operation is a specific function performed by a service that was discovered by Application Signals, and is often an API that is called by an upstream dependent.
" + }, + "ServiceOperations":{ + "type":"list", + "member":{"shape":"ServiceOperation"}, + "max":100, + "min":0 + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"This request exceeds a service quota.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "ServiceSummaries":{ + "type":"list", + "member":{"shape":"ServiceSummary"} + }, + "ServiceSummary":{ + "type":"structure", + "required":[ + "KeyAttributes", + "MetricReferences" + ], + "members":{ + "KeyAttributes":{ + "shape":"Attributes", + "documentation":"This is a string-to-string map that help identify the objects discovered by Application Signals. 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.
This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.
Platform attributes contain information the service's platform.
PlatformType defines the hosted-in platform.
EKS.Cluster is the name of the Amazon EKS cluster.
K8s.Cluster is the name of the self-hosted Kubernetes cluster.
K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.
K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.
K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.
K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.
EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.
EC2.InstanceId is the ID of the Amazon EC2 instance.
Host is the name of the host, for all platform types.
Application attributes contain information about the application.
AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.
AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
Telemetry attributes contain telemetry information.
Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.
Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.
Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.
An array of structures that each contain information about one metric associated with this service.
" + } + }, + "documentation":"This structure contains information about one of your services that was discovered by Application Signals
" + }, + "StandardUnit":{ + "type":"string", + "enum":[ + "Microseconds", + "Milliseconds", + "Seconds", + "Bytes", + "Kilobytes", + "Megabytes", + "Gigabytes", + "Terabytes", + "Bits", + "Kilobits", + "Megabits", + "Gigabits", + "Terabits", + "Percent", + "Count", + "Bytes/Second", + "Kilobytes/Second", + "Megabytes/Second", + "Gigabytes/Second", + "Terabytes/Second", + "Bits/Second", + "Kilobits/Second", + "Megabits/Second", + "Gigabits/Second", + "Terabits/Second", + "Count/Second", + "None" + ] + }, + "StartDiscoveryInput":{ + "type":"structure", + "members":{ + } + }, + "StartDiscoveryOutput":{ + "type":"structure", + "members":{ + } + }, + "Stat":{"type":"string"}, + "String":{"type":"string"}, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"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":{ + "shape":"TagValue", + "documentation":"The value for the specified tag key.
" + } + }, + "documentation":"A key-value pair associated with a resource. Tags can help you organize and categorize your resources.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the CloudWatch resource that you want to set tags for.
The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The list of key-value pairs to associate with the alarm.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "ThrottlingException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request was throttled because of quota limits.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "TotalBudgetRequests":{ + "type":"integer", + "box":true + }, + "TotalBudgetSeconds":{ + "type":"integer", + "box":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the CloudWatch resource that you want to delete tags from.
The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"The list of tag keys to remove from the resource.
" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateServiceLevelObjectiveInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ServiceLevelObjectiveId", + "documentation":"The Amazon Resource Name (ARN) or name of the service level objective that you want to update.
", + "location":"uri", + "locationName":"Id" + }, + "Description":{ + "shape":"ServiceLevelObjectiveDescription", + "documentation":"An optional description for the SLO.
" + }, + "SliConfig":{ + "shape":"ServiceLevelIndicatorConfig", + "documentation":"If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.
" + }, + "RequestBasedSliConfig":{ + "shape":"RequestBasedServiceLevelIndicatorConfig", + "documentation":"If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.
You can't specify both SliConfig and RequestBasedSliConfig in the same operation.
A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.
" + } + } + }, + "UpdateServiceLevelObjectiveOutput":{ + "type":"structure", + "required":["Slo"], + "members":{ + "Slo":{ + "shape":"ServiceLevelObjective", + "documentation":"A structure that contains information about the SLO that you just updated.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ValidationExceptionMessage"} + }, + "documentation":"The resource is not valid.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionMessage":{"type":"string"}, + "WarningThreshold":{ + "type":"double", + "box":true + } + }, + "documentation":"Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications. It enables real-time service health dashboards and helps you track long-term performance trends against your business goals. The application-centric view provides you with unified visibility across your applications, services, and dependencies, so you can proactively monitor and efficiently triage any issues that may arise, ensuring optimal customer experience.
Application Signals provides the following benefits:
Automatically collect metrics and traces from your applications, and display key metrics such as call volume, availability, latency, faults, and errors.
Create and monitor service level objectives (SLOs).
See a map of your application topology that Application Signals automatically discovers, that gives you a visual representation of your applications, dependencies, and their connectivity.
Application Signals works with CloudWatch RUM, CloudWatch Synthetics canaries, and Amazon Web Services Service Catalog AppRegistry, to display your client pages, Synthetics canaries, and application names within dashboards and maps.
" +} diff --git a/testbed/boto__botocore/botocore/data/arc-zonal-shift/2022-10-30/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/arc-zonal-shift/2022-10-30/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..dcb0d6105699df6eb78cef4f7ec81de97ffd91f9 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/arc-zonal-shift/2022-10-30/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://arc-zonal-shift-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://arc-zonal-shift-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://arc-zonal-shift.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://arc-zonal-shift.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/arc-zonal-shift/2022-10-30/paginators-1.json b/testbed/boto__botocore/botocore/data/arc-zonal-shift/2022-10-30/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..9fcfc565410f26b59b2e85578af16510db6541b6 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/arc-zonal-shift/2022-10-30/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListManagedResources": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "items" + }, + "ListZonalShifts": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "items" + }, + "ListAutoshifts": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "items" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/arc-zonal-shift/2022-10-30/service-2.json b/testbed/boto__botocore/botocore/data/arc-zonal-shift/2022-10-30/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..4e90fa1451409eb14efe91403d549a6b093761dc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/arc-zonal-shift/2022-10-30/service-2.json @@ -0,0 +1,1244 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-10-30", + "endpointPrefix":"arc-zonal-shift", + "jsonVersion":"1.1", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"AWS ARC - Zonal Shift", + "serviceId":"ARC Zonal Shift", + "signatureVersion":"v4", + "signingName":"arc-zonal-shift", + "uid":"arc-zonal-shift-2022-10-30", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "CancelZonalShift":{ + "name":"CancelZonalShift", + "http":{ + "method":"DELETE", + "requestUri":"/zonalshifts/{zonalShiftId}", + "responseCode":200 + }, + "input":{"shape":"CancelZonalShiftRequest"}, + "output":{"shape":"ZonalShift"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID.
A zonal shift can be one that you've started for a resource in your Amazon Web Services account in an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal autoshift.
" + }, + "CreatePracticeRunConfiguration":{ + "name":"CreatePracticeRunConfiguration", + "http":{ + "method":"POST", + "requestUri":"/configuration", + "responseCode":201 + }, + "input":{"shape":"CreatePracticeRunConfigurationRequest"}, + "output":{"shape":"CreatePracticeRunConfigurationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting.
When a resource has a practice run configuration, Route 53 ARC starts zonal shifts for the resource weekly, to shift traffic for practice runs. Practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
" + }, + "DeletePracticeRunConfiguration":{ + "name":"DeletePracticeRunConfiguration", + "http":{ + "method":"DELETE", + "requestUri":"/configuration/{resourceIdentifier}", + "responseCode":200 + }, + "input":{"shape":"DeletePracticeRunConfigurationRequest"}, + "output":{"shape":"DeletePracticeRunConfigurationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.
", + "idempotent":true + }, + "GetAutoshiftObserverNotificationStatus":{ + "name":"GetAutoshiftObserverNotificationStatus", + "http":{ + "method":"GET", + "requestUri":"/autoshift-observer-notification", + "responseCode":200 + }, + "input":{"shape":"GetAutoshiftObserverNotificationStatusRequest"}, + "output":{"shape":"GetAutoshiftObserverNotificationStatusResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.
If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.
For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.
" + }, + "GetManagedResource":{ + "name":"GetManagedResource", + "http":{ + "method":"GET", + "requestUri":"/managedresources/{resourceIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetManagedResourceRequest"}, + "output":{"shape":"GetManagedResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources.
At this time, you can only start a zonal shift or configure zonal autoshift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
" + }, + "ListAutoshifts":{ + "name":"ListAutoshifts", + "http":{ + "method":"GET", + "requestUri":"/autoshifts", + "responseCode":200 + }, + "input":{"shape":"ListAutoshiftsRequest"}, + "output":{"shape":"ListAutoshiftsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a list of autoshifts for an Amazon Web Services Region. By default, the call returns only ACTIVE autoshifts. Optionally, you can specify the status parameter to return COMPLETED autoshifts.
Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.
" + }, + "ListZonalShifts":{ + "name":"ListZonalShifts", + "http":{ + "method":"GET", + "requestUri":"/zonalshifts", + "responseCode":200 + }, + "input":{"shape":"ListZonalShiftsRequest"}, + "output":{"shape":"ListZonalShiftsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-initiated zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift.
The ListZonalShifts operation does not list autoshifts. For more information about listing autoshifts, see \">ListAutoshifts.
You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with Route 53 ARC by Amazon Web Services services.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes, for existing, in-progress connections in the Availability Zone to complete.
For more information, see Zonal shift in the Amazon Route 53 Application Recovery Controller Developer Guide.
" + }, + "UpdateAutoshiftObserverNotificationStatus":{ + "name":"UpdateAutoshiftObserverNotificationStatus", + "http":{ + "method":"PUT", + "requestUri":"/autoshift-observer-notification", + "responseCode":200 + }, + "input":{"shape":"UpdateAutoshiftObserverNotificationStatusRequest"}, + "output":{"shape":"UpdateAutoshiftObserverNotificationStatusResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Update the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.
If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.
For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.
", + "idempotent":true + }, + "UpdatePracticeRunConfiguration":{ + "name":"UpdatePracticeRunConfiguration", + "http":{ + "method":"PATCH", + "requestUri":"/configuration/{resourceIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdatePracticeRunConfigurationRequest"}, + "output":{"shape":"UpdatePracticeRunConfigurationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.
" + }, + "UpdateZonalAutoshiftConfiguration":{ + "name":"UpdateZonalAutoshiftConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/managedresources/{resourceIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateZonalAutoshiftConfigurationRequest"}, + "output":{"shape":"UpdateZonalAutoshiftConfigurationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuation, Route 53 ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.
You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal autoshift is ENABLED, you authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs.
Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AppliedStatus":{ + "type":"string", + "enum":[ + "APPLIED", + "NOT_APPLIED" + ] + }, + "AppliedWeights":{ + "type":"map", + "key":{"shape":"AvailabilityZone"}, + "value":{"shape":"Weight"} + }, + "AutoshiftAppliedStatus":{ + "type":"string", + "enum":[ + "APPLIED", + "NOT_APPLIED" + ] + }, + "AutoshiftExecutionStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "COMPLETED" + ] + }, + "AutoshiftInResource":{ + "type":"structure", + "required":[ + "appliedStatus", + "awayFrom", + "startTime" + ], + "members":{ + "appliedStatus":{ + "shape":"AutoshiftAppliedStatus", + "documentation":"The appliedStatus field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The appliedStatus field for a shift that is in progress for a resource can have one of two values: APPLIED or NOT_APPLIED. The zonal shift or autoshift that is currently in effect for the resource has an appliedStatus set to APPLIED.
The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run zonal shifts.
For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
" + }, + "awayFrom":{ + "shape":"AvailabilityZone", + "documentation":"The Availability Zone (for example, use1-az1) that traffic is shifted away from for a resource, when Amazon Web Services starts an autoshift. Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region. An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when you disable zonal autoshift for the resource.
The time (UTC) when the autoshift started.
" + } + }, + "documentation":"A complex structure that lists an autoshift that is currently active for a managed resource and information about the autoshift.
For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
" + }, + "AutoshiftObserverNotificationStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "AutoshiftSummaries":{ + "type":"list", + "member":{"shape":"AutoshiftSummary"} + }, + "AutoshiftSummary":{ + "type":"structure", + "required":[ + "awayFrom", + "endTime", + "startTime", + "status" + ], + "members":{ + "awayFrom":{ + "shape":"AvailabilityZone", + "documentation":"The Availability Zone (for example, use1-az1) that traffic is shifted away from for a resource when Amazon Web Services starts an autoshift. Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region. An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when you disable zonal autoshift for the resource.
The time (in UTC) when the autoshift ended.
" + }, + "startTime":{ + "shape":"StartTime", + "documentation":"The time (in UTC) when the autoshift started.
" + }, + "status":{ + "shape":"AutoshiftExecutionStatus", + "documentation":"The status for an autoshift.
" + } + }, + "documentation":"Information about an autoshift. Amazon Web Services starts an autoshift to temporarily move traffic for a resource away from an Availability Zone in an Amazon Web Services Region when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers. You can configure zonal autoshift in Route 53 ARC for managed resources in your Amazon Web Services account in a Region. Supported Amazon Web Services resources are automatically registered with Route 53 ARC.
Autoshifts are temporary. When the Availability Zone recovers, Amazon Web Services ends the autoshift, and traffic for the resource is no longer directed to the other Availability Zones in the Region.
You can stop an autoshift for a resource by disabling zonal autoshift.
" + }, + "AutoshiftsInResource":{ + "type":"list", + "member":{"shape":"AutoshiftInResource"} + }, + "AvailabilityZone":{ + "type":"string", + "max":20, + "min":0 + }, + "AvailabilityZones":{ + "type":"list", + "member":{"shape":"AvailabilityZone"} + }, + "BlockedDate":{ + "type":"string", + "max":10, + "min":10, + "pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + }, + "BlockedDates":{ + "type":"list", + "member":{"shape":"BlockedDate"}, + "max":15, + "min":0 + }, + "BlockedWindow":{ + "type":"string", + "max":19, + "min":19, + "pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):[0-9]{2}:[0-9]{2}-(Mon|Tue|Wed|Thu|Fri|Sat|Sun):[0-9]{2}:[0-9]{2}$" + }, + "BlockedWindows":{ + "type":"list", + "member":{"shape":"BlockedWindow"}, + "max":15, + "min":0 + }, + "CancelZonalShiftRequest":{ + "type":"structure", + "required":["zonalShiftId"], + "members":{ + "zonalShiftId":{ + "shape":"ZonalShiftId", + "documentation":"The internally-generated identifier of a zonal shift.
", + "location":"uri", + "locationName":"zonalShiftId" + } + } + }, + "ConflictException":{ + "type":"structure", + "required":[ + "message", + "reason" + ], + "members":{ + "message":{"shape":"String"}, + "reason":{ + "shape":"ConflictExceptionReason", + "documentation":"The reason for the conflict exception.
" + }, + "zonalShiftId":{ + "shape":"String", + "documentation":"The zonal shift ID associated with the conflict exception.
" + } + }, + "documentation":"The request could not be processed because of conflict in the current state of the resource.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ConflictExceptionReason":{ + "type":"string", + "enum":[ + "ZonalShiftAlreadyExists", + "ZonalShiftStatusNotActive", + "SimultaneousZonalShiftsConflict", + "PracticeConfigurationAlreadyExists", + "AutoShiftEnabled", + "PracticeConfigurationDoesNotExist" + ] + }, + "ControlCondition":{ + "type":"structure", + "required":[ + "alarmIdentifier", + "type" + ], + "members":{ + "alarmIdentifier":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
" + }, + "type":{ + "shape":"ControlConditionType", + "documentation":"The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH.
A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting or to interrupt a practice run in progress.
Control condition alarms do not apply for autoshifts.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
" + }, + "ControlConditionType":{ + "type":"string", + "enum":["CLOUDWATCH"] + }, + "ControlConditions":{ + "type":"list", + "member":{"shape":"ControlCondition"}, + "max":1, + "min":1 + }, + "CreatePracticeRunConfigurationRequest":{ + "type":"structure", + "required":[ + "outcomeAlarms", + "resourceIdentifier" + ], + "members":{ + "blockedDates":{ + "shape":"BlockedDates", + "documentation":"Optionally, you can block Route 53 ARC from starting practice runs for a resource on specific calendar dates.
The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.
For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.
Optionally, you can block Route 53 ARC from starting practice runs for specific windows of days and times.
The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.
For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.
An Amazon CloudWatch alarm that you can specify for zonal autoshift practice runs. This alarm blocks Route 53 ARC from starting practice run zonal shifts, and ends a practice run that's in progress, when the alarm is in an ALARM state.
The outcome alarm for practice runs is a required Amazon CloudWatch alarm that you specify that ends a practice run when the alarm is in an ALARM state.
Configure the alarm to monitor the health of your application when traffic is shifted away from an Availability Zone during each weekly practice run. You should configure the alarm to go into an ALARM state if your application is impacted by the zonal shift, and you want to stop the zonal shift, to let traffic for the resource return to the Availability Zone.
The identifier of the resource that Amazon Web Services shifts traffic for with a practice run zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
" + } + } + }, + "CreatePracticeRunConfigurationResponse":{ + "type":"structure", + "required":[ + "arn", + "name", + "practiceRunConfiguration", + "zonalAutoshiftStatus" + ], + "members":{ + "arn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the resource that you configured the practice run for.
" + }, + "name":{ + "shape":"ResourceName", + "documentation":"The name of the resource that you configured the practice run for.
" + }, + "practiceRunConfiguration":{ + "shape":"PracticeRunConfiguration", + "documentation":"A practice run configuration for a resource. Configurations include the outcome alarm that you specify for practice runs, and, optionally, a blocking alarm and blocking dates and windows.
" + }, + "zonalAutoshiftStatus":{ + "shape":"ZonalAutoshiftStatus", + "documentation":"The status for zonal autoshift for a resource. When you specify ENABLED for the autoshift status, Amazon Web Services shifts traffic away from shifts away application resource traffic from an Availability Zone, on your behalf, when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers.
When you enable zonal autoshift, you must also configure practice runs for the resource.
" + } + } + }, + "DeletePracticeRunConfigurationRequest":{ + "type":"structure", + "required":["resourceIdentifier"], + "members":{ + "resourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"The identifier for the resource that you want to delete the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
", + "location":"uri", + "locationName":"resourceIdentifier" + } + } + }, + "DeletePracticeRunConfigurationResponse":{ + "type":"structure", + "required":[ + "arn", + "name", + "zonalAutoshiftStatus" + ], + "members":{ + "arn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the resource that you deleted the practice run for.
" + }, + "name":{ + "shape":"ResourceName", + "documentation":"The name of the resource that you deleted the practice run for.
" + }, + "zonalAutoshiftStatus":{ + "shape":"ZonalAutoshiftStatus", + "documentation":"The status of zonal autoshift for the resource.
" + } + } + }, + "ExpiresIn":{ + "type":"string", + "max":5, + "min":2, + "pattern":"^([1-9][0-9]*)(m|h)$" + }, + "ExpiryTime":{"type":"timestamp"}, + "GetAutoshiftObserverNotificationStatusRequest":{ + "type":"structure", + "members":{ + } + }, + "GetAutoshiftObserverNotificationStatusResponse":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"AutoshiftObserverNotificationStatus", + "documentation":"The status of autoshift observer notification. If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the Amazon EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.
The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
", + "location":"uri", + "locationName":"resourceIdentifier" + } + } + }, + "GetManagedResourceResponse":{ + "type":"structure", + "required":[ + "appliedWeights", + "zonalShifts" + ], + "members":{ + "appliedWeights":{ + "shape":"AppliedWeights", + "documentation":"A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.
" + }, + "arn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) for the resource.
" + }, + "autoshifts":{ + "shape":"AutoshiftsInResource", + "documentation":"An array of the autoshifts that are active for the resource.
" + }, + "name":{ + "shape":"ResourceName", + "documentation":"The name of the resource.
" + }, + "practiceRunConfiguration":{ + "shape":"PracticeRunConfiguration", + "documentation":"The practice run configuration for zonal autoshift that's associated with the resource.
" + }, + "zonalAutoshiftStatus":{ + "shape":"ZonalAutoshiftStatus", + "documentation":"The status for zonal autoshift for a resource. When the autoshift status is ENABLED, Amazon Web Services shifts traffic for a resource away from an Availability Zone, on your behalf, when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers.
The zonal shifts that are currently active for a resource.
" + } + } + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"There was an internal server error.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "ListAutoshiftsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The number of objects that you want to return with this call.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"String", + "documentation":"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.
The status of the autoshift.
", + "location":"querystring", + "locationName":"status" + } + } + }, + "ListAutoshiftsResponse":{ + "type":"structure", + "members":{ + "items":{ + "shape":"AutoshiftSummaries", + "documentation":"The items in the response list.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"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.
The number of objects that you want to return with this call.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"String", + "documentation":"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.
The items in the response list.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"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.
The number of objects that you want to return with this call.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"String", + "documentation":"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.
The identifier for the resource that you want to list zonal shifts for. The identifier is the Amazon Resource Name (ARN) for the resource.
", + "location":"querystring", + "locationName":"resourceIdentifier" + }, + "status":{ + "shape":"ZonalShiftStatus", + "documentation":"A status for a zonal shift.
The Status for a zonal shift can have one of the following values:
ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
The items in the response list.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"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.
A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.
" + }, + "arn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) for the managed resource.
" + }, + "autoshifts":{ + "shape":"AutoshiftsInResource", + "documentation":"An array of the autoshifts that have been completed for a resource.
" + }, + "availabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"The Availability Zones that a resource is deployed in.
" + }, + "name":{ + "shape":"ResourceName", + "documentation":"The name of the managed resource.
" + }, + "practiceRunStatus":{ + "shape":"ZonalAutoshiftStatus", + "documentation":"This status tracks whether a practice run configuration exists for a resource. When you configure a practice run for a resource so that a practice run configuration exists, Route 53 ARC sets this value to ENABLED. If a you have not configured a practice run for the resource, or delete a practice run configuration, Route 53 ARC sets the value to DISABLED.
Route 53 ARC updates this status; you can't set a practice run status to ENABLED or DISABLED.
The status of autoshift for a resource. When you configure zonal autoshift for a resource, you can set the value of the status to ENABLED or DISABLED.
An array of the zonal shifts for a resource.
" + } + }, + "documentation":"A complex structure for a managed resource in an Amazon Web Services account with information about zonal shifts and autoshifts.
A managed resource is a load balancer that has been registered with Route 53 ARC by Elastic Load Balancing. You can start a zonal shift in Route 53 ARC for a managed resource to temporarily move traffic for the resource away from an Availability Zone in an Amazon Web Services Region. You can also configure zonal autoshift for a managed resource.
At this time, managed resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
An array of one or more dates that you can specify when Amazon Web Services does not start practice runs for a resource.
Specify blocked dates, in UTC, in the format YYYY-MM-DD, separated by spaces.
An array of one or more windows of days and times that you can block Route 53 ARC from starting practice runs for a resource.
Specify the blocked windows in UTC, using the format DAY:HH:MM-DAY:HH:MM, separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30.
The blocking alarm for practice runs is an optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state.
The outcome alarm for practice runs is an alarm that you specify that ends a practice run when the alarm is in an ALARM state.
A practice run configuration for a resource includes the Amazon CloudWatch alarms that you've specified for a practice run, as well as any blocked dates or blocked windows for the practice run. When a resource has a practice run configuration, Route 53 ARC shifts traffic for the resource weekly for practice runs.
Practice runs are required for zonal autoshift. The zonal shifts that Route 53 ARC starts for practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.
You can update or delete a practice run configuration. Before you delete a practice run configuration, you must disable zonal autoshift for the resource. A practice run configuration is required when zonal autoshift is enabled.
" + }, + "PracticeRunOutcome":{ + "type":"string", + "enum":[ + "FAILED", + "INTERRUPTED", + "PENDING", + "SUCCEEDED" + ] + }, + "ResourceArn":{ + "type":"string", + "max":1024, + "min":8, + "pattern":"^arn:.*$" + }, + "ResourceIdentifier":{ + "type":"string", + "max":1024, + "min":8 + }, + "ResourceName":{ + "type":"string", + "max":256, + "min":1 + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The input requested a resource that was not found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "StartTime":{"type":"timestamp"}, + "StartZonalShiftRequest":{ + "type":"structure", + "required":[ + "awayFrom", + "comment", + "expiresIn", + "resourceIdentifier" + ], + "members":{ + "awayFrom":{ + "shape":"AvailabilityZone", + "documentation":"The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.
A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.
" + }, + "expiresIn":{ + "shape":"ExpiresIn", + "documentation":"The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).
If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.
To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:
A lowercase letter m: To specify that the value is in minutes.
A lowercase letter h: To specify that the value is in hours.
For example: 20h means the zonal shift expires in 20 hours. 120m means the zonal shift expires in 120 minutes (2 hours).
The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
" + } + } + }, + "String":{"type":"string"}, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "UpdateAutoshiftObserverNotificationStatusRequest":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"AutoshiftObserverNotificationStatus", + "documentation":"The status to set for autoshift observer notification. If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the Amazon EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.
The status for autoshift observer notification.
" + } + } + }, + "UpdatePracticeRunConfigurationRequest":{ + "type":"structure", + "required":["resourceIdentifier"], + "members":{ + "blockedDates":{ + "shape":"BlockedDates", + "documentation":"Add, change, or remove blocked dates for a practice run in zonal autoshift.
Optionally, you can block practice runs for specific calendar dates. The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.
For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.
Add, change, or remove windows of days and times for when you can, optionally, block Route 53 ARC from starting a practice run for a resource.
The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.
For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.
Add, change, or remove the Amazon CloudWatch alarm that you optionally specify as the blocking alarm for practice runs.
" + }, + "outcomeAlarms":{ + "shape":"ControlConditions", + "documentation":"Specify a new the Amazon CloudWatch alarm as the outcome alarm for practice runs.
" + }, + "resourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"The identifier for the resource that you want to update the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
", + "location":"uri", + "locationName":"resourceIdentifier" + } + } + }, + "UpdatePracticeRunConfigurationResponse":{ + "type":"structure", + "required":[ + "arn", + "name", + "practiceRunConfiguration", + "zonalAutoshiftStatus" + ], + "members":{ + "arn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the resource that you updated the practice run for.
" + }, + "name":{ + "shape":"ResourceName", + "documentation":"The name of the resource that you updated the practice run for.
" + }, + "practiceRunConfiguration":{ + "shape":"PracticeRunConfiguration", + "documentation":"The practice run configuration that was updated.
" + }, + "zonalAutoshiftStatus":{ + "shape":"ZonalAutoshiftStatus", + "documentation":"The zonal autoshift status for the resource that you updated the practice run for.
" + } + } + }, + "UpdateZonalAutoshiftConfigurationRequest":{ + "type":"structure", + "required":[ + "resourceIdentifier", + "zonalAutoshiftStatus" + ], + "members":{ + "resourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"The identifier for the resource that you want to update the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
", + "location":"uri", + "locationName":"resourceIdentifier" + }, + "zonalAutoshiftStatus":{ + "shape":"ZonalAutoshiftStatus", + "documentation":"The zonal autoshift status for the resource that you want to update the zonal autoshift configuration for. Choose ENABLED to authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery.
The identifier for the resource that you updated the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
" + }, + "zonalAutoshiftStatus":{ + "shape":"ZonalAutoshiftStatus", + "documentation":"The updated zonal autoshift status for the resource.
" + } + } + }, + "UpdateZonalShiftRequest":{ + "type":"structure", + "required":["zonalShiftId"], + "members":{ + "comment":{ + "shape":"ZonalShiftComment", + "documentation":"A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.
" + }, + "expiresIn":{ + "shape":"ExpiresIn", + "documentation":"The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).
If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.
To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:
A lowercase letter m: To specify that the value is in minutes.
A lowercase letter h: To specify that the value is in hours.
For example: 20h means the zonal shift expires in 20 hours. 120m means the zonal shift expires in 120 minutes (2 hours).
The identifier of a zonal shift.
", + "location":"uri", + "locationName":"zonalShiftId" + } + } + }, + "ValidationException":{ + "type":"structure", + "required":[ + "message", + "reason" + ], + "members":{ + "message":{"shape":"String"}, + "reason":{ + "shape":"ValidationExceptionReason", + "documentation":"The reason for the validation exception.
" + } + }, + "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "InvalidExpiresIn", + "InvalidStatus", + "MissingValue", + "InvalidToken", + "InvalidResourceIdentifier", + "InvalidAz", + "UnsupportedAz", + "InvalidAlarmCondition", + "InvalidConditionType", + "InvalidPracticeBlocker" + ] + }, + "Weight":{ + "type":"float", + "box":true, + "max":1.0, + "min":0.0 + }, + "ZonalAutoshiftStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "ZonalShift":{ + "type":"structure", + "required":[ + "awayFrom", + "comment", + "expiryTime", + "resourceIdentifier", + "startTime", + "status", + "zonalShiftId" + ], + "members":{ + "awayFrom":{ + "shape":"AvailabilityZone", + "documentation":"The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.
A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.
" + }, + "expiryTime":{ + "shape":"ExpiryTime", + "documentation":"The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.
When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
" + }, + "resourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
" + }, + "startTime":{ + "shape":"StartTime", + "documentation":"The time (UTC) when the zonal shift starts.
" + }, + "status":{ + "shape":"ZonalShiftStatus", + "documentation":"A status for a zonal shift.
The Status for a zonal shift can have one of the following values:
ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
The identifier of a zonal shift.
" + } + } + }, + "ZonalShiftComment":{ + "type":"string", + "max":128, + "min":0 + }, + "ZonalShiftId":{ + "type":"string", + "max":36, + "min":6, + "pattern":"^[A-Za-z0-9-]+$" + }, + "ZonalShiftInResource":{ + "type":"structure", + "required":[ + "appliedStatus", + "awayFrom", + "comment", + "expiryTime", + "resourceIdentifier", + "startTime", + "zonalShiftId" + ], + "members":{ + "appliedStatus":{ + "shape":"AppliedStatus", + "documentation":"The appliedStatus field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The appliedStatus field for a shift that is in progress for a resource can have one of two values: APPLIED or NOT_APPLIED. The zonal shift or autoshift that is currently in effect for the resource has an appliedStatus set to APPLIED.
The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run zonal shifts.
For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
" + }, + "awayFrom":{ + "shape":"AvailabilityZone", + "documentation":"The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.
A comment that you enter for a customer-initiated zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.
" + }, + "expiryTime":{ + "shape":"ExpiryTime", + "documentation":"The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.
When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
" + }, + "practiceRunOutcome":{ + "shape":"PracticeRunOutcome", + "documentation":"The outcome, or end state, returned for a practice run. The following values can be returned:
PENDING: Outcome value when a practice run is in progress.
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an ALARM state during the practice run, and the practice run was not interrupted before it completed the expected 30 minute zonal shift.
INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, or there was another problem with the practice run that created an inconclusive outcome.
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an ALARM state during the practice run, and the practice run was not interrupted before it completed.
For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
" + }, + "resourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
" + }, + "startTime":{ + "shape":"StartTime", + "documentation":"The time (UTC) when the zonal shift starts.
" + }, + "zonalShiftId":{ + "shape":"ZonalShiftId", + "documentation":"The identifier of a zonal shift.
" + } + }, + "documentation":"A complex structure that lists the zonal shifts for a managed resource and their statuses for the resource.
" + }, + "ZonalShiftStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "EXPIRED", + "CANCELED" + ] + }, + "ZonalShiftSummaries":{ + "type":"list", + "member":{"shape":"ZonalShiftSummary"} + }, + "ZonalShiftSummary":{ + "type":"structure", + "required":[ + "awayFrom", + "comment", + "expiryTime", + "resourceIdentifier", + "startTime", + "status", + "zonalShiftId" + ], + "members":{ + "awayFrom":{ + "shape":"AvailabilityZone", + "documentation":"The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.
A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.
" + }, + "expiryTime":{ + "shape":"ExpiryTime", + "documentation":"The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.
When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
" + }, + "practiceRunOutcome":{ + "shape":"PracticeRunOutcome", + "documentation":"The outcome, or end state, of a practice run. The following values can be returned:
PENDING: Outcome value when the practice run is in progress.
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an ALARM state during the practice run, and the practice run was not interrupted before it completed.
INTERRUPTED: Outcome value when the practice run did not run for the expected 30 minutes or there was another problem with the practice run that created an inconclusive outcome.
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an ALARM state during the practice run, and the practice run was not interrupted before it completed.
For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
" + }, + "resourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
" + }, + "startTime":{ + "shape":"StartTime", + "documentation":"The time (UTC) when the zonal shift starts.
" + }, + "status":{ + "shape":"ZonalShiftStatus", + "documentation":"A status for a zonal shift.
The Status for a zonal shift can have one of the following values:
ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
The identifier of a zonal shift.
" + } + }, + "documentation":"Lists information about zonal shifts in Amazon Route 53 Application Recovery Controller, including zonal shifts that you start yourself and zonal shifts that Route 53 ARC starts on your behalf for practice runs with zonal autoshift.
Zonal shifts are temporary, including customer-initiated zonal shifts and the zonal autoshift practice run zonal shifts that Route 53 ARC starts weekly, on your behalf. A zonal shift that a customer starts can be active for up to three days (72 hours). A practice run zonal shift has a 30 minute duration.
" + }, + "ZonalShiftsInResource":{ + "type":"list", + "member":{"shape":"ZonalShiftInResource"} + } + }, + "documentation":"Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (Route 53 ARC).
You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to help your application recover quickly from an impairment in an Availability Zone. For example, you can recover your application from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone.
You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift is a capability in Route 53 ARC where you authorize Amazon Web Services to shift away application resource traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery. Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers.
To help make sure that zonal autoshift is safe for your application, you must also configure practice runs when you enable zonal autoshift for a resource. Practice runs start weekly zonal shifts for a resource, to shift traffic for the resource away from an Availability Zone. Practice runs help you to make sure, on a regular basis, that you have enough capacity in all the Availability Zones in an Amazon Web Services Region for your application to continue to operate normally when traffic for a resource is shifted away from one Availability Zone.
Before you configure practice runs or enable zonal autoshift, we strongly recommend that you prescale your application resource capacity in all Availability Zones in the Region where your application resources are deployed. You should not rely on scaling on demand when an autoshift or practice run starts. Zonal autoshift, including practice runs, works independently, and does not wait for auto scaling actions to complete. Relying on auto scaling, instead of pre-scaling, can result in loss of availability.
If you use auto scaling to handle regular cycles of traffic, we strongly recommend that you configure the minimum capacity of your auto scaling to continue operating normally with the loss of an Availability Zone.
Be aware that Route 53 ARC does not inspect the health of individual resources. Amazon Web Services only starts an autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could potentially impact customers. In some cases, resources might be shifted away that are not experiencing impact.
For more information about using zonal shift and zonal autoshift, see the Amazon Route 53 Application Recovery Controller Developer Guide.
" +} diff --git a/testbed/boto__botocore/botocore/data/billingconductor/2021-07-30/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/billingconductor/2021-07-30/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..d54dad5ad91fc28fd986e84916e4be46fa42567a --- /dev/null +++ b/testbed/boto__botocore/botocore/data/billingconductor/2021-07-30/endpoint-rule-set-1.json @@ -0,0 +1,365 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://billingconductor.us-east-1.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "billingconductor", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://billingconductor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://billingconductor-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://billingconductor.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://billingconductor.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/billingconductor/2021-07-30/examples-1.json b/testbed/boto__botocore/botocore/data/billingconductor/2021-07-30/examples-1.json new file mode 100644 index 0000000000000000000000000000000000000000..0ea7e3b0bbe917eb027880396ac01509becd1fa0 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/billingconductor/2021-07-30/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/testbed/boto__botocore/botocore/data/billingconductor/2021-07-30/paginators-1.json b/testbed/boto__botocore/botocore/data/billingconductor/2021-07-30/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..2ca4d75f92cd6cd76495371a14e204723d10e5cc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/billingconductor/2021-07-30/paginators-1.json @@ -0,0 +1,80 @@ +{ + "pagination": { + "ListAccountAssociations": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "LinkedAccounts" + }, + "ListBillingGroupCostReports": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "BillingGroupCostReports" + }, + "ListBillingGroups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "BillingGroups" + }, + "ListCustomLineItems": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "CustomLineItems" + }, + "ListPricingPlans": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "non_aggregate_keys": [ + "BillingPeriod" + ], + "output_token": "NextToken", + "result_key": "PricingPlans" + }, + "ListPricingPlansAssociatedWithPricingRule": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "non_aggregate_keys": [ + "BillingPeriod", + "PricingRuleArn" + ], + "output_token": "NextToken", + "result_key": "PricingPlanArns" + }, + "ListPricingRules": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "non_aggregate_keys": [ + "BillingPeriod" + ], + "output_token": "NextToken", + "result_key": "PricingRules" + }, + "ListPricingRulesAssociatedToPricingPlan": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "non_aggregate_keys": [ + "BillingPeriod", + "PricingPlanArn" + ], + "output_token": "NextToken", + "result_key": "PricingRuleArns" + }, + "ListResourcesAssociatedToCustomLineItem": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "non_aggregate_keys": [ + "Arn" + ], + "output_token": "NextToken", + "result_key": "AssociatedResources" + }, + "ListCustomLineItemVersions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "CustomLineItemVersions" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/billingconductor/2021-07-30/service-2.json b/testbed/boto__botocore/botocore/data/billingconductor/2021-07-30/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..ee8d080aebfc2bb2ac8383aa5c7abb7df75153c2 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/billingconductor/2021-07-30/service-2.json @@ -0,0 +1,3373 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-07-30", + "endpointPrefix":"billingconductor", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"AWSBillingConductor", + "serviceId":"billingconductor", + "signatureVersion":"v4", + "signingName":"billingconductor", + "uid":"billingconductor-2021-07-30" + }, + "operations":{ + "AssociateAccounts":{ + "name":"AssociateAccounts", + "http":{ + "method":"POST", + "requestUri":"/associate-accounts", + "responseCode":200 + }, + "input":{"shape":"AssociateAccountsInput"}, + "output":{"shape":"AssociateAccountsOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceLimitExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Connects an array of account IDs in a consolidated billing family to a predefined billing group. The account IDs must be a part of the consolidated billing family during the current month, and not already associated with another billing group. The maximum number of accounts that can be associated in one call is 30.
", + "idempotent":true + }, + "AssociatePricingRules":{ + "name":"AssociatePricingRules", + "http":{ + "method":"PUT", + "requestUri":"/associate-pricing-rules", + "responseCode":200 + }, + "input":{"shape":"AssociatePricingRulesInput"}, + "output":{"shape":"AssociatePricingRulesOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceLimitExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Connects an array of PricingRuleArns to a defined PricingPlan. The maximum number PricingRuleArn that can be associated in one call is 30.
Associates a batch of resources to a percentage custom line item.
", + "idempotent":true + }, + "BatchDisassociateResourcesFromCustomLineItem":{ + "name":"BatchDisassociateResourcesFromCustomLineItem", + "http":{ + "method":"PUT", + "requestUri":"/batch-disassociate-resources-from-custom-line-item", + "responseCode":200 + }, + "input":{"shape":"BatchDisassociateResourcesFromCustomLineItemInput"}, + "output":{"shape":"BatchDisassociateResourcesFromCustomLineItemOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Disassociates a batch of resources from a percentage custom line item.
", + "idempotent":true + }, + "CreateBillingGroup":{ + "name":"CreateBillingGroup", + "http":{ + "method":"POST", + "requestUri":"/create-billing-group", + "responseCode":200 + }, + "input":{"shape":"CreateBillingGroupInput"}, + "output":{"shape":"CreateBillingGroupOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceLimitExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation.
", + "idempotent":true + }, + "CreateCustomLineItem":{ + "name":"CreateCustomLineItem", + "http":{ + "method":"POST", + "requestUri":"/create-custom-line-item", + "responseCode":200 + }, + "input":{"shape":"CreateCustomLineItemInput"}, + "output":{"shape":"CreateCustomLineItemOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceLimitExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount.
" + }, + "CreatePricingPlan":{ + "name":"CreatePricingPlan", + "http":{ + "method":"POST", + "requestUri":"/create-pricing-plan", + "responseCode":200 + }, + "input":{"shape":"CreatePricingPlanInput"}, + "output":{"shape":"CreatePricingPlanOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceLimitExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups.
", + "idempotent":true + }, + "CreatePricingRule":{ + "name":"CreatePricingRule", + "http":{ + "method":"POST", + "requestUri":"/create-pricing-rule", + "responseCode":200 + }, + "input":{"shape":"CreatePricingRuleInput"}, + "output":{"shape":"CreatePricingRuleOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceLimitExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans.
", + "idempotent":true + }, + "DeleteBillingGroup":{ + "name":"DeleteBillingGroup", + "http":{ + "method":"POST", + "requestUri":"/delete-billing-group", + "responseCode":200 + }, + "input":{"shape":"DeleteBillingGroupInput"}, + "output":{"shape":"DeleteBillingGroupOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes a billing group.
", + "idempotent":true + }, + "DeleteCustomLineItem":{ + "name":"DeleteCustomLineItem", + "http":{ + "method":"POST", + "requestUri":"/delete-custom-line-item", + "responseCode":200 + }, + "input":{"shape":"DeleteCustomLineItemInput"}, + "output":{"shape":"DeleteCustomLineItemOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes the custom line item identified by the given ARN in the current, or previous billing period.
", + "idempotent":true + }, + "DeletePricingPlan":{ + "name":"DeletePricingPlan", + "http":{ + "method":"POST", + "requestUri":"/delete-pricing-plan", + "responseCode":200 + }, + "input":{"shape":"DeletePricingPlanInput"}, + "output":{"shape":"DeletePricingPlanOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes a pricing plan. The pricing plan must not be associated with any billing groups to delete successfully.
", + "idempotent":true + }, + "DeletePricingRule":{ + "name":"DeletePricingRule", + "http":{ + "method":"POST", + "requestUri":"/delete-pricing-rule", + "responseCode":200 + }, + "input":{"shape":"DeletePricingRuleInput"}, + "output":{"shape":"DeletePricingRuleOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes the pricing rule that's identified by the input Amazon Resource Name (ARN).
", + "idempotent":true + }, + "DisassociateAccounts":{ + "name":"DisassociateAccounts", + "http":{ + "method":"POST", + "requestUri":"/disassociate-accounts", + "responseCode":200 + }, + "input":{"shape":"DisassociateAccountsInput"}, + "output":{"shape":"DisassociateAccountsOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Removes the specified list of account IDs from the given billing group.
", + "idempotent":true + }, + "DisassociatePricingRules":{ + "name":"DisassociatePricingRules", + "http":{ + "method":"PUT", + "requestUri":"/disassociate-pricing-rules", + "responseCode":200 + }, + "input":{"shape":"DisassociatePricingRulesInput"}, + "output":{"shape":"DisassociatePricingRulesOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Disassociates a list of pricing rules from a pricing plan.
", + "idempotent":true + }, + "GetBillingGroupCostReport":{ + "name":"GetBillingGroupCostReport", + "http":{ + "method":"POST", + "requestUri":"/get-billing-group-cost-report", + "responseCode":200 + }, + "input":{"shape":"GetBillingGroupCostReportInput"}, + "output":{"shape":"GetBillingGroupCostReportOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves the margin summary report, which includes the Amazon Web Services cost and charged amount (pro forma cost) by Amazon Web Service for a specific billing group.
" + }, + "ListAccountAssociations":{ + "name":"ListAccountAssociations", + "http":{ + "method":"POST", + "requestUri":"/list-account-associations", + "responseCode":200 + }, + "input":{"shape":"ListAccountAssociationsInput"}, + "output":{"shape":"ListAccountAssociationsOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"This is a paginated call to list linked accounts that are linked to the payer account for the specified time period. If no information is provided, the current billing period is used. The response will optionally include the billing group that's associated with the linked account.
" + }, + "ListBillingGroupCostReports":{ + "name":"ListBillingGroupCostReports", + "http":{ + "method":"POST", + "requestUri":"/list-billing-group-cost-reports", + "responseCode":200 + }, + "input":{"shape":"ListBillingGroupCostReportsInput"}, + "output":{"shape":"ListBillingGroupCostReportsOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated Amazon Web Services charges based on the associated pricing plan of a billing group.
" + }, + "ListBillingGroups":{ + "name":"ListBillingGroups", + "http":{ + "method":"POST", + "requestUri":"/list-billing-groups", + "responseCode":200 + }, + "input":{"shape":"ListBillingGroupsInput"}, + "output":{"shape":"ListBillingGroupsOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used.
" + }, + "ListCustomLineItemVersions":{ + "name":"ListCustomLineItemVersions", + "http":{ + "method":"POST", + "requestUri":"/list-custom-line-item-versions", + "responseCode":200 + }, + "input":{"shape":"ListCustomLineItemVersionsInput"}, + "output":{"shape":"ListCustomLineItemVersionsOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"A paginated call to get a list of all custom line item versions.
" + }, + "ListCustomLineItems":{ + "name":"ListCustomLineItems", + "http":{ + "method":"POST", + "requestUri":"/list-custom-line-items", + "responseCode":200 + }, + "input":{"shape":"ListCustomLineItemsInput"}, + "output":{"shape":"ListCustomLineItemsOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"A paginated call to get a list of all custom line items (FFLIs) for the given billing period. If you don't provide a billing period, the current billing period is used.
" + }, + "ListPricingPlans":{ + "name":"ListPricingPlans", + "http":{ + "method":"POST", + "requestUri":"/list-pricing-plans", + "responseCode":200 + }, + "input":{"shape":"ListPricingPlansInput"}, + "output":{"shape":"ListPricingPlansOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"A paginated call to get pricing plans for the given billing period. If you don't provide a billing period, the current billing period is used.
" + }, + "ListPricingPlansAssociatedWithPricingRule":{ + "name":"ListPricingPlansAssociatedWithPricingRule", + "http":{ + "method":"POST", + "requestUri":"/list-pricing-plans-associated-with-pricing-rule", + "responseCode":200 + }, + "input":{"shape":"ListPricingPlansAssociatedWithPricingRuleInput"}, + "output":{"shape":"ListPricingPlansAssociatedWithPricingRuleOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"A list of the pricing plans that are associated with a pricing rule.
" + }, + "ListPricingRules":{ + "name":"ListPricingRules", + "http":{ + "method":"POST", + "requestUri":"/list-pricing-rules", + "responseCode":200 + }, + "input":{"shape":"ListPricingRulesInput"}, + "output":{"shape":"ListPricingRulesOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans.
" + }, + "ListPricingRulesAssociatedToPricingPlan":{ + "name":"ListPricingRulesAssociatedToPricingPlan", + "http":{ + "method":"POST", + "requestUri":"/list-pricing-rules-associated-to-pricing-plan", + "responseCode":200 + }, + "input":{"shape":"ListPricingRulesAssociatedToPricingPlanInput"}, + "output":{"shape":"ListPricingRulesAssociatedToPricingPlanOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Lists the pricing rules that are associated with a pricing plan.
" + }, + "ListResourcesAssociatedToCustomLineItem":{ + "name":"ListResourcesAssociatedToCustomLineItem", + "http":{ + "method":"POST", + "requestUri":"/list-resources-associated-to-custom-line-item", + "responseCode":200 + }, + "input":{"shape":"ListResourcesAssociatedToCustomLineItemInput"}, + "output":{"shape":"ListResourcesAssociatedToCustomLineItemOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"List the resources that are associated to a custom line item.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{ResourceArn}", + "responseCode":204 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"A list the tags for a resource.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{ResourceArn}", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":" Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed.
Deletes specified tags from a resource.
" + }, + "UpdateBillingGroup":{ + "name":"UpdateBillingGroup", + "http":{ + "method":"POST", + "requestUri":"/update-billing-group", + "responseCode":200 + }, + "input":{"shape":"UpdateBillingGroupInput"}, + "output":{"shape":"UpdateBillingGroupOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"This updates an existing billing group.
", + "idempotent":true + }, + "UpdateCustomLineItem":{ + "name":"UpdateCustomLineItem", + "http":{ + "method":"POST", + "requestUri":"/update-custom-line-item", + "responseCode":200 + }, + "input":{"shape":"UpdateCustomLineItemInput"}, + "output":{"shape":"UpdateCustomLineItemOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Update an existing custom line item in the current or previous billing period.
", + "idempotent":true + }, + "UpdatePricingPlan":{ + "name":"UpdatePricingPlan", + "http":{ + "method":"PUT", + "requestUri":"/update-pricing-plan", + "responseCode":200 + }, + "input":{"shape":"UpdatePricingPlanInput"}, + "output":{"shape":"UpdatePricingPlanOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"This updates an existing pricing plan.
", + "idempotent":true + }, + "UpdatePricingRule":{ + "name":"UpdatePricingRule", + "http":{ + "method":"PUT", + "requestUri":"/update-pricing-rule", + "responseCode":200 + }, + "input":{"shape":"UpdatePricingRuleInput"}, + "output":{"shape":"UpdatePricingRuleOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Updates an existing pricing rule.
", + "idempotent":true + } + }, + "shapes":{ + "AWSCost":{"type":"string"}, + "AccessDeniedException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccountAssociationsList":{ + "type":"list", + "member":{"shape":"AccountAssociationsListElement"} + }, + "AccountAssociationsListElement":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"The associating array of account IDs.
" + }, + "BillingGroupArn":{ + "shape":"BillingGroupArn", + "documentation":"The Billing Group Arn that the linked account is associated to.
" + }, + "AccountName":{ + "shape":"AccountName", + "documentation":"The Amazon Web Services account name.
" + }, + "AccountEmail":{ + "shape":"AccountEmail", + "documentation":"The Amazon Web Services account email.
" + } + }, + "documentation":"A representation of a linked account.
" + }, + "AccountEmail":{ + "type":"string", + "sensitive":true + }, + "AccountGrouping":{ + "type":"structure", + "required":["LinkedAccountIds"], + "members":{ + "LinkedAccountIds":{ + "shape":"AccountIdList", + "documentation":"The account IDs that make up the billing group. Account IDs must be a part of the consolidated billing family, and not associated with another billing group.
" + }, + "AutoAssociate":{ + "shape":"Boolean", + "documentation":"Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family.
" + } + }, + "documentation":"The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated billing family.
" + }, + "AccountId":{ + "type":"string", + "pattern":"[0-9]{12}" + }, + "AccountIdFilterList":{ + "type":"list", + "member":{"shape":"AccountId"}, + "max":30, + "min":1 + }, + "AccountIdList":{ + "type":"list", + "member":{"shape":"AccountId"}, + "max":30, + "min":1 + }, + "AccountName":{ + "type":"string", + "sensitive":true + }, + "Arn":{ + "type":"string", + "max":100, + "min":0, + "pattern":"arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/?[0-9]{12}$|^arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10}$|^arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/[a-zA-Z0-9]{10}$|^(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}" + }, + "AssociateAccountsInput":{ + "type":"structure", + "required":[ + "Arn", + "AccountIds" + ], + "members":{ + "Arn":{ + "shape":"BillingGroupArn", + "documentation":"The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs.
" + }, + "AccountIds":{ + "shape":"AccountIdList", + "documentation":"The associating array of account IDs.
" + } + } + }, + "AssociateAccountsOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"BillingGroupArn", + "documentation":"The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs.
" + } + } + }, + "AssociatePricingRulesInput":{ + "type":"structure", + "required":[ + "Arn", + "PricingRuleArns" + ], + "members":{ + "Arn":{ + "shape":"PricingPlanArn", + "documentation":" The PricingPlanArn that the PricingRuleArns are associated with.
The PricingRuleArns that are associated with the Pricing Plan.
The PricingPlanArn that the PricingRuleArns are associated with.
The reason why the resource association failed.
" + }, + "Reason":{ + "shape":"AssociateResourceErrorReason", + "documentation":"A static error code that's used to classify the type of failure.
" + } + }, + "documentation":"A representation of a resource association error.
" + }, + "AssociateResourceErrorReason":{ + "type":"string", + "enum":[ + "INVALID_ARN", + "SERVICE_LIMIT_EXCEEDED", + "ILLEGAL_CUSTOMLINEITEM", + "INTERNAL_SERVER_EXCEPTION", + "INVALID_BILLING_PERIOD_RANGE" + ] + }, + "AssociateResourceResponseElement":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"CustomLineItemAssociationElement", + "documentation":"The resource ARN that was associated to the custom line item.
" + }, + "Error":{ + "shape":"AssociateResourceError", + "documentation":"An AssociateResourceError that will populate if the resource association fails.
A resource association result for a percentage custom line item.
" + }, + "AssociateResourcesResponseList":{ + "type":"list", + "member":{"shape":"AssociateResourceResponseElement"} + }, + "Association":{ + "type":"string", + "pattern":"((arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[0-9]{12}|MONITORED|UNMONITORED)" + }, + "Attribute":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"The key in a key-value pair that describes the margin summary.
" + }, + "Value":{ + "shape":"String", + "documentation":"The value in a key-value pair that describes the margin summary.
" + } + }, + "documentation":"The key-value pair that represents the attribute by which the BillingGroupCostReportResults are grouped. For example, if you want a service-level breakdown for Amazon Simple Storage Service (Amazon S3) of the billing group, the attribute will be a key-value pair of \"PRODUCT_NAME\" and \"S3\".
A percentage custom line item ARN to associate the resources to.
" + }, + "ResourceArns":{ + "shape":"CustomLineItemBatchAssociationsList", + "documentation":"A list containing the ARNs of the resources to be associated.
" + }, + "BillingPeriodRange":{"shape":"CustomLineItemBillingPeriodRange"} + } + }, + "BatchAssociateResourcesToCustomLineItemOutput":{ + "type":"structure", + "members":{ + "SuccessfullyAssociatedResources":{ + "shape":"AssociateResourcesResponseList", + "documentation":" A list of AssociateResourceResponseElement for each resource that's been associated to a percentage custom line item successfully.
A list of AssociateResourceResponseElement for each resource that failed association to a percentage custom line item.
A percentage custom line item ARN to disassociate the resources from.
" + }, + "ResourceArns":{ + "shape":"CustomLineItemBatchDisassociationsList", + "documentation":"A list containing the ARNs of resources to be disassociated.
" + }, + "BillingPeriodRange":{"shape":"CustomLineItemBillingPeriodRange"} + } + }, + "BatchDisassociateResourcesFromCustomLineItemOutput":{ + "type":"structure", + "members":{ + "SuccessfullyDisassociatedResources":{ + "shape":"DisassociateResourcesResponseList", + "documentation":" A list of DisassociateResourceResponseElement for each resource that's been disassociated from a percentage custom line item successfully.
A list of DisassociateResourceResponseElement for each resource that failed disassociation from a percentage custom line item.
The Amazon Resource Name (ARN) of a billing group.
" + }, + "AWSCost":{ + "shape":"AWSCost", + "documentation":"The actual Amazon Web Services charges for the billing group.
" + }, + "ProformaCost":{ + "shape":"ProformaCost", + "documentation":"The hypothetical Amazon Web Services charges based on the associated pricing plan of a billing group.
" + }, + "Margin":{ + "shape":"Margin", + "documentation":"The billing group margin.
" + }, + "MarginPercentage":{ + "shape":"MarginPercentage", + "documentation":"The percentage of billing group margin.
" + }, + "Currency":{ + "shape":"Currency", + "documentation":"The displayed currency.
" + } + }, + "documentation":"A summary report of actual Amazon Web Services charges and calculated Amazon Web Services charges, based on the associated pricing plan of a billing group.
" + }, + "BillingGroupCostReportList":{ + "type":"list", + "member":{"shape":"BillingGroupCostReportElement"} + }, + "BillingGroupCostReportResultElement":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"BillingGroupArn", + "documentation":"The Amazon Resource Number (ARN) that uniquely identifies the billing group.
" + }, + "AWSCost":{ + "shape":"AWSCost", + "documentation":"The actual Amazon Web Services charges for the billing group.
" + }, + "ProformaCost":{ + "shape":"ProformaCost", + "documentation":"The hypothetical Amazon Web Services charges based on the associated pricing plan of a billing group.
" + }, + "Margin":{ + "shape":"Margin", + "documentation":"The billing group margin.
" + }, + "MarginPercentage":{ + "shape":"MarginPercentage", + "documentation":"The percentage of the billing group margin.
" + }, + "Currency":{ + "shape":"Currency", + "documentation":"The displayed currency.
" + }, + "Attributes":{ + "shape":"AttributesList", + "documentation":"The list of key-value pairs that represent the attributes by which the BillingGroupCostReportResults are grouped. For example, if you want the Amazon S3 service-level breakdown of a billing group for November 2023, the attributes list will contain a key-value pair of \"PRODUCT_NAME\" and \"S3\" and a key-value pair of \"BILLING_PERIOD\" and \"Nov 2023\".
A paginated call to retrieve a list of summary reports of actual Amazon Web Services charges and the calculated Amazon Web Services charges, broken down by attributes.
" + }, + "BillingGroupCostReportResultsList":{ + "type":"list", + "member":{"shape":"BillingGroupCostReportResultElement"} + }, + "BillingGroupDescription":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "BillingGroupFullArn":{ + "type":"string", + "pattern":"arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/[0-9]{12}" + }, + "BillingGroupList":{ + "type":"list", + "member":{"shape":"BillingGroupListElement"} + }, + "BillingGroupListElement":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"BillingGroupName", + "documentation":"The name of the billing group.
" + }, + "Arn":{ + "shape":"BillingGroupArn", + "documentation":"The Amazon Resource Number (ARN) that can be used to uniquely identify the billing group.
" + }, + "Description":{ + "shape":"BillingGroupDescription", + "documentation":"The description of the billing group.
" + }, + "PrimaryAccountId":{ + "shape":"AccountId", + "documentation":"The account ID that serves as the main account in a billing group.
" + }, + "ComputationPreference":{"shape":"ComputationPreference"}, + "Size":{ + "shape":"NumberOfAccounts", + "documentation":"The number of accounts in the particular billing group.
" + }, + "CreationTime":{ + "shape":"Instant", + "documentation":"The time when the billing group was created.
" + }, + "LastModifiedTime":{ + "shape":"Instant", + "documentation":"The most recent time when the billing group was modified.
" + }, + "Status":{ + "shape":"BillingGroupStatus", + "documentation":"The billing group status. Only one of the valid values can be used.
" + }, + "StatusReason":{ + "shape":"BillingGroupStatusReason", + "documentation":"The reason why the billing group is in its current status.
" + }, + "AccountGrouping":{ + "shape":"ListBillingGroupAccountGrouping", + "documentation":"Specifies if the billing group has automatic account association (AutoAssociate) enabled.
A representation of a billing group.
" + }, + "BillingGroupName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_\\+=\\.\\-@]+", + "sensitive":true + }, + "BillingGroupStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "PRIMARY_ACCOUNT_MISSING" + ] + }, + "BillingGroupStatusList":{ + "type":"list", + "member":{"shape":"BillingGroupStatus"}, + "max":2, + "min":1 + }, + "BillingGroupStatusReason":{"type":"string"}, + "BillingPeriod":{ + "type":"string", + "pattern":"\\d{4}-(0?[1-9]|1[012])" + }, + "BillingPeriodRange":{ + "type":"structure", + "required":[ + "InclusiveStartBillingPeriod", + "ExclusiveEndBillingPeriod" + ], + "members":{ + "InclusiveStartBillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The inclusive start billing period that defines a billing period range for the margin summary.
" + }, + "ExclusiveEndBillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The exclusive end billing period that defines a billing period range for the margin summary. For example, if you choose a billing period that starts in October 2023 and ends in December 2023, the margin summary will only include data from October 2023 and November 2023.
" + } + }, + "documentation":"A time range for which the margin summary is effective. The time range can be up to 12 months.
" + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ClientToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9-]+" + }, + "ComputationPreference":{ + "type":"structure", + "required":["PricingPlanArn"], + "members":{ + "PricingPlanArn":{ + "shape":"PricingPlanFullArn", + "documentation":"The Amazon Resource Name (ARN) of the pricing plan that's used to compute the Amazon Web Services charges for a billing group.
" + } + }, + "documentation":"The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.
" + }, + "ConflictException":{ + "type":"structure", + "required":[ + "Message", + "ResourceId", + "ResourceType" + ], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{ + "shape":"String", + "documentation":"Identifier of the resource in use.
" + }, + "ResourceType":{ + "shape":"String", + "documentation":"Type of the resource in use.
" + }, + "Reason":{ + "shape":"ConflictExceptionReason", + "documentation":"Reason for the inconsistent state.
" + } + }, + "documentation":"You can cause an inconsistent state by updating or deleting a resource.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ConflictExceptionReason":{ + "type":"string", + "enum":[ + "RESOURCE_NAME_CONFLICT", + "PRICING_RULE_IN_PRICING_PLAN_CONFLICT", + "PRICING_PLAN_ATTACHED_TO_BILLING_GROUP_DELETE_CONFLICT", + "PRICING_RULE_ATTACHED_TO_PRICING_PLAN_DELETE_CONFLICT", + "WRITE_CONFLICT_RETRY" + ] + }, + "CreateBillingGroupInput":{ + "type":"structure", + "required":[ + "Name", + "AccountGrouping", + "ComputationPreference" + ], + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "documentation":"The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.
", + "idempotencyToken":true, + "location":"header", + "locationName":"X-Amzn-Client-Token" + }, + "Name":{ + "shape":"BillingGroupName", + "documentation":"The billing group name. The names must be unique.
" + }, + "AccountGrouping":{ + "shape":"AccountGrouping", + "documentation":"The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated billing family.
" + }, + "ComputationPreference":{ + "shape":"ComputationPreference", + "documentation":"The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.
" + }, + "PrimaryAccountId":{ + "shape":"AccountId", + "documentation":"The account ID that serves as the main account in a billing group.
" + }, + "Description":{ + "shape":"BillingGroupDescription", + "documentation":"The description of the billing group.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"A map that contains tag keys and tag values that are attached to a billing group. This feature isn't available during the beta.
" + } + } + }, + "CreateBillingGroupOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"BillingGroupArn", + "documentation":"The Amazon Resource Name (ARN) of the created billing group.
" + } + } + }, + "CreateCustomLineItemInput":{ + "type":"structure", + "required":[ + "Name", + "Description", + "BillingGroupArn", + "ChargeDetails" + ], + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "documentation":"The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.
", + "idempotencyToken":true, + "location":"header", + "locationName":"X-Amzn-Client-Token" + }, + "Name":{ + "shape":"CustomLineItemName", + "documentation":"The name of the custom line item.
" + }, + "Description":{ + "shape":"CustomLineItemDescription", + "documentation":"The description of the custom line item. This is shown on the Bills page in association with the charge value.
" + }, + "BillingGroupArn":{ + "shape":"BillingGroupArn", + "documentation":"The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.
" + }, + "BillingPeriodRange":{ + "shape":"CustomLineItemBillingPeriodRange", + "documentation":"A time range for which the custom line item is effective.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"A map that contains tag keys and tag values that are attached to a custom line item.
" + }, + "ChargeDetails":{ + "shape":"CustomLineItemChargeDetails", + "documentation":" A CustomLineItemChargeDetails that describes the charge details for a custom line item.
The Amazon Web Services account in which this custom line item will be applied to.
" + } + } + }, + "CreateCustomLineItemOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"CustomLineItemArn", + "documentation":"The Amazon Resource Name (ARN) of the created custom line item.
" + } + } + }, + "CreateFreeTierConfig":{ + "type":"structure", + "required":["Activated"], + "members":{ + "Activated":{ + "shape":"TieringActivated", + "documentation":"Activate or deactivate Amazon Web Services Free Tier.
" + } + }, + "documentation":"The possible Amazon Web Services Free Tier configurations.
" + }, + "CreatePricingPlanInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "documentation":"The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.
", + "idempotencyToken":true, + "location":"header", + "locationName":"X-Amzn-Client-Token" + }, + "Name":{ + "shape":"PricingPlanName", + "documentation":"The name of the pricing plan. The names must be unique to each pricing plan.
" + }, + "Description":{ + "shape":"PricingPlanDescription", + "documentation":"The description of the pricing plan.
" + }, + "PricingRuleArns":{ + "shape":"PricingRuleArnsInput", + "documentation":"A list of Amazon Resource Names (ARNs) that define the pricing plan parameters.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"A map that contains tag keys and tag values that are attached to a pricing plan.
" + } + } + }, + "CreatePricingPlanOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"PricingPlanArn", + "documentation":"The Amazon Resource Name (ARN) of the created pricing plan.
" + } + } + }, + "CreatePricingRuleInput":{ + "type":"structure", + "required":[ + "Name", + "Scope", + "Type" + ], + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "documentation":"The token that's needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.
", + "idempotencyToken":true, + "location":"header", + "locationName":"X-Amzn-Client-Token" + }, + "Name":{ + "shape":"PricingRuleName", + "documentation":"The pricing rule name. The names must be unique to each pricing rule.
" + }, + "Description":{ + "shape":"PricingRuleDescription", + "documentation":"The pricing rule description.
" + }, + "Scope":{ + "shape":"PricingRuleScope", + "documentation":"The scope of pricing rule that indicates if it's globally applicable, or it's service-specific.
" + }, + "Type":{ + "shape":"PricingRuleType", + "documentation":"The type of pricing rule.
" + }, + "ModifierPercentage":{ + "shape":"ModifierPercentage", + "documentation":"A percentage modifier that's applied on the public pricing rates.
" + }, + "Service":{ + "shape":"Service", + "documentation":" If the Scope attribute is set to SERVICE or SKU, the attribute indicates which service the PricingRule is applicable for.
A map that contains tag keys and tag values that are attached to a pricing rule.
" + }, + "BillingEntity":{ + "shape":"BillingEntity", + "documentation":"The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace.
" + }, + "Tiering":{ + "shape":"CreateTieringInput", + "documentation":"The set of tiering configurations for the pricing rule.
" + }, + "UsageType":{ + "shape":"UsageType", + "documentation":"Usage type is the unit that each service uses to measure the usage of a specific type of resource.
If the Scope attribute is set to SKU, this attribute indicates which usage type the PricingRule is modifying. For example, USW2-BoxUsage:m2.2xlarge describes an M2 High Memory Double Extra Large instance in the US West (Oregon) Region.
</p> Operation is the specific Amazon Web Services action covered by this line item. This describes the specific usage of the line item.
If the Scope attribute is set to SKU, this attribute indicates which operation the PricingRule is modifying. For example, a value of RunInstances:0202 indicates the operation of running an Amazon EC2 instance.
The Amazon Resource Name (ARN) of the created pricing rule.
" + } + } + }, + "CreateTieringInput":{ + "type":"structure", + "required":["FreeTier"], + "members":{ + "FreeTier":{ + "shape":"CreateFreeTierConfig", + "documentation":"The possible Amazon Web Services Free Tier configurations.
" + } + }, + "documentation":"The set of tiering configurations for the pricing rule.
" + }, + "Currency":{"type":"string"}, + "CurrencyCode":{ + "type":"string", + "enum":[ + "USD", + "CNY" + ] + }, + "CustomLineItemArn":{ + "type":"string", + "pattern":"(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}" + }, + "CustomLineItemArns":{ + "type":"list", + "member":{"shape":"CustomLineItemArn"}, + "max":100, + "min":1 + }, + "CustomLineItemAssociationElement":{ + "type":"string", + "pattern":"(arn:aws(-cn)?:billingconductor::[0-9]{12}:(customlineitem|billinggroup)/)?[a-zA-Z0-9]{10,12}" + }, + "CustomLineItemAssociationsList":{ + "type":"list", + "member":{"shape":"CustomLineItemAssociationElement"}, + "max":5, + "min":0 + }, + "CustomLineItemBatchAssociationsList":{ + "type":"list", + "member":{"shape":"CustomLineItemAssociationElement"}, + "max":30, + "min":1 + }, + "CustomLineItemBatchDisassociationsList":{ + "type":"list", + "member":{"shape":"CustomLineItemAssociationElement"}, + "max":30, + "min":1 + }, + "CustomLineItemBillingPeriodRange":{ + "type":"structure", + "required":["InclusiveStartBillingPeriod"], + "members":{ + "InclusiveStartBillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The inclusive start billing period that defines a billing period range where a custom line is applied.
" + }, + "ExclusiveEndBillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The inclusive end billing period that defines a billing period range where a custom line is applied.
" + } + }, + "documentation":"The billing period range in which the custom line item request will be applied.
" + }, + "CustomLineItemChargeDetails":{ + "type":"structure", + "required":["Type"], + "members":{ + "Flat":{ + "shape":"CustomLineItemFlatChargeDetails", + "documentation":"A CustomLineItemFlatChargeDetails that describes the charge details of a flat custom line item.
A CustomLineItemPercentageChargeDetails that describes the charge details of a percentage custom line item.
The type of the custom line item that indicates whether the charge is a fee or credit.
" + }, + "LineItemFilters":{ + "shape":"LineItemFiltersList", + "documentation":"A representation of the line item filter.
" + } + }, + "documentation":"The charge details of a custom line item. It should contain only one of Flat or Percentage.
The custom line item's fixed charge value in USD.
" + } + }, + "documentation":"A representation of the charge details that are associated with a flat custom line item.
" + }, + "CustomLineItemList":{ + "type":"list", + "member":{"shape":"CustomLineItemListElement"} + }, + "CustomLineItemListElement":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"CustomLineItemArn", + "documentation":"The Amazon Resource Names (ARNs) for custom line items.
" + }, + "Name":{ + "shape":"CustomLineItemName", + "documentation":"The custom line item's name.
" + }, + "ChargeDetails":{ + "shape":"ListCustomLineItemChargeDetails", + "documentation":"A ListCustomLineItemChargeDetails that describes the charge details of a custom line item.
The custom line item's charge value currency. Only one of the valid values can be used.
" + }, + "Description":{ + "shape":"CustomLineItemDescription", + "documentation":"The custom line item's description. This is shown on the Bills page in association with the charge value.
" + }, + "ProductCode":{ + "shape":"CustomLineItemProductCode", + "documentation":"The product code that's associated with the custom line item.
" + }, + "BillingGroupArn":{ + "shape":"BillingGroupArn", + "documentation":"The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.
" + }, + "CreationTime":{ + "shape":"Instant", + "documentation":"The time created.
" + }, + "LastModifiedTime":{ + "shape":"Instant", + "documentation":"The most recent time when the custom line item was modified.
" + }, + "AssociationSize":{ + "shape":"NumberOfAssociations", + "documentation":"The number of resources that are associated to the custom line item.
" + }, + "AccountId":{ + "shape":"AccountId", + "documentation":"The Amazon Web Services account in which this custom line item will be applied to.
" + } + }, + "documentation":"A representation of a custom line item.
" + }, + "CustomLineItemName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_\\+=\\.\\-@]+", + "sensitive":true + }, + "CustomLineItemNameList":{ + "type":"list", + "member":{"shape":"CustomLineItemName"}, + "max":100, + "min":1 + }, + "CustomLineItemPercentageChargeDetails":{ + "type":"structure", + "required":["PercentageValue"], + "members":{ + "PercentageValue":{ + "shape":"CustomLineItemPercentageChargeValue", + "documentation":"The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.
" + }, + "AssociatedValues":{ + "shape":"CustomLineItemAssociationsList", + "documentation":"A list of resource ARNs to associate to the percentage custom line item.
" + } + }, + "documentation":"A representation of the charge details that are associated with a percentage custom line item.
" + }, + "CustomLineItemPercentageChargeValue":{ + "type":"double", + "box":true, + "max":10000, + "min":0 + }, + "CustomLineItemProductCode":{ + "type":"string", + "max":29, + "min":1 + }, + "CustomLineItemRelationship":{ + "type":"string", + "enum":[ + "PARENT", + "CHILD" + ] + }, + "CustomLineItemType":{ + "type":"string", + "enum":[ + "CREDIT", + "FEE" + ] + }, + "CustomLineItemVersionList":{ + "type":"list", + "member":{"shape":"CustomLineItemVersionListElement"} + }, + "CustomLineItemVersionListElement":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"CustomLineItemName", + "documentation":"The name of the custom line item.
" + }, + "ChargeDetails":{"shape":"ListCustomLineItemChargeDetails"}, + "CurrencyCode":{ + "shape":"CurrencyCode", + "documentation":"The charge value currency of the custom line item.
" + }, + "Description":{ + "shape":"CustomLineItemDescription", + "documentation":"The description of the custom line item.
" + }, + "ProductCode":{ + "shape":"CustomLineItemProductCode", + "documentation":"The product code that’s associated with the custom line item.
" + }, + "BillingGroupArn":{ + "shape":"BillingGroupArn", + "documentation":"The Amazon Resource Name (ARN) of the billing group that the custom line item applies to.
" + }, + "CreationTime":{ + "shape":"Instant", + "documentation":"The time when the custom line item version was created.
" + }, + "LastModifiedTime":{ + "shape":"Instant", + "documentation":"The most recent time that the custom line item version was modified.
" + }, + "AssociationSize":{ + "shape":"NumberOfAssociations", + "documentation":"The number of resources that are associated with the custom line item.
" + }, + "StartBillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The start billing period of the custom line item version.
" + }, + "EndBillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The end billing period of the custom line item version.
" + }, + "Arn":{ + "shape":"CustomLineItemArn", + "documentation":"A list of custom line item Amazon Resource Names (ARNs) to retrieve information.
" + }, + "StartTime":{ + "shape":"Instant", + "documentation":"The inclusive start time.
" + }, + "AccountId":{ + "shape":"AccountId", + "documentation":"The Amazon Web Services account in which this custom line item will be applied to.
" + } + }, + "documentation":"A representation of a custom line item version.
" + }, + "DeleteBillingGroupInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"BillingGroupArn", + "documentation":"The Amazon Resource Name (ARN) of the billing group that you're deleting.
" + } + } + }, + "DeleteBillingGroupOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"BillingGroupArn", + "documentation":"The Amazon Resource Name (ARN) of the deleted billing group.
" + } + } + }, + "DeleteCustomLineItemInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"CustomLineItemArn", + "documentation":"The ARN of the custom line item to be deleted.
" + }, + "BillingPeriodRange":{"shape":"CustomLineItemBillingPeriodRange"} + } + }, + "DeleteCustomLineItemOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"CustomLineItemArn", + "documentation":"The ARN of the deleted custom line item.
" + } + } + }, + "DeletePricingPlanInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"PricingPlanArn", + "documentation":"The Amazon Resource Name (ARN) of the pricing plan that you're deleting.
" + } + } + }, + "DeletePricingPlanOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"PricingPlanArn", + "documentation":"The Amazon Resource Name (ARN) of the deleted pricing plan.
" + } + } + }, + "DeletePricingRuleInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"PricingRuleArn", + "documentation":"The Amazon Resource Name (ARN) of the pricing rule that you are deleting.
" + } + } + }, + "DeletePricingRuleOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"PricingRuleArn", + "documentation":"The Amazon Resource Name (ARN) of the deleted pricing rule.
" + } + } + }, + "DisassociateAccountsInput":{ + "type":"structure", + "required":[ + "Arn", + "AccountIds" + ], + "members":{ + "Arn":{ + "shape":"BillingGroupArn", + "documentation":"The Amazon Resource Name (ARN) of the billing group that the array of account IDs will disassociate from.
" + }, + "AccountIds":{ + "shape":"AccountIdList", + "documentation":"The array of account IDs to disassociate.
" + } + } + }, + "DisassociateAccountsOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"BillingGroupArn", + "documentation":"The Amazon Resource Name (ARN) of the billing group that the array of account IDs is disassociated from.
" + } + } + }, + "DisassociatePricingRulesInput":{ + "type":"structure", + "required":[ + "Arn", + "PricingRuleArns" + ], + "members":{ + "Arn":{ + "shape":"PricingPlanArn", + "documentation":"The pricing plan Amazon Resource Name (ARN) to disassociate pricing rules from.
" + }, + "PricingRuleArns":{ + "shape":"PricingRuleArnsNonEmptyInput", + "documentation":"A list containing the Amazon Resource Name (ARN) of the pricing rules that will be disassociated.
" + } + } + }, + "DisassociatePricingRulesOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"PricingPlanArn", + "documentation":"The Amazon Resource Name (ARN) of the pricing plan that the pricing rules successfully disassociated from.
" + } + } + }, + "DisassociateResourceResponseElement":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"CustomLineItemAssociationElement", + "documentation":"The resource ARN that was disassociated from the custom line item.
" + }, + "Error":{ + "shape":"AssociateResourceError", + "documentation":" An AssociateResourceError that's shown if the resource disassociation fails.
A resource disassociation result for a percentage custom line item.
" + }, + "DisassociateResourcesResponseList":{ + "type":"list", + "member":{"shape":"DisassociateResourceResponseElement"} + }, + "FreeTierConfig":{ + "type":"structure", + "required":["Activated"], + "members":{ + "Activated":{ + "shape":"TieringActivated", + "documentation":"Activate or deactivate Amazon Web Services Free Tier application.
" + } + }, + "documentation":"The possible Amazon Web Services Free Tier configurations.
" + }, + "GetBillingGroupCostReportInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"BillingGroupArn", + "documentation":"The Amazon Resource Number (ARN) that uniquely identifies the billing group.
" + }, + "BillingPeriodRange":{ + "shape":"BillingPeriodRange", + "documentation":"A time range for which the margin summary is effective. You can specify up to 12 months.
" + }, + "GroupBy":{ + "shape":"GroupByAttributesList", + "documentation":"A list of strings that specify the attributes that are used to break down costs in the margin summary reports for the billing group. For example, you can view your costs by the Amazon Web Service name or the billing period.
" + }, + "MaxResults":{ + "shape":"MaxBillingGroupCostReportResults", + "documentation":"The maximum number of margin summary reports to retrieve.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token used on subsequent calls to get reports.
" + } + } + }, + "GetBillingGroupCostReportOutput":{ + "type":"structure", + "members":{ + "BillingGroupCostReportResults":{ + "shape":"BillingGroupCostReportResultsList", + "documentation":"The list of margin summary reports.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token used on subsequent calls to get reports.
" + } + } + }, + "GroupByAttributeName":{ + "type":"string", + "enum":[ + "PRODUCT_NAME", + "BILLING_PERIOD" + ] + }, + "GroupByAttributesList":{ + "type":"list", + "member":{"shape":"GroupByAttributeName"} + }, + "Instant":{"type":"long"}, + "InternalServerException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"}, + "RetryAfterSeconds":{ + "shape":"RetryAfterSeconds", + "documentation":"Number of seconds you can retry after the call.
", + "location":"header", + "locationName":"Retry-After" + } + }, + "documentation":"An unexpected error occurred while processing a request.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "LineItemFilter":{ + "type":"structure", + "required":[ + "Attribute", + "MatchOption", + "Values" + ], + "members":{ + "Attribute":{ + "shape":"LineItemFilterAttributeName", + "documentation":"The attribute of the line item filter. This specifies what attribute that you can filter on.
" + }, + "MatchOption":{ + "shape":"MatchOption", + "documentation":"The match criteria of the line item filter. This parameter specifies whether not to include the resource value from the billing group total cost.
" + }, + "Values":{ + "shape":"LineItemFilterValuesList", + "documentation":"The values of the line item filter. This specifies the values to filter on. Currently, you can only exclude Savings Plan discounts.
" + } + }, + "documentation":"A representation of the line item filter for your custom line item. You can use line item filters to include or exclude specific resource values from the billing group's total cost. For example, if you create a custom line item and you want to filter out a value, such as Savings Plan discounts, you can update LineItemFilter to exclude it.
MONITORED: linked accounts that are associated to billing groups.
UNMONITORED: linked accounts that are not associated to billing groups.
Billing Group Arn: linked accounts that are associated to the provided Billing Group Arn.
The Amazon Web Services account ID to filter on.
" + }, + "AccountIds":{ + "shape":"AccountIdFilterList", + "documentation":"The list of Amazon Web Services IDs to retrieve their associated billing group for a given time range.
" + } + }, + "documentation":"The filter on the account ID of the linked account, or any of the following:
MONITORED: linked accounts that are associated to billing groups.
UNMONITORED: linked accounts that are not associated to billing groups.
Billing Group Arn: linked accounts that are associated to the provided Billing Group Arn.
The preferred billing period to get account associations.
" + }, + "Filters":{ + "shape":"ListAccountAssociationsFilter", + "documentation":"The filter on the account ID of the linked account, or any of the following:
MONITORED: linked accounts that are associated to billing groups.
UNMONITORED: linked accounts that aren't associated to billing groups.
Billing Group Arn: linked accounts that are associated to the provided billing group Arn.
The pagination token that's used on subsequent calls to retrieve accounts.
" + } + } + }, + "ListAccountAssociationsOutput":{ + "type":"structure", + "members":{ + "LinkedAccounts":{ + "shape":"AccountAssociationsList", + "documentation":"The list of linked accounts in the payer account.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token that's used on subsequent calls to get accounts.
" + } + } + }, + "ListBillingGroupAccountGrouping":{ + "type":"structure", + "members":{ + "AutoAssociate":{ + "shape":"Boolean", + "documentation":"Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family.
" + } + }, + "documentation":"Specifies if the billing group has the following features enabled.
" + }, + "ListBillingGroupCostReportsFilter":{ + "type":"structure", + "members":{ + "BillingGroupArns":{ + "shape":"BillingGroupArnList", + "documentation":"The list of Amazon Resource Names (ARNs) used to filter billing groups to retrieve reports.
" + } + }, + "documentation":"The filter used to retrieve specific BillingGroupCostReportElements.
The preferred billing period for your report.
" + }, + "MaxResults":{ + "shape":"MaxBillingGroupResults", + "documentation":"The maximum number of reports to retrieve.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token that's used on subsequent calls to get reports.
" + }, + "Filters":{ + "shape":"ListBillingGroupCostReportsFilter", + "documentation":"A ListBillingGroupCostReportsFilter to specify billing groups to retrieve reports from.
A list of BillingGroupCostReportElement retrieved.
The pagination token that's used on subsequent calls to get reports.
" + } + } + }, + "ListBillingGroupsFilter":{ + "type":"structure", + "members":{ + "Arns":{ + "shape":"BillingGroupArnList", + "documentation":"The list of billing group Amazon Resource Names (ARNs) to retrieve information.
" + }, + "PricingPlan":{ + "shape":"PricingPlanFullArn", + "documentation":"The pricing plan Amazon Resource Names (ARNs) to retrieve information.
" + }, + "Statuses":{ + "shape":"BillingGroupStatusList", + "documentation":"A list of billing groups to retrieve their current status for a specific time range
" + }, + "AutoAssociate":{ + "shape":"Boolean", + "documentation":"Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family.
" + } + }, + "documentation":"The filter that specifies the billing groups and pricing plans to retrieve billing group information.
" + }, + "ListBillingGroupsInput":{ + "type":"structure", + "members":{ + "BillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The preferred billing period to get billing groups.
" + }, + "MaxResults":{ + "shape":"MaxBillingGroupResults", + "documentation":"The maximum number of billing groups to retrieve.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token that's used on subsequent calls to get billing groups.
" + }, + "Filters":{ + "shape":"ListBillingGroupsFilter", + "documentation":"A ListBillingGroupsFilter that specifies the billing group and pricing plan to retrieve billing group information.
A list of BillingGroupListElement retrieved.
The pagination token that's used on subsequent calls to get billing groups.
" + } + } + }, + "ListCustomLineItemChargeDetails":{ + "type":"structure", + "required":["Type"], + "members":{ + "Flat":{ + "shape":"ListCustomLineItemFlatChargeDetails", + "documentation":" A ListCustomLineItemFlatChargeDetails that describes the charge details of a flat custom line item.
A ListCustomLineItemPercentageChargeDetails that describes the charge details of a percentage custom line item.
The type of the custom line item that indicates whether the charge is a fee or credit.
A representation of the line item filter.
" + } + }, + "documentation":"A representation of the charge details of a custom line item.
" + }, + "ListCustomLineItemFlatChargeDetails":{ + "type":"structure", + "required":["ChargeValue"], + "members":{ + "ChargeValue":{ + "shape":"CustomLineItemChargeValue", + "documentation":"The custom line item's fixed charge value in USD.
" + } + }, + "documentation":"A representation of the charge details that are associated with a flat custom line item.
" + }, + "ListCustomLineItemPercentageChargeDetails":{ + "type":"structure", + "required":["PercentageValue"], + "members":{ + "PercentageValue":{ + "shape":"CustomLineItemPercentageChargeValue", + "documentation":"The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.
" + } + }, + "documentation":"A representation of the charge details that are associated with a percentage custom line item.
" + }, + "ListCustomLineItemVersionsBillingPeriodRangeFilter":{ + "type":"structure", + "members":{ + "StartBillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The inclusive start billing period that defines a billing period range where a custom line item version is applied.
" + }, + "EndBillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The exclusive end billing period that defines a billing period range where a custom line item version is applied.
" + } + }, + "documentation":"A billing period filter that specifies the custom line item versions to retrieve.
" + }, + "ListCustomLineItemVersionsFilter":{ + "type":"structure", + "members":{ + "BillingPeriodRange":{ + "shape":"ListCustomLineItemVersionsBillingPeriodRangeFilter", + "documentation":"The billing period range in which the custom line item version is applied.
" + } + }, + "documentation":"A filter that specifies the billing period range where the custom line item versions reside.
" + }, + "ListCustomLineItemVersionsInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"CustomLineItemArn", + "documentation":"The Amazon Resource Name (ARN) for the custom line item.
" + }, + "MaxResults":{ + "shape":"MaxCustomLineItemResults", + "documentation":"The maximum number of custom line item versions to retrieve.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token that's used on subsequent calls to retrieve custom line item versions.
" + }, + "Filters":{ + "shape":"ListCustomLineItemVersionsFilter", + "documentation":"A ListCustomLineItemVersionsFilter that specifies the billing period range in which the custom line item versions are applied.
A list of CustomLineItemVersionListElements that are received.
The pagination token that's used on subsequent calls to retrieve custom line item versions.
" + } + } + }, + "ListCustomLineItemsFilter":{ + "type":"structure", + "members":{ + "Names":{ + "shape":"CustomLineItemNameList", + "documentation":"A list of custom line items to retrieve information.
" + }, + "BillingGroups":{ + "shape":"BillingGroupArnList", + "documentation":"The billing group Amazon Resource Names (ARNs) to retrieve information.
" + }, + "Arns":{ + "shape":"CustomLineItemArns", + "documentation":"A list of custom line item ARNs to retrieve information.
" + }, + "AccountIds":{ + "shape":"AccountIdList", + "documentation":"The Amazon Web Services accounts in which this custom line item will be applied to.
" + } + }, + "documentation":"A filter that specifies the custom line items and billing groups to retrieve FFLI information.
" + }, + "ListCustomLineItemsInput":{ + "type":"structure", + "members":{ + "BillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The preferred billing period to get custom line items (FFLIs).
" + }, + "MaxResults":{ + "shape":"MaxCustomLineItemResults", + "documentation":"The maximum number of billing groups to retrieve.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token that's used on subsequent calls to get custom line items (FFLIs).
" + }, + "Filters":{ + "shape":"ListCustomLineItemsFilter", + "documentation":"A ListCustomLineItemsFilter that specifies the custom line item names and/or billing group Amazon Resource Names (ARNs) to retrieve FFLI information.
A list of FreeFormLineItemListElements received.
The pagination token that's used on subsequent calls to get custom line items (FFLIs).
" + } + } + }, + "ListPricingPlansAssociatedWithPricingRuleInput":{ + "type":"structure", + "required":["PricingRuleArn"], + "members":{ + "BillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The pricing plan billing period for which associations will be listed.
" + }, + "PricingRuleArn":{ + "shape":"PricingRuleArn", + "documentation":"The pricing rule Amazon Resource Name (ARN) for which associations will be listed.
" + }, + "MaxResults":{ + "shape":"MaxPricingRuleResults", + "documentation":"The optional maximum number of pricing rule associations to retrieve.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The optional pagination token returned by a previous call.
" + } + } + }, + "ListPricingPlansAssociatedWithPricingRuleOutput":{ + "type":"structure", + "members":{ + "BillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The pricing plan billing period for which associations will be listed.
" + }, + "PricingRuleArn":{ + "shape":"PricingRuleArn", + "documentation":"The pricing rule Amazon Resource Name (ARN) for which associations will be listed.
" + }, + "PricingPlanArns":{ + "shape":"PricingPlanArns", + "documentation":"The list containing pricing plans that are associated with the requested pricing rule.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token to be used on subsequent calls.
" + } + } + }, + "ListPricingPlansFilter":{ + "type":"structure", + "members":{ + "Arns":{ + "shape":"PricingPlanArns", + "documentation":"A list of pricing plan Amazon Resource Names (ARNs) to retrieve information.
" + } + }, + "documentation":"The filter that specifies the Amazon Resource Names (ARNs) of pricing plans, to retrieve pricing plan information.
" + }, + "ListPricingPlansInput":{ + "type":"structure", + "members":{ + "BillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The preferred billing period to get pricing plan.
" + }, + "Filters":{ + "shape":"ListPricingPlansFilter", + "documentation":"A ListPricingPlansFilter that specifies the Amazon Resource Name (ARNs) of pricing plans to retrieve pricing plans information.
The maximum number of pricing plans to retrieve.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token that's used on subsequent call to get pricing plans.
" + } + } + }, + "ListPricingPlansOutput":{ + "type":"structure", + "members":{ + "BillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The billing period for which the described pricing plans are applicable.
" + }, + "PricingPlans":{ + "shape":"PricingPlanList", + "documentation":"A list of PricingPlanListElement retrieved.
The pagination token that's used on subsequent calls to get pricing plans.
" + } + } + }, + "ListPricingRulesAssociatedToPricingPlanInput":{ + "type":"structure", + "required":["PricingPlanArn"], + "members":{ + "BillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The billing period for which the pricing rule associations are to be listed.
" + }, + "PricingPlanArn":{ + "shape":"PricingPlanArn", + "documentation":"The Amazon Resource Name (ARN) of the pricing plan for which associations are to be listed.
" + }, + "MaxResults":{ + "shape":"MaxPricingPlanResults", + "documentation":"The optional maximum number of pricing rule associations to retrieve.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The optional pagination token returned by a previous call.
" + } + } + }, + "ListPricingRulesAssociatedToPricingPlanOutput":{ + "type":"structure", + "members":{ + "BillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The billing period for which the pricing rule associations are listed.
" + }, + "PricingPlanArn":{ + "shape":"PricingPlanArn", + "documentation":"The Amazon Resource Name (ARN) of the pricing plan for which associations are listed.
" + }, + "PricingRuleArns":{ + "shape":"PricingRuleArns", + "documentation":"A list containing pricing rules that are associated with the requested pricing plan.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token to be used on subsequent calls.
" + } + } + }, + "ListPricingRulesFilter":{ + "type":"structure", + "members":{ + "Arns":{ + "shape":"PricingRuleArns", + "documentation":"A list containing the pricing rule Amazon Resource Names (ARNs) to include in the API response.
" + } + }, + "documentation":" The filter that specifies criteria that the pricing rules returned by the ListPricingRules API will adhere to.
The preferred billing period to get the pricing plan.
" + }, + "Filters":{ + "shape":"ListPricingRulesFilter", + "documentation":" A DescribePricingRuleFilter that specifies the Amazon Resource Name (ARNs) of pricing rules to retrieve pricing rules information.
The maximum number of pricing rules to retrieve.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token that's used on subsequent call to get pricing rules.
" + } + } + }, + "ListPricingRulesOutput":{ + "type":"structure", + "members":{ + "BillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The billing period for which the described pricing rules are applicable.
" + }, + "PricingRules":{ + "shape":"PricingRuleList", + "documentation":"A list containing the described pricing rules.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token that's used on subsequent calls to get pricing rules.
" + } + } + }, + "ListResourcesAssociatedToCustomLineItemFilter":{ + "type":"structure", + "members":{ + "Relationship":{ + "shape":"CustomLineItemRelationship", + "documentation":"The type of relationship between the custom line item and the associated resource.
" + } + }, + "documentation":"A filter that specifies the type of resource associations that should be retrieved for a custom line item.
" + }, + "ListResourcesAssociatedToCustomLineItemInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "BillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The billing period for which the resource associations will be listed.
" + }, + "Arn":{ + "shape":"CustomLineItemArn", + "documentation":"The ARN of the custom line item for which the resource associations will be listed.
" + }, + "MaxResults":{ + "shape":"MaxCustomLineItemResults", + "documentation":"(Optional) The maximum number of resource associations to be retrieved.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"(Optional) The pagination token that's returned by a previous request.
" + }, + "Filters":{ + "shape":"ListResourcesAssociatedToCustomLineItemFilter", + "documentation":" (Optional) A ListResourcesAssociatedToCustomLineItemFilter that can specify the types of resources that should be retrieved.
The custom line item ARN for which the resource associations are listed.
" + }, + "AssociatedResources":{ + "shape":"ListResourcesAssociatedToCustomLineItemResponseList", + "documentation":" A list of ListResourcesAssociatedToCustomLineItemResponseElement for each resource association retrieved.
The pagination token to be used in subsequent requests to retrieve additional results.
" + } + } + }, + "ListResourcesAssociatedToCustomLineItemResponseElement":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"CustomLineItemAssociationElement", + "documentation":"The ARN of the associated resource.
" + }, + "Relationship":{ + "shape":"CustomLineItemRelationship", + "documentation":"The type of relationship between the custom line item and the associated resource.
" + }, + "EndBillingPeriod":{ + "shape":"BillingPeriod", + "documentation":"The end billing period of the associated resource.
" + } + }, + "documentation":"A representation of a resource association for a custom line item.
" + }, + "ListResourcesAssociatedToCustomLineItemResponseList":{ + "type":"list", + "member":{"shape":"ListResourcesAssociatedToCustomLineItemResponseElement"} + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) that identifies the resource to list the tags.
", + "location":"uri", + "locationName":"ResourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"The tags for the resource.
" + } + } + }, + "Margin":{"type":"string"}, + "MarginPercentage":{"type":"string"}, + "MatchOption":{ + "type":"string", + "enum":["NOT_EQUAL"] + }, + "MaxBillingGroupCostReportResults":{ + "type":"integer", + "box":true, + "max":300, + "min":200 + }, + "MaxBillingGroupResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MaxCustomLineItemResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MaxPricingPlanResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MaxPricingRuleResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ModifierPercentage":{ + "type":"double", + "box":true, + "min":0 + }, + "NumberOfAccounts":{ + "type":"long", + "min":0 + }, + "NumberOfAssociatedPricingRules":{ + "type":"long", + "min":1 + }, + "NumberOfAssociations":{ + "type":"long", + "min":0 + }, + "NumberOfPricingPlansAssociatedWith":{ + "type":"long", + "min":0 + }, + "Operation":{ + "type":"string", + "max":256, + "min":1, + "pattern":"\\S+" + }, + "PricingPlanArn":{ + "type":"string", + "pattern":"(arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/)?[a-zA-Z0-9]{10}" + }, + "PricingPlanArns":{ + "type":"list", + "member":{"shape":"PricingPlanArn"}, + "max":100, + "min":1 + }, + "PricingPlanDescription":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "PricingPlanFullArn":{ + "type":"string", + "pattern":"arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10}" + }, + "PricingPlanList":{ + "type":"list", + "member":{"shape":"PricingPlanListElement"} + }, + "PricingPlanListElement":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"PricingPlanName", + "documentation":"The name of a pricing plan.
" + }, + "Arn":{ + "shape":"PricingPlanArn", + "documentation":"The pricing plan Amazon Resource Names (ARN). This can be used to uniquely identify a pricing plan.
" + }, + "Description":{ + "shape":"PricingPlanDescription", + "documentation":"The pricing plan description.
" + }, + "Size":{ + "shape":"NumberOfAssociatedPricingRules", + "documentation":"The pricing rules count that's currently associated with this pricing plan list element.
" + }, + "CreationTime":{ + "shape":"Instant", + "documentation":"The time when the pricing plan was created.
" + }, + "LastModifiedTime":{ + "shape":"Instant", + "documentation":"The most recent time when the pricing plan was modified.
" + } + }, + "documentation":"A representation of a pricing plan.
" + }, + "PricingPlanName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_\\+=\\.\\-@]+", + "sensitive":true + }, + "PricingRuleArn":{ + "type":"string", + "pattern":"(arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}" + }, + "PricingRuleArns":{ + "type":"list", + "member":{"shape":"PricingRuleArn"}, + "max":100, + "min":1 + }, + "PricingRuleArnsInput":{ + "type":"list", + "member":{"shape":"PricingRuleArn"}, + "max":30, + "min":0 + }, + "PricingRuleArnsNonEmptyInput":{ + "type":"list", + "member":{"shape":"PricingRuleArn"}, + "max":30, + "min":1 + }, + "PricingRuleDescription":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "PricingRuleList":{ + "type":"list", + "member":{"shape":"PricingRuleListElement"} + }, + "PricingRuleListElement":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"PricingRuleName", + "documentation":"The name of a pricing rule.
" + }, + "Arn":{ + "shape":"PricingRuleArn", + "documentation":"The Amazon Resource Name (ARN) used to uniquely identify a pricing rule.
" + }, + "Description":{ + "shape":"PricingRuleDescription", + "documentation":"The pricing rule description.
" + }, + "Scope":{ + "shape":"PricingRuleScope", + "documentation":"The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific.
" + }, + "Type":{ + "shape":"PricingRuleType", + "documentation":"The type of pricing rule.
" + }, + "ModifierPercentage":{ + "shape":"ModifierPercentage", + "documentation":"A percentage modifier applied on the public pricing rates.
" + }, + "Service":{ + "shape":"Service", + "documentation":"If the Scope attribute is SERVICE, this attribute indicates which service the PricingRule is applicable for.
The pricing plans count that this pricing rule is associated with.
" + }, + "CreationTime":{ + "shape":"Instant", + "documentation":"The time when the pricing rule was created.
" + }, + "LastModifiedTime":{ + "shape":"Instant", + "documentation":"The most recent time when the pricing rule was modified.
" + }, + "BillingEntity":{ + "shape":"BillingEntity", + "documentation":"The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace.
" + }, + "Tiering":{ + "shape":"Tiering", + "documentation":"The set of tiering configurations for the pricing rule.
" + }, + "UsageType":{ + "shape":"UsageType", + "documentation":"Usage type is the unit that each service uses to measure the usage of a specific type of resource.
If the Scope attribute is set to SKU, this attribute indicates which usage type the PricingRule is modifying. For example, USW2-BoxUsage:m2.2xlarge describes an M2 High Memory Double Extra Large instance in the US West (Oregon) Region.
</p> Operation is the specific Amazon Web Services action covered by this line item. This describes the specific usage of the line item.
If the Scope attribute is set to SKU, this attribute indicates which operation the PricingRule is modifying. For example, a value of RunInstances:0202 indicates the operation of running an Amazon EC2 instance.
A representation of a pricing rule.
" + }, + "PricingRuleName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_\\+=\\.\\-@]+", + "sensitive":true + }, + "PricingRuleScope":{ + "type":"string", + "enum":[ + "GLOBAL", + "SERVICE", + "BILLING_ENTITY", + "SKU" + ] + }, + "PricingRuleType":{ + "type":"string", + "enum":[ + "MARKUP", + "DISCOUNT", + "TIERING" + ] + }, + "ProformaCost":{"type":"string"}, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "Message", + "ResourceId", + "ResourceType" + ], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{ + "shape":"String", + "documentation":"Resource identifier that was not found.
" + }, + "ResourceType":{ + "shape":"String", + "documentation":"Resource type that was not found.
" + } + }, + "documentation":"The request references a resource that doesn't exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "RetryAfterSeconds":{"type":"integer"}, + "Service":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9]+" + }, + "ServiceLimitExceededException":{ + "type":"structure", + "required":[ + "Message", + "LimitCode", + "ServiceCode" + ], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{ + "shape":"String", + "documentation":"Identifier of the resource affected.
" + }, + "ResourceType":{ + "shape":"String", + "documentation":"Type of the resource affected.
" + }, + "LimitCode":{ + "shape":"String", + "documentation":"The unique code identifier of the service limit that is being exceeded.
" + }, + "ServiceCode":{ + "shape":"String", + "documentation":"The unique code for the service of the limit that is being exceeded.
" + } + }, + "documentation":"The request would cause a service limit to exceed.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":1 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource to which to add tags.
", + "location":"uri", + "locationName":"ResourceArn" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The tags to add to the resource as a list of key-value pairs.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "ThrottlingException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"}, + "RetryAfterSeconds":{ + "shape":"RetryAfterSeconds", + "documentation":"Number of seconds you can safely retry after the call.
", + "location":"header", + "locationName":"Retry-After" + } + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "Tiering":{ + "type":"structure", + "required":["FreeTier"], + "members":{ + "FreeTier":{ + "shape":"FreeTierConfig", + "documentation":"The possible Amazon Web Services Free Tier configurations.
" + } + }, + "documentation":"The set of tiering configurations for the pricing rule.
" + }, + "TieringActivated":{ + "type":"boolean", + "box":true + }, + "Token":{"type":"string"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource to which to delete tags.
", + "location":"uri", + "locationName":"ResourceArn" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"The tags to delete from the resource as a list of key-value pairs.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateBillingGroupAccountGrouping":{ + "type":"structure", + "members":{ + "AutoAssociate":{ + "shape":"Boolean", + "documentation":"Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family.
" + } + }, + "documentation":"Specifies if the billing group has the following features enabled.
" + }, + "UpdateBillingGroupInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"BillingGroupArn", + "documentation":"The Amazon Resource Name (ARN) of the billing group being updated.
" + }, + "Name":{ + "shape":"BillingGroupName", + "documentation":"The name of the billing group. The names must be unique to each billing group.
" + }, + "Status":{ + "shape":"BillingGroupStatus", + "documentation":"The status of the billing group. Only one of the valid values can be used.
" + }, + "ComputationPreference":{ + "shape":"ComputationPreference", + "documentation":"The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.
" + }, + "Description":{ + "shape":"BillingGroupDescription", + "documentation":"A description of the billing group.
" + }, + "AccountGrouping":{ + "shape":"UpdateBillingGroupAccountGrouping", + "documentation":"Specifies if the billing group has automatic account association (AutoAssociate) enabled.
The Amazon Resource Name (ARN) of the billing group that was updated.
" + }, + "Name":{ + "shape":"BillingGroupName", + "documentation":"The name of the billing group. The names must be unique to each billing group.
" + }, + "Description":{ + "shape":"BillingGroupDescription", + "documentation":"A description of the billing group.
" + }, + "PrimaryAccountId":{ + "shape":"AccountId", + "documentation":"The account ID that serves as the main account in a billing group.
" + }, + "PricingPlanArn":{ + "shape":"PricingPlanArn", + "documentation":"The Amazon Resource Name (ARN) of the pricing plan to compute Amazon Web Services charges for the billing group.
" + }, + "Size":{ + "shape":"NumberOfAccounts", + "documentation":"The number of accounts in the particular billing group.
" + }, + "LastModifiedTime":{ + "shape":"Instant", + "documentation":"The most recent time when the billing group was modified.
" + }, + "Status":{ + "shape":"BillingGroupStatus", + "documentation":"The status of the billing group. Only one of the valid values can be used.
" + }, + "StatusReason":{ + "shape":"BillingGroupStatusReason", + "documentation":"The reason why the billing group is in its current status.
" + }, + "AccountGrouping":{ + "shape":"UpdateBillingGroupAccountGrouping", + "documentation":"Specifies if the billing group has automatic account association (AutoAssociate) enabled.
An UpdateCustomLineItemFlatChargeDetails that describes the new charge details of a flat custom line item.
An UpdateCustomLineItemPercentageChargeDetails that describes the new charge details of a percentage custom line item.
A representation of the line item filter.
" + } + }, + "documentation":" A representation of the new charge details of a custom line item. This should contain only one of Flat or Percentage.
The custom line item's new fixed charge value in USD.
" + } + }, + "documentation":"A representation of the new charge details that are associated with a flat custom line item.
" + }, + "UpdateCustomLineItemInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"CustomLineItemArn", + "documentation":"The ARN of the custom line item to be updated.
" + }, + "Name":{ + "shape":"CustomLineItemName", + "documentation":"The new name for the custom line item.
" + }, + "Description":{ + "shape":"CustomLineItemDescription", + "documentation":"The new line item description of the custom line item.
" + }, + "ChargeDetails":{ + "shape":"UpdateCustomLineItemChargeDetails", + "documentation":" A ListCustomLineItemChargeDetails containing the new charge details for the custom line item.
The ARN of the successfully updated custom line item.
" + }, + "BillingGroupArn":{ + "shape":"BillingGroupFullArn", + "documentation":"The ARN of the billing group that the custom line item is applied to.
" + }, + "Name":{ + "shape":"CustomLineItemName", + "documentation":"The name of the successfully updated custom line item.
" + }, + "Description":{ + "shape":"CustomLineItemDescription", + "documentation":"The description of the successfully updated custom line item.
" + }, + "ChargeDetails":{ + "shape":"ListCustomLineItemChargeDetails", + "documentation":" A ListCustomLineItemChargeDetails containing the charge details of the successfully updated custom line item.
The most recent time when the custom line item was modified.
" + }, + "AssociationSize":{ + "shape":"NumberOfAssociations", + "documentation":"The number of resources that are associated to the custom line item.
" + } + } + }, + "UpdateCustomLineItemPercentageChargeDetails":{ + "type":"structure", + "required":["PercentageValue"], + "members":{ + "PercentageValue":{ + "shape":"CustomLineItemPercentageChargeValue", + "documentation":"The custom line item's new percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.
" + } + }, + "documentation":"A representation of the new charge details that are associated with a percentage custom line item.
" + }, + "UpdateFreeTierConfig":{ + "type":"structure", + "required":["Activated"], + "members":{ + "Activated":{ + "shape":"TieringActivated", + "documentation":"Activate or deactivate application of Amazon Web Services Free Tier.
" + } + }, + "documentation":"The possible Amazon Web Services Free Tier configurations.
" + }, + "UpdatePricingPlanInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"PricingPlanArn", + "documentation":"The Amazon Resource Name (ARN) of the pricing plan that you're updating.
" + }, + "Name":{ + "shape":"PricingPlanName", + "documentation":"The name of the pricing plan. The name must be unique to each pricing plan.
" + }, + "Description":{ + "shape":"PricingPlanDescription", + "documentation":"The description of the pricing plan.
" + } + } + }, + "UpdatePricingPlanOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"PricingPlanArn", + "documentation":"The Amazon Resource Name (ARN) of the updated pricing plan.
" + }, + "Name":{ + "shape":"PricingPlanName", + "documentation":"The name of the pricing plan. The name must be unique to each pricing plan.
" + }, + "Description":{ + "shape":"PricingPlanDescription", + "documentation":"The new description for the pricing rule.
" + }, + "Size":{ + "shape":"NumberOfAssociatedPricingRules", + "documentation":"The pricing rules count that's currently associated with this pricing plan list.
" + }, + "LastModifiedTime":{ + "shape":"Instant", + "documentation":"The most recent time when the pricing plan was modified.
" + } + } + }, + "UpdatePricingRuleInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"PricingRuleArn", + "documentation":"The Amazon Resource Name (ARN) of the pricing rule to update.
" + }, + "Name":{ + "shape":"PricingRuleName", + "documentation":"The new name of the pricing rule. The name must be unique to each pricing rule.
" + }, + "Description":{ + "shape":"PricingRuleDescription", + "documentation":"The new description for the pricing rule.
" + }, + "Type":{ + "shape":"PricingRuleType", + "documentation":"The new pricing rule type.
" + }, + "ModifierPercentage":{ + "shape":"ModifierPercentage", + "documentation":"The new modifier to show pricing plan rates as a percentage.
" + }, + "Tiering":{ + "shape":"UpdateTieringInput", + "documentation":"The set of tiering configurations for the pricing rule.
" + } + } + }, + "UpdatePricingRuleOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"PricingRuleArn", + "documentation":"The Amazon Resource Name (ARN) of the successfully updated pricing rule.
" + }, + "Name":{ + "shape":"PricingRuleName", + "documentation":"The new name of the pricing rule. The name must be unique to each pricing rule.
" + }, + "Description":{ + "shape":"PricingRuleDescription", + "documentation":"The new description for the pricing rule.
" + }, + "Scope":{ + "shape":"PricingRuleScope", + "documentation":"The scope of pricing rule that indicates if it's globally applicable, or it's service-specific.
" + }, + "Type":{ + "shape":"PricingRuleType", + "documentation":"The new pricing rule type.
" + }, + "ModifierPercentage":{ + "shape":"ModifierPercentage", + "documentation":"The new modifier to show pricing plan rates as a percentage.
" + }, + "Service":{ + "shape":"Service", + "documentation":" If the Scope attribute is set to SERVICE, the attribute indicates which service the PricingRule is applicable for.
The pricing plans count that this pricing rule is associated with.
" + }, + "LastModifiedTime":{ + "shape":"Instant", + "documentation":"The most recent time the pricing rule was modified.
" + }, + "BillingEntity":{ + "shape":"BillingEntity", + "documentation":"The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace.
" + }, + "Tiering":{ + "shape":"UpdateTieringInput", + "documentation":"The set of tiering configurations for the pricing rule.
" + }, + "UsageType":{ + "shape":"UsageType", + "documentation":"Usage type is the unit that each service uses to measure the usage of a specific type of resource.
If the Scope attribute is set to SKU, this attribute indicates which usage type the PricingRule is modifying. For example, USW2-BoxUsage:m2.2xlarge describes an M2 High Memory Double Extra Large instance in the US West (Oregon) Region.
Operation refers to the specific Amazon Web Services covered by this line item. This describes the specific usage of the line item.
If the Scope attribute is set to SKU, this attribute indicates which operation the PricingRule is modifying. For example, a value of RunInstances:0202 indicates the operation of running an Amazon EC2 instance.
The possible Amazon Web Services Free Tier configurations.
" + } + }, + "documentation":"The set of tiering configurations for the pricing rule.
" + }, + "UsageType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"\\S+" + }, + "ValidationException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"}, + "Reason":{ + "shape":"ValidationExceptionReason", + "documentation":"The reason the request's validation failed.
" + }, + "Fields":{ + "shape":"ValidationExceptionFieldList", + "documentation":"The fields that caused the error, if applicable.
" + } + }, + "documentation":"The input doesn't match with the constraints specified by Amazon Web Services.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "Name", + "Message" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"The field name.
" + }, + "Message":{ + "shape":"String", + "documentation":"The message describing why the field failed validation.
" + } + }, + "documentation":"The field's information of a request that resulted in an exception.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "UNKNOWN_OPERATION", + "CANNOT_PARSE", + "FIELD_VALIDATION_FAILED", + "OTHER", + "PRIMARY_NOT_ASSOCIATED", + "PRIMARY_CANNOT_DISASSOCIATE", + "ACCOUNTS_NOT_ASSOCIATED", + "ACCOUNTS_ALREADY_ASSOCIATED", + "ILLEGAL_PRIMARY_ACCOUNT", + "ILLEGAL_ACCOUNTS", + "MISMATCHED_BILLINGGROUP_ARN", + "MISSING_BILLINGGROUP", + "MISMATCHED_CUSTOMLINEITEM_ARN", + "ILLEGAL_BILLING_PERIOD", + "ILLEGAL_BILLING_PERIOD_RANGE", + "TOO_MANY_ACCOUNTS_IN_REQUEST", + "DUPLICATE_ACCOUNT", + "INVALID_BILLING_GROUP_STATUS", + "MISMATCHED_PRICINGPLAN_ARN", + "MISSING_PRICINGPLAN", + "MISMATCHED_PRICINGRULE_ARN", + "DUPLICATE_PRICINGRULE_ARNS", + "ILLEGAL_EXPRESSION", + "ILLEGAL_SCOPE", + "ILLEGAL_SERVICE", + "PRICINGRULES_NOT_EXIST", + "PRICINGRULES_ALREADY_ASSOCIATED", + "PRICINGRULES_NOT_ASSOCIATED", + "INVALID_TIME_RANGE", + "INVALID_BILLINGVIEW_ARN", + "MISMATCHED_BILLINGVIEW_ARN", + "ILLEGAL_CUSTOMLINEITEM", + "MISSING_CUSTOMLINEITEM", + "ILLEGAL_CUSTOMLINEITEM_UPDATE", + "TOO_MANY_CUSTOMLINEITEMS_IN_REQUEST", + "ILLEGAL_CHARGE_DETAILS", + "ILLEGAL_UPDATE_CHARGE_DETAILS", + "INVALID_ARN", + "ILLEGAL_RESOURCE_ARNS", + "ILLEGAL_CUSTOMLINEITEM_MODIFICATION", + "MISSING_LINKED_ACCOUNT_IDS", + "MULTIPLE_LINKED_ACCOUNT_IDS", + "MISSING_PRICING_PLAN_ARN", + "MULTIPLE_PRICING_PLAN_ARN", + "ILLEGAL_CHILD_ASSOCIATE_RESOURCE", + "CUSTOM_LINE_ITEM_ASSOCIATION_EXISTS", + "INVALID_BILLING_GROUP", + "INVALID_BILLING_PERIOD_FOR_OPERATION", + "ILLEGAL_BILLING_ENTITY", + "ILLEGAL_MODIFIER_PERCENTAGE", + "ILLEGAL_TYPE", + "ILLEGAL_ENDED_BILLINGGROUP", + "ILLEGAL_TIERING_INPUT", + "ILLEGAL_OPERATION", + "ILLEGAL_USAGE_TYPE", + "INVALID_SKU_COMBO", + "INVALID_FILTER", + "TOO_MANY_AUTO_ASSOCIATE_BILLING_GROUPS", + "CANNOT_DELETE_AUTO_ASSOCIATE_BILLING_GROUP", + "ILLEGAL_ACCOUNT_ID" + ] + } + }, + "documentation":"Amazon Web Services Billing Conductor is a fully managed service that you can use to customize a proforma version of your billing data each month, to accurately show or chargeback your end customers. Amazon Web Services Billing Conductor doesn't change the way you're billed by Amazon Web Services each month by design. Instead, it provides you with a mechanism to configure, generate, and display rates to certain customers over a given billing period. You can also analyze the difference between the rates you apply to your accounting groupings relative to your actual rates from Amazon Web Services. As a result of your Amazon Web Services Billing Conductor configuration, the payer account can also see the custom rate applied on the billing details page of the Amazon Web Services Billing console, or configure a cost and usage report per billing group.
This documentation shows how you can configure Amazon Web Services Billing Conductor using its API. For more information about using the Amazon Web Services Billing Conductor user interface, see the Amazon Web Services Billing Conductor User Guide.
" +} diff --git a/testbed/boto__botocore/botocore/data/billingconductor/2021-07-30/waiters-2.json b/testbed/boto__botocore/botocore/data/billingconductor/2021-07-30/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..ee5023dc5bd8d0a6d3d30f2bd413c5e82a2c2ee5 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/billingconductor/2021-07-30/waiters-2.json @@ -0,0 +1,4 @@ +{ + "version": 2, + "waiters": {} +} diff --git a/testbed/boto__botocore/botocore/data/chime-sdk-media-pipelines/2021-07-15/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/chime-sdk-media-pipelines/2021-07-15/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..c82bcc16b678e1b90859cad2b3805e05162486dc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/chime-sdk-media-pipelines/2021-07-15/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://media-pipelines-chime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://media-pipelines-chime-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://media-pipelines-chime.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://media-pipelines-chime.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/chime-sdk-media-pipelines/2021-07-15/paginators-1.json b/testbed/boto__botocore/botocore/data/chime-sdk-media-pipelines/2021-07-15/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..ea142457a6a77d6e6a54942329f1199bc2f2a60c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/chime-sdk-media-pipelines/2021-07-15/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/testbed/boto__botocore/botocore/data/chime-sdk-media-pipelines/2021-07-15/service-2.json b/testbed/boto__botocore/botocore/data/chime-sdk-media-pipelines/2021-07-15/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..c4e1dbd72865219c2dc97a571a3ab6221095fa73 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/chime-sdk-media-pipelines/2021-07-15/service-2.json @@ -0,0 +1,3904 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-07-15", + "endpointPrefix":"media-pipelines-chime", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"Amazon Chime SDK Media Pipelines", + "serviceId":"Chime SDK Media Pipelines", + "signatureVersion":"v4", + "signingName":"chime", + "uid":"chime-sdk-media-pipelines-2021-07-15", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "CreateMediaCapturePipeline":{ + "name":"CreateMediaCapturePipeline", + "http":{ + "method":"POST", + "requestUri":"/sdk-media-capture-pipelines", + "responseCode":201 + }, + "input":{"shape":"CreateMediaCapturePipelineRequest"}, + "output":{"shape":"CreateMediaCapturePipelineResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Creates a media pipeline.
" + }, + "CreateMediaConcatenationPipeline":{ + "name":"CreateMediaConcatenationPipeline", + "http":{ + "method":"POST", + "requestUri":"/sdk-media-concatenation-pipelines", + "responseCode":201 + }, + "input":{"shape":"CreateMediaConcatenationPipelineRequest"}, + "output":{"shape":"CreateMediaConcatenationPipelineResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Creates a media concatenation pipeline.
" + }, + "CreateMediaInsightsPipeline":{ + "name":"CreateMediaInsightsPipeline", + "http":{ + "method":"POST", + "requestUri":"/media-insights-pipelines", + "responseCode":201 + }, + "input":{"shape":"CreateMediaInsightsPipelineRequest"}, + "output":{"shape":"CreateMediaInsightsPipelineResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Creates a media insights pipeline.
" + }, + "CreateMediaInsightsPipelineConfiguration":{ + "name":"CreateMediaInsightsPipelineConfiguration", + "http":{ + "method":"POST", + "requestUri":"/media-insights-pipeline-configurations", + "responseCode":201 + }, + "input":{"shape":"CreateMediaInsightsPipelineConfigurationRequest"}, + "output":{"shape":"CreateMediaInsightsPipelineConfigurationResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"A structure that contains the static configurations for a media insights pipeline.
" + }, + "CreateMediaLiveConnectorPipeline":{ + "name":"CreateMediaLiveConnectorPipeline", + "http":{ + "method":"POST", + "requestUri":"/sdk-media-live-connector-pipelines", + "responseCode":201 + }, + "input":{"shape":"CreateMediaLiveConnectorPipelineRequest"}, + "output":{"shape":"CreateMediaLiveConnectorPipelineResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Creates a media live connector pipeline in an Amazon Chime SDK meeting.
" + }, + "CreateMediaPipelineKinesisVideoStreamPool":{ + "name":"CreateMediaPipelineKinesisVideoStreamPool", + "http":{ + "method":"POST", + "requestUri":"/media-pipeline-kinesis-video-stream-pools", + "responseCode":201 + }, + "input":{"shape":"CreateMediaPipelineKinesisVideoStreamPoolRequest"}, + "output":{"shape":"CreateMediaPipelineKinesisVideoStreamPoolResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines.
If a meeting uses an opt-in Region as its MediaRegion, the KVS stream must be in that same Region. For example, if a meeting uses the af-south-1 Region, the KVS stream must also be in af-south-1. However, if the meeting uses a Region that AWS turns on by default, the KVS stream can be in any available Region, including an opt-in Region. For example, if the meeting uses ca-central-1, the KVS stream can be in eu-west-2, us-east-1, af-south-1, or any other Region that the Amazon Chime SDK supports.
To learn which AWS Region a meeting uses, call the GetMeeting API and use the MediaRegion parameter from the response.
For more information about opt-in Regions, refer to Available Regions in the Amazon Chime SDK Developer Guide, and Specify which AWS Regions your account can use, in the AWS Account Management Reference Guide.
Creates a streaming media pipeline.
" + }, + "DeleteMediaCapturePipeline":{ + "name":"DeleteMediaCapturePipeline", + "http":{ + "method":"DELETE", + "requestUri":"/sdk-media-capture-pipelines/{mediaPipelineId}", + "responseCode":204 + }, + "input":{"shape":"DeleteMediaCapturePipelineRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes the media pipeline.
" + }, + "DeleteMediaInsightsPipelineConfiguration":{ + "name":"DeleteMediaInsightsPipelineConfiguration", + "http":{ + "method":"DELETE", + "requestUri":"/media-insights-pipeline-configurations/{identifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteMediaInsightsPipelineConfigurationRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes the specified configuration settings.
" + }, + "DeleteMediaPipeline":{ + "name":"DeleteMediaPipeline", + "http":{ + "method":"DELETE", + "requestUri":"/sdk-media-pipelines/{mediaPipelineId}", + "responseCode":204 + }, + "input":{"shape":"DeleteMediaPipelineRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes the media pipeline.
" + }, + "DeleteMediaPipelineKinesisVideoStreamPool":{ + "name":"DeleteMediaPipelineKinesisVideoStreamPool", + "http":{ + "method":"DELETE", + "requestUri":"/media-pipeline-kinesis-video-stream-pools/{identifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteMediaPipelineKinesisVideoStreamPoolRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes an Amazon Kinesis Video Stream pool.
" + }, + "GetMediaCapturePipeline":{ + "name":"GetMediaCapturePipeline", + "http":{ + "method":"GET", + "requestUri":"/sdk-media-capture-pipelines/{mediaPipelineId}", + "responseCode":200 + }, + "input":{"shape":"GetMediaCapturePipelineRequest"}, + "output":{"shape":"GetMediaCapturePipelineResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Gets an existing media pipeline.
" + }, + "GetMediaInsightsPipelineConfiguration":{ + "name":"GetMediaInsightsPipelineConfiguration", + "http":{ + "method":"GET", + "requestUri":"/media-insights-pipeline-configurations/{identifier}", + "responseCode":200 + }, + "input":{"shape":"GetMediaInsightsPipelineConfigurationRequest"}, + "output":{"shape":"GetMediaInsightsPipelineConfigurationResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Gets the configuration settings for a media insights pipeline.
" + }, + "GetMediaPipeline":{ + "name":"GetMediaPipeline", + "http":{ + "method":"GET", + "requestUri":"/sdk-media-pipelines/{mediaPipelineId}", + "responseCode":200 + }, + "input":{"shape":"GetMediaPipelineRequest"}, + "output":{"shape":"GetMediaPipelineResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Gets an existing media pipeline.
" + }, + "GetMediaPipelineKinesisVideoStreamPool":{ + "name":"GetMediaPipelineKinesisVideoStreamPool", + "http":{ + "method":"GET", + "requestUri":"/media-pipeline-kinesis-video-stream-pools/{identifier}", + "responseCode":200 + }, + "input":{"shape":"GetMediaPipelineKinesisVideoStreamPoolRequest"}, + "output":{"shape":"GetMediaPipelineKinesisVideoStreamPoolResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Gets an Kinesis video stream pool.
" + }, + "GetSpeakerSearchTask":{ + "name":"GetSpeakerSearchTask", + "http":{ + "method":"GET", + "requestUri":"/media-insights-pipelines/{identifier}/speaker-search-tasks/{speakerSearchTaskId}", + "responseCode":200 + }, + "input":{"shape":"GetSpeakerSearchTaskRequest"}, + "output":{"shape":"GetSpeakerSearchTaskResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves the details of the specified speaker search task.
" + }, + "GetVoiceToneAnalysisTask":{ + "name":"GetVoiceToneAnalysisTask", + "http":{ + "method":"GET", + "requestUri":"/media-insights-pipelines/{identifier}/voice-tone-analysis-tasks/{voiceToneAnalysisTaskId}", + "responseCode":200 + }, + "input":{"shape":"GetVoiceToneAnalysisTaskRequest"}, + "output":{"shape":"GetVoiceToneAnalysisTaskResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves the details of a voice tone analysis task.
" + }, + "ListMediaCapturePipelines":{ + "name":"ListMediaCapturePipelines", + "http":{ + "method":"GET", + "requestUri":"/sdk-media-capture-pipelines", + "responseCode":200 + }, + "input":{"shape":"ListMediaCapturePipelinesRequest"}, + "output":{"shape":"ListMediaCapturePipelinesResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Returns a list of media pipelines.
" + }, + "ListMediaInsightsPipelineConfigurations":{ + "name":"ListMediaInsightsPipelineConfigurations", + "http":{ + "method":"GET", + "requestUri":"/media-insights-pipeline-configurations", + "responseCode":200 + }, + "input":{"shape":"ListMediaInsightsPipelineConfigurationsRequest"}, + "output":{"shape":"ListMediaInsightsPipelineConfigurationsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the available media insights pipeline configurations.
" + }, + "ListMediaPipelineKinesisVideoStreamPools":{ + "name":"ListMediaPipelineKinesisVideoStreamPools", + "http":{ + "method":"GET", + "requestUri":"/media-pipeline-kinesis-video-stream-pools", + "responseCode":200 + }, + "input":{"shape":"ListMediaPipelineKinesisVideoStreamPoolsRequest"}, + "output":{"shape":"ListMediaPipelineKinesisVideoStreamPoolsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the video stream pools in the media pipeline.
" + }, + "ListMediaPipelines":{ + "name":"ListMediaPipelines", + "http":{ + "method":"GET", + "requestUri":"/sdk-media-pipelines", + "responseCode":200 + }, + "input":{"shape":"ListMediaPipelinesRequest"}, + "output":{"shape":"ListMediaPipelinesResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Returns a list of media pipelines.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the tags available for a media pipeline.
" + }, + "StartSpeakerSearchTask":{ + "name":"StartSpeakerSearchTask", + "http":{ + "method":"POST", + "requestUri":"/media-insights-pipelines/{identifier}/speaker-search-tasks?operation=start", + "responseCode":201 + }, + "input":{"shape":"StartSpeakerSearchTaskRequest"}, + "output":{"shape":"StartSpeakerSearchTaskResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"ConflictException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Starts a speaker search task.
Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide.
Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
Stops a speaker search task.
" + }, + "StopVoiceToneAnalysisTask":{ + "name":"StopVoiceToneAnalysisTask", + "http":{ + "method":"POST", + "requestUri":"/media-insights-pipelines/{identifier}/voice-tone-analysis-tasks/{voiceToneAnalysisTaskId}?operation=stop", + "responseCode":204 + }, + "input":{"shape":"StopVoiceToneAnalysisTaskRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"ConflictException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Stops a voice tone analysis task.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags?operation=tag-resource", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"The ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/tags?operation=untag-resource", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Removes any tags from a media pipeline.
" + }, + "UpdateMediaInsightsPipelineConfiguration":{ + "name":"UpdateMediaInsightsPipelineConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/media-insights-pipeline-configurations/{identifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateMediaInsightsPipelineConfigurationRequest"}, + "output":{"shape":"UpdateMediaInsightsPipelineConfigurationResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates the media insights pipeline's configuration settings.
" + }, + "UpdateMediaInsightsPipelineStatus":{ + "name":"UpdateMediaInsightsPipelineStatus", + "http":{ + "method":"PUT", + "requestUri":"/media-insights-pipeline-status/{identifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateMediaInsightsPipelineStatusRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"ConflictException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates the status of a media insights pipeline.
" + }, + "UpdateMediaPipelineKinesisVideoStreamPool":{ + "name":"UpdateMediaPipelineKinesisVideoStreamPool", + "http":{ + "method":"PUT", + "requestUri":"/media-pipeline-kinesis-video-stream-pools/{identifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateMediaPipelineKinesisVideoStreamPoolRequest"}, + "output":{"shape":"UpdateMediaPipelineKinesisVideoStreamPoolResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates an Amazon Kinesis Video Stream pool in a media pipeline.
" + } + }, + "shapes":{ + "ActiveSpeakerOnlyConfiguration":{ + "type":"structure", + "members":{ + "ActiveSpeakerPosition":{ + "shape":"ActiveSpeakerPosition", + "documentation":"The position of the ActiveSpeakerOnly video tile.
Defines the configuration for an ActiveSpeakerOnly video tile.
The language code in the configuration.
" + }, + "VocabularyName":{ + "shape":"VocabularyName", + "documentation":"Specifies the name of the custom vocabulary to use when processing a transcription. Note that vocabulary names are case sensitive.
If the language of the specified custom vocabulary doesn't match the language identified in your media, the custom vocabulary is not applied to your transcription.
For more information, see Custom vocabularies in the Amazon Transcribe Developer Guide.
Length Constraints: Minimum length of 1. Maximum length of 200.
" + }, + "VocabularyFilterName":{ + "shape":"VocabularyFilterName", + "documentation":"Specifies the name of the custom vocabulary filter to use when processing a transcription. Note that vocabulary filter names are case sensitive.
If the language of the specified custom vocabulary filter doesn't match the language identified in your media, the vocabulary filter is not applied to your transcription.
For more information, see Using vocabulary filtering with unwanted words in the Amazon Transcribe Developer Guide.
Length Constraints: Minimum length of 1. Maximum length of 200.
" + }, + "VocabularyFilterMethod":{ + "shape":"VocabularyFilterMethod", + "documentation":"Specifies how to apply a vocabulary filter to a transcript.
To replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
Specifies the name of the custom language model to use when processing a transcription. Note that language model names are case sensitive.
The language of the specified language model must match the language code specified in the transcription request. If the languages don't match, the custom language model isn't applied. Language mismatches don't generate errors or warnings.
For more information, see Custom language models in the Amazon Transcribe Developer Guide.
" + }, + "EnablePartialResultsStabilization":{ + "shape":"Boolean", + "documentation":"Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.
" + }, + "PartialResultsStability":{ + "shape":"PartialResultsStability", + "documentation":"Specifies the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization).
Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.
" + }, + "ContentIdentificationType":{ + "shape":"ContentType", + "documentation":"Labels all personally identifiable information (PII) identified in your transcript.
Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment.
You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you do, your request returns a BadRequestException.
For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.
" + }, + "ContentRedactionType":{ + "shape":"ContentType", + "documentation":"Redacts all personally identifiable information (PII) identified in your transcript.
Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.
You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you do, your request returns a BadRequestException.
For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.
" + }, + "PiiEntityTypes":{ + "shape":"PiiEntityTypes", + "documentation":"Specifies the types of personally identifiable information (PII) to redact from a transcript. You can include as many types as you'd like, or you can select ALL.
To include PiiEntityTypes in your Call Analytics request, you must also include ContentIdentificationType or ContentRedactionType, but you can't include both.
Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.
Length Constraints: Minimum length of 1. Maximum length of 300.
" + }, + "FilterPartialResults":{ + "shape":"Boolean", + "documentation":"If true, UtteranceEvents with IsPartial: true are filtered out of the insights target.
The settings for a post-call analysis task in an analytics configuration.
" + }, + "CallAnalyticsStreamCategories":{ + "shape":"CategoryNameList", + "documentation":"By default, all CategoryEvents are sent to the insights target. If this parameter is specified, only included categories are sent to the insights target.
A structure that contains the configuration settings for an Amazon Transcribe call analytics processor.
" + }, + "AmazonTranscribeProcessorConfiguration":{ + "type":"structure", + "members":{ + "LanguageCode":{ + "shape":"CallAnalyticsLanguageCode", + "documentation":"The language code that represents the language spoken in your audio.
If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.
For a list of languages that real-time Call Analytics supports, see the Supported languages table in the Amazon Transcribe Developer Guide.
" + }, + "VocabularyName":{ + "shape":"VocabularyName", + "documentation":"The name of the custom vocabulary that you specified in your Call Analytics request.
Length Constraints: Minimum length of 1. Maximum length of 200.
" + }, + "VocabularyFilterName":{ + "shape":"VocabularyFilterName", + "documentation":"The name of the custom vocabulary filter that you specified in your Call Analytics request.
Length Constraints: Minimum length of 1. Maximum length of 200.
" + }, + "VocabularyFilterMethod":{ + "shape":"VocabularyFilterMethod", + "documentation":"The vocabulary filtering method used in your Call Analytics transcription.
" + }, + "ShowSpeakerLabel":{ + "shape":"Boolean", + "documentation":"Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.
For more information, see Partitioning speakers (diarization) in the Amazon Transcribe Developer Guide.
" + }, + "EnablePartialResultsStabilization":{ + "shape":"Boolean", + "documentation":"Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.
" + }, + "PartialResultsStability":{ + "shape":"PartialResultsStability", + "documentation":"The level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization).
Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.
" + }, + "ContentIdentificationType":{ + "shape":"ContentType", + "documentation":"Labels all personally identifiable information (PII) identified in your transcript.
Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment.
You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.
For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.
" + }, + "ContentRedactionType":{ + "shape":"ContentType", + "documentation":"Redacts all personally identifiable information (PII) identified in your transcript.
Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.
You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.
For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.
" + }, + "PiiEntityTypes":{ + "shape":"PiiEntityTypes", + "documentation":"The types of personally identifiable information (PII) to redact from a transcript. You can include as many types as you'd like, or you can select ALL.
To include PiiEntityTypes in your Call Analytics request, you must also include ContentIdentificationType or ContentRedactionType, but you can't include both.
Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.
If you leave this parameter empty, the default behavior is equivalent to ALL.
The name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.
The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
For more information, see Custom language models in the Amazon Transcribe Developer Guide.
" + }, + "FilterPartialResults":{ + "shape":"Boolean", + "documentation":"If true, TranscriptEvents with IsPartial: true are filtered out of the insights target.
Turns language identification on or off.
" + }, + "IdentifyMultipleLanguages":{ + "shape":"Boolean", + "documentation":"Turns language identification on or off for multiple languages.
" + }, + "LanguageOptions":{ + "shape":"LanguageOptions", + "documentation":"The language options for the transcription, such as automatic language detection.
" + }, + "PreferredLanguage":{ + "shape":"CallAnalyticsLanguageCode", + "documentation":"The preferred language for the transcription.
" + }, + "VocabularyNames":{ + "shape":"VocabularyNames", + "documentation":"The names of the custom vocabulary or vocabularies used during transcription.
" + }, + "VocabularyFilterNames":{ + "shape":"VocabularyFilterNames", + "documentation":"The names of the custom vocabulary filter or filters using during transcription.
" + } + }, + "documentation":"A structure that contains the configuration settings for an Amazon Transcribe processor.
Calls to this API must include a LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages parameter. If you include more than one of those parameters, your transcription job fails.
The configuration for the audio artifacts concatenation.
" + }, + "Video":{ + "shape":"VideoConcatenationConfiguration", + "documentation":"The configuration for the video artifacts concatenation.
" + }, + "Content":{ + "shape":"ContentConcatenationConfiguration", + "documentation":"The configuration for the content artifacts concatenation.
" + }, + "DataChannel":{ + "shape":"DataChannelConcatenationConfiguration", + "documentation":"The configuration for the data channel artifacts concatenation.
" + }, + "TranscriptionMessages":{ + "shape":"TranscriptionMessagesConcatenationConfiguration", + "documentation":"The configuration for the transcription messages artifacts concatenation.
" + }, + "MeetingEvents":{ + "shape":"MeetingEventsConcatenationConfiguration", + "documentation":"The configuration for the meeting events artifacts concatenation.
" + }, + "CompositedVideo":{ + "shape":"CompositedVideoConcatenationConfiguration", + "documentation":"The configuration for the composited video artifacts concatenation.
" + } + }, + "documentation":"The configuration for the artifacts concatenation.
" + }, + "ArtifactsConcatenationState":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "ArtifactsConfiguration":{ + "type":"structure", + "required":[ + "Audio", + "Video", + "Content" + ], + "members":{ + "Audio":{ + "shape":"AudioArtifactsConfiguration", + "documentation":"The configuration for the audio artifacts.
" + }, + "Video":{ + "shape":"VideoArtifactsConfiguration", + "documentation":"The configuration for the video artifacts.
" + }, + "Content":{ + "shape":"ContentArtifactsConfiguration", + "documentation":"The configuration for the content artifacts.
" + }, + "CompositedVideo":{ + "shape":"CompositedVideoArtifactsConfiguration", + "documentation":"Enables video compositing.
" + } + }, + "documentation":"The configuration for the artifacts.
" + }, + "ArtifactsState":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "AttendeeIdList":{ + "type":"list", + "member":{"shape":"GuidString"}, + "min":1 + }, + "AudioArtifactsConcatenationState":{ + "type":"string", + "enum":["Enabled"] + }, + "AudioArtifactsConfiguration":{ + "type":"structure", + "required":["MuxType"], + "members":{ + "MuxType":{ + "shape":"AudioMuxType", + "documentation":"The MUX type of the audio artifact configuration object.
" + } + }, + "documentation":"The audio artifact configuration object.
" + }, + "AudioChannelsOption":{ + "type":"string", + "enum":[ + "Stereo", + "Mono" + ] + }, + "AudioConcatenationConfiguration":{ + "type":"structure", + "required":["State"], + "members":{ + "State":{ + "shape":"AudioArtifactsConcatenationState", + "documentation":"Enables or disables the configuration object.
" + } + }, + "documentation":"The audio artifact concatenation configuration object.
" + }, + "AudioMuxType":{ + "type":"string", + "enum":[ + "AudioOnly", + "AudioWithActiveSpeakerVideo", + "AudioWithCompositedVideo" + ] + }, + "AudioSampleRateOption":{ + "type":"string", + "pattern":"44100|48000" + }, + "AwsRegion":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^([a-z]+-){2,}\\d+$" + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"The request ID associated with the call responsible for the exception.
" + } + }, + "documentation":"The input parameters don't match the service's restrictions.
", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Boolean":{"type":"boolean"}, + "BorderColor":{ + "type":"string", + "enum":[ + "Black", + "Blue", + "Red", + "Green", + "White", + "Yellow" + ] + }, + "BorderThickness":{ + "type":"integer", + "max":20, + "min":1 + }, + "CallAnalyticsLanguageCode":{ + "type":"string", + "enum":[ + "en-US", + "en-GB", + "es-US", + "fr-CA", + "fr-FR", + "en-AU", + "it-IT", + "de-DE", + "pt-BR" + ] + }, + "CanvasOrientation":{ + "type":"string", + "enum":[ + "Landscape", + "Portrait" + ] + }, + "CategoryName":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[0-9a-zA-Z._-]+" + }, + "CategoryNameList":{ + "type":"list", + "member":{"shape":"CategoryName"}, + "max":20, + "min":1 + }, + "ChannelDefinition":{ + "type":"structure", + "required":["ChannelId"], + "members":{ + "ChannelId":{ + "shape":"ChannelId", + "documentation":"The channel ID.
" + }, + "ParticipantRole":{ + "shape":"ParticipantRole", + "documentation":"Specifies whether the audio in a channel belongs to the AGENT or CUSTOMER.
Defines an audio channel in a Kinesis video stream.
" + }, + "ChannelDefinitions":{ + "type":"list", + "member":{"shape":"ChannelDefinition"}, + "max":2, + "min":1 + }, + "ChannelId":{ + "type":"integer", + "max":1, + "min":0 + }, + "ChimeSdkMeetingConcatenationConfiguration":{ + "type":"structure", + "required":["ArtifactsConfiguration"], + "members":{ + "ArtifactsConfiguration":{ + "shape":"ArtifactsConcatenationConfiguration", + "documentation":"The configuration for the artifacts in an Amazon Chime SDK meeting concatenation.
" + } + }, + "documentation":"The configuration object of the Amazon Chime SDK meeting concatenation for a specified media pipeline.
" + }, + "ChimeSdkMeetingConfiguration":{ + "type":"structure", + "members":{ + "SourceConfiguration":{ + "shape":"SourceConfiguration", + "documentation":"The source configuration for a specified media pipeline.
" + }, + "ArtifactsConfiguration":{ + "shape":"ArtifactsConfiguration", + "documentation":"The configuration for the artifacts in an Amazon Chime SDK meeting.
" + } + }, + "documentation":"The configuration object of the Amazon Chime SDK meeting for a specified media pipeline. SourceType must be ChimeSdkMeeting.
The configuration object's Chime SDK meeting ARN.
" + }, + "MuxType":{ + "shape":"LiveConnectorMuxType", + "documentation":"The configuration object's multiplex type.
" + }, + "CompositedVideo":{ + "shape":"CompositedVideoArtifactsConfiguration", + "documentation":"The media pipeline's composited video.
" + }, + "SourceConfiguration":{ + "shape":"SourceConfiguration", + "documentation":"The source configuration settings of the media pipeline's configuration object.
" + } + }, + "documentation":"The media pipeline's configuration object.
" + }, + "ClientRequestToken":{ + "type":"string", + "max":64, + "min":2, + "pattern":"[-_a-zA-Z0-9]*", + "sensitive":true + }, + "CompositedVideoArtifactsConfiguration":{ + "type":"structure", + "required":["GridViewConfiguration"], + "members":{ + "Layout":{ + "shape":"LayoutOption", + "documentation":"The layout setting, such as GridView in the configuration object.
The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.
" + }, + "GridViewConfiguration":{ + "shape":"GridViewConfiguration", + "documentation":"The GridView configuration setting.
Specifies the configuration for compositing video artifacts.
" + }, + "CompositedVideoConcatenationConfiguration":{ + "type":"structure", + "required":["State"], + "members":{ + "State":{ + "shape":"ArtifactsConcatenationState", + "documentation":"Enables or disables the configuration object.
" + } + }, + "documentation":"The composited video configuration object for a specified media pipeline. SourceType must be ChimeSdkMeeting.
The type of data sink in the configuration object.
" + }, + "S3BucketSinkConfiguration":{ + "shape":"S3BucketSinkConfiguration", + "documentation":"The configuration settings for an Amazon S3 bucket sink.
" + } + }, + "documentation":"The data sink of the configuration object.
" + }, + "ConcatenationSinkList":{ + "type":"list", + "member":{"shape":"ConcatenationSink"}, + "max":1, + "min":1 + }, + "ConcatenationSinkType":{ + "type":"string", + "enum":["S3Bucket"] + }, + "ConcatenationSource":{ + "type":"structure", + "required":[ + "Type", + "MediaCapturePipelineSourceConfiguration" + ], + "members":{ + "Type":{ + "shape":"ConcatenationSourceType", + "documentation":"The type of concatenation source in a configuration object.
" + }, + "MediaCapturePipelineSourceConfiguration":{ + "shape":"MediaCapturePipelineSourceConfiguration", + "documentation":"The concatenation settings for the media pipeline in a configuration object.
" + } + }, + "documentation":"The source type and media pipeline configuration settings in a configuration object.
" + }, + "ConcatenationSourceList":{ + "type":"list", + "member":{"shape":"ConcatenationSource"}, + "max":1, + "min":1 + }, + "ConcatenationSourceType":{ + "type":"string", + "enum":["MediaCapturePipeline"] + }, + "ConflictException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"The request ID associated with the call responsible for the exception.
" + } + }, + "documentation":"The request could not be processed because of conflict in the current state of the resource.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ContentArtifactsConfiguration":{ + "type":"structure", + "required":["State"], + "members":{ + "State":{ + "shape":"ArtifactsState", + "documentation":"Indicates whether the content artifact is enabled or disabled.
" + }, + "MuxType":{ + "shape":"ContentMuxType", + "documentation":"The MUX type of the artifact configuration.
" + } + }, + "documentation":"The content artifact object.
" + }, + "ContentConcatenationConfiguration":{ + "type":"structure", + "required":["State"], + "members":{ + "State":{ + "shape":"ArtifactsConcatenationState", + "documentation":"Enables or disables the configuration object.
" + } + }, + "documentation":"The composited content configuration object for a specified media pipeline.
" + }, + "ContentMuxType":{ + "type":"string", + "enum":["ContentOnly"] + }, + "ContentRedactionOutput":{ + "type":"string", + "enum":[ + "redacted", + "redacted_and_unredacted" + ] + }, + "ContentShareLayoutOption":{ + "type":"string", + "enum":[ + "PresenterOnly", + "Horizontal", + "Vertical", + "ActiveSpeakerOnly" + ] + }, + "ContentType":{ + "type":"string", + "enum":["PII"] + }, + "CornerRadius":{ + "type":"integer", + "max":20, + "min":1 + }, + "CreateMediaCapturePipelineRequest":{ + "type":"structure", + "required":[ + "SourceType", + "SourceArn", + "SinkType", + "SinkArn" + ], + "members":{ + "SourceType":{ + "shape":"MediaPipelineSourceType", + "documentation":"Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.
" + }, + "SourceArn":{ + "shape":"Arn", + "documentation":"ARN of the source from which the media artifacts are captured.
" + }, + "SinkType":{ + "shape":"MediaPipelineSinkType", + "documentation":"Destination type to which the media artifacts are saved. You must use an S3 bucket.
" + }, + "SinkArn":{ + "shape":"Arn", + "documentation":"The ARN of the sink type.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.
", + "idempotencyToken":true + }, + "ChimeSdkMeetingConfiguration":{ + "shape":"ChimeSdkMeetingConfiguration", + "documentation":"The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.
The tag key-value pairs.
" + } + } + }, + "CreateMediaCapturePipelineResponse":{ + "type":"structure", + "members":{ + "MediaCapturePipeline":{ + "shape":"MediaCapturePipeline", + "documentation":"A media pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media pipeline object.
" + } + } + }, + "CreateMediaConcatenationPipelineRequest":{ + "type":"structure", + "required":[ + "Sources", + "Sinks" + ], + "members":{ + "Sources":{ + "shape":"ConcatenationSourceList", + "documentation":"An object that specifies the sources for the media concatenation pipeline.
" + }, + "Sinks":{ + "shape":"ConcatenationSinkList", + "documentation":"An object that specifies the data sinks for the media concatenation pipeline.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media concatenation pipeline request.
", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags associated with the media concatenation pipeline.
" + } + } + }, + "CreateMediaConcatenationPipelineResponse":{ + "type":"structure", + "members":{ + "MediaConcatenationPipeline":{ + "shape":"MediaConcatenationPipeline", + "documentation":"A media concatenation pipeline object, the ID, source type, MediaPipelineARN, and sink of a media concatenation pipeline object.
The name of the media insights pipeline configuration.
" + }, + "ResourceAccessRoleArn":{ + "shape":"Arn", + "documentation":"The ARN of the role used by the service to access Amazon Web Services resources, including Transcribe and Transcribe Call Analytics, on the caller’s behalf.
The configuration settings for the real-time alerts in a media insights pipeline configuration.
" + }, + "Elements":{ + "shape":"MediaInsightsPipelineConfigurationElements", + "documentation":"The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags assigned to the media insights pipeline configuration.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"The unique identifier for the media insights pipeline configuration request.
", + "idempotencyToken":true + } + } + }, + "CreateMediaInsightsPipelineConfigurationResponse":{ + "type":"structure", + "members":{ + "MediaInsightsPipelineConfiguration":{ + "shape":"MediaInsightsPipelineConfiguration", + "documentation":"The configuration settings for the media insights pipeline.
" + } + } + }, + "CreateMediaInsightsPipelineRequest":{ + "type":"structure", + "required":["MediaInsightsPipelineConfigurationArn"], + "members":{ + "MediaInsightsPipelineConfigurationArn":{ + "shape":"Arn", + "documentation":"The ARN of the pipeline's configuration.
" + }, + "KinesisVideoStreamSourceRuntimeConfiguration":{ + "shape":"KinesisVideoStreamSourceRuntimeConfiguration", + "documentation":"The runtime configuration for the Kinesis video stream source of the media insights pipeline.
" + }, + "MediaInsightsRuntimeMetadata":{ + "shape":"MediaInsightsRuntimeMetadata", + "documentation":"The runtime metadata for the media insights pipeline. Consists of a key-value map of strings.
" + }, + "KinesisVideoStreamRecordingSourceRuntimeConfiguration":{ + "shape":"KinesisVideoStreamRecordingSourceRuntimeConfiguration", + "documentation":"The runtime configuration for the Kinesis video recording stream source.
" + }, + "S3RecordingSinkRuntimeConfiguration":{ + "shape":"S3RecordingSinkRuntimeConfiguration", + "documentation":"The runtime configuration for the S3 recording sink. If specified, the settings in this structure override any settings in S3RecordingSinkConfiguration.
The tags assigned to the media insights pipeline.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"The unique identifier for the media insights pipeline request.
", + "idempotencyToken":true + } + } + }, + "CreateMediaInsightsPipelineResponse":{ + "type":"structure", + "required":["MediaInsightsPipeline"], + "members":{ + "MediaInsightsPipeline":{ + "shape":"MediaInsightsPipeline", + "documentation":"The media insights pipeline object.
" + } + } + }, + "CreateMediaLiveConnectorPipelineRequest":{ + "type":"structure", + "required":[ + "Sources", + "Sinks" + ], + "members":{ + "Sources":{ + "shape":"LiveConnectorSourceList", + "documentation":"The media live connector pipeline's data sources.
" + }, + "Sinks":{ + "shape":"LiveConnectorSinkList", + "documentation":"The media live connector pipeline's data sinks.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"The token assigned to the client making the request.
", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags associated with the media live connector pipeline.
" + } + } + }, + "CreateMediaLiveConnectorPipelineResponse":{ + "type":"structure", + "members":{ + "MediaLiveConnectorPipeline":{ + "shape":"MediaLiveConnectorPipeline", + "documentation":"The new media live connector pipeline.
" + } + } + }, + "CreateMediaPipelineKinesisVideoStreamPoolRequest":{ + "type":"structure", + "required":[ + "StreamConfiguration", + "PoolName" + ], + "members":{ + "StreamConfiguration":{ + "shape":"KinesisVideoStreamConfiguration", + "documentation":"The configuration settings for the stream.
" + }, + "PoolName":{ + "shape":"KinesisVideoStreamPoolName", + "documentation":"The name of the pool.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"The token assigned to the client making the request.
", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags assigned to the stream pool.
" + } + } + }, + "CreateMediaPipelineKinesisVideoStreamPoolResponse":{ + "type":"structure", + "members":{ + "KinesisVideoStreamPoolConfiguration":{ + "shape":"KinesisVideoStreamPoolConfiguration", + "documentation":"The configuration for applying the streams to the pool.
The data sources for the media pipeline.
" + }, + "Sinks":{ + "shape":"MediaStreamSinkList", + "documentation":"The data sink for the media pipeline.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"The token assigned to the client making the request.
", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags assigned to the media pipeline.
" + } + } + }, + "CreateMediaStreamPipelineResponse":{ + "type":"structure", + "members":{ + "MediaStreamPipeline":{ + "shape":"MediaStreamPipeline", + "documentation":"The requested media pipeline.
" + } + } + }, + "DataChannelConcatenationConfiguration":{ + "type":"structure", + "required":["State"], + "members":{ + "State":{ + "shape":"ArtifactsConcatenationState", + "documentation":"Enables or disables the configuration object.
" + } + }, + "documentation":"The content configuration object's data channel.
" + }, + "DataRetentionChangeInHours":{ + "type":"integer", + "min":1 + }, + "DataRetentionInHours":{ + "type":"integer", + "min":0 + }, + "DeleteMediaCapturePipelineRequest":{ + "type":"structure", + "required":["MediaPipelineId"], + "members":{ + "MediaPipelineId":{ + "shape":"GuidString", + "documentation":"The ID of the media pipeline being deleted.
", + "location":"uri", + "locationName":"mediaPipelineId" + } + } + }, + "DeleteMediaInsightsPipelineConfigurationRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"NonEmptyString", + "documentation":"The unique identifier of the resource to be deleted. Valid values include the name and ARN of the media insights pipeline configuration.
", + "location":"uri", + "locationName":"identifier" + } + } + }, + "DeleteMediaPipelineKinesisVideoStreamPoolRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"NonEmptyString", + "documentation":"The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.
", + "location":"uri", + "locationName":"identifier" + } + } + }, + "DeleteMediaPipelineRequest":{ + "type":"structure", + "required":["MediaPipelineId"], + "members":{ + "MediaPipelineId":{ + "shape":"GuidString", + "documentation":"The ID of the media pipeline to delete.
", + "location":"uri", + "locationName":"mediaPipelineId" + } + } + }, + "ErrorCode":{ + "type":"string", + "enum":[ + "BadRequest", + "Forbidden", + "NotFound", + "ResourceLimitExceeded", + "ServiceFailure", + "ServiceUnavailable", + "Throttling" + ] + }, + "ExternalUserIdList":{ + "type":"list", + "member":{"shape":"ExternalUserIdType"}, + "min":1 + }, + "ExternalUserIdType":{ + "type":"string", + "max":64, + "min":2, + "sensitive":true + }, + "ForbiddenException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"The request id associated with the call responsible for the exception.
" + } + }, + "documentation":"The client is permanently forbidden from making the request.
", + "error":{"httpStatusCode":403}, + "exception":true + }, + "FragmentNumberString":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[0-9]+$" + }, + "FragmentSelector":{ + "type":"structure", + "required":[ + "FragmentSelectorType", + "TimestampRange" + ], + "members":{ + "FragmentSelectorType":{ + "shape":"FragmentSelectorType", + "documentation":"The origin of the timestamps to use, Server or Producer. For more information, see StartSelectorType in the Amazon Kinesis Video Streams Developer Guide.
The range of timestamps to return.
" + } + }, + "documentation":"Describes the timestamp range and timestamp origin of a range of fragments.
Only fragments with a start timestamp greater than or equal to the given start time and less than or equal to the end time are returned. For example, say a stream contains fragments with the following start timestamps:
00:00:00
00:00:02
00:00:04
00:00:06
A fragment selector range with a start time of 00:00:01 and end time of 00:00:04 would return the fragments with start times of 00:00:02 and 00:00:04.
" + }, + "FragmentSelectorType":{ + "type":"string", + "enum":[ + "ProducerTimestamp", + "ServerTimestamp" + ] + }, + "GetMediaCapturePipelineRequest":{ + "type":"structure", + "required":["MediaPipelineId"], + "members":{ + "MediaPipelineId":{ + "shape":"GuidString", + "documentation":"The ID of the pipeline that you want to get.
", + "location":"uri", + "locationName":"mediaPipelineId" + } + } + }, + "GetMediaCapturePipelineResponse":{ + "type":"structure", + "members":{ + "MediaCapturePipeline":{ + "shape":"MediaCapturePipeline", + "documentation":"The media pipeline object.
" + } + } + }, + "GetMediaInsightsPipelineConfigurationRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"NonEmptyString", + "documentation":"The unique identifier of the requested resource. Valid values include the name and ARN of the media insights pipeline configuration.
", + "location":"uri", + "locationName":"identifier" + } + } + }, + "GetMediaInsightsPipelineConfigurationResponse":{ + "type":"structure", + "members":{ + "MediaInsightsPipelineConfiguration":{ + "shape":"MediaInsightsPipelineConfiguration", + "documentation":"The requested media insights pipeline configuration.
" + } + } + }, + "GetMediaPipelineKinesisVideoStreamPoolRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"NonEmptyString", + "documentation":"The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.
", + "location":"uri", + "locationName":"identifier" + } + } + }, + "GetMediaPipelineKinesisVideoStreamPoolResponse":{ + "type":"structure", + "members":{ + "KinesisVideoStreamPoolConfiguration":{ + "shape":"KinesisVideoStreamPoolConfiguration", + "documentation":"The video stream pool configuration object.
" + } + } + }, + "GetMediaPipelineRequest":{ + "type":"structure", + "required":["MediaPipelineId"], + "members":{ + "MediaPipelineId":{ + "shape":"GuidString", + "documentation":"The ID of the pipeline that you want to get.
", + "location":"uri", + "locationName":"mediaPipelineId" + } + } + }, + "GetMediaPipelineResponse":{ + "type":"structure", + "members":{ + "MediaPipeline":{ + "shape":"MediaPipeline", + "documentation":"The media pipeline object.
" + } + } + }, + "GetSpeakerSearchTaskRequest":{ + "type":"structure", + "required":[ + "Identifier", + "SpeakerSearchTaskId" + ], + "members":{ + "Identifier":{ + "shape":"NonEmptyString", + "documentation":"The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
", + "location":"uri", + "locationName":"identifier" + }, + "SpeakerSearchTaskId":{ + "shape":"GuidString", + "documentation":"The ID of the speaker search task.
", + "location":"uri", + "locationName":"speakerSearchTaskId" + } + } + }, + "GetSpeakerSearchTaskResponse":{ + "type":"structure", + "members":{ + "SpeakerSearchTask":{ + "shape":"SpeakerSearchTask", + "documentation":"The details of the speaker search task.
" + } + } + }, + "GetVoiceToneAnalysisTaskRequest":{ + "type":"structure", + "required":[ + "Identifier", + "VoiceToneAnalysisTaskId" + ], + "members":{ + "Identifier":{ + "shape":"NonEmptyString", + "documentation":"The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
", + "location":"uri", + "locationName":"identifier" + }, + "VoiceToneAnalysisTaskId":{ + "shape":"GuidString", + "documentation":"The ID of the voice tone analysis task.
", + "location":"uri", + "locationName":"voiceToneAnalysisTaskId" + } + } + }, + "GetVoiceToneAnalysisTaskResponse":{ + "type":"structure", + "members":{ + "VoiceToneAnalysisTask":{ + "shape":"VoiceToneAnalysisTask", + "documentation":"The details of the voice tone analysis task.
" + } + } + }, + "GridViewConfiguration":{ + "type":"structure", + "required":["ContentShareLayout"], + "members":{ + "ContentShareLayout":{ + "shape":"ContentShareLayoutOption", + "documentation":"Defines the layout of the video tiles when content sharing is enabled.
" + }, + "PresenterOnlyConfiguration":{ + "shape":"PresenterOnlyConfiguration", + "documentation":"Defines the configuration options for a presenter only video tile.
" + }, + "ActiveSpeakerOnlyConfiguration":{ + "shape":"ActiveSpeakerOnlyConfiguration", + "documentation":"The configuration settings for an ActiveSpeakerOnly video tile.
The configuration settings for a horizontal layout.
" + }, + "VerticalLayoutConfiguration":{ + "shape":"VerticalLayoutConfiguration", + "documentation":"The configuration settings for a vertical layout.
" + }, + "VideoAttribute":{ + "shape":"VideoAttribute", + "documentation":"The attribute settings for the video tiles.
" + }, + "CanvasOrientation":{ + "shape":"CanvasOrientation", + "documentation":"The orientation setting, horizontal or vertical.
" + } + }, + "documentation":"Specifies the type of grid layout.
" + }, + "GuidString":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}" + }, + "HighlightColor":{ + "type":"string", + "enum":[ + "Black", + "Blue", + "Red", + "Green", + "White", + "Yellow" + ] + }, + "HorizontalLayoutConfiguration":{ + "type":"structure", + "members":{ + "TileOrder":{ + "shape":"TileOrder", + "documentation":"Sets the automatic ordering of the video tiles.
" + }, + "TilePosition":{ + "shape":"HorizontalTilePosition", + "documentation":"Sets the position of horizontal tiles.
" + }, + "TileCount":{ + "shape":"TileCount", + "documentation":"The maximum number of video tiles to display.
" + }, + "TileAspectRatio":{ + "shape":"TileAspectRatio", + "documentation":"Specifies the aspect ratio of all video tiles.
" + } + }, + "documentation":"Defines the configuration settings for the horizontal layout.
" + }, + "HorizontalTilePosition":{ + "type":"string", + "enum":[ + "Top", + "Bottom" + ] + }, + "Iso8601Timestamp":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "IssueDetectionConfiguration":{ + "type":"structure", + "required":["RuleName"], + "members":{ + "RuleName":{ + "shape":"RuleName", + "documentation":"The name of the issue detection rule.
" + } + }, + "documentation":"A structure that contains the configuration settings for an issue detection task.
" + }, + "Keyword":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[\\s0-9a-zA-Z'-]+" + }, + "KeywordMatchConfiguration":{ + "type":"structure", + "required":[ + "RuleName", + "Keywords" + ], + "members":{ + "RuleName":{ + "shape":"RuleName", + "documentation":"The name of the keyword match rule.
" + }, + "Keywords":{ + "shape":"KeywordMatchWordList", + "documentation":"The keywords or phrases that you want to match.
" + }, + "Negate":{ + "shape":"Boolean", + "documentation":"Matches keywords or phrases on their presence or absence. If set to TRUE, the rule matches when all the specified keywords or phrases are absent. Default: FALSE.
A structure that contains the settings for a keyword match task.
" + }, + "KeywordMatchWordList":{ + "type":"list", + "member":{"shape":"Keyword"}, + "max":10, + "min":1 + }, + "KinesisDataStreamSinkConfiguration":{ + "type":"structure", + "members":{ + "InsightsTarget":{ + "shape":"Arn", + "documentation":"The ARN of the sink.
" + } + }, + "documentation":"A structure that contains the configuration settings for a Kinesis Data Stream sink.
" + }, + "KinesisVideoStreamArn":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"arn:[a-z\\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+" + }, + "KinesisVideoStreamConfiguration":{ + "type":"structure", + "required":["Region"], + "members":{ + "Region":{ + "shape":"AwsRegion", + "documentation":"The Amazon Web Services Region of the video stream.
" + }, + "DataRetentionInHours":{ + "shape":"DataRetentionInHours", + "documentation":"The amount of time that data is retained.
" + } + }, + "documentation":"The configuration of an Kinesis video stream.
If a meeting uses an opt-in Region as its MediaRegion, the KVS stream must be in that same Region. For example, if a meeting uses the af-south-1 Region, the KVS stream must also be in af-south-1. However, if the meeting uses a Region that AWS turns on by default, the KVS stream can be in any available Region, including an opt-in Region. For example, if the meeting uses ca-central-1, the KVS stream can be in eu-west-2, us-east-1, af-south-1, or any other Region that the Amazon Chime SDK supports.
To learn which AWS Region a meeting uses, call the GetMeeting API and use the MediaRegion parameter from the response.
For more information about opt-in Regions, refer to Available Regions in the Amazon Chime SDK Developer Guide, and Specify which AWS Regions your account can use, in the AWS Account Management Reference Guide.
The updated time that data is retained.
" + } + }, + "documentation":"The updated Kinesis video stream configuration object.
" + }, + "KinesisVideoStreamPoolConfiguration":{ + "type":"structure", + "members":{ + "PoolArn":{ + "shape":"Arn", + "documentation":"The ARN of the video stream pool configuration.
" + }, + "PoolName":{ + "shape":"KinesisVideoStreamPoolName", + "documentation":"The name of the video stream pool configuration.
" + }, + "PoolId":{ + "shape":"KinesisVideoStreamPoolId", + "documentation":"The ID of the video stream pool in the configuration.
" + }, + "PoolStatus":{ + "shape":"KinesisVideoStreamPoolStatus", + "documentation":"The status of the video stream pool in the configuration.
" + }, + "PoolSize":{ + "shape":"KinesisVideoStreamPoolSize", + "documentation":"The size of the video stream pool in the configuration.
" + }, + "StreamConfiguration":{ + "shape":"KinesisVideoStreamConfiguration", + "documentation":"The Kinesis video stream pool configuration object.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the configuration was created.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the configuration was updated.
" + } + }, + "documentation":"The video stream pool configuration object.
" + }, + "KinesisVideoStreamPoolId":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[0-9a-zA-Z._-]+" + }, + "KinesisVideoStreamPoolName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[0-9a-zA-Z._-]+" + }, + "KinesisVideoStreamPoolSize":{ + "type":"integer", + "min":0 + }, + "KinesisVideoStreamPoolStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "UPDATING", + "DELETING", + "FAILED" + ] + }, + "KinesisVideoStreamPoolSummary":{ + "type":"structure", + "members":{ + "PoolName":{ + "shape":"KinesisVideoStreamPoolName", + "documentation":"The name of the video stream pool.
" + }, + "PoolId":{ + "shape":"KinesisVideoStreamPoolId", + "documentation":"The ID of the video stream pool.
" + }, + "PoolArn":{ + "shape":"Arn", + "documentation":"The ARN of the video stream pool.
" + } + }, + "documentation":"A summary of the Kinesis video stream pool.
" + }, + "KinesisVideoStreamPoolSummaryList":{ + "type":"list", + "member":{"shape":"KinesisVideoStreamPoolSummary"} + }, + "KinesisVideoStreamRecordingSourceRuntimeConfiguration":{ + "type":"structure", + "required":[ + "Streams", + "FragmentSelector" + ], + "members":{ + "Streams":{ + "shape":"RecordingStreamList", + "documentation":"The stream or streams to be recorded.
" + }, + "FragmentSelector":{ + "shape":"FragmentSelector", + "documentation":"Describes the timestamp range and timestamp origin of a range of fragments in the Kinesis video stream.
" + } + }, + "documentation":"A structure that contains the runtime settings for recording a Kinesis video stream.
" + }, + "KinesisVideoStreamSourceRuntimeConfiguration":{ + "type":"structure", + "required":[ + "Streams", + "MediaEncoding", + "MediaSampleRate" + ], + "members":{ + "Streams":{ + "shape":"Streams", + "documentation":"The streams in the source runtime configuration of a Kinesis video stream.
" + }, + "MediaEncoding":{ + "shape":"MediaEncoding", + "documentation":"Specifies the encoding of your input audio. Supported format: PCM (only signed 16-bit little-endian audio formats, which does not include WAV)
For more information, see Media formats in the Amazon Transcribe Developer Guide.
" + }, + "MediaSampleRate":{ + "shape":"MediaSampleRateHertz", + "documentation":"The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.
Valid Range: Minimum value of 8000. Maximum value of 48000.
" + } + }, + "documentation":"The runtime configuration settings for the Kinesis video stream source.
" + }, + "KinesisVideoStreamSourceTaskConfiguration":{ + "type":"structure", + "required":[ + "StreamArn", + "ChannelId" + ], + "members":{ + "StreamArn":{ + "shape":"KinesisVideoStreamArn", + "documentation":"The ARN of the stream.
" + }, + "ChannelId":{ + "shape":"ChannelId", + "documentation":"The channel ID.
" + }, + "FragmentNumber":{ + "shape":"FragmentNumberString", + "documentation":"The unique identifier of the fragment to begin processing.
" + } + }, + "documentation":"The task configuration settings for the Kinesis video stream source.
" + }, + "LambdaFunctionSinkConfiguration":{ + "type":"structure", + "members":{ + "InsightsTarget":{ + "shape":"Arn", + "documentation":"The ARN of the sink.
" + } + }, + "documentation":"A structure that contains the configuration settings for an AWS Lambda function's data sink.
" + }, + "LanguageOptions":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[a-zA-Z-,]+" + }, + "LayoutOption":{ + "type":"string", + "enum":["GridView"] + }, + "ListMediaCapturePipelinesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"The token used to retrieve the next page of results.
", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"The maximum number of results to return in a single call. Valid Range: 1 - 99.
", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListMediaCapturePipelinesResponse":{ + "type":"structure", + "members":{ + "MediaCapturePipelines":{ + "shape":"MediaCapturePipelineSummaryList", + "documentation":"The media pipeline objects in the list.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token used to retrieve the next page of results.
" + } + } + }, + "ListMediaInsightsPipelineConfigurationsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"The token used to return the next page of results.
", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"The maximum number of results to return in a single call.
", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListMediaInsightsPipelineConfigurationsResponse":{ + "type":"structure", + "members":{ + "MediaInsightsPipelineConfigurations":{ + "shape":"MediaInsightsPipelineConfigurationSummaryList", + "documentation":"The requested list of media insights pipeline configurations.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token used to return the next page of results.
" + } + } + }, + "ListMediaPipelineKinesisVideoStreamPoolsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"The token used to return the next page of results.
", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"The maximum number of results to return in a single call.
", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListMediaPipelineKinesisVideoStreamPoolsResponse":{ + "type":"structure", + "members":{ + "KinesisVideoStreamPools":{ + "shape":"KinesisVideoStreamPoolSummaryList", + "documentation":"The list of video stream pools.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token used to return the next page of results.
" + } + } + }, + "ListMediaPipelinesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"The token used to retrieve the next page of results.
", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"The maximum number of results to return in a single call. Valid Range: 1 - 99.
", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListMediaPipelinesResponse":{ + "type":"structure", + "members":{ + "MediaPipelines":{ + "shape":"MediaPipelineList", + "documentation":"The media pipeline objects in the list.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token used to retrieve the next page of results.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's region, resource ID, and pipeline ID.
", + "location":"querystring", + "locationName":"arn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"The tags associated with the specified media pipeline.
" + } + } + }, + "LiveConnectorMuxType":{ + "type":"string", + "enum":[ + "AudioWithCompositedVideo", + "AudioWithActiveSpeakerVideo" + ] + }, + "LiveConnectorRTMPConfiguration":{ + "type":"structure", + "required":["Url"], + "members":{ + "Url":{ + "shape":"SensitiveString", + "documentation":"The URL of the RTMP configuration.
" + }, + "AudioChannels":{ + "shape":"AudioChannelsOption", + "documentation":"The audio channels set for the RTMP configuration
" + }, + "AudioSampleRate":{ + "shape":"AudioSampleRateOption", + "documentation":"The audio sample rate set for the RTMP configuration. Default: 48000.
" + } + }, + "documentation":"The media pipeline's RTMP configuration object.
" + }, + "LiveConnectorSinkConfiguration":{ + "type":"structure", + "required":[ + "SinkType", + "RTMPConfiguration" + ], + "members":{ + "SinkType":{ + "shape":"LiveConnectorSinkType", + "documentation":"The sink configuration's sink type.
" + }, + "RTMPConfiguration":{ + "shape":"LiveConnectorRTMPConfiguration", + "documentation":"The sink configuration's RTMP configuration settings.
" + } + }, + "documentation":"The media pipeline's sink configuration settings.
" + }, + "LiveConnectorSinkList":{ + "type":"list", + "member":{"shape":"LiveConnectorSinkConfiguration"}, + "max":1, + "min":1 + }, + "LiveConnectorSinkType":{ + "type":"string", + "enum":["RTMP"] + }, + "LiveConnectorSourceConfiguration":{ + "type":"structure", + "required":[ + "SourceType", + "ChimeSdkMeetingLiveConnectorConfiguration" + ], + "members":{ + "SourceType":{ + "shape":"LiveConnectorSourceType", + "documentation":"The source configuration's media source type.
" + }, + "ChimeSdkMeetingLiveConnectorConfiguration":{ + "shape":"ChimeSdkMeetingLiveConnectorConfiguration", + "documentation":"The configuration settings of the connector pipeline.
" + } + }, + "documentation":"The data source configuration object of a streaming media pipeline.
" + }, + "LiveConnectorSourceList":{ + "type":"list", + "member":{"shape":"LiveConnectorSourceConfiguration"}, + "max":1, + "min":1 + }, + "LiveConnectorSourceType":{ + "type":"string", + "enum":["ChimeSdkMeeting"] + }, + "MediaCapturePipeline":{ + "type":"structure", + "members":{ + "MediaPipelineId":{ + "shape":"GuidString", + "documentation":"The ID of a media pipeline.
" + }, + "MediaPipelineArn":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the media capture pipeline
" + }, + "SourceType":{ + "shape":"MediaPipelineSourceType", + "documentation":"Source type from which media artifacts are saved. You must use ChimeMeeting.
ARN of the source from which the media artifacts are saved.
" + }, + "Status":{ + "shape":"MediaPipelineStatus", + "documentation":"The status of the media pipeline.
" + }, + "SinkType":{ + "shape":"MediaPipelineSinkType", + "documentation":"Destination type to which the media artifacts are saved. You must use an S3 Bucket.
" + }, + "SinkArn":{ + "shape":"Arn", + "documentation":"ARN of the destination to which the media artifacts are saved.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the pipeline was created, in ISO 8601 format.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the pipeline was updated, in ISO 8601 format.
" + }, + "ChimeSdkMeetingConfiguration":{ + "shape":"ChimeSdkMeetingConfiguration", + "documentation":"The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.
A media pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.
" + }, + "MediaCapturePipelineSourceConfiguration":{ + "type":"structure", + "required":[ + "MediaPipelineArn", + "ChimeSdkMeetingConfiguration" + ], + "members":{ + "MediaPipelineArn":{ + "shape":"Arn", + "documentation":"The media pipeline ARN in the configuration object of a media capture pipeline.
" + }, + "ChimeSdkMeetingConfiguration":{ + "shape":"ChimeSdkMeetingConcatenationConfiguration", + "documentation":"The meeting configuration settings in a media capture pipeline configuration object.
" + } + }, + "documentation":"The source configuration object of a media capture pipeline.
" + }, + "MediaCapturePipelineSummary":{ + "type":"structure", + "members":{ + "MediaPipelineId":{ + "shape":"GuidString", + "documentation":"The ID of the media pipeline in the summary.
" + }, + "MediaPipelineArn":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the media pipeline in the summary.
" + } + }, + "documentation":"The summary data of a media capture pipeline.
" + }, + "MediaCapturePipelineSummaryList":{ + "type":"list", + "member":{"shape":"MediaCapturePipelineSummary"} + }, + "MediaConcatenationPipeline":{ + "type":"structure", + "members":{ + "MediaPipelineId":{ + "shape":"GuidString", + "documentation":"The ID of the media pipeline being concatenated.
" + }, + "MediaPipelineArn":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the media pipeline that you specify in the SourceConfiguration object.
The data sources being concatenated.
" + }, + "Sinks":{ + "shape":"ConcatenationSinkList", + "documentation":"The data sinks of the concatenation pipeline.
" + }, + "Status":{ + "shape":"MediaPipelineStatus", + "documentation":"The status of the concatenation pipeline.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the concatenation pipeline was created.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the concatenation pipeline was last updated.
" + } + }, + "documentation":"Concatenates audio and video data from one or more data streams.
" + }, + "MediaEncoding":{ + "type":"string", + "enum":["pcm"] + }, + "MediaInsightsPipeline":{ + "type":"structure", + "members":{ + "MediaPipelineId":{ + "shape":"GuidString", + "documentation":"The ID of a media insights pipeline.
" + }, + "MediaPipelineArn":{ + "shape":"Arn", + "documentation":"The ARN of a media insights pipeline.
" + }, + "MediaInsightsPipelineConfigurationArn":{ + "shape":"Arn", + "documentation":"The ARN of a media insight pipeline's configuration settings.
" + }, + "Status":{ + "shape":"MediaPipelineStatus", + "documentation":"The status of a media insights pipeline.
" + }, + "KinesisVideoStreamSourceRuntimeConfiguration":{ + "shape":"KinesisVideoStreamSourceRuntimeConfiguration", + "documentation":"The configuration settings for a Kinesis runtime video stream in a media insights pipeline.
" + }, + "MediaInsightsRuntimeMetadata":{ + "shape":"MediaInsightsRuntimeMetadata", + "documentation":"The runtime metadata of a media insights pipeline.
" + }, + "KinesisVideoStreamRecordingSourceRuntimeConfiguration":{ + "shape":"KinesisVideoStreamRecordingSourceRuntimeConfiguration", + "documentation":"The runtime configuration settings for a Kinesis recording video stream in a media insights pipeline.
" + }, + "S3RecordingSinkRuntimeConfiguration":{ + "shape":"S3RecordingSinkRuntimeConfiguration", + "documentation":"The runtime configuration of the Amazon S3 bucket that stores recordings in a media insights pipeline.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the media insights pipeline was created.
" + }, + "ElementStatuses":{ + "shape":"MediaInsightsPipelineElementStatuses", + "documentation":"The statuses that the elements in a media insights pipeline can have during data processing.
" + } + }, + "documentation":"A media pipeline that streams call analytics data.
" + }, + "MediaInsightsPipelineConfiguration":{ + "type":"structure", + "members":{ + "MediaInsightsPipelineConfigurationName":{ + "shape":"MediaInsightsPipelineConfigurationNameString", + "documentation":"The name of the configuration.
" + }, + "MediaInsightsPipelineConfigurationArn":{ + "shape":"Arn", + "documentation":"The ARN of the configuration.
" + }, + "ResourceAccessRoleArn":{ + "shape":"Arn", + "documentation":"The ARN of the role used by the service to access Amazon Web Services resources.
" + }, + "RealTimeAlertConfiguration":{ + "shape":"RealTimeAlertConfiguration", + "documentation":"Lists the rules that trigger a real-time alert.
" + }, + "Elements":{ + "shape":"MediaInsightsPipelineConfigurationElements", + "documentation":"The elements in the configuration.
" + }, + "MediaInsightsPipelineConfigurationId":{ + "shape":"GuidString", + "documentation":"The ID of the configuration.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the configuration was created.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the configuration was last updated.
" + } + }, + "documentation":"A structure that contains the configuration settings for a media insights pipeline.
" + }, + "MediaInsightsPipelineConfigurationElement":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"MediaInsightsPipelineConfigurationElementType", + "documentation":"The element type.
" + }, + "AmazonTranscribeCallAnalyticsProcessorConfiguration":{ + "shape":"AmazonTranscribeCallAnalyticsProcessorConfiguration", + "documentation":"The analytics configuration settings for transcribing audio in a media insights pipeline configuration element.
" + }, + "AmazonTranscribeProcessorConfiguration":{ + "shape":"AmazonTranscribeProcessorConfiguration", + "documentation":"The transcription processor configuration settings in a media insights pipeline configuration element.
" + }, + "KinesisDataStreamSinkConfiguration":{ + "shape":"KinesisDataStreamSinkConfiguration", + "documentation":"The configuration settings for the Kinesis Data Stream Sink in a media insights pipeline configuration element.
" + }, + "S3RecordingSinkConfiguration":{ + "shape":"S3RecordingSinkConfiguration", + "documentation":"The configuration settings for the Amazon S3 recording bucket in a media insights pipeline configuration element.
" + }, + "VoiceAnalyticsProcessorConfiguration":{ + "shape":"VoiceAnalyticsProcessorConfiguration", + "documentation":"The voice analytics configuration settings in a media insights pipeline configuration element.
" + }, + "LambdaFunctionSinkConfiguration":{ + "shape":"LambdaFunctionSinkConfiguration", + "documentation":"The configuration settings for the Amazon Web Services Lambda sink in a media insights pipeline configuration element.
" + }, + "SqsQueueSinkConfiguration":{ + "shape":"SqsQueueSinkConfiguration", + "documentation":"The configuration settings for an SQS queue sink in a media insights pipeline configuration element.
" + }, + "SnsTopicSinkConfiguration":{ + "shape":"SnsTopicSinkConfiguration", + "documentation":"The configuration settings for an SNS topic sink in a media insights pipeline configuration element.
" + }, + "VoiceEnhancementSinkConfiguration":{ + "shape":"VoiceEnhancementSinkConfiguration", + "documentation":"The configuration settings for voice enhancement sink in a media insights pipeline configuration element.
" + } + }, + "documentation":"An element in a media insights pipeline configuration.
" + }, + "MediaInsightsPipelineConfigurationElementType":{ + "type":"string", + "enum":[ + "AmazonTranscribeCallAnalyticsProcessor", + "VoiceAnalyticsProcessor", + "AmazonTranscribeProcessor", + "KinesisDataStreamSink", + "LambdaFunctionSink", + "SqsQueueSink", + "SnsTopicSink", + "S3RecordingSink", + "VoiceEnhancementSink" + ] + }, + "MediaInsightsPipelineConfigurationElements":{ + "type":"list", + "member":{"shape":"MediaInsightsPipelineConfigurationElement"} + }, + "MediaInsightsPipelineConfigurationNameString":{ + "type":"string", + "max":64, + "min":2, + "pattern":"^[0-9a-zA-Z._-]+" + }, + "MediaInsightsPipelineConfigurationSummary":{ + "type":"structure", + "members":{ + "MediaInsightsPipelineConfigurationName":{ + "shape":"MediaInsightsPipelineConfigurationNameString", + "documentation":"The name of the media insights pipeline configuration.
" + }, + "MediaInsightsPipelineConfigurationId":{ + "shape":"GuidString", + "documentation":"The ID of the media insights pipeline configuration.
" + }, + "MediaInsightsPipelineConfigurationArn":{ + "shape":"Arn", + "documentation":"The ARN of the media insights pipeline configuration.
" + } + }, + "documentation":"A summary of the media insights pipeline configuration.
" + }, + "MediaInsightsPipelineConfigurationSummaryList":{ + "type":"list", + "member":{"shape":"MediaInsightsPipelineConfigurationSummary"} + }, + "MediaInsightsPipelineElementStatus":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"MediaInsightsPipelineConfigurationElementType", + "documentation":"The type of status.
" + }, + "Status":{ + "shape":"MediaPipelineElementStatus", + "documentation":"The element's status.
" + } + }, + "documentation":"The status of the pipeline element.
" + }, + "MediaInsightsPipelineElementStatuses":{ + "type":"list", + "member":{"shape":"MediaInsightsPipelineElementStatus"} + }, + "MediaInsightsRuntimeMetadata":{ + "type":"map", + "key":{"shape":"NonEmptyString"}, + "value":{"shape":"String"}, + "sensitive":true + }, + "MediaLiveConnectorPipeline":{ + "type":"structure", + "members":{ + "Sources":{ + "shape":"LiveConnectorSourceList", + "documentation":"The connector pipeline's data sources.
" + }, + "Sinks":{ + "shape":"LiveConnectorSinkList", + "documentation":"The connector pipeline's data sinks.
" + }, + "MediaPipelineId":{ + "shape":"GuidString", + "documentation":"The connector pipeline's ID.
" + }, + "MediaPipelineArn":{ + "shape":"AmazonResourceName", + "documentation":"The connector pipeline's ARN.
" + }, + "Status":{ + "shape":"MediaPipelineStatus", + "documentation":"The connector pipeline's status.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the connector pipeline was created.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the connector pipeline was last updated.
" + } + }, + "documentation":"The connector pipeline.
" + }, + "MediaPipeline":{ + "type":"structure", + "members":{ + "MediaCapturePipeline":{ + "shape":"MediaCapturePipeline", + "documentation":"A pipeline that enables users to capture audio and video.
" + }, + "MediaLiveConnectorPipeline":{ + "shape":"MediaLiveConnectorPipeline", + "documentation":"The connector pipeline of the media pipeline.
" + }, + "MediaConcatenationPipeline":{ + "shape":"MediaConcatenationPipeline", + "documentation":"The media concatenation pipeline in a media pipeline.
" + }, + "MediaInsightsPipeline":{ + "shape":"MediaInsightsPipeline", + "documentation":"The media insights pipeline of a media pipeline.
" + }, + "MediaStreamPipeline":{ + "shape":"MediaStreamPipeline", + "documentation":"Designates a media pipeline as a media stream pipeline.
" + } + }, + "documentation":"A pipeline consisting of a media capture, media concatenation, or live-streaming pipeline.
" + }, + "MediaPipelineElementStatus":{ + "type":"string", + "enum":[ + "NotStarted", + "NotSupported", + "Initializing", + "InProgress", + "Failed", + "Stopping", + "Stopped", + "Paused" + ] + }, + "MediaPipelineList":{ + "type":"list", + "member":{"shape":"MediaPipelineSummary"} + }, + "MediaPipelineSinkType":{ + "type":"string", + "enum":["S3Bucket"] + }, + "MediaPipelineSourceType":{ + "type":"string", + "enum":["ChimeSdkMeeting"] + }, + "MediaPipelineStatus":{ + "type":"string", + "enum":[ + "Initializing", + "InProgress", + "Failed", + "Stopping", + "Stopped", + "Paused", + "NotStarted" + ] + }, + "MediaPipelineStatusUpdate":{ + "type":"string", + "enum":[ + "Pause", + "Resume" + ] + }, + "MediaPipelineSummary":{ + "type":"structure", + "members":{ + "MediaPipelineId":{ + "shape":"GuidString", + "documentation":"The ID of the media pipeline in the summary.
" + }, + "MediaPipelineArn":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the media pipeline in the summary.
" + } + }, + "documentation":"The summary of the media pipeline.
" + }, + "MediaPipelineTaskStatus":{ + "type":"string", + "enum":[ + "NotStarted", + "Initializing", + "InProgress", + "Failed", + "Stopping", + "Stopped" + ] + }, + "MediaSampleRateHertz":{ + "type":"integer", + "max":48000, + "min":8000 + }, + "MediaStreamPipeline":{ + "type":"structure", + "members":{ + "MediaPipelineId":{ + "shape":"GuidString", + "documentation":"The ID of the media stream pipeline
" + }, + "MediaPipelineArn":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the media stream pipeline.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the media stream pipeline was created.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the media stream pipeline was updated.
" + }, + "Status":{ + "shape":"MediaPipelineStatus", + "documentation":"The status of the media stream pipeline.
" + }, + "Sources":{ + "shape":"MediaStreamSourceList", + "documentation":"The media stream pipeline's data sources.
" + }, + "Sinks":{ + "shape":"MediaStreamSinkList", + "documentation":"The media stream pipeline's data sinks.
" + } + }, + "documentation":"Structure that contains the settings for a media stream pipeline.
" + }, + "MediaStreamPipelineSinkType":{ + "type":"string", + "enum":["KinesisVideoStreamPool"] + }, + "MediaStreamSink":{ + "type":"structure", + "required":[ + "SinkArn", + "SinkType", + "ReservedStreamCapacity", + "MediaStreamType" + ], + "members":{ + "SinkArn":{ + "shape":"Arn", + "documentation":"The ARN of the Kinesis Video Stream pool returned by the CreateMediaPipelineKinesisVideoStreamPool API.
" + }, + "SinkType":{ + "shape":"MediaStreamPipelineSinkType", + "documentation":"The media stream sink's type.
" + }, + "ReservedStreamCapacity":{ + "shape":"ReservedStreamCapacity", + "documentation":"Specifies the number of streams that the sink can accept.
" + }, + "MediaStreamType":{ + "shape":"MediaStreamType", + "documentation":"The media stream sink's media stream type.
" + } + }, + "documentation":"Structure that contains the settings for a media stream sink.
" + }, + "MediaStreamSinkList":{ + "type":"list", + "member":{"shape":"MediaStreamSink"}, + "max":2, + "min":1 + }, + "MediaStreamSource":{ + "type":"structure", + "required":[ + "SourceType", + "SourceArn" + ], + "members":{ + "SourceType":{ + "shape":"MediaPipelineSourceType", + "documentation":"The type of media stream source.
" + }, + "SourceArn":{ + "shape":"Arn", + "documentation":"The ARN of the meeting.
" + } + }, + "documentation":"Structure that contains the settings for media stream sources.
" + }, + "MediaStreamSourceList":{ + "type":"list", + "member":{"shape":"MediaStreamSource"}, + "min":1 + }, + "MediaStreamType":{ + "type":"string", + "enum":[ + "MixedAudio", + "IndividualAudio" + ] + }, + "MeetingEventsConcatenationConfiguration":{ + "type":"structure", + "required":["State"], + "members":{ + "State":{ + "shape":"ArtifactsConcatenationState", + "documentation":"Enables or disables the configuration object.
" + } + }, + "documentation":"The configuration object for an event concatenation pipeline.
" + }, + "ModelName":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[0-9a-zA-Z._-]+" + }, + "NonEmptyString":{ + "type":"string", + "max":1024, + "pattern":".*\\S.*" + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"The request ID associated with the call responsible for the exception.
" + } + }, + "documentation":"One or more of the resources in the request does not exist in the system.
", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NumberOfChannels":{ + "type":"integer", + "max":2, + "min":1 + }, + "PartialResultsStability":{ + "type":"string", + "enum":[ + "high", + "medium", + "low" + ] + }, + "ParticipantRole":{ + "type":"string", + "enum":[ + "AGENT", + "CUSTOMER" + ] + }, + "PiiEntityTypes":{ + "type":"string", + "max":300, + "min":1, + "pattern":"^[A-Z_, ]+" + }, + "PostCallAnalyticsSettings":{ + "type":"structure", + "required":[ + "OutputLocation", + "DataAccessRoleArn" + ], + "members":{ + "OutputLocation":{ + "shape":"String", + "documentation":"The URL of the Amazon S3 bucket that contains the post-call data.
" + }, + "DataAccessRoleArn":{ + "shape":"String", + "documentation":"The ARN of the role used by Amazon Web Services Transcribe to upload your post call analysis. For more information, see Post-call analytics with real-time transcriptions in the Amazon Transcribe Developer Guide.
" + }, + "ContentRedactionOutput":{ + "shape":"ContentRedactionOutput", + "documentation":"The content redaction output settings for a post-call analysis task.
" + }, + "OutputEncryptionKMSKeyId":{ + "shape":"String", + "documentation":"The ID of the KMS (Key Management Service) key used to encrypt the output.
" + } + }, + "documentation":"Allows you to specify additional settings for your Call Analytics post-call request, including output locations for your redacted transcript, which IAM role to use, and which encryption key to use.
DataAccessRoleArn and OutputLocation are required fields.
PostCallAnalyticsSettings provides the same insights as a Call Analytics post-call transcription. For more information, refer to Post-call analytics with real-time transcriptions in the Amazon Transcribe Developer Guide.
Defines the position of the presenter video tile. Default: TopRight.
Defines the configuration for a presenter-only video tile.
" + }, + "PresenterPosition":{ + "type":"string", + "enum":[ + "TopLeft", + "TopRight", + "BottomLeft", + "BottomRight" + ] + }, + "RealTimeAlertConfiguration":{ + "type":"structure", + "members":{ + "Disabled":{ + "shape":"Boolean", + "documentation":"Turns off real-time alerts.
" + }, + "Rules":{ + "shape":"RealTimeAlertRuleList", + "documentation":"The rules in the alert. Rules specify the words or phrases that you want to be notified about.
" + } + }, + "documentation":"A structure that contains the configuration settings for real-time alerts.
" + }, + "RealTimeAlertRule":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"RealTimeAlertRuleType", + "documentation":"The type of alert rule.
" + }, + "KeywordMatchConfiguration":{ + "shape":"KeywordMatchConfiguration", + "documentation":"Specifies the settings for matching the keywords in a real-time alert rule.
" + }, + "SentimentConfiguration":{ + "shape":"SentimentConfiguration", + "documentation":"Specifies the settings for predicting sentiment in a real-time alert rule.
" + }, + "IssueDetectionConfiguration":{ + "shape":"IssueDetectionConfiguration", + "documentation":"Specifies the issue detection settings for a real-time alert rule.
" + } + }, + "documentation":"Specifies the words or phrases that trigger an alert.
" + }, + "RealTimeAlertRuleList":{ + "type":"list", + "member":{"shape":"RealTimeAlertRule"}, + "max":3, + "min":1 + }, + "RealTimeAlertRuleType":{ + "type":"string", + "enum":[ + "KeywordMatch", + "Sentiment", + "IssueDetection" + ] + }, + "RecordingFileFormat":{ + "type":"string", + "enum":[ + "Wav", + "Opus" + ] + }, + "RecordingStreamConfiguration":{ + "type":"structure", + "members":{ + "StreamArn":{ + "shape":"KinesisVideoStreamArn", + "documentation":"The ARN of the recording stream.
" + } + }, + "documentation":"A structure that holds the settings for recording media.
" + }, + "RecordingStreamList":{ + "type":"list", + "member":{"shape":"RecordingStreamConfiguration"}, + "max":2, + "min":1 + }, + "ReservedStreamCapacity":{ + "type":"integer", + "max":10, + "min":1 + }, + "ResolutionOption":{ + "type":"string", + "enum":[ + "HD", + "FHD" + ] + }, + "ResourceLimitExceededException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"The request ID associated with the call responsible for the exception.
" + } + }, + "documentation":"The request exceeds the resource limit.
", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ResultMax":{ + "type":"integer", + "max":100, + "min":1 + }, + "RuleName":{ + "type":"string", + "max":64, + "min":2, + "pattern":"^[0-9a-zA-Z._-]+" + }, + "S3BucketSinkConfiguration":{ + "type":"structure", + "required":["Destination"], + "members":{ + "Destination":{ + "shape":"Arn", + "documentation":"The destination URL of the S3 bucket.
" + } + }, + "documentation":"The configuration settings for the S3 bucket.
" + }, + "S3RecordingSinkConfiguration":{ + "type":"structure", + "members":{ + "Destination":{ + "shape":"Arn", + "documentation":"The default URI of the Amazon S3 bucket used as the recording sink.
" + }, + "RecordingFileFormat":{ + "shape":"RecordingFileFormat", + "documentation":"The default file format for the media files sent to the Amazon S3 bucket.
" + } + }, + "documentation":"The structure that holds the settings for transmitting media to the Amazon S3 bucket. These values are used as defaults if S3RecordingSinkRuntimeConfiguration is not specified.
The URI of the S3 bucket used as the sink.
" + }, + "RecordingFileFormat":{ + "shape":"RecordingFileFormat", + "documentation":"The file format for the media files sent to the Amazon S3 bucket.
" + } + }, + "documentation":"A structure that holds the settings for transmitting media files to the Amazon S3 bucket. If specified, the settings in this structure override any settings in S3RecordingSinkConfiguration.
The attendee IDs of the streams selected for a media pipeline.
" + }, + "ExternalUserIds":{ + "shape":"ExternalUserIdList", + "documentation":"The external user IDs of the streams selected for a media pipeline.
" + } + }, + "documentation":"The video streams for a specified media pipeline. The total number of video streams can't exceed 25.
" + }, + "SensitiveString":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "SentimentConfiguration":{ + "type":"structure", + "required":[ + "RuleName", + "SentimentType", + "TimePeriod" + ], + "members":{ + "RuleName":{ + "shape":"RuleName", + "documentation":"The name of the rule in the sentiment configuration.
" + }, + "SentimentType":{ + "shape":"SentimentType", + "documentation":"The type of sentiment, POSITIVE, NEGATIVE, or NEUTRAL.
Specifies the analysis interval.
" + } + }, + "documentation":"A structure that contains the configuration settings for a sentiment analysis task.
" + }, + "SentimentTimePeriodInSeconds":{ + "type":"integer", + "max":1800, + "min":60 + }, + "SentimentType":{ + "type":"string", + "enum":["NEGATIVE"] + }, + "ServiceFailureException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"The request ID associated with the call responsible for the exception.
" + } + }, + "documentation":"The service encountered an unexpected error.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"The request ID associated with the call responsible for the exception.
" + } + }, + "documentation":"The service is currently unavailable.
", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "SnsTopicSinkConfiguration":{ + "type":"structure", + "members":{ + "InsightsTarget":{ + "shape":"Arn", + "documentation":"The ARN of the SNS sink.
" + } + }, + "documentation":"The configuration settings for the SNS topic sink.
" + }, + "SourceConfiguration":{ + "type":"structure", + "members":{ + "SelectedVideoStreams":{ + "shape":"SelectedVideoStreams", + "documentation":"The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.
" + } + }, + "documentation":"Source configuration for a specified media pipeline.
" + }, + "SpeakerSearchTask":{ + "type":"structure", + "members":{ + "SpeakerSearchTaskId":{ + "shape":"GuidString", + "documentation":"The speaker search task ID.
" + }, + "SpeakerSearchTaskStatus":{ + "shape":"MediaPipelineTaskStatus", + "documentation":"The status of the speaker search task.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which a speaker search task was created.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which a speaker search task was updated.
" + } + }, + "documentation":"A representation of an asynchronous request to perform speaker search analysis on a media insights pipeline.
" + }, + "SqsQueueSinkConfiguration":{ + "type":"structure", + "members":{ + "InsightsTarget":{ + "shape":"Arn", + "documentation":"The ARN of the SQS sink.
" + } + }, + "documentation":"The configuration settings for the SQS sink.
" + }, + "StartSpeakerSearchTaskRequest":{ + "type":"structure", + "required":[ + "Identifier", + "VoiceProfileDomainArn" + ], + "members":{ + "Identifier":{ + "shape":"NonEmptyString", + "documentation":"The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
", + "location":"uri", + "locationName":"identifier" + }, + "VoiceProfileDomainArn":{ + "shape":"Arn", + "documentation":"The ARN of the voice profile domain that will store the voice profile.
" + }, + "KinesisVideoStreamSourceTaskConfiguration":{ + "shape":"KinesisVideoStreamSourceTaskConfiguration", + "documentation":"The task configuration for the Kinesis video stream source of the media insights pipeline.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"The unique identifier for the client request. Use a different token for different speaker search tasks.
", + "idempotencyToken":true + } + } + }, + "StartSpeakerSearchTaskResponse":{ + "type":"structure", + "members":{ + "SpeakerSearchTask":{ + "shape":"SpeakerSearchTask", + "documentation":"The details of the speaker search task.
" + } + } + }, + "StartVoiceToneAnalysisTaskRequest":{ + "type":"structure", + "required":[ + "Identifier", + "LanguageCode" + ], + "members":{ + "Identifier":{ + "shape":"NonEmptyString", + "documentation":"The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
", + "location":"uri", + "locationName":"identifier" + }, + "LanguageCode":{ + "shape":"VoiceAnalyticsLanguageCode", + "documentation":"The language code.
" + }, + "KinesisVideoStreamSourceTaskConfiguration":{ + "shape":"KinesisVideoStreamSourceTaskConfiguration", + "documentation":"The task configuration for the Kinesis video stream source of the media insights pipeline.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"The unique identifier for the client request. Use a different token for different voice tone analysis tasks.
", + "idempotencyToken":true + } + } + }, + "StartVoiceToneAnalysisTaskResponse":{ + "type":"structure", + "members":{ + "VoiceToneAnalysisTask":{ + "shape":"VoiceToneAnalysisTask", + "documentation":"The details of the voice tone analysis task.
" + } + } + }, + "StopSpeakerSearchTaskRequest":{ + "type":"structure", + "required":[ + "Identifier", + "SpeakerSearchTaskId" + ], + "members":{ + "Identifier":{ + "shape":"NonEmptyString", + "documentation":"The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
", + "location":"uri", + "locationName":"identifier" + }, + "SpeakerSearchTaskId":{ + "shape":"GuidString", + "documentation":"The speaker search task ID.
", + "location":"uri", + "locationName":"speakerSearchTaskId" + } + } + }, + "StopVoiceToneAnalysisTaskRequest":{ + "type":"structure", + "required":[ + "Identifier", + "VoiceToneAnalysisTaskId" + ], + "members":{ + "Identifier":{ + "shape":"NonEmptyString", + "documentation":"The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
", + "location":"uri", + "locationName":"identifier" + }, + "VoiceToneAnalysisTaskId":{ + "shape":"GuidString", + "documentation":"The ID of the voice tone analysis task.
", + "location":"uri", + "locationName":"voiceToneAnalysisTaskId" + } + } + }, + "StreamChannelDefinition":{ + "type":"structure", + "required":["NumberOfChannels"], + "members":{ + "NumberOfChannels":{ + "shape":"NumberOfChannels", + "documentation":"The number of channels in a streaming channel.
" + }, + "ChannelDefinitions":{ + "shape":"ChannelDefinitions", + "documentation":"The definitions of the channels in a streaming channel.
" + } + }, + "documentation":"Defines a streaming channel.
" + }, + "StreamConfiguration":{ + "type":"structure", + "required":[ + "StreamArn", + "StreamChannelDefinition" + ], + "members":{ + "StreamArn":{ + "shape":"KinesisVideoStreamArn", + "documentation":"The ARN of the stream.
" + }, + "FragmentNumber":{ + "shape":"FragmentNumberString", + "documentation":"The unique identifier of the fragment to begin processing.
" + }, + "StreamChannelDefinition":{ + "shape":"StreamChannelDefinition", + "documentation":"The streaming channel definition in the stream configuration.
" + } + }, + "documentation":"The configuration settings for a stream.
" + }, + "Streams":{ + "type":"list", + "member":{"shape":"StreamConfiguration"}, + "max":2, + "min":1 + }, + "String":{ + "type":"string", + "max":4096, + "pattern":".*" + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"The key half of a tag.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The value half of a tag.
" + } + }, + "documentation":"A key/value pair that grants users access to meeting resources.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's endpoint region, resource ID, and pipeline ID.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags associated with the specified media pipeline.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "ThrottledClientException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"The request ID associated with the call responsible for the exception.
" + } + }, + "documentation":"The client exceeded its request rate limit.
", + "error":{"httpStatusCode":429}, + "exception":true + }, + "TileAspectRatio":{ + "type":"string", + "pattern":"^\\d{1,2}\\/\\d{1,2}$" + }, + "TileCount":{ + "type":"integer", + "max":10, + "min":1 + }, + "TileOrder":{ + "type":"string", + "enum":[ + "JoinSequence", + "SpeakerSequence" + ] + }, + "Timestamp":{"type":"timestamp"}, + "TimestampRange":{ + "type":"structure", + "required":[ + "StartTimestamp", + "EndTimestamp" + ], + "members":{ + "StartTimestamp":{ + "shape":"Timestamp", + "documentation":"The starting timestamp for the specified range.
" + }, + "EndTimestamp":{ + "shape":"Timestamp", + "documentation":"The ending timestamp for the specified range.
" + } + }, + "documentation":"The range of timestamps to return.
" + }, + "TranscriptionMessagesConcatenationConfiguration":{ + "type":"structure", + "required":["State"], + "members":{ + "State":{ + "shape":"ArtifactsConcatenationState", + "documentation":"Enables or disables the configuration object.
" + } + }, + "documentation":"The configuration object for concatenating transcription messages.
" + }, + "UnauthorizedClientException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"The request ID associated with the call responsible for the exception.
" + } + }, + "documentation":"The client is not currently authorized to make the request.
", + "error":{"httpStatusCode":401}, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the pipeline that you want to untag.
" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"The key/value pairs in the tag that you want to remove.
" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateMediaInsightsPipelineConfigurationRequest":{ + "type":"structure", + "required":[ + "Identifier", + "ResourceAccessRoleArn", + "Elements" + ], + "members":{ + "Identifier":{ + "shape":"NonEmptyString", + "documentation":"The unique identifier for the resource to be updated. Valid values include the name and ARN of the media insights pipeline configuration.
", + "location":"uri", + "locationName":"identifier" + }, + "ResourceAccessRoleArn":{ + "shape":"Arn", + "documentation":"The ARN of the role used by the service to access Amazon Web Services resources.
" + }, + "RealTimeAlertConfiguration":{ + "shape":"RealTimeAlertConfiguration", + "documentation":"The configuration settings for real-time alerts for the media insights pipeline.
" + }, + "Elements":{ + "shape":"MediaInsightsPipelineConfigurationElements", + "documentation":"The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream..
" + } + } + }, + "UpdateMediaInsightsPipelineConfigurationResponse":{ + "type":"structure", + "members":{ + "MediaInsightsPipelineConfiguration":{ + "shape":"MediaInsightsPipelineConfiguration", + "documentation":"The updated configuration settings.
" + } + } + }, + "UpdateMediaInsightsPipelineStatusRequest":{ + "type":"structure", + "required":[ + "Identifier", + "UpdateStatus" + ], + "members":{ + "Identifier":{ + "shape":"NonEmptyString", + "documentation":"The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
", + "location":"uri", + "locationName":"identifier" + }, + "UpdateStatus":{ + "shape":"MediaPipelineStatusUpdate", + "documentation":"The requested status of the media insights pipeline.
" + } + } + }, + "UpdateMediaPipelineKinesisVideoStreamPoolRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"NonEmptyString", + "documentation":"The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.
", + "location":"uri", + "locationName":"identifier" + }, + "StreamConfiguration":{ + "shape":"KinesisVideoStreamConfigurationUpdate", + "documentation":"The configuration settings for the video stream.
" + } + } + }, + "UpdateMediaPipelineKinesisVideoStreamPoolResponse":{ + "type":"structure", + "members":{ + "KinesisVideoStreamPoolConfiguration":{ + "shape":"KinesisVideoStreamPoolConfiguration", + "documentation":"The video stream pool configuration object.
" + } + } + }, + "VerticalLayoutConfiguration":{ + "type":"structure", + "members":{ + "TileOrder":{ + "shape":"TileOrder", + "documentation":"Sets the automatic ordering of the video tiles.
" + }, + "TilePosition":{ + "shape":"VerticalTilePosition", + "documentation":"Sets the position of vertical tiles.
" + }, + "TileCount":{ + "shape":"TileCount", + "documentation":"The maximum number of tiles to display.
" + }, + "TileAspectRatio":{ + "shape":"TileAspectRatio", + "documentation":"Sets the aspect ratio of the video tiles, such as 16:9.
" + } + }, + "documentation":"Defines the configuration settings for a vertical layout.
" + }, + "VerticalTilePosition":{ + "type":"string", + "enum":[ + "Left", + "Right" + ] + }, + "VideoArtifactsConfiguration":{ + "type":"structure", + "required":["State"], + "members":{ + "State":{ + "shape":"ArtifactsState", + "documentation":"Indicates whether the video artifact is enabled or disabled.
" + }, + "MuxType":{ + "shape":"VideoMuxType", + "documentation":"The MUX type of the video artifact configuration object.
" + } + }, + "documentation":"The video artifact configuration object.
" + }, + "VideoAttribute":{ + "type":"structure", + "members":{ + "CornerRadius":{ + "shape":"CornerRadius", + "documentation":"Sets the corner radius of all video tiles.
" + }, + "BorderColor":{ + "shape":"BorderColor", + "documentation":"Defines the border color of all video tiles.
" + }, + "HighlightColor":{ + "shape":"HighlightColor", + "documentation":"Defines the highlight color for the active video tile.
" + }, + "BorderThickness":{ + "shape":"BorderThickness", + "documentation":"Defines the border thickness for all video tiles.
" + } + }, + "documentation":"Defines the settings for a video tile.
" + }, + "VideoConcatenationConfiguration":{ + "type":"structure", + "required":["State"], + "members":{ + "State":{ + "shape":"ArtifactsConcatenationState", + "documentation":"Enables or disables the configuration object.
" + } + }, + "documentation":"The configuration object of a video concatenation pipeline.
" + }, + "VideoMuxType":{ + "type":"string", + "enum":["VideoOnly"] + }, + "VocabularyFilterMethod":{ + "type":"string", + "enum":[ + "remove", + "mask", + "tag" + ] + }, + "VocabularyFilterName":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[0-9a-zA-Z._-]+" + }, + "VocabularyFilterNames":{ + "type":"string", + "max":3000, + "min":1, + "pattern":"^[a-zA-Z0-9,-._]+" + }, + "VocabularyName":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[0-9a-zA-Z._-]+" + }, + "VocabularyNames":{ + "type":"string", + "max":3000, + "min":1, + "pattern":"^[a-zA-Z0-9,-._]+" + }, + "VoiceAnalyticsConfigurationStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "VoiceAnalyticsLanguageCode":{ + "type":"string", + "enum":["en-US"] + }, + "VoiceAnalyticsProcessorConfiguration":{ + "type":"structure", + "members":{ + "SpeakerSearchStatus":{ + "shape":"VoiceAnalyticsConfigurationStatus", + "documentation":"The status of the speaker search task.
" + }, + "VoiceToneAnalysisStatus":{ + "shape":"VoiceAnalyticsConfigurationStatus", + "documentation":"The status of the voice tone analysis task.
" + } + }, + "documentation":"The configuration settings for a voice analytics processor.
" + }, + "VoiceEnhancementSinkConfiguration":{ + "type":"structure", + "members":{ + "Disabled":{ + "shape":"Boolean", + "documentation":"Disables the VoiceEnhancementSinkConfiguration element.
A static structure that contains the configuration data for a VoiceEnhancementSinkConfiguration element.
The ID of the voice tone analysis task.
" + }, + "VoiceToneAnalysisTaskStatus":{ + "shape":"MediaPipelineTaskStatus", + "documentation":"The status of a voice tone analysis task.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which a voice tone analysis task was created.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which a voice tone analysis task was updated.
" + } + }, + "documentation":"A representation of an asynchronous request to perform voice tone analysis on a media insights pipeline.
" + } + }, + "documentation":"The Amazon Chime SDK media pipeline APIs in this section allow software developers to create Amazon Chime SDK media pipelines that capture, concatenate, or stream your Amazon Chime SDK meetings. For more information about media pipelines, see Amazon Chime SDK media pipelines.
" +} diff --git a/testbed/boto__botocore/botocore/data/chime-sdk-voice/2022-08-03/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/chime-sdk-voice/2022-08-03/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..b3a334df4e8b1e6e08ff88dba77593e5f994c61b --- /dev/null +++ b/testbed/boto__botocore/botocore/data/chime-sdk-voice/2022-08-03/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://voice-chime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://voice-chime-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://voice-chime.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://voice-chime.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/chime-sdk-voice/2022-08-03/paginators-1.json b/testbed/boto__botocore/botocore/data/chime-sdk-voice/2022-08-03/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..648f71ee5b3b14ef627a123fd58f8c00378e5a98 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/chime-sdk-voice/2022-08-03/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListSipMediaApplications": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SipMediaApplications" + }, + "ListSipRules": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SipRules" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/chime-sdk-voice/2022-08-03/service-2.json b/testbed/boto__botocore/botocore/data/chime-sdk-voice/2022-08-03/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..688027c055a2b6b5a12e8c440680c9de09faf980 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/chime-sdk-voice/2022-08-03/service-2.json @@ -0,0 +1,6072 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-08-03", + "endpointPrefix":"voice-chime", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"Amazon Chime SDK Voice", + "serviceId":"Chime SDK Voice", + "signatureVersion":"v4", + "signingName":"chime", + "uid":"chime-sdk-voice-2022-08-03", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "AssociatePhoneNumbersWithVoiceConnector":{ + "name":"AssociatePhoneNumbersWithVoiceConnector", + "http":{ + "method":"POST", + "requestUri":"/voice-connectors/{voiceConnectorId}?operation=associate-phone-numbers", + "responseCode":200 + }, + "input":{"shape":"AssociatePhoneNumbersWithVoiceConnectorRequest"}, + "output":{"shape":"AssociatePhoneNumbersWithVoiceConnectorResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Associates phone numbers with the specified Amazon Chime SDK Voice Connector.
" + }, + "AssociatePhoneNumbersWithVoiceConnectorGroup":{ + "name":"AssociatePhoneNumbersWithVoiceConnectorGroup", + "http":{ + "method":"POST", + "requestUri":"/voice-connector-groups/{voiceConnectorGroupId}?operation=associate-phone-numbers", + "responseCode":200 + }, + "input":{"shape":"AssociatePhoneNumbersWithVoiceConnectorGroupRequest"}, + "output":{"shape":"AssociatePhoneNumbersWithVoiceConnectorGroupResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.
" + }, + "BatchDeletePhoneNumber":{ + "name":"BatchDeletePhoneNumber", + "http":{ + "method":"POST", + "requestUri":"/phone-numbers?operation=batch-delete", + "responseCode":200 + }, + "input":{"shape":"BatchDeletePhoneNumberRequest"}, + "output":{"shape":"BatchDeletePhoneNumberResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime SDK Voice Connectors before they can be deleted.
Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
" + }, + "BatchUpdatePhoneNumber":{ + "name":"BatchUpdatePhoneNumber", + "http":{ + "method":"POST", + "requestUri":"/phone-numbers?operation=batch-update", + "responseCode":200 + }, + "input":{"shape":"BatchUpdatePhoneNumberRequest"}, + "output":{"shape":"BatchUpdatePhoneNumberResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates phone number product types, calling names, or phone number names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type, the calling name, or phone name.
You cannot have a duplicate phoneNumberId in a request.
Creates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product type.
" + }, + "CreateProxySession":{ + "name":"CreateProxySession", + "http":{ + "method":"POST", + "requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions", + "responseCode":201 + }, + "input":{"shape":"CreateProxySessionRequest"}, + "output":{"shape":"CreateProxySessionResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.
" + }, + "CreateSipMediaApplication":{ + "name":"CreateSipMediaApplication", + "http":{ + "method":"POST", + "requestUri":"/sip-media-applications", + "responseCode":201 + }, + "input":{"shape":"CreateSipMediaApplicationRequest"}, + "output":{"shape":"CreateSipMediaApplicationResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.
" + }, + "CreateSipMediaApplicationCall":{ + "name":"CreateSipMediaApplicationCall", + "http":{ + "method":"POST", + "requestUri":"/sip-media-applications/{sipMediaApplicationId}/calls", + "responseCode":201 + }, + "input":{"shape":"CreateSipMediaApplicationCallRequest"}, + "output":{"shape":"CreateSipMediaApplicationCallResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ThrottledClientException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.
Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.
" + }, + "CreateVoiceConnector":{ + "name":"CreateVoiceConnector", + "http":{ + "method":"POST", + "requestUri":"/voice-connectors", + "responseCode":201 + }, + "input":{"shape":"CreateVoiceConnectorRequest"}, + "output":{"shape":"CreateVoiceConnectorResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.
" + }, + "CreateVoiceConnectorGroup":{ + "name":"CreateVoiceConnectorGroup", + "http":{ + "method":"POST", + "requestUri":"/voice-connector-groups", + "responseCode":201 + }, + "input":{"shape":"CreateVoiceConnectorGroupRequest"}, + "output":{"shape":"CreateVoiceConnectorGroupResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account. You can associate Amazon Chime SDK Voice Connectors with the Voice Connector group by including VoiceConnectorItems in the request.
You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.
" + }, + "CreateVoiceProfile":{ + "name":"CreateVoiceProfile", + "http":{ + "method":"POST", + "requestUri":"/voice-profiles", + "responseCode":201 + }, + "input":{"shape":"CreateVoiceProfileRequest"}, + "output":{"shape":"CreateVoiceProfileResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"GoneException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Creates a voice profile, which consists of an enrolled user and their latest voice print.
Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
For more information about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.
" + }, + "CreateVoiceProfileDomain":{ + "name":"CreateVoiceProfileDomain", + "http":{ + "method":"POST", + "requestUri":"/voice-profile-domains", + "responseCode":201 + }, + "input":{"shape":"CreateVoiceProfileDomainRequest"}, + "output":{"shape":"CreateVoiceProfileDomainResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.
Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.
" + }, + "DeletePhoneNumber":{ + "name":"DeletePhoneNumber", + "http":{ + "method":"DELETE", + "requestUri":"/phone-numbers/{phoneNumberId}", + "responseCode":204 + }, + "input":{"shape":"DeletePhoneNumberRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime SDK Voice Connectors before it can be deleted.
Deleted phone numbers remain in the Deletion queue queue for 7 days before they are deleted permanently.
" + }, + "DeleteProxySession":{ + "name":"DeleteProxySession", + "http":{ + "method":"DELETE", + "requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}", + "responseCode":204 + }, + "input":{"shape":"DeleteProxySessionRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.
" + }, + "DeleteSipMediaApplication":{ + "name":"DeleteSipMediaApplication", + "http":{ + "method":"DELETE", + "requestUri":"/sip-media-applications/{sipMediaApplicationId}", + "responseCode":204 + }, + "input":{"shape":"DeleteSipMediaApplicationRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes a SIP media application.
" + }, + "DeleteSipRule":{ + "name":"DeleteSipRule", + "http":{ + "method":"DELETE", + "requestUri":"/sip-rules/{sipRuleId}", + "responseCode":204 + }, + "input":{"shape":"DeleteSipRuleRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes a SIP rule.
" + }, + "DeleteVoiceConnector":{ + "name":"DeleteVoiceConnector", + "http":{ + "method":"DELETE", + "requestUri":"/voice-connectors/{voiceConnectorId}", + "responseCode":204 + }, + "input":{"shape":"DeleteVoiceConnectorRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes an Amazon Chime SDK Voice Connector. Any phone numbers associated with the Amazon Chime SDK Voice Connector must be disassociated from it before it can be deleted.
" + }, + "DeleteVoiceConnectorEmergencyCallingConfiguration":{ + "name":"DeleteVoiceConnectorEmergencyCallingConfiguration", + "http":{ + "method":"DELETE", + "requestUri":"/voice-connectors/{voiceConnectorId}/emergency-calling-configuration", + "responseCode":204 + }, + "input":{"shape":"DeleteVoiceConnectorEmergencyCallingConfigurationRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.
" + }, + "DeleteVoiceConnectorGroup":{ + "name":"DeleteVoiceConnectorGroup", + "http":{ + "method":"DELETE", + "requestUri":"/voice-connector-groups/{voiceConnectorGroupId}", + "responseCode":204 + }, + "input":{"shape":"DeleteVoiceConnectorGroupRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes an Amazon Chime SDK Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.
Deletes the origination settings for the specified Amazon Chime SDK Voice Connector.
If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the origination settings.
Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.
" + }, + "DeleteVoiceConnectorStreamingConfiguration":{ + "name":"DeleteVoiceConnectorStreamingConfiguration", + "http":{ + "method":"DELETE", + "requestUri":"/voice-connectors/{voiceConnectorId}/streaming-configuration", + "responseCode":204 + }, + "input":{"shape":"DeleteVoiceConnectorStreamingConfigurationRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes a Voice Connector's streaming configuration.
" + }, + "DeleteVoiceConnectorTermination":{ + "name":"DeleteVoiceConnectorTermination", + "http":{ + "method":"DELETE", + "requestUri":"/voice-connectors/{voiceConnectorId}/termination", + "responseCode":204 + }, + "input":{"shape":"DeleteVoiceConnectorTerminationRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes the termination settings for the specified Amazon Chime SDK Voice Connector.
If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the termination settings.
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
" + }, + "DeleteVoiceProfile":{ + "name":"DeleteVoiceProfile", + "http":{ + "method":"DELETE", + "requestUri":"/voice-profiles/{VoiceProfileId}", + "responseCode":204 + }, + "input":{"shape":"DeleteVoiceProfileRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.
" + }, + "DeleteVoiceProfileDomain":{ + "name":"DeleteVoiceProfileDomain", + "http":{ + "method":"DELETE", + "requestUri":"/voice-profile-domains/{VoiceProfileDomainId}", + "responseCode":204 + }, + "input":{"shape":"DeleteVoiceProfileDomainRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes all voice profiles in the domain. WARNING: This action is not reversible.
" + }, + "DisassociatePhoneNumbersFromVoiceConnector":{ + "name":"DisassociatePhoneNumbersFromVoiceConnector", + "http":{ + "method":"POST", + "requestUri":"/voice-connectors/{voiceConnectorId}?operation=disassociate-phone-numbers", + "responseCode":200 + }, + "input":{"shape":"DisassociatePhoneNumbersFromVoiceConnectorRequest"}, + "output":{"shape":"DisassociatePhoneNumbersFromVoiceConnectorResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.
" + }, + "DisassociatePhoneNumbersFromVoiceConnectorGroup":{ + "name":"DisassociatePhoneNumbersFromVoiceConnectorGroup", + "http":{ + "method":"POST", + "requestUri":"/voice-connector-groups/{voiceConnectorGroupId}?operation=disassociate-phone-numbers", + "responseCode":200 + }, + "input":{"shape":"DisassociatePhoneNumbersFromVoiceConnectorGroupRequest"}, + "output":{"shape":"DisassociatePhoneNumbersFromVoiceConnectorGroupResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.
" + }, + "GetGlobalSettings":{ + "name":"GetGlobalSettings", + "http":{ + "method":"GET", + "requestUri":"/settings", + "responseCode":200 + }, + "output":{"shape":"GetGlobalSettingsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
" + }, + "GetPhoneNumber":{ + "name":"GetPhoneNumber", + "http":{ + "method":"GET", + "requestUri":"/phone-numbers/{phoneNumberId}" + }, + "input":{"shape":"GetPhoneNumberRequest"}, + "output":{"shape":"GetPhoneNumberResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
" + }, + "GetPhoneNumberOrder":{ + "name":"GetPhoneNumberOrder", + "http":{ + "method":"GET", + "requestUri":"/phone-number-orders/{phoneNumberOrderId}", + "responseCode":200 + }, + "input":{"shape":"GetPhoneNumberOrderRequest"}, + "output":{"shape":"GetPhoneNumberOrderResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.
" + }, + "GetPhoneNumberSettings":{ + "name":"GetPhoneNumberSettings", + "http":{ + "method":"GET", + "requestUri":"/settings/phone-number", + "responseCode":200 + }, + "output":{"shape":"GetPhoneNumberSettingsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
" + }, + "GetProxySession":{ + "name":"GetProxySession", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}", + "responseCode":200 + }, + "input":{"shape":"GetProxySessionRequest"}, + "output":{"shape":"GetProxySessionResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.
" + }, + "GetSipMediaApplication":{ + "name":"GetSipMediaApplication", + "http":{ + "method":"GET", + "requestUri":"/sip-media-applications/{sipMediaApplicationId}", + "responseCode":200 + }, + "input":{"shape":"GetSipMediaApplicationRequest"}, + "output":{"shape":"GetSipMediaApplicationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
" + }, + "GetSipMediaApplicationAlexaSkillConfiguration":{ + "name":"GetSipMediaApplicationAlexaSkillConfiguration", + "http":{ + "method":"GET", + "requestUri":"/sip-media-applications/{sipMediaApplicationId}/alexa-skill-configuration", + "responseCode":200 + }, + "input":{"shape":"GetSipMediaApplicationAlexaSkillConfigurationRequest"}, + "output":{"shape":"GetSipMediaApplicationAlexaSkillConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Gets the Alexa Skill configuration for the SIP media application.
Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page.
Retrieves the logging configuration for the specified SIP media application.
" + }, + "GetSipRule":{ + "name":"GetSipRule", + "http":{ + "method":"GET", + "requestUri":"/sip-rules/{sipRuleId}", + "responseCode":200 + }, + "input":{"shape":"GetSipRuleRequest"}, + "output":{"shape":"GetSipRuleResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
" + }, + "GetSpeakerSearchTask":{ + "name":"GetSpeakerSearchTask", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{VoiceConnectorId}/speaker-search-tasks/{SpeakerSearchTaskId}", + "responseCode":200 + }, + "input":{"shape":"GetSpeakerSearchTaskRequest"}, + "output":{"shape":"GetSpeakerSearchTaskResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottledClientException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Retrieves the details of the specified speaker search task.
" + }, + "GetVoiceConnector":{ + "name":"GetVoiceConnector", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorRequest"}, + "output":{"shape":"GetVoiceConnectorResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
" + }, + "GetVoiceConnectorEmergencyCallingConfiguration":{ + "name":"GetVoiceConnectorEmergencyCallingConfiguration", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/emergency-calling-configuration", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorEmergencyCallingConfigurationRequest"}, + "output":{"shape":"GetVoiceConnectorEmergencyCallingConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves the emergency calling configuration details for the specified Voice Connector.
" + }, + "GetVoiceConnectorGroup":{ + "name":"GetVoiceConnectorGroup", + "http":{ + "method":"GET", + "requestUri":"/voice-connector-groups/{voiceConnectorGroupId}", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorGroupRequest"}, + "output":{"shape":"GetVoiceConnectorGroupResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.
Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
" + }, + "GetVoiceConnectorOrigination":{ + "name":"GetVoiceConnectorOrigination", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/origination", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorOriginationRequest"}, + "output":{"shape":"GetVoiceConnectorOriginationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves the origination settings for the specified Voice Connector.
" + }, + "GetVoiceConnectorProxy":{ + "name":"GetVoiceConnectorProxy", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorProxyRequest"}, + "output":{"shape":"GetVoiceConnectorProxyResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.
" + }, + "GetVoiceConnectorStreamingConfiguration":{ + "name":"GetVoiceConnectorStreamingConfiguration", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/streaming-configuration", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorStreamingConfigurationRequest"}, + "output":{"shape":"GetVoiceConnectorStreamingConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.
" + }, + "GetVoiceConnectorTermination":{ + "name":"GetVoiceConnectorTermination", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/termination", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorTerminationRequest"}, + "output":{"shape":"GetVoiceConnectorTerminationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves the termination setting details for the specified Voice Connector.
" + }, + "GetVoiceConnectorTerminationHealth":{ + "name":"GetVoiceConnectorTerminationHealth", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/termination/health", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorTerminationHealthRequest"}, + "output":{"shape":"GetVoiceConnectorTerminationHealthResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector.
Retrieves the details of the specified voice profile.
" + }, + "GetVoiceProfileDomain":{ + "name":"GetVoiceProfileDomain", + "http":{ + "method":"GET", + "requestUri":"/voice-profile-domains/{VoiceProfileDomainId}", + "responseCode":200 + }, + "input":{"shape":"GetVoiceProfileDomainRequest"}, + "output":{"shape":"GetVoiceProfileDomainResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Retrieves the details of the specified voice profile domain.
" + }, + "GetVoiceToneAnalysisTask":{ + "name":"GetVoiceToneAnalysisTask", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{VoiceConnectorId}/voice-tone-analysis-tasks/{VoiceToneAnalysisTaskId}", + "responseCode":200 + }, + "input":{"shape":"GetVoiceToneAnalysisTaskRequest"}, + "output":{"shape":"GetVoiceToneAnalysisTaskResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottledClientException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Retrieves the details of a voice tone analysis task.
" + }, + "ListAvailableVoiceConnectorRegions":{ + "name":"ListAvailableVoiceConnectorRegions", + "http":{ + "method":"GET", + "requestUri":"/voice-connector-regions", + "responseCode":200 + }, + "output":{"shape":"ListAvailableVoiceConnectorRegionsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.
" + }, + "ListPhoneNumberOrders":{ + "name":"ListPhoneNumberOrders", + "http":{ + "method":"GET", + "requestUri":"/phone-number-orders", + "responseCode":200 + }, + "input":{"shape":"ListPhoneNumberOrdersRequest"}, + "output":{"shape":"ListPhoneNumberOrdersResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the phone numbers for an administrator's Amazon Chime SDK account.
" + }, + "ListPhoneNumbers":{ + "name":"ListPhoneNumbers", + "http":{ + "method":"GET", + "requestUri":"/phone-numbers" + }, + "input":{"shape":"ListPhoneNumbersRequest"}, + "output":{"shape":"ListPhoneNumbersResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice Connector group.
" + }, + "ListProxySessions":{ + "name":"ListProxySessions", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions", + "responseCode":200 + }, + "input":{"shape":"ListProxySessionsRequest"}, + "output":{"shape":"ListProxySessionsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.
" + }, + "ListSipMediaApplications":{ + "name":"ListSipMediaApplications", + "http":{ + "method":"GET", + "requestUri":"/sip-media-applications", + "responseCode":200 + }, + "input":{"shape":"ListSipMediaApplicationsRequest"}, + "output":{"shape":"ListSipMediaApplicationsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the SIP media applications under the administrator's AWS account.
" + }, + "ListSipRules":{ + "name":"ListSipRules", + "http":{ + "method":"GET", + "requestUri":"/sip-rules", + "responseCode":200 + }, + "input":{"shape":"ListSipRulesRequest"}, + "output":{"shape":"ListSipRulesResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the SIP rules under the administrator's AWS account.
" + }, + "ListSupportedPhoneNumberCountries":{ + "name":"ListSupportedPhoneNumberCountries", + "http":{ + "method":"GET", + "requestUri":"/phone-number-countries", + "responseCode":200 + }, + "input":{"shape":"ListSupportedPhoneNumberCountriesRequest"}, + "output":{"shape":"ListSupportedPhoneNumberCountriesResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the countries that you can order phone numbers from.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Returns a list of the tags in a given resource.
" + }, + "ListVoiceConnectorGroups":{ + "name":"ListVoiceConnectorGroups", + "http":{ + "method":"GET", + "requestUri":"/voice-connector-groups", + "responseCode":200 + }, + "input":{"shape":"ListVoiceConnectorGroupsRequest"}, + "output":{"shape":"ListVoiceConnectorGroupsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.
" + }, + "ListVoiceConnectorTerminationCredentials":{ + "name":"ListVoiceConnectorTerminationCredentials", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/termination/credentials", + "responseCode":200 + }, + "input":{"shape":"ListVoiceConnectorTerminationCredentialsRequest"}, + "output":{"shape":"ListVoiceConnectorTerminationCredentialsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.
" + }, + "ListVoiceConnectors":{ + "name":"ListVoiceConnectors", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors", + "responseCode":200 + }, + "input":{"shape":"ListVoiceConnectorsRequest"}, + "output":{"shape":"ListVoiceConnectorsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.
" + }, + "ListVoiceProfileDomains":{ + "name":"ListVoiceProfileDomains", + "http":{ + "method":"GET", + "requestUri":"/voice-profile-domains", + "responseCode":200 + }, + "input":{"shape":"ListVoiceProfileDomainsRequest"}, + "output":{"shape":"ListVoiceProfileDomainsResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the specified voice profile domains in the administrator's AWS account.
" + }, + "ListVoiceProfiles":{ + "name":"ListVoiceProfiles", + "http":{ + "method":"GET", + "requestUri":"/voice-profiles", + "responseCode":200 + }, + "input":{"shape":"ListVoiceProfilesRequest"}, + "output":{"shape":"ListVoiceProfilesResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the voice profiles in a voice profile domain.
" + }, + "PutSipMediaApplicationAlexaSkillConfiguration":{ + "name":"PutSipMediaApplicationAlexaSkillConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/sip-media-applications/{sipMediaApplicationId}/alexa-skill-configuration", + "responseCode":200 + }, + "input":{"shape":"PutSipMediaApplicationAlexaSkillConfigurationRequest"}, + "output":{"shape":"PutSipMediaApplicationAlexaSkillConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates the Alexa Skill configuration for the SIP media application.
Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page.
Updates the logging configuration for the specified SIP media application.
" + }, + "PutVoiceConnectorEmergencyCallingConfiguration":{ + "name":"PutVoiceConnectorEmergencyCallingConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/voice-connectors/{voiceConnectorId}/emergency-calling-configuration", + "responseCode":200 + }, + "input":{"shape":"PutVoiceConnectorEmergencyCallingConfigurationRequest"}, + "output":{"shape":"PutVoiceConnectorEmergencyCallingConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates a Voice Connector's emergency calling configuration.
" + }, + "PutVoiceConnectorLoggingConfiguration":{ + "name":"PutVoiceConnectorLoggingConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/voice-connectors/{voiceConnectorId}/logging-configuration", + "responseCode":200 + }, + "input":{"shape":"PutVoiceConnectorLoggingConfigurationRequest"}, + "output":{"shape":"PutVoiceConnectorLoggingConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates a Voice Connector's logging configuration.
" + }, + "PutVoiceConnectorOrigination":{ + "name":"PutVoiceConnectorOrigination", + "http":{ + "method":"PUT", + "requestUri":"/voice-connectors/{voiceConnectorId}/origination", + "responseCode":200 + }, + "input":{"shape":"PutVoiceConnectorOriginationRequest"}, + "output":{"shape":"PutVoiceConnectorOriginationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates a Voice Connector's origination settings.
" + }, + "PutVoiceConnectorProxy":{ + "name":"PutVoiceConnectorProxy", + "http":{ + "method":"PUT", + "requestUri":"/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy" + }, + "input":{"shape":"PutVoiceConnectorProxyRequest"}, + "output":{"shape":"PutVoiceConnectorProxyResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.
" + }, + "PutVoiceConnectorStreamingConfiguration":{ + "name":"PutVoiceConnectorStreamingConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/voice-connectors/{voiceConnectorId}/streaming-configuration", + "responseCode":200 + }, + "input":{"shape":"PutVoiceConnectorStreamingConfigurationRequest"}, + "output":{"shape":"PutVoiceConnectorStreamingConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates a Voice Connector's streaming configuration settings.
" + }, + "PutVoiceConnectorTermination":{ + "name":"PutVoiceConnectorTermination", + "http":{ + "method":"PUT", + "requestUri":"/voice-connectors/{voiceConnectorId}/termination", + "responseCode":200 + }, + "input":{"shape":"PutVoiceConnectorTerminationRequest"}, + "output":{"shape":"PutVoiceConnectorTerminationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates a Voice Connector's termination settings.
" + }, + "PutVoiceConnectorTerminationCredentials":{ + "name":"PutVoiceConnectorTerminationCredentials", + "http":{ + "method":"POST", + "requestUri":"/voice-connectors/{voiceConnectorId}/termination/credentials?operation=put", + "responseCode":204 + }, + "input":{"shape":"PutVoiceConnectorTerminationCredentialsRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates a Voice Connector's termination credentials.
" + }, + "RestorePhoneNumber":{ + "name":"RestorePhoneNumber", + "http":{ + "method":"POST", + "requestUri":"/phone-numbers/{phoneNumberId}?operation=restore", + "responseCode":200 + }, + "input":{"shape":"RestorePhoneNumberRequest"}, + "output":{"shape":"RestorePhoneNumberResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Restores a deleted phone number.
" + }, + "SearchAvailablePhoneNumbers":{ + "name":"SearchAvailablePhoneNumbers", + "http":{ + "method":"GET", + "requestUri":"/search?type=phone-numbers" + }, + "input":{"shape":"SearchAvailablePhoneNumbersRequest"}, + "output":{"shape":"SearchAvailablePhoneNumbersResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Searches the provisioned phone numbers in an organization.
" + }, + "StartSpeakerSearchTask":{ + "name":"StartSpeakerSearchTask", + "http":{ + "method":"POST", + "requestUri":"/voice-connectors/{VoiceConnectorId}/speaker-search-tasks", + "responseCode":201 + }, + "input":{"shape":"StartSpeakerSearchTaskRequest"}, + "output":{"shape":"StartSpeakerSearchTaskResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"GoneException"}, + {"shape":"UnprocessableEntityException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Starts a speaker search task.
Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide.
Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
Stops a speaker search task.
" + }, + "StopVoiceToneAnalysisTask":{ + "name":"StopVoiceToneAnalysisTask", + "http":{ + "method":"POST", + "requestUri":"/voice-connectors/{VoiceConnectorId}/voice-tone-analysis-tasks/{VoiceToneAnalysisTaskId}?operation=stop", + "responseCode":204 + }, + "input":{"shape":"StopVoiceToneAnalysisTaskRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"UnprocessableEntityException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Stops a voice tone analysis task.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags?operation=tag-resource", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Adds a tag to the specified resource.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/tags?operation=untag-resource", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Removes tags from a resource.
" + }, + "UpdateGlobalSettings":{ + "name":"UpdateGlobalSettings", + "http":{ + "method":"PUT", + "requestUri":"/settings", + "responseCode":204 + }, + "input":{"shape":"UpdateGlobalSettingsRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
" + }, + "UpdatePhoneNumber":{ + "name":"UpdatePhoneNumber", + "http":{ + "method":"POST", + "requestUri":"/phone-numbers/{phoneNumberId}", + "responseCode":200 + }, + "input":{"shape":"UpdatePhoneNumberRequest"}, + "output":{"shape":"UpdatePhoneNumberResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates phone number details, such as product type, calling name, or phone number name for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type, calling name, or phone number name in one action.
For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In product type.
Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
" + }, + "UpdatePhoneNumberSettings":{ + "name":"UpdatePhoneNumberSettings", + "http":{ + "method":"PUT", + "requestUri":"/settings/phone-number", + "responseCode":204 + }, + "input":{"shape":"UpdatePhoneNumberSettingsRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.
" + }, + "UpdateProxySession":{ + "name":"UpdateProxySession", + "http":{ + "method":"POST", + "requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}", + "responseCode":201 + }, + "input":{"shape":"UpdateProxySessionRequest"}, + "output":{"shape":"UpdateProxySessionResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates the specified proxy session details, such as voice or SMS capabilities.
" + }, + "UpdateSipMediaApplication":{ + "name":"UpdateSipMediaApplication", + "http":{ + "method":"PUT", + "requestUri":"/sip-media-applications/{sipMediaApplicationId}", + "responseCode":200 + }, + "input":{"shape":"UpdateSipMediaApplicationRequest"}, + "output":{"shape":"UpdateSipMediaApplicationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates the details of the specified SIP media application.
" + }, + "UpdateSipMediaApplicationCall":{ + "name":"UpdateSipMediaApplicationCall", + "http":{ + "method":"POST", + "requestUri":"/sip-media-applications/{sipMediaApplicationId}/calls/{transactionId}", + "responseCode":202 + }, + "input":{"shape":"UpdateSipMediaApplicationCallRequest"}, + "output":{"shape":"UpdateSipMediaApplicationCallResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ThrottledClientException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.
" + }, + "UpdateSipRule":{ + "name":"UpdateSipRule", + "http":{ + "method":"PUT", + "requestUri":"/sip-rules/{sipRuleId}", + "responseCode":202 + }, + "input":{"shape":"UpdateSipRuleRequest"}, + "output":{"shape":"UpdateSipRuleResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates the details of the specified SIP rule.
" + }, + "UpdateVoiceConnector":{ + "name":"UpdateVoiceConnector", + "http":{ + "method":"PUT", + "requestUri":"/voice-connectors/{voiceConnectorId}", + "responseCode":200 + }, + "input":{"shape":"UpdateVoiceConnectorRequest"}, + "output":{"shape":"UpdateVoiceConnectorResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates the details for the specified Amazon Chime SDK Voice Connector.
" + }, + "UpdateVoiceConnectorGroup":{ + "name":"UpdateVoiceConnectorGroup", + "http":{ + "method":"PUT", + "requestUri":"/voice-connector-groups/{voiceConnectorGroupId}", + "responseCode":202 + }, + "input":{"shape":"UpdateVoiceConnectorGroupRequest"}, + "output":{"shape":"UpdateVoiceConnectorGroupResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates the settings for the specified Amazon Chime SDK Voice Connector group.
" + }, + "UpdateVoiceProfile":{ + "name":"UpdateVoiceProfile", + "http":{ + "method":"PUT", + "requestUri":"/voice-profiles/{VoiceProfileId}", + "responseCode":200 + }, + "input":{"shape":"UpdateVoiceProfileRequest"}, + "output":{"shape":"UpdateVoiceProfileResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"GoneException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates the specified voice profile’s voice print and refreshes its expiration timestamp.
As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric identifiers and biometric information (“biometric data”) in the form of a digital voiceprint requires the caller’s informed consent via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state privacy laws.
You must provide a written release to each caller through a process that clearly reflects each caller’s informed consent before using Amazon Chime SDK Voice Insights service, as required under the terms of your agreement with AWS governing your use of the service.
Updates the settings for the specified voice profile domain.
" + }, + "ValidateE911Address":{ + "name":"ValidateE911Address", + "http":{ + "method":"POST", + "requestUri":"/emergency-calling/address", + "responseCode":202 + }, + "input":{"shape":"ValidateE911AddressRequest"}, + "output":{"shape":"ValidateE911AddressResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + }, + "documentation":"You don't have the permissions needed to run this action.
", + "error":{"httpStatusCode":403}, + "exception":true + }, + "Address":{ + "type":"structure", + "members":{ + "streetName":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The address street, such as 8th Avenue.
The address suffix, such as the N in 8th Avenue N.
An address suffix location, such as the S. Unit A in Central Park S. Unit A.
An address prefix location, such as the N in N. Third St.
The numeric portion of an address.
" + }, + "city":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The city of an address.
" + }, + "state":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The state of an address.
" + }, + "postalCode":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The postal code of an address.
" + }, + "postalCodePlus4":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The zip + 4 or postal code + 4 of an address.
" + }, + "country":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The country of an address.
" + } + }, + "documentation":"A validated address.
" + }, + "AlexaSkillId":{ + "type":"string", + "max":64, + "pattern":"amzn1\\.application-oa2-client\\.[0-9a-fA-F]{32}", + "sensitive":true + }, + "AlexaSkillIdList":{ + "type":"list", + "member":{"shape":"AlexaSkillId"}, + "max":1, + "min":1 + }, + "AlexaSkillStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE" + ] + }, + "Alpha2CountryCode":{ + "type":"string", + "pattern":"[A-Z]{2}" + }, + "AreaCode":{ + "type":"string", + "pattern":"^$|^[0-9]{3,3}$" + }, + "Arn":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^arn[\\/\\:\\-\\_\\.a-zA-Z0-9]+$", + "sensitive":true + }, + "AssociatePhoneNumbersWithVoiceConnectorGroupRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorGroupId", + "E164PhoneNumbers" + ], + "members":{ + "VoiceConnectorGroupId":{ + "shape":"NonEmptyString", + "documentation":"The Amazon Chime SDK Voice Connector group ID.
", + "location":"uri", + "locationName":"voiceConnectorGroupId" + }, + "E164PhoneNumbers":{ + "shape":"E164PhoneNumberList", + "documentation":"List of phone numbers, in E.164 format.
" + }, + "ForceAssociate":{ + "shape":"NullableBoolean", + "documentation":"If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
" + } + } + }, + "AssociatePhoneNumbersWithVoiceConnectorGroupResponse":{ + "type":"structure", + "members":{ + "PhoneNumberErrors":{ + "shape":"PhoneNumberErrorList", + "documentation":"If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
" + } + } + }, + "AssociatePhoneNumbersWithVoiceConnectorRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "E164PhoneNumbers" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "E164PhoneNumbers":{ + "shape":"E164PhoneNumberList", + "documentation":"List of phone numbers, in E.164 format.
" + }, + "ForceAssociate":{ + "shape":"NullableBoolean", + "documentation":"If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
" + } + } + }, + "AssociatePhoneNumbersWithVoiceConnectorResponse":{ + "type":"structure", + "members":{ + "PhoneNumberErrors":{ + "shape":"PhoneNumberErrorList", + "documentation":"If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
" + } + } + }, + "BadRequestException":{ + "type":"structure", + "members":{ + }, + "documentation":"The input parameters don't match the service's restrictions.
", + "error":{"httpStatusCode":400}, + "exception":true + }, + "BatchDeletePhoneNumberRequest":{ + "type":"structure", + "required":["PhoneNumberIds"], + "members":{ + "PhoneNumberIds":{ + "shape":"NonEmptyStringList", + "documentation":"List of phone number IDs.
" + } + } + }, + "BatchDeletePhoneNumberResponse":{ + "type":"structure", + "members":{ + "PhoneNumberErrors":{ + "shape":"PhoneNumberErrorList", + "documentation":"If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
" + } + } + }, + "BatchUpdatePhoneNumberRequest":{ + "type":"structure", + "required":["UpdatePhoneNumberRequestItems"], + "members":{ + "UpdatePhoneNumberRequestItems":{ + "shape":"UpdatePhoneNumberRequestItemList", + "documentation":"Lists the phone numbers in the update request.
" + } + } + }, + "BatchUpdatePhoneNumberResponse":{ + "type":"structure", + "members":{ + "PhoneNumberErrors":{ + "shape":"PhoneNumberErrorList", + "documentation":"A list of failed phone numbers and their error messages.
" + } + } + }, + "Boolean":{"type":"boolean"}, + "CallDetails":{ + "type":"structure", + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
" + }, + "TransactionId":{ + "shape":"NonEmptyString256", + "documentation":"The transaction ID of a Voice Connector call.
" + }, + "IsCaller":{ + "shape":"Boolean", + "documentation":"Identifies a person as the caller or the callee.
" + } + }, + "documentation":"The details of an Amazon Chime SDK Voice Connector call.
" + }, + "CallLegType":{ + "type":"string", + "enum":[ + "Caller", + "Callee" + ] + }, + "CallingName":{ + "type":"string", + "pattern":"^$|^[a-zA-Z0-9 ]{2,15}$", + "sensitive":true + }, + "CallingNameStatus":{ + "type":"string", + "enum":[ + "Unassigned", + "UpdateInProgress", + "UpdateSucceeded", + "UpdateFailed" + ] + }, + "CallingRegion":{"type":"string"}, + "CallingRegionList":{ + "type":"list", + "member":{"shape":"CallingRegion"} + }, + "CandidateAddress":{ + "type":"structure", + "members":{ + "streetInfo":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The street information of the candidate address.
" + }, + "streetNumber":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The numeric portion of the candidate address.
" + }, + "city":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The city of the candidate address.
" + }, + "state":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The state of the candidate address.
" + }, + "postalCode":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The postal code of the candidate address.
" + }, + "postalCodePlus4":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The zip + 4 or postal code +4 of the candidate address.
" + }, + "country":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The country of the candidate address.
" + } + }, + "documentation":"A suggested address.
" + }, + "CandidateAddressList":{ + "type":"list", + "member":{"shape":"CandidateAddress"} + }, + "Capability":{ + "type":"string", + "enum":[ + "Voice", + "SMS" + ] + }, + "CapabilityList":{ + "type":"list", + "member":{"shape":"Capability"} + }, + "ClientRequestId":{ + "type":"string", + "pattern":"^[-_a-zA-Z0-9]*${2,64}$" + }, + "ConfidenceScore":{ + "type":"float", + "max":1, + "min":0 + }, + "ConflictException":{ + "type":"structure", + "members":{ + }, + "documentation":"Multiple instances of the same request were made simultaneously.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "Country":{ + "type":"string", + "pattern":"^$|^[A-Z]{2,2}$" + }, + "CountryList":{ + "type":"list", + "member":{"shape":"Country"}, + "max":100, + "min":1 + }, + "CpsLimit":{ + "type":"integer", + "min":1 + }, + "CreatePhoneNumberOrderRequest":{ + "type":"structure", + "required":[ + "ProductType", + "E164PhoneNumbers" + ], + "members":{ + "ProductType":{ + "shape":"PhoneNumberProductType", + "documentation":"The phone number product type.
" + }, + "E164PhoneNumbers":{ + "shape":"E164PhoneNumberList", + "documentation":"List of phone numbers, in E.164 format.
" + }, + "Name":{ + "shape":"PhoneNumberName", + "documentation":"Specifies the name assigned to one or more phone numbers.
" + } + } + }, + "CreatePhoneNumberOrderResponse":{ + "type":"structure", + "members":{ + "PhoneNumberOrder":{ + "shape":"PhoneNumberOrder", + "documentation":"The phone number order details.
" + } + } + }, + "CreateProxySessionRequest":{ + "type":"structure", + "required":[ + "ParticipantPhoneNumbers", + "Capabilities", + "VoiceConnectorId" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "ParticipantPhoneNumbers":{ + "shape":"ParticipantPhoneNumberList", + "documentation":"The participant phone numbers.
" + }, + "Name":{ + "shape":"ProxySessionNameString", + "documentation":"The name of the proxy session.
" + }, + "ExpiryMinutes":{ + "shape":"PositiveInteger", + "documentation":"The number of minutes allowed for the proxy session.
" + }, + "Capabilities":{ + "shape":"CapabilityList", + "documentation":"The proxy session's capabilities.
" + }, + "NumberSelectionBehavior":{ + "shape":"NumberSelectionBehavior", + "documentation":"The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
" + }, + "GeoMatchLevel":{ + "shape":"GeoMatchLevel", + "documentation":"The preference for matching the country or area code of the proxy phone number with that of the first participant.
" + }, + "GeoMatchParams":{ + "shape":"GeoMatchParams", + "documentation":"The country and area code for the proxy phone number.
" + } + } + }, + "CreateProxySessionResponse":{ + "type":"structure", + "members":{ + "ProxySession":{ + "shape":"ProxySession", + "documentation":"The proxy session details.
" + } + } + }, + "CreateSipMediaApplicationCallRequest":{ + "type":"structure", + "required":[ + "FromPhoneNumber", + "ToPhoneNumber", + "SipMediaApplicationId" + ], + "members":{ + "FromPhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"The phone number that a user calls from. This is a phone number in your Amazon Chime SDK phone number inventory.
" + }, + "ToPhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"The phone number that the service should call.
" + }, + "SipMediaApplicationId":{ + "shape":"NonEmptyString", + "documentation":"The ID of the SIP media application.
", + "location":"uri", + "locationName":"sipMediaApplicationId" + }, + "SipHeaders":{ + "shape":"SipHeadersMap", + "documentation":"The SIP headers added to an outbound call leg.
" + }, + "ArgumentsMap":{ + "shape":"SMACreateCallArgumentsMap", + "documentation":"Context passed to a CreateSipMediaApplication API call. For example, you could pass key-value pairs such as: \"FirstName\": \"John\", \"LastName\": \"Doe\"
The actual call.
" + } + } + }, + "CreateSipMediaApplicationRequest":{ + "type":"structure", + "required":[ + "AwsRegion", + "Name", + "Endpoints" + ], + "members":{ + "AwsRegion":{ + "shape":"String", + "documentation":"The AWS Region assigned to the SIP media application.
" + }, + "Name":{ + "shape":"SipMediaApplicationName", + "documentation":"The SIP media application's name.
" + }, + "Endpoints":{ + "shape":"SipMediaApplicationEndpointList", + "documentation":"List of endpoints (Lambda ARNs) specified for the SIP media application.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags assigned to the SIP media application.
" + } + } + }, + "CreateSipMediaApplicationResponse":{ + "type":"structure", + "members":{ + "SipMediaApplication":{ + "shape":"SipMediaApplication", + "documentation":"The SIP media application details.
" + } + } + }, + "CreateSipRuleRequest":{ + "type":"structure", + "required":[ + "Name", + "TriggerType", + "TriggerValue" + ], + "members":{ + "Name":{ + "shape":"SipRuleName", + "documentation":"The name of the SIP rule.
" + }, + "TriggerType":{ + "shape":"SipRuleTriggerType", + "documentation":"The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
If TriggerType is RequestUriHostname, the value can be the outbound host name of a Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.
Disables or enables a SIP rule. You must disable SIP rules before you can delete them.
" + }, + "TargetApplications":{ + "shape":"SipRuleTargetApplicationList", + "documentation":"List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.
" + } + } + }, + "CreateSipRuleResponse":{ + "type":"structure", + "members":{ + "SipRule":{ + "shape":"SipRule", + "documentation":"The SIP rule information, including the rule ID, triggers, and target applications.
" + } + } + }, + "CreateVoiceConnectorGroupRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"VoiceConnectorGroupName", + "documentation":"The name of the Voice Connector group.
" + }, + "VoiceConnectorItems":{ + "shape":"VoiceConnectorItemList", + "documentation":"Lists the Voice Connectors that inbound calls are routed to.
" + } + } + }, + "CreateVoiceConnectorGroupResponse":{ + "type":"structure", + "members":{ + "VoiceConnectorGroup":{ + "shape":"VoiceConnectorGroup", + "documentation":"The details of the Voice Connector group.
" + } + } + }, + "CreateVoiceConnectorRequest":{ + "type":"structure", + "required":[ + "Name", + "RequireEncryption" + ], + "members":{ + "Name":{ + "shape":"VoiceConnectorName", + "documentation":"The name of the Voice Connector.
" + }, + "AwsRegion":{ + "shape":"VoiceConnectorAwsRegion", + "documentation":"The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: us-east-1 .
Enables or disables encryption for the Voice Connector.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags assigned to the Voice Connector.
" + } + } + }, + "CreateVoiceConnectorResponse":{ + "type":"structure", + "members":{ + "VoiceConnector":{ + "shape":"VoiceConnector", + "documentation":"The details of the Voice Connector.
" + } + } + }, + "CreateVoiceProfileDomainRequest":{ + "type":"structure", + "required":[ + "Name", + "ServerSideEncryptionConfiguration" + ], + "members":{ + "Name":{ + "shape":"VoiceProfileDomainName", + "documentation":"The name of the voice profile domain.
" + }, + "Description":{ + "shape":"VoiceProfileDomainDescription", + "documentation":"A description of the voice profile domain.
" + }, + "ServerSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"The server-side encryption configuration for the request.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestId", + "documentation":"The unique identifier for the client request. Use a different token for different domain creation requests.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags assigned to the domain.
" + } + } + }, + "CreateVoiceProfileDomainResponse":{ + "type":"structure", + "members":{ + "VoiceProfileDomain":{ + "shape":"VoiceProfileDomain", + "documentation":"The requested voice profile domain.
" + } + } + }, + "CreateVoiceProfileRequest":{ + "type":"structure", + "required":["SpeakerSearchTaskId"], + "members":{ + "SpeakerSearchTaskId":{ + "shape":"NonEmptyString256", + "documentation":"The ID of the speaker search task.
" + } + } + }, + "CreateVoiceProfileResponse":{ + "type":"structure", + "members":{ + "VoiceProfile":{ + "shape":"VoiceProfile", + "documentation":"The requested voice profile.
" + } + } + }, + "Credential":{ + "type":"structure", + "members":{ + "Username":{ + "shape":"SensitiveString", + "documentation":"The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.
" + }, + "Password":{ + "shape":"SensitiveString", + "documentation":"The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.
" + } + }, + "documentation":"The SIP credentials used to authenticate requests to an Amazon Chime SDK Voice Connector.
" + }, + "CredentialList":{ + "type":"list", + "member":{"shape":"Credential"} + }, + "DNISEmergencyCallingConfiguration":{ + "type":"structure", + "required":[ + "EmergencyPhoneNumber", + "CallingCountry" + ], + "members":{ + "EmergencyPhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"The DNIS phone number that you route emergency calls to, in E.164 format.
" + }, + "TestPhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"The DNIS phone number for routing test emergency calls to, in E.164 format.
" + }, + "CallingCountry":{ + "shape":"Alpha2CountryCode", + "documentation":"The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.
" + } + }, + "documentation":"The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime SDK Voice Connector's emergency calling configuration.
" + }, + "DNISEmergencyCallingConfigurationList":{ + "type":"list", + "member":{"shape":"DNISEmergencyCallingConfiguration"} + }, + "DataRetentionInHours":{ + "type":"integer", + "min":0 + }, + "DeletePhoneNumberRequest":{ + "type":"structure", + "required":["PhoneNumberId"], + "members":{ + "PhoneNumberId":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The phone number ID.
", + "location":"uri", + "locationName":"phoneNumberId" + } + } + }, + "DeleteProxySessionRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "ProxySessionId" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "ProxySessionId":{ + "shape":"NonEmptyString128", + "documentation":"The proxy session ID.
", + "location":"uri", + "locationName":"proxySessionId" + } + } + }, + "DeleteSipMediaApplicationRequest":{ + "type":"structure", + "required":["SipMediaApplicationId"], + "members":{ + "SipMediaApplicationId":{ + "shape":"NonEmptyString", + "documentation":"The SIP media application ID.
", + "location":"uri", + "locationName":"sipMediaApplicationId" + } + } + }, + "DeleteSipRuleRequest":{ + "type":"structure", + "required":["SipRuleId"], + "members":{ + "SipRuleId":{ + "shape":"NonEmptyString", + "documentation":"The SIP rule ID.
", + "location":"uri", + "locationName":"sipRuleId" + } + } + }, + "DeleteVoiceConnectorEmergencyCallingConfigurationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "DeleteVoiceConnectorGroupRequest":{ + "type":"structure", + "required":["VoiceConnectorGroupId"], + "members":{ + "VoiceConnectorGroupId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector Group ID.
", + "location":"uri", + "locationName":"voiceConnectorGroupId" + } + } + }, + "DeleteVoiceConnectorOriginationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "DeleteVoiceConnectorProxyRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "DeleteVoiceConnectorRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "DeleteVoiceConnectorStreamingConfigurationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "DeleteVoiceConnectorTerminationCredentialsRequest":{ + "type":"structure", + "required":[ + "Usernames", + "VoiceConnectorId" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "Usernames":{ + "shape":"SensitiveStringList", + "documentation":"The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.
" + } + } + }, + "DeleteVoiceConnectorTerminationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "DeleteVoiceProfileDomainRequest":{ + "type":"structure", + "required":["VoiceProfileDomainId"], + "members":{ + "VoiceProfileDomainId":{ + "shape":"NonEmptyString256", + "documentation":"The voice profile domain ID.
", + "location":"uri", + "locationName":"VoiceProfileDomainId" + } + } + }, + "DeleteVoiceProfileRequest":{ + "type":"structure", + "required":["VoiceProfileId"], + "members":{ + "VoiceProfileId":{ + "shape":"NonEmptyString256", + "documentation":"The voice profile ID.
", + "location":"uri", + "locationName":"VoiceProfileId" + } + } + }, + "DisassociatePhoneNumbersFromVoiceConnectorGroupRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorGroupId", + "E164PhoneNumbers" + ], + "members":{ + "VoiceConnectorGroupId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector group ID.
", + "location":"uri", + "locationName":"voiceConnectorGroupId" + }, + "E164PhoneNumbers":{ + "shape":"E164PhoneNumberList", + "documentation":"The list of phone numbers, in E.164 format.
" + } + } + }, + "DisassociatePhoneNumbersFromVoiceConnectorGroupResponse":{ + "type":"structure", + "members":{ + "PhoneNumberErrors":{ + "shape":"PhoneNumberErrorList", + "documentation":"If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
" + } + } + }, + "DisassociatePhoneNumbersFromVoiceConnectorRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "E164PhoneNumbers" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "E164PhoneNumbers":{ + "shape":"E164PhoneNumberList", + "documentation":"List of phone numbers, in E.164 format.
" + } + } + }, + "DisassociatePhoneNumbersFromVoiceConnectorResponse":{ + "type":"structure", + "members":{ + "PhoneNumberErrors":{ + "shape":"PhoneNumberErrorList", + "documentation":"If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
" + } + } + }, + "E164PhoneNumber":{ + "type":"string", + "pattern":"^\\+?[1-9]\\d{1,14}$", + "sensitive":true + }, + "E164PhoneNumberList":{ + "type":"list", + "member":{"shape":"E164PhoneNumber"} + }, + "EmergencyCallingConfiguration":{ + "type":"structure", + "members":{ + "DNIS":{ + "shape":"DNISEmergencyCallingConfigurationList", + "documentation":"The Dialed Number Identification Service (DNIS) emergency calling configuration details.
" + } + }, + "documentation":"The emergency calling configuration details associated with an Amazon Chime SDK Voice Connector.
" + }, + "ErrorCode":{ + "type":"string", + "enum":[ + "BadRequest", + "Conflict", + "Forbidden", + "NotFound", + "PreconditionFailed", + "ResourceLimitExceeded", + "ServiceFailure", + "AccessDenied", + "ServiceUnavailable", + "Throttled", + "Throttling", + "Unauthorized", + "Unprocessable", + "VoiceConnectorGroupAssociationsExist", + "PhoneNumberAssociationsExist", + "Gone" + ] + }, + "ForbiddenException":{ + "type":"structure", + "members":{ + }, + "documentation":"The client is permanently forbidden from making the request.
", + "error":{"httpStatusCode":403}, + "exception":true + }, + "FunctionArn":{ + "type":"string", + "max":10000, + "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?", + "sensitive":true + }, + "GeoMatchLevel":{ + "type":"string", + "enum":[ + "Country", + "AreaCode" + ] + }, + "GeoMatchParams":{ + "type":"structure", + "required":[ + "Country", + "AreaCode" + ], + "members":{ + "Country":{ + "shape":"Country", + "documentation":"The country.
" + }, + "AreaCode":{ + "shape":"AreaCode", + "documentation":"The area code.
" + } + }, + "documentation":"The country and area code for a proxy phone number in a proxy phone session.
" + }, + "GetGlobalSettingsResponse":{ + "type":"structure", + "members":{ + "VoiceConnector":{ + "shape":"VoiceConnectorSettings", + "documentation":"The Voice Connector settings.
" + } + } + }, + "GetPhoneNumberOrderRequest":{ + "type":"structure", + "required":["PhoneNumberOrderId"], + "members":{ + "PhoneNumberOrderId":{ + "shape":"GuidString", + "documentation":"The ID of the phone number order .
", + "location":"uri", + "locationName":"phoneNumberOrderId" + } + } + }, + "GetPhoneNumberOrderResponse":{ + "type":"structure", + "members":{ + "PhoneNumberOrder":{ + "shape":"PhoneNumberOrder", + "documentation":"The phone number order details.
" + } + } + }, + "GetPhoneNumberRequest":{ + "type":"structure", + "required":["PhoneNumberId"], + "members":{ + "PhoneNumberId":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The phone number ID.
", + "location":"uri", + "locationName":"phoneNumberId" + } + } + }, + "GetPhoneNumberResponse":{ + "type":"structure", + "members":{ + "PhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The phone number details.
" + } + } + }, + "GetPhoneNumberSettingsResponse":{ + "type":"structure", + "members":{ + "CallingName":{ + "shape":"CallingName", + "documentation":"The default outbound calling name for the account.
" + }, + "CallingNameUpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The updated outbound calling name timestamp, in ISO 8601 format.
" + } + } + }, + "GetProxySessionRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "ProxySessionId" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "ProxySessionId":{ + "shape":"NonEmptyString128", + "documentation":"The proxy session ID.
", + "location":"uri", + "locationName":"proxySessionId" + } + } + }, + "GetProxySessionResponse":{ + "type":"structure", + "members":{ + "ProxySession":{ + "shape":"ProxySession", + "documentation":"The proxy session details.
" + } + } + }, + "GetSipMediaApplicationAlexaSkillConfigurationRequest":{ + "type":"structure", + "required":["SipMediaApplicationId"], + "members":{ + "SipMediaApplicationId":{ + "shape":"NonEmptyString", + "documentation":"The SIP media application ID.
", + "location":"uri", + "locationName":"sipMediaApplicationId" + } + } + }, + "GetSipMediaApplicationAlexaSkillConfigurationResponse":{ + "type":"structure", + "members":{ + "SipMediaApplicationAlexaSkillConfiguration":{ + "shape":"SipMediaApplicationAlexaSkillConfiguration", + "documentation":"Returns the Alexa Skill configuration.
" + } + } + }, + "GetSipMediaApplicationLoggingConfigurationRequest":{ + "type":"structure", + "required":["SipMediaApplicationId"], + "members":{ + "SipMediaApplicationId":{ + "shape":"NonEmptyString", + "documentation":"The SIP media application ID.
", + "location":"uri", + "locationName":"sipMediaApplicationId" + } + } + }, + "GetSipMediaApplicationLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + "SipMediaApplicationLoggingConfiguration":{ + "shape":"SipMediaApplicationLoggingConfiguration", + "documentation":"The actual logging configuration.
" + } + } + }, + "GetSipMediaApplicationRequest":{ + "type":"structure", + "required":["SipMediaApplicationId"], + "members":{ + "SipMediaApplicationId":{ + "shape":"NonEmptyString", + "documentation":"The SIP media application ID .
", + "location":"uri", + "locationName":"sipMediaApplicationId" + } + } + }, + "GetSipMediaApplicationResponse":{ + "type":"structure", + "members":{ + "SipMediaApplication":{ + "shape":"SipMediaApplication", + "documentation":"The details of the SIP media application.
" + } + } + }, + "GetSipRuleRequest":{ + "type":"structure", + "required":["SipRuleId"], + "members":{ + "SipRuleId":{ + "shape":"NonEmptyString", + "documentation":"The SIP rule ID.
", + "location":"uri", + "locationName":"sipRuleId" + } + } + }, + "GetSipRuleResponse":{ + "type":"structure", + "members":{ + "SipRule":{ + "shape":"SipRule", + "documentation":"The SIP rule details.
" + } + } + }, + "GetSpeakerSearchTaskRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "SpeakerSearchTaskId" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"VoiceConnectorId" + }, + "SpeakerSearchTaskId":{ + "shape":"NonEmptyString256", + "documentation":"The ID of the speaker search task.
", + "location":"uri", + "locationName":"SpeakerSearchTaskId" + } + } + }, + "GetSpeakerSearchTaskResponse":{ + "type":"structure", + "members":{ + "SpeakerSearchTask":{ + "shape":"SpeakerSearchTask", + "documentation":"The details of the speaker search task.
" + } + } + }, + "GetVoiceConnectorEmergencyCallingConfigurationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorEmergencyCallingConfigurationResponse":{ + "type":"structure", + "members":{ + "EmergencyCallingConfiguration":{ + "shape":"EmergencyCallingConfiguration", + "documentation":"The details of the emergency calling configuration.
" + } + } + }, + "GetVoiceConnectorGroupRequest":{ + "type":"structure", + "required":["VoiceConnectorGroupId"], + "members":{ + "VoiceConnectorGroupId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector group ID.
", + "location":"uri", + "locationName":"voiceConnectorGroupId" + } + } + }, + "GetVoiceConnectorGroupResponse":{ + "type":"structure", + "members":{ + "VoiceConnectorGroup":{ + "shape":"VoiceConnectorGroup", + "documentation":"The details of the Voice Connector group.
" + } + } + }, + "GetVoiceConnectorLoggingConfigurationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + "LoggingConfiguration":{ + "shape":"LoggingConfiguration", + "documentation":"The logging configuration details .
" + } + } + }, + "GetVoiceConnectorOriginationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorOriginationResponse":{ + "type":"structure", + "members":{ + "Origination":{ + "shape":"Origination", + "documentation":"The origination setting details.
" + } + } + }, + "GetVoiceConnectorProxyRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorProxyResponse":{ + "type":"structure", + "members":{ + "Proxy":{ + "shape":"Proxy", + "documentation":"The proxy configuration details.
" + } + } + }, + "GetVoiceConnectorRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorResponse":{ + "type":"structure", + "members":{ + "VoiceConnector":{ + "shape":"VoiceConnector", + "documentation":"The Voice Connector details.
" + } + } + }, + "GetVoiceConnectorStreamingConfigurationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorStreamingConfigurationResponse":{ + "type":"structure", + "members":{ + "StreamingConfiguration":{ + "shape":"StreamingConfiguration", + "documentation":"The details of the streaming configuration.
" + } + } + }, + "GetVoiceConnectorTerminationHealthRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorTerminationHealthResponse":{ + "type":"structure", + "members":{ + "TerminationHealth":{ + "shape":"TerminationHealth", + "documentation":"The termination health details.
" + } + } + }, + "GetVoiceConnectorTerminationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorTerminationResponse":{ + "type":"structure", + "members":{ + "Termination":{ + "shape":"Termination", + "documentation":"The termination setting details.
" + } + } + }, + "GetVoiceProfileDomainRequest":{ + "type":"structure", + "required":["VoiceProfileDomainId"], + "members":{ + "VoiceProfileDomainId":{ + "shape":"NonEmptyString256", + "documentation":"The voice profile domain ID.
", + "location":"uri", + "locationName":"VoiceProfileDomainId" + } + } + }, + "GetVoiceProfileDomainResponse":{ + "type":"structure", + "members":{ + "VoiceProfileDomain":{ + "shape":"VoiceProfileDomain", + "documentation":"The details of the voice profile domain.
" + } + } + }, + "GetVoiceProfileRequest":{ + "type":"structure", + "required":["VoiceProfileId"], + "members":{ + "VoiceProfileId":{ + "shape":"NonEmptyString256", + "documentation":"The voice profile ID.
", + "location":"uri", + "locationName":"VoiceProfileId" + } + } + }, + "GetVoiceProfileResponse":{ + "type":"structure", + "members":{ + "VoiceProfile":{ + "shape":"VoiceProfile", + "documentation":"The voice profile details.
" + } + } + }, + "GetVoiceToneAnalysisTaskRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "VoiceToneAnalysisTaskId", + "IsCaller" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"VoiceConnectorId" + }, + "VoiceToneAnalysisTaskId":{ + "shape":"NonEmptyString256", + "documentation":"The ID of the voice tone analysis task.
", + "location":"uri", + "locationName":"VoiceToneAnalysisTaskId" + }, + "IsCaller":{ + "shape":"Boolean", + "documentation":"Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).
", + "location":"querystring", + "locationName":"isCaller" + } + } + }, + "GetVoiceToneAnalysisTaskResponse":{ + "type":"structure", + "members":{ + "VoiceToneAnalysisTask":{ + "shape":"VoiceToneAnalysisTask", + "documentation":"The details of the voice tone analysis task.
" + } + } + }, + "GoneException":{ + "type":"structure", + "members":{ + }, + "documentation":"Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.
", + "error":{"httpStatusCode":410}, + "exception":true + }, + "GuidString":{ + "type":"string", + "pattern":"[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}" + }, + "Integer":{"type":"integer"}, + "Iso8601Timestamp":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "LanguageCode":{ + "type":"string", + "enum":["en-US"] + }, + "ListAvailableVoiceConnectorRegionsResponse":{ + "type":"structure", + "members":{ + "VoiceConnectorRegions":{ + "shape":"VoiceConnectorAwsRegionList", + "documentation":"The list of AWS Regions.
" + } + } + }, + "ListPhoneNumberOrdersRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"The token used to retrieve the next page of results.
", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"The maximum number of results to return in a single call.
", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListPhoneNumberOrdersResponse":{ + "type":"structure", + "members":{ + "PhoneNumberOrders":{ + "shape":"PhoneNumberOrderList", + "documentation":"The phone number order details.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token used to retrieve the next page of results.
" + } + } + }, + "ListPhoneNumbersRequest":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"The status of your organization's phone numbers.
", + "location":"querystring", + "locationName":"status" + }, + "ProductType":{ + "shape":"PhoneNumberProductType", + "documentation":"The phone number product types.
", + "location":"querystring", + "locationName":"product-type" + }, + "FilterName":{ + "shape":"PhoneNumberAssociationName", + "documentation":"The filter to limit the number of results.
", + "location":"querystring", + "locationName":"filter-name" + }, + "FilterValue":{ + "shape":"String", + "documentation":"The filter value.
", + "location":"querystring", + "locationName":"filter-value" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"The maximum number of results to return in a single call.
", + "location":"querystring", + "locationName":"max-results" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token used to return the next page of results.
", + "location":"querystring", + "locationName":"next-token" + } + } + }, + "ListPhoneNumbersResponse":{ + "type":"structure", + "members":{ + "PhoneNumbers":{ + "shape":"PhoneNumberList", + "documentation":"The phone number details.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token used to return the next page of results.
" + } + } + }, + "ListProxySessionsRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "Status":{ + "shape":"ProxySessionStatus", + "documentation":"The proxy session status.
", + "location":"querystring", + "locationName":"status" + }, + "NextToken":{ + "shape":"NextTokenString", + "documentation":"The token used to retrieve the next page of results.
", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"The maximum number of results to return in a single call.
", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListProxySessionsResponse":{ + "type":"structure", + "members":{ + "ProxySessions":{ + "shape":"ProxySessions", + "documentation":"The proxy sessions' details.
" + }, + "NextToken":{ + "shape":"NextTokenString", + "documentation":"The token used to retrieve the next page of results.
" + } + } + }, + "ListSipMediaApplicationsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ResultMax", + "documentation":"The maximum number of results to return in a single call. Defaults to 100.
", + "location":"querystring", + "locationName":"max-results" + }, + "NextToken":{ + "shape":"NextTokenString", + "documentation":"The token used to return the next page of results.
", + "location":"querystring", + "locationName":"next-token" + } + } + }, + "ListSipMediaApplicationsResponse":{ + "type":"structure", + "members":{ + "SipMediaApplications":{ + "shape":"SipMediaApplicationList", + "documentation":"The list of SIP media applications and application details.
" + }, + "NextToken":{ + "shape":"NextTokenString", + "documentation":"The token used to return the next page of results.
" + } + } + }, + "ListSipRulesRequest":{ + "type":"structure", + "members":{ + "SipMediaApplicationId":{ + "shape":"NonEmptyString", + "documentation":"The SIP media application ID.
", + "location":"querystring", + "locationName":"sip-media-application" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"The maximum number of results to return in a single call. Defaults to 100.
", + "location":"querystring", + "locationName":"max-results" + }, + "NextToken":{ + "shape":"NextTokenString", + "documentation":"The token used to return the next page of results.
", + "location":"querystring", + "locationName":"next-token" + } + } + }, + "ListSipRulesResponse":{ + "type":"structure", + "members":{ + "SipRules":{ + "shape":"SipRuleList", + "documentation":"The list of SIP rules and details.
" + }, + "NextToken":{ + "shape":"NextTokenString", + "documentation":"The token used to return the next page of results.
" + } + } + }, + "ListSupportedPhoneNumberCountriesRequest":{ + "type":"structure", + "required":["ProductType"], + "members":{ + "ProductType":{ + "shape":"PhoneNumberProductType", + "documentation":"The phone number product type.
", + "location":"querystring", + "locationName":"product-type" + } + } + }, + "ListSupportedPhoneNumberCountriesResponse":{ + "type":"structure", + "members":{ + "PhoneNumberCountries":{ + "shape":"PhoneNumberCountriesList", + "documentation":"The supported phone number countries.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"Arn", + "documentation":"The resource ARN.
", + "location":"querystring", + "locationName":"arn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"The tags in the list.
" + } + } + }, + "ListVoiceConnectorGroupsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"The token used to return the next page of results.
", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"The maximum number of results to return in a single call.
", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListVoiceConnectorGroupsResponse":{ + "type":"structure", + "members":{ + "VoiceConnectorGroups":{ + "shape":"VoiceConnectorGroupList", + "documentation":"The details of the Voice Connector groups.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token used to return the next page of results.
" + } + } + }, + "ListVoiceConnectorTerminationCredentialsRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "ListVoiceConnectorTerminationCredentialsResponse":{ + "type":"structure", + "members":{ + "Usernames":{ + "shape":"SensitiveStringList", + "documentation":"A list of user names.
" + } + } + }, + "ListVoiceConnectorsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"The token used to return the next page of results.
", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"The maximum number of results to return in a single call.
", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListVoiceConnectorsResponse":{ + "type":"structure", + "members":{ + "VoiceConnectors":{ + "shape":"VoiceConnectorList", + "documentation":"The details of the Voice Connectors.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token used to return the next page of results.
" + } + } + }, + "ListVoiceProfileDomainsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"The token used to return the next page of results.
", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"The maximum number of results to return in a single call.
", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListVoiceProfileDomainsResponse":{ + "type":"structure", + "members":{ + "VoiceProfileDomains":{ + "shape":"VoiceProfileDomainSummaryList", + "documentation":"The list of voice profile domains.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token used to return the next page of results.
" + } + } + }, + "ListVoiceProfilesRequest":{ + "type":"structure", + "required":["VoiceProfileDomainId"], + "members":{ + "VoiceProfileDomainId":{ + "shape":"NonEmptyString256", + "documentation":"The ID of the voice profile domain.
", + "location":"querystring", + "locationName":"voice-profile-domain-id" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token used to retrieve the next page of results.
", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"The maximum number of results in the request.
", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListVoiceProfilesResponse":{ + "type":"structure", + "members":{ + "VoiceProfiles":{ + "shape":"VoiceProfileSummaryList", + "documentation":"The list of voice profiles.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token used to retrieve the next page of results.
" + } + } + }, + "LoggingConfiguration":{ + "type":"structure", + "members":{ + "EnableSIPLogs":{ + "shape":"Boolean", + "documentation":"Boolean that enables sending SIP message logs to Amazon CloudWatch.
" + }, + "EnableMediaMetricLogs":{ + "shape":"Boolean", + "documentation":"Enables or disables media metrics logging.
" + } + }, + "documentation":"The logging configuration associated with an Amazon Chime SDK Voice Connector. Specifies whether SIP message logs can be sent to Amazon CloudWatch Logs.
" + }, + "MediaInsightsConfiguration":{ + "type":"structure", + "members":{ + "Disabled":{ + "shape":"Boolean", + "documentation":"Denotes the configuration as enabled or disabled.
" + }, + "ConfigurationArn":{ + "shape":"Arn", + "documentation":"The configuration's ARN.
" + } + }, + "documentation":"The configuration for a call analytics task.
" + }, + "NextTokenString":{ + "type":"string", + "max":65535 + }, + "NonEmptyString":{ + "type":"string", + "pattern":".*\\S.*" + }, + "NonEmptyString128":{ + "type":"string", + "max":128, + "min":1, + "pattern":".*\\S.*" + }, + "NonEmptyString256":{ + "type":"string", + "max":256, + "min":1, + "pattern":".*\\S.*" + }, + "NonEmptyStringList":{ + "type":"list", + "member":{"shape":"String"}, + "min":1 + }, + "NotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"The requested resource couldn't be found.
", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NotificationTarget":{ + "type":"string", + "enum":[ + "EventBridge", + "SNS", + "SQS" + ] + }, + "NullableBoolean":{"type":"boolean"}, + "NumberSelectionBehavior":{ + "type":"string", + "enum":[ + "PreferSticky", + "AvoidSticky" + ] + }, + "OrderedPhoneNumber":{ + "type":"structure", + "members":{ + "E164PhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"The phone number, in E.164 format.
" + }, + "Status":{ + "shape":"OrderedPhoneNumberStatus", + "documentation":"The phone number status.
" + } + }, + "documentation":"A phone number for which an order has been placed.
" + }, + "OrderedPhoneNumberList":{ + "type":"list", + "member":{"shape":"OrderedPhoneNumber"} + }, + "OrderedPhoneNumberStatus":{ + "type":"string", + "enum":[ + "Processing", + "Acquired", + "Failed" + ] + }, + "Origination":{ + "type":"structure", + "members":{ + "Routes":{ + "shape":"OriginationRouteList", + "documentation":"The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or Disabled.
When origination settings are disabled, inbound calls are not enabled for your Amazon Chime SDK Voice Connector. This parameter is not required, but you must specify this parameter or Routes.
Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime SDK Voice Connector.
The parameters listed below are not required, but you must use at least one.
The FQDN or IP address to contact for origination traffic.
" + }, + "Port":{ + "shape":"Port", + "documentation":"The designated origination route port. Defaults to 5060.
" + }, + "Protocol":{ + "shape":"OriginationRouteProtocol", + "documentation":"The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default.
" + }, + "Priority":{ + "shape":"OriginationRoutePriority", + "documentation":"The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
" + }, + "Weight":{ + "shape":"OriginationRouteWeight", + "documentation":"The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights.
" + } + }, + "documentation":"Origination routes define call distribution properties for your SIP hosts to receive inbound calls using an Amazon Chime SDK Voice Connector. Limit: Ten origination routes for each Voice Connector.
The parameters listed below are not required, but you must use at least one.
The participant's phone number.
" + }, + "ProxyPhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"The participant's proxy phone number.
" + } + }, + "documentation":"The phone number and proxy phone number for a participant in an Amazon Chime SDK Voice Connector proxy session.
" + }, + "ParticipantPhoneNumberList":{ + "type":"list", + "member":{"shape":"E164PhoneNumber"}, + "max":2, + "min":2 + }, + "Participants":{ + "type":"list", + "member":{"shape":"Participant"} + }, + "PhoneNumber":{ + "type":"structure", + "members":{ + "PhoneNumberId":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The phone number's ID.
" + }, + "E164PhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"The phone number, in E.164 format.
" + }, + "Country":{ + "shape":"Alpha2CountryCode", + "documentation":"The phone number's country. Format: ISO 3166-1 alpha-2.
" + }, + "Type":{ + "shape":"PhoneNumberType", + "documentation":"The phone number's type.
" + }, + "ProductType":{ + "shape":"PhoneNumberProductType", + "documentation":"The phone number's product type.
" + }, + "Status":{ + "shape":"PhoneNumberStatus", + "documentation":"The phone number's status.
" + }, + "Capabilities":{ + "shape":"PhoneNumberCapabilities", + "documentation":"The phone number's capabilities.
" + }, + "Associations":{ + "shape":"PhoneNumberAssociationList", + "documentation":"The phone number's associations.
" + }, + "CallingName":{ + "shape":"CallingName", + "documentation":"The outbound calling name associated with the phone number.
" + }, + "CallingNameStatus":{ + "shape":"CallingNameStatus", + "documentation":"The outbound calling name status.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The phone number creation timestamp, in ISO 8601 format.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The updated phone number timestamp, in ISO 8601 format.
" + }, + "DeletionTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The deleted phone number timestamp, in ISO 8601 format.
" + }, + "OrderId":{ + "shape":"GuidString", + "documentation":"The phone number's order ID.
" + }, + "Name":{ + "shape":"PhoneNumberName", + "documentation":"The name of the phone number.
" + } + }, + "documentation":"A phone number used to call an Amazon Chime SDK Voice Connector.
" + }, + "PhoneNumberAssociation":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"Contains the ID for the entity specified in Name.
" + }, + "Name":{ + "shape":"PhoneNumberAssociationName", + "documentation":"Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.
" + }, + "AssociatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The timestamp of the phone number association, in ISO 8601 format.
" + } + }, + "documentation":"The phone number associations, such as an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.
" + }, + "PhoneNumberAssociationList":{ + "type":"list", + "member":{"shape":"PhoneNumberAssociation"} + }, + "PhoneNumberAssociationName":{ + "type":"string", + "enum":[ + "VoiceConnectorId", + "VoiceConnectorGroupId", + "SipRuleId" + ] + }, + "PhoneNumberCapabilities":{ + "type":"structure", + "members":{ + "InboundCall":{ + "shape":"NullableBoolean", + "documentation":"Allows or denies inbound calling for the specified phone number.
" + }, + "OutboundCall":{ + "shape":"NullableBoolean", + "documentation":"Allows or denies outbound calling for the specified phone number.
" + }, + "InboundSMS":{ + "shape":"NullableBoolean", + "documentation":"Allows or denies inbound SMS messaging for the specified phone number.
" + }, + "OutboundSMS":{ + "shape":"NullableBoolean", + "documentation":"Allows or denies outbound SMS messaging for the specified phone number.
" + }, + "InboundMMS":{ + "shape":"NullableBoolean", + "documentation":"Allows or denies inbound MMS messaging for the specified phone number.
" + }, + "OutboundMMS":{ + "shape":"NullableBoolean", + "documentation":"Allows or denies inbound MMS messaging for the specified phone number.
" + } + }, + "documentation":"The phone number capabilities for Amazon Chime SDK phone numbers, such as enabled inbound and outbound calling, and text messaging.
" + }, + "PhoneNumberCountriesList":{ + "type":"list", + "member":{"shape":"PhoneNumberCountry"} + }, + "PhoneNumberCountry":{ + "type":"structure", + "members":{ + "CountryCode":{ + "shape":"Alpha2CountryCode", + "documentation":"The phone number country code. Format: ISO 3166-1 alpha-2.
" + }, + "SupportedPhoneNumberTypes":{ + "shape":"PhoneNumberTypeList", + "documentation":"The supported phone number types.
" + } + }, + "documentation":"The phone number's country.
" + }, + "PhoneNumberError":{ + "type":"structure", + "members":{ + "PhoneNumberId":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The phone number ID for which the action failed.
" + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"The error code.
" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"The error message.
" + } + }, + "documentation":"If a phone number action fails for one or more of the phone numbers in a request, a list of the failed phone numbers is returned, along with error codes and error messages.
" + }, + "PhoneNumberErrorList":{ + "type":"list", + "member":{"shape":"PhoneNumberError"} + }, + "PhoneNumberList":{ + "type":"list", + "member":{"shape":"PhoneNumber"} + }, + "PhoneNumberMaxResults":{ + "type":"integer", + "max":500, + "min":1 + }, + "PhoneNumberName":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^$|^[a-zA-Z0-9\\,\\.\\_\\-]+(\\s+[a-zA-Z0-9\\,\\.\\_\\-]+)*$", + "sensitive":true + }, + "PhoneNumberOrder":{ + "type":"structure", + "members":{ + "PhoneNumberOrderId":{ + "shape":"GuidString", + "documentation":"The ID of the phone order.
" + }, + "ProductType":{ + "shape":"PhoneNumberProductType", + "documentation":"The phone number order product type.
" + }, + "Status":{ + "shape":"PhoneNumberOrderStatus", + "documentation":"The status of the phone number order.
" + }, + "OrderType":{ + "shape":"PhoneNumberOrderType", + "documentation":"The type of phone number being ordered, local or toll-free.
" + }, + "OrderedPhoneNumbers":{ + "shape":"OrderedPhoneNumberList", + "documentation":"The ordered phone number details, such as the phone number in E.164 format and the phone number status.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The phone number order creation time stamp, in ISO 8601 format.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The updated phone number order time stamp, in ISO 8601 format.
" + } + }, + "documentation":"The details of an Amazon Chime SDK phone number order.
" + }, + "PhoneNumberOrderList":{ + "type":"list", + "member":{"shape":"PhoneNumberOrder"} + }, + "PhoneNumberOrderStatus":{ + "type":"string", + "enum":[ + "Processing", + "Successful", + "Failed", + "Partial", + "PendingDocuments", + "Submitted", + "FOC", + "ChangeRequested", + "Exception", + "CancelRequested", + "Cancelled" + ] + }, + "PhoneNumberOrderType":{ + "type":"string", + "enum":[ + "New", + "Porting" + ] + }, + "PhoneNumberProductType":{ + "type":"string", + "enum":[ + "VoiceConnector", + "SipMediaApplicationDialIn" + ] + }, + "PhoneNumberStatus":{ + "type":"string", + "enum":[ + "Cancelled", + "PortinCancelRequested", + "PortinInProgress", + "AcquireInProgress", + "AcquireFailed", + "Unassigned", + "Assigned", + "ReleaseInProgress", + "DeleteInProgress", + "ReleaseFailed", + "DeleteFailed" + ] + }, + "PhoneNumberType":{ + "type":"string", + "enum":[ + "Local", + "TollFree" + ] + }, + "PhoneNumberTypeList":{ + "type":"list", + "member":{"shape":"PhoneNumberType"} + }, + "Port":{ + "type":"integer", + "max":65535, + "min":0 + }, + "PositiveInteger":{ + "type":"integer", + "min":1 + }, + "Proxy":{ + "type":"structure", + "members":{ + "DefaultSessionExpiryMinutes":{ + "shape":"Integer", + "documentation":"The default number of minutes allowed for proxy sessions.
" + }, + "Disabled":{ + "shape":"Boolean", + "documentation":"When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.
" + }, + "FallBackPhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"The phone number to route calls to after a proxy session expires.
" + }, + "PhoneNumberCountries":{ + "shape":"StringList", + "documentation":"The countries for proxy phone numbers to be selected from.
" + } + }, + "documentation":"The proxy configuration for an Amazon Chime SDK Voice Connector.
" + }, + "ProxySession":{ + "type":"structure", + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
" + }, + "ProxySessionId":{ + "shape":"NonEmptyString128", + "documentation":"The proxy session ID.
" + }, + "Name":{ + "shape":"String128", + "documentation":"The proxy session name.
" + }, + "Status":{ + "shape":"ProxySessionStatus", + "documentation":"The proxy session status.
" + }, + "ExpiryMinutes":{ + "shape":"PositiveInteger", + "documentation":"The number of minutes allowed for the proxy session.
" + }, + "Capabilities":{ + "shape":"CapabilityList", + "documentation":"The proxy session capabilities.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The created time stamp, in ISO 8601 format.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The updated time stamp, in ISO 8601 format.
" + }, + "EndedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The ended time stamp, in ISO 8601 format.
" + }, + "Participants":{ + "shape":"Participants", + "documentation":"The proxy session participants.
" + }, + "NumberSelectionBehavior":{ + "shape":"NumberSelectionBehavior", + "documentation":"The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
" + }, + "GeoMatchLevel":{ + "shape":"GeoMatchLevel", + "documentation":"The preference for matching the country or area code of the proxy phone number with that of the first participant.
" + }, + "GeoMatchParams":{ + "shape":"GeoMatchParams", + "documentation":"The country and area code for the proxy phone number.
" + } + }, + "documentation":"The proxy session for an Amazon Chime SDK Voice Connector.
" + }, + "ProxySessionNameString":{ + "type":"string", + "pattern":"^$|^[a-zA-Z0-9 ]{0,30}$", + "sensitive":true + }, + "ProxySessionStatus":{ + "type":"string", + "enum":[ + "Open", + "InProgress", + "Closed" + ] + }, + "ProxySessions":{ + "type":"list", + "member":{"shape":"ProxySession"} + }, + "PutSipMediaApplicationAlexaSkillConfigurationRequest":{ + "type":"structure", + "required":["SipMediaApplicationId"], + "members":{ + "SipMediaApplicationId":{ + "shape":"NonEmptyString", + "documentation":"The SIP media application ID.
", + "location":"uri", + "locationName":"sipMediaApplicationId" + }, + "SipMediaApplicationAlexaSkillConfiguration":{ + "shape":"SipMediaApplicationAlexaSkillConfiguration", + "documentation":"The Alexa Skill configuration.
" + } + } + }, + "PutSipMediaApplicationAlexaSkillConfigurationResponse":{ + "type":"structure", + "members":{ + "SipMediaApplicationAlexaSkillConfiguration":{ + "shape":"SipMediaApplicationAlexaSkillConfiguration", + "documentation":"Returns the Alexa Skill configuration.
" + } + } + }, + "PutSipMediaApplicationLoggingConfigurationRequest":{ + "type":"structure", + "required":["SipMediaApplicationId"], + "members":{ + "SipMediaApplicationId":{ + "shape":"NonEmptyString", + "documentation":"The SIP media application ID.
", + "location":"uri", + "locationName":"sipMediaApplicationId" + }, + "SipMediaApplicationLoggingConfiguration":{ + "shape":"SipMediaApplicationLoggingConfiguration", + "documentation":"The logging configuration for the specified SIP media application.
" + } + } + }, + "PutSipMediaApplicationLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + "SipMediaApplicationLoggingConfiguration":{ + "shape":"SipMediaApplicationLoggingConfiguration", + "documentation":"The updated logging configuration for the specified SIP media application.
" + } + } + }, + "PutVoiceConnectorEmergencyCallingConfigurationRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "EmergencyCallingConfiguration" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "EmergencyCallingConfiguration":{ + "shape":"EmergencyCallingConfiguration", + "documentation":"The configuration being updated.
" + } + } + }, + "PutVoiceConnectorEmergencyCallingConfigurationResponse":{ + "type":"structure", + "members":{ + "EmergencyCallingConfiguration":{ + "shape":"EmergencyCallingConfiguration", + "documentation":"The updated configuration.
" + } + } + }, + "PutVoiceConnectorLoggingConfigurationRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "LoggingConfiguration" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "LoggingConfiguration":{ + "shape":"LoggingConfiguration", + "documentation":"The logging configuration being updated.
" + } + } + }, + "PutVoiceConnectorLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + "LoggingConfiguration":{ + "shape":"LoggingConfiguration", + "documentation":"The updated logging configuration.
" + } + } + }, + "PutVoiceConnectorOriginationRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "Origination" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "Origination":{ + "shape":"Origination", + "documentation":"The origination settings being updated.
" + } + } + }, + "PutVoiceConnectorOriginationResponse":{ + "type":"structure", + "members":{ + "Origination":{ + "shape":"Origination", + "documentation":"The updated origination settings.
" + } + } + }, + "PutVoiceConnectorProxyRequest":{ + "type":"structure", + "required":[ + "DefaultSessionExpiryMinutes", + "PhoneNumberPoolCountries", + "VoiceConnectorId" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "DefaultSessionExpiryMinutes":{ + "shape":"Integer", + "documentation":"The default number of minutes allowed for proxy session.
" + }, + "PhoneNumberPoolCountries":{ + "shape":"CountryList", + "documentation":"The countries for proxy phone numbers to be selected from.
" + }, + "FallBackPhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"The phone number to route calls to after a proxy session expires.
" + }, + "Disabled":{ + "shape":"Boolean", + "documentation":"When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.
" + } + } + }, + "PutVoiceConnectorProxyResponse":{ + "type":"structure", + "members":{ + "Proxy":{ + "shape":"Proxy", + "documentation":"The proxy configuration details.
" + } + } + }, + "PutVoiceConnectorStreamingConfigurationRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "StreamingConfiguration" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "StreamingConfiguration":{ + "shape":"StreamingConfiguration", + "documentation":"The streaming settings being updated.
" + } + } + }, + "PutVoiceConnectorStreamingConfigurationResponse":{ + "type":"structure", + "members":{ + "StreamingConfiguration":{ + "shape":"StreamingConfiguration", + "documentation":"The updated streaming settings.
" + } + } + }, + "PutVoiceConnectorTerminationCredentialsRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "Credentials":{ + "shape":"CredentialList", + "documentation":"The termination credentials being updated.
" + } + } + }, + "PutVoiceConnectorTerminationRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "Termination" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "Termination":{ + "shape":"Termination", + "documentation":"The termination settings to be updated.
" + } + } + }, + "PutVoiceConnectorTerminationResponse":{ + "type":"structure", + "members":{ + "Termination":{ + "shape":"Termination", + "documentation":"The updated termination settings.
" + } + } + }, + "ResourceLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"The request exceeds the resource limit.
", + "error":{"httpStatusCode":400}, + "exception":true + }, + "RestorePhoneNumberRequest":{ + "type":"structure", + "required":["PhoneNumberId"], + "members":{ + "PhoneNumberId":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The ID of the phone number being restored.
", + "location":"uri", + "locationName":"phoneNumberId" + } + } + }, + "RestorePhoneNumberResponse":{ + "type":"structure", + "members":{ + "PhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The restored phone number.
" + } + } + }, + "ResultMax":{ + "type":"integer", + "max":100, + "min":1 + }, + "SMACreateCallArgumentsMap":{ + "type":"map", + "key":{"shape":"SensitiveString"}, + "value":{"shape":"SensitiveString"}, + "max":20, + "min":0 + }, + "SMAUpdateCallArgumentsMap":{ + "type":"map", + "key":{"shape":"SensitiveString"}, + "value":{"shape":"SensitiveString"}, + "max":20, + "min":0 + }, + "SearchAvailablePhoneNumbersRequest":{ + "type":"structure", + "members":{ + "AreaCode":{ + "shape":"String", + "documentation":"Confines a search to just the phone numbers associated with the specified area code.
", + "location":"querystring", + "locationName":"area-code" + }, + "City":{ + "shape":"String", + "documentation":"Confines a search to just the phone numbers associated with the specified city.
", + "location":"querystring", + "locationName":"city" + }, + "Country":{ + "shape":"Alpha2CountryCode", + "documentation":"Confines a search to just the phone numbers associated with the specified country.
", + "location":"querystring", + "locationName":"country" + }, + "State":{ + "shape":"String", + "documentation":"Confines a search to just the phone numbers associated with the specified state.
", + "location":"querystring", + "locationName":"state" + }, + "TollFreePrefix":{ + "shape":"TollFreePrefix", + "documentation":"Confines a search to just the phone numbers associated with the specified toll-free prefix.
", + "location":"querystring", + "locationName":"toll-free-prefix" + }, + "PhoneNumberType":{ + "shape":"PhoneNumberType", + "documentation":"Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.
", + "location":"querystring", + "locationName":"phone-number-type" + }, + "MaxResults":{ + "shape":"PhoneNumberMaxResults", + "documentation":"The maximum number of results to return.
", + "location":"querystring", + "locationName":"max-results" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token used to return the next page of results.
", + "location":"querystring", + "locationName":"next-token" + } + } + }, + "SearchAvailablePhoneNumbersResponse":{ + "type":"structure", + "members":{ + "E164PhoneNumbers":{ + "shape":"E164PhoneNumberList", + "documentation":"Confines a search to just the phone numbers in the E.164 format.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token used to return the next page of results.
" + } + } + }, + "SensitiveNonEmptyString":{ + "type":"string", + "pattern":".*\\S.*", + "sensitive":true + }, + "SensitiveString":{ + "type":"string", + "sensitive":true + }, + "SensitiveStringList":{ + "type":"list", + "member":{"shape":"SensitiveString"} + }, + "ServerSideEncryptionConfiguration":{ + "type":"structure", + "required":["KmsKeyArn"], + "members":{ + "KmsKeyArn":{ + "shape":"Arn", + "documentation":"The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported.
" + } + }, + "documentation":"A structure that contains the configuration settings for server-side encryption.
We only support symmetric keys. Do not use asymmetric or HMAC keys, or KMS aliases.
The service encountered an unexpected error.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + }, + "documentation":"The service is currently unavailable.
", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "SipApplicationPriority":{ + "type":"integer", + "min":1 + }, + "SipHeadersMap":{ + "type":"map", + "key":{"shape":"SensitiveString"}, + "value":{"shape":"SensitiveString"}, + "max":20, + "min":0 + }, + "SipMediaApplication":{ + "type":"structure", + "members":{ + "SipMediaApplicationId":{ + "shape":"NonEmptyString", + "documentation":"A SIP media application's ID.
" + }, + "AwsRegion":{ + "shape":"String", + "documentation":"The AWS Region in which the SIP media application is created.
" + }, + "Name":{ + "shape":"SipMediaApplicationName", + "documentation":"The SIP media application's name.
" + }, + "Endpoints":{ + "shape":"SipMediaApplicationEndpointList", + "documentation":"List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The SIP media application creation timestamp, in ISO 8601 format.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the SIP media application was updated.
" + }, + "SipMediaApplicationArn":{ + "shape":"NonEmptyString", + "documentation":"The ARN of the SIP media application.
" + } + }, + "documentation":"The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications.
" + }, + "SipMediaApplicationAlexaSkillConfiguration":{ + "type":"structure", + "required":[ + "AlexaSkillStatus", + "AlexaSkillIds" + ], + "members":{ + "AlexaSkillStatus":{ + "shape":"AlexaSkillStatus", + "documentation":"The status of the Alexa Skill configuration.
" + }, + "AlexaSkillIds":{ + "shape":"AlexaSkillIdList", + "documentation":"The ID of the Alexa Skill configuration.
" + } + }, + "documentation":"The Alexa Skill configuration of a SIP media application.
Due to changes made by the Amazon Alexa service, this data type is no longer available for use. For more information, refer to the Alexa Smart Properties page.
The call's transaction ID.
" + } + }, + "documentation":"A Call instance for a SIP media application.
Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.
" + } + }, + "documentation":"The endpoint assigned to a SIP media application.
" + }, + "SipMediaApplicationEndpointList":{ + "type":"list", + "member":{"shape":"SipMediaApplicationEndpoint"}, + "max":1, + "min":1 + }, + "SipMediaApplicationList":{ + "type":"list", + "member":{"shape":"SipMediaApplication"} + }, + "SipMediaApplicationLoggingConfiguration":{ + "type":"structure", + "members":{ + "EnableSipMediaApplicationMessageLogs":{ + "shape":"Boolean", + "documentation":"Enables message logging for the specified SIP media application.
" + } + }, + "documentation":"The logging configuration of a SIP media application.
" + }, + "SipMediaApplicationName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9 _.-]+" + }, + "SipRule":{ + "type":"structure", + "members":{ + "SipRuleId":{ + "shape":"NonEmptyString", + "documentation":"A SIP rule's ID.
" + }, + "Name":{ + "shape":"SipRuleName", + "documentation":"A SIP rule's name.
" + }, + "Disabled":{ + "shape":"Boolean", + "documentation":"Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
" + }, + "TriggerType":{ + "shape":"SipRuleTriggerType", + "documentation":"The type of trigger set for a SIP rule, either a phone number or a URI request host name.
" + }, + "TriggerValue":{ + "shape":"NonEmptyString", + "documentation":"The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.
" + }, + "TargetApplications":{ + "shape":"SipRuleTargetApplicationList", + "documentation":"The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the SIP rule was created, in ISO 8601 format.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the SIP rule was updated, in ISO 8601 format.
" + } + }, + "documentation":"The details of a SIP rule, including name, triggers, and target applications. An AWS account can have multiple SIP rules.
" + }, + "SipRuleList":{ + "type":"list", + "member":{"shape":"SipRule"} + }, + "SipRuleName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9 _.-]+" + }, + "SipRuleTargetApplication":{ + "type":"structure", + "members":{ + "SipMediaApplicationId":{ + "shape":"NonEmptyString", + "documentation":"The ID of a rule's target SIP media application.
" + }, + "Priority":{ + "shape":"SipApplicationPriority", + "documentation":"The priority setting of a rule's target SIP media application.
" + }, + "AwsRegion":{ + "shape":"String", + "documentation":"The AWS Region of a rule's target SIP media application.
" + } + }, + "documentation":"A target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
" + }, + "SipRuleTargetApplicationList":{ + "type":"list", + "member":{"shape":"SipRuleTargetApplication"}, + "max":25, + "min":1 + }, + "SipRuleTriggerType":{ + "type":"string", + "enum":[ + "ToPhoneNumber", + "RequestUriHostname" + ] + }, + "SpeakerSearchDetails":{ + "type":"structure", + "members":{ + "Results":{ + "shape":"SpeakerSearchResultList", + "documentation":"The result value in the speaker search details.
" + }, + "VoiceprintGenerationStatus":{ + "shape":"NonEmptyString256", + "documentation":"The status of a voice print generation operation, VoiceprintGenerationSuccess or VoiceprintGenerationFailure..
The details of a speaker search task.
" + }, + "SpeakerSearchResult":{ + "type":"structure", + "members":{ + "ConfidenceScore":{ + "shape":"ConfidenceScore", + "documentation":"The confidence score in the speaker search analysis.
" + }, + "VoiceProfileId":{ + "shape":"NonEmptyString256", + "documentation":"The voice profile ID.
" + } + }, + "documentation":"The result of a speaker search analysis.
" + }, + "SpeakerSearchResultList":{ + "type":"list", + "member":{"shape":"SpeakerSearchResult"} + }, + "SpeakerSearchTask":{ + "type":"structure", + "members":{ + "SpeakerSearchTaskId":{ + "shape":"NonEmptyString256", + "documentation":"The speaker search task ID.
" + }, + "SpeakerSearchTaskStatus":{ + "shape":"NonEmptyString", + "documentation":"The status of the speaker search task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.
The call details of a speaker search task.
" + }, + "SpeakerSearchDetails":{ + "shape":"SpeakerSearchDetails", + "documentation":"The details of a speaker search task.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which a speaker search task was created.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which a speaker search task was updated.
" + }, + "StartedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the speaker search task began.
" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"A detailed message about the status of a speaker search.
" + } + }, + "documentation":"A representation of an asynchronous request to perform speaker search analysis on a Voice Connector call.
" + }, + "StartSpeakerSearchTaskRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "TransactionId", + "VoiceProfileDomainId" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"VoiceConnectorId" + }, + "TransactionId":{ + "shape":"NonEmptyString256", + "documentation":"The transaction ID of the call being analyzed.
" + }, + "VoiceProfileDomainId":{ + "shape":"NonEmptyString256", + "documentation":"The ID of the voice profile domain that will store the voice profile.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestId", + "documentation":"The unique identifier for the client request. Use a different token for different speaker search tasks.
" + }, + "CallLeg":{ + "shape":"CallLegType", + "documentation":"Specifies which call leg to stream for speaker search.
" + } + } + }, + "StartSpeakerSearchTaskResponse":{ + "type":"structure", + "members":{ + "SpeakerSearchTask":{ + "shape":"SpeakerSearchTask", + "documentation":"The details of the speaker search task.
" + } + } + }, + "StartVoiceToneAnalysisTaskRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "TransactionId", + "LanguageCode" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"VoiceConnectorId" + }, + "TransactionId":{ + "shape":"NonEmptyString256", + "documentation":"The transaction ID.
" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"The language code.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestId", + "documentation":"The unique identifier for the client request. Use a different token for different voice tone analysis tasks.
" + } + } + }, + "StartVoiceToneAnalysisTaskResponse":{ + "type":"structure", + "members":{ + "VoiceToneAnalysisTask":{ + "shape":"VoiceToneAnalysisTask", + "documentation":"The details of the voice tone analysis task.
" + } + } + }, + "StopSpeakerSearchTaskRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "SpeakerSearchTaskId" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"VoiceConnectorId" + }, + "SpeakerSearchTaskId":{ + "shape":"NonEmptyString256", + "documentation":"The speaker search task ID.
", + "location":"uri", + "locationName":"SpeakerSearchTaskId" + } + } + }, + "StopVoiceToneAnalysisTaskRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "VoiceToneAnalysisTaskId" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"VoiceConnectorId" + }, + "VoiceToneAnalysisTaskId":{ + "shape":"NonEmptyString256", + "documentation":"The ID of the voice tone analysis task.
", + "location":"uri", + "locationName":"VoiceToneAnalysisTaskId" + } + } + }, + "StreamingConfiguration":{ + "type":"structure", + "required":[ + "DataRetentionInHours", + "Disabled" + ], + "members":{ + "DataRetentionInHours":{ + "shape":"DataRetentionInHours", + "documentation":"The amount of time, in hours, to the Kinesis data.
" + }, + "Disabled":{ + "shape":"Boolean", + "documentation":"When true, streaming to Kinesis is off.
" + }, + "StreamingNotificationTargets":{ + "shape":"StreamingNotificationTargetList", + "documentation":"The streaming notification targets.
" + }, + "MediaInsightsConfiguration":{ + "shape":"MediaInsightsConfiguration", + "documentation":"The call analytics configuration.
" + } + }, + "documentation":"The streaming configuration associated with an Amazon Chime SDK Voice Connector. Specifies whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.
" + }, + "StreamingNotificationTarget":{ + "type":"structure", + "members":{ + "NotificationTarget":{ + "shape":"NotificationTarget", + "documentation":"The streaming notification target.
" + } + }, + "documentation":"The target recipient for a streaming configuration notification.
" + }, + "StreamingNotificationTargetList":{ + "type":"list", + "member":{"shape":"StreamingNotificationTarget"}, + "max":3, + "min":1 + }, + "String":{"type":"string"}, + "String128":{ + "type":"string", + "max":128 + }, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"The tag's key.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The tag's value.
" + } + }, + "documentation":"Describes a tag applied to a resource.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "sensitive":true + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{ + "shape":"Arn", + "documentation":"The ARN of the resource being tagged.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A list of the tags being added to the resource.
" + } + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "sensitive":true + }, + "Termination":{ + "type":"structure", + "members":{ + "CpsLimit":{ + "shape":"CpsLimit", + "documentation":"The limit on calls per second. Max value based on account service quota. Default value of 1.
" + }, + "DefaultPhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"The default outbound calling number.
" + }, + "CallingRegions":{ + "shape":"CallingRegionList", + "documentation":"The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
" + }, + "CidrAllowedList":{ + "shape":"StringList", + "documentation":"The IP addresses allowed to make calls, in CIDR format.
" + }, + "Disabled":{ + "shape":"Boolean", + "documentation":"When termination is disabled, outbound calls cannot be made.
" + } + }, + "documentation":"Termination settings enable SIP hosts to make outbound calls using an Amazon Chime SDK Voice Connector.
" + }, + "TerminationHealth":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The timestamp, in ISO 8601 format.
" + }, + "Source":{ + "shape":"String", + "documentation":"The source IP address.
" + } + }, + "documentation":"The termination health details, including the source IP address and timestamp of the last successful SIP OPTIONS message from your SIP infrastructure.
The number of customer requests exceeds the request rate limit.
", + "error":{"httpStatusCode":429}, + "exception":true + }, + "TollFreePrefix":{ + "type":"string", + "max":3, + "min":3, + "pattern":"^8(00|33|44|55|66|77|88)$" + }, + "UnauthorizedClientException":{ + "type":"structure", + "members":{ + }, + "documentation":"The client isn't authorized to request a resource.
", + "error":{"httpStatusCode":401}, + "exception":true + }, + "UnprocessableEntityException":{ + "type":"structure", + "members":{ + }, + "documentation":"A well-formed request couldn't be followed due to semantic errors.
", + "error":{"httpStatusCode":422}, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{ + "shape":"Arn", + "documentation":"The ARN of the resource having its tags removed.
" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"The keys of the tags being removed from the resource.
" + } + } + }, + "UpdateGlobalSettingsRequest":{ + "type":"structure", + "members":{ + "VoiceConnector":{ + "shape":"VoiceConnectorSettings", + "documentation":"The Voice Connector settings.
" + } + } + }, + "UpdatePhoneNumberRequest":{ + "type":"structure", + "required":["PhoneNumberId"], + "members":{ + "PhoneNumberId":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The phone number ID.
", + "location":"uri", + "locationName":"phoneNumberId" + }, + "ProductType":{ + "shape":"PhoneNumberProductType", + "documentation":"The product type.
" + }, + "CallingName":{ + "shape":"CallingName", + "documentation":"The outbound calling name associated with the phone number.
" + }, + "Name":{ + "shape":"PhoneNumberName", + "documentation":"Specifies the updated name assigned to one or more phone numbers.
" + } + } + }, + "UpdatePhoneNumberRequestItem":{ + "type":"structure", + "required":["PhoneNumberId"], + "members":{ + "PhoneNumberId":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The phone number ID to update.
" + }, + "ProductType":{ + "shape":"PhoneNumberProductType", + "documentation":"The product type to update.
" + }, + "CallingName":{ + "shape":"CallingName", + "documentation":"The outbound calling name to update.
" + }, + "Name":{ + "shape":"PhoneNumberName", + "documentation":"The name of the phone number.
" + } + }, + "documentation":"The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.
" + }, + "UpdatePhoneNumberRequestItemList":{ + "type":"list", + "member":{"shape":"UpdatePhoneNumberRequestItem"} + }, + "UpdatePhoneNumberResponse":{ + "type":"structure", + "members":{ + "PhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The updated phone number details.
" + } + } + }, + "UpdatePhoneNumberSettingsRequest":{ + "type":"structure", + "required":["CallingName"], + "members":{ + "CallingName":{ + "shape":"CallingName", + "documentation":"The default outbound calling name for the account.
" + } + } + }, + "UpdateProxySessionRequest":{ + "type":"structure", + "required":[ + "Capabilities", + "VoiceConnectorId", + "ProxySessionId" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "ProxySessionId":{ + "shape":"NonEmptyString128", + "documentation":"The proxy session ID.
", + "location":"uri", + "locationName":"proxySessionId" + }, + "Capabilities":{ + "shape":"CapabilityList", + "documentation":"The proxy session capabilities.
" + }, + "ExpiryMinutes":{ + "shape":"PositiveInteger", + "documentation":"The number of minutes allowed for the proxy session.
" + } + } + }, + "UpdateProxySessionResponse":{ + "type":"structure", + "members":{ + "ProxySession":{ + "shape":"ProxySession", + "documentation":"The updated proxy session details.
" + } + } + }, + "UpdateSipMediaApplicationCallRequest":{ + "type":"structure", + "required":[ + "SipMediaApplicationId", + "TransactionId", + "Arguments" + ], + "members":{ + "SipMediaApplicationId":{ + "shape":"NonEmptyString", + "documentation":"The ID of the SIP media application handling the call.
", + "location":"uri", + "locationName":"sipMediaApplicationId" + }, + "TransactionId":{ + "shape":"NonEmptyString", + "documentation":"The ID of the call transaction.
", + "location":"uri", + "locationName":"transactionId" + }, + "Arguments":{ + "shape":"SMAUpdateCallArgumentsMap", + "documentation":"Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.
A Call instance for a SIP media application.
The SIP media application ID.
", + "location":"uri", + "locationName":"sipMediaApplicationId" + }, + "Name":{ + "shape":"SipMediaApplicationName", + "documentation":"The new name for the specified SIP media application.
" + }, + "Endpoints":{ + "shape":"SipMediaApplicationEndpointList", + "documentation":"The new set of endpoints for the specified SIP media application.
" + } + } + }, + "UpdateSipMediaApplicationResponse":{ + "type":"structure", + "members":{ + "SipMediaApplication":{ + "shape":"SipMediaApplication", + "documentation":"The updated SIP media application’s details.
" + } + } + }, + "UpdateSipRuleRequest":{ + "type":"structure", + "required":[ + "SipRuleId", + "Name" + ], + "members":{ + "SipRuleId":{ + "shape":"NonEmptyString", + "documentation":"The SIP rule ID.
", + "location":"uri", + "locationName":"sipRuleId" + }, + "Name":{ + "shape":"SipRuleName", + "documentation":"The new name for the specified SIP rule.
" + }, + "Disabled":{ + "shape":"NullableBoolean", + "documentation":"The new value that indicates whether the rule is disabled.
" + }, + "TargetApplications":{ + "shape":"SipRuleTargetApplicationList", + "documentation":"The new list of target applications.
" + } + } + }, + "UpdateSipRuleResponse":{ + "type":"structure", + "members":{ + "SipRule":{ + "shape":"SipRule", + "documentation":"The updated SIP rule details.
" + } + } + }, + "UpdateVoiceConnectorGroupRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorGroupId", + "Name", + "VoiceConnectorItems" + ], + "members":{ + "VoiceConnectorGroupId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorGroupId" + }, + "Name":{ + "shape":"VoiceConnectorGroupName", + "documentation":"The name of the Voice Connector group.
" + }, + "VoiceConnectorItems":{ + "shape":"VoiceConnectorItemList", + "documentation":"The VoiceConnectorItems to associate with the Voice Connector group.
The updated Voice Connector group.
" + } + } + }, + "UpdateVoiceConnectorRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "Name", + "RequireEncryption" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "Name":{ + "shape":"VoiceConnectorName", + "documentation":"The name of the Voice Connector.
" + }, + "RequireEncryption":{ + "shape":"Boolean", + "documentation":"When enabled, requires encryption for the Voice Connector.
" + } + } + }, + "UpdateVoiceConnectorResponse":{ + "type":"structure", + "members":{ + "VoiceConnector":{ + "shape":"VoiceConnector", + "documentation":"The updated Voice Connector details.
" + } + } + }, + "UpdateVoiceProfileDomainRequest":{ + "type":"structure", + "required":["VoiceProfileDomainId"], + "members":{ + "VoiceProfileDomainId":{ + "shape":"NonEmptyString256", + "documentation":"The domain ID.
", + "location":"uri", + "locationName":"VoiceProfileDomainId" + }, + "Name":{ + "shape":"VoiceProfileDomainName", + "documentation":"The name of the voice profile domain.
" + }, + "Description":{ + "shape":"VoiceProfileDomainDescription", + "documentation":"The description of the voice profile domain.
" + } + } + }, + "UpdateVoiceProfileDomainResponse":{ + "type":"structure", + "members":{ + "VoiceProfileDomain":{ + "shape":"VoiceProfileDomain", + "documentation":"The updated details of the voice profile domain.
" + } + } + }, + "UpdateVoiceProfileRequest":{ + "type":"structure", + "required":[ + "VoiceProfileId", + "SpeakerSearchTaskId" + ], + "members":{ + "VoiceProfileId":{ + "shape":"NonEmptyString256", + "documentation":"The profile ID.
", + "location":"uri", + "locationName":"VoiceProfileId" + }, + "SpeakerSearchTaskId":{ + "shape":"NonEmptyString256", + "documentation":"The ID of the speaker search task.
" + } + } + }, + "UpdateVoiceProfileResponse":{ + "type":"structure", + "members":{ + "VoiceProfile":{ + "shape":"VoiceProfile", + "documentation":"The updated voice profile settings.
" + } + } + }, + "ValidateE911AddressRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "StreetNumber", + "StreetInfo", + "City", + "State", + "Country", + "PostalCode" + ], + "members":{ + "AwsAccountId":{ + "shape":"NonEmptyString", + "documentation":"The AWS account ID.
" + }, + "StreetNumber":{ + "shape":"SensitiveNonEmptyString", + "documentation":"The address street number, such as 200 or 2121.
The address street information, such as 8th Avenue.
The address city, such as Portland.
The address state, such as ME.
The country in the address being validated as two-letter country code in ISO 3166-1 alpha-2 format, such as US. For more information, see ISO 3166-1 alpha-2 in Wikipedia.
The dress postal code, such 04352.
Number indicating the result of address validation.
Each possible result is defined as follows:
0 - Address validation succeeded.
1 - Address validation succeeded. The address was a close enough match and has been corrected as part of the address object.
2 - Address validation failed. You should re-submit the validation request with candidates from the CandidateAddressList result, if it's a close match.
The ID that represents the address.
" + }, + "Address":{ + "shape":"Address", + "documentation":"The validated address.
" + }, + "CandidateAddressList":{ + "shape":"CandidateAddressList", + "documentation":"The list of address suggestions..
" + } + } + }, + "ValidationResult":{ + "type":"integer", + "max":2, + "min":0 + }, + "VoiceConnector":{ + "type":"structure", + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector's ID.
" + }, + "AwsRegion":{ + "shape":"VoiceConnectorAwsRegion", + "documentation":"The AWS Region in which the Voice Connector is created. Default: us-east-1.
" + }, + "Name":{ + "shape":"VoiceConnectorName", + "documentation":"The Voice Connector's name.
" + }, + "OutboundHostName":{ + "shape":"String", + "documentation":"The outbound host name for the Voice Connector.
" + }, + "RequireEncryption":{ + "shape":"Boolean", + "documentation":"Enables or disables encryption for the Voice Connector.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The Voice Connector's creation timestamp, in ISO 8601 format.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The Voice Connector's updated timestamp, in ISO 8601 format.
" + }, + "VoiceConnectorArn":{ + "shape":"NonEmptyString", + "documentation":"The ARN of the Voice Connector.
" + } + }, + "documentation":"The Amazon Chime SDK Voice Connector configuration, including outbound host name and encryption settings.
" + }, + "VoiceConnectorAwsRegion":{ + "type":"string", + "enum":[ + "us-east-1", + "us-west-2", + "ca-central-1", + "eu-central-1", + "eu-west-1", + "eu-west-2", + "ap-northeast-2", + "ap-northeast-1", + "ap-southeast-1", + "ap-southeast-2" + ] + }, + "VoiceConnectorAwsRegionList":{ + "type":"list", + "member":{"shape":"VoiceConnectorAwsRegion"} + }, + "VoiceConnectorGroup":{ + "type":"structure", + "members":{ + "VoiceConnectorGroupId":{ + "shape":"NonEmptyString", + "documentation":"The ID of a Voice Connector group.
" + }, + "Name":{ + "shape":"VoiceConnectorGroupName", + "documentation":"The name of a Voice Connector group.
" + }, + "VoiceConnectorItems":{ + "shape":"VoiceConnectorItemList", + "documentation":"The Voice Connectors to which you route inbound calls.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The Voice Connector group's creation time stamp, in ISO 8601 format.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The Voice Connector group's creation time stamp, in ISO 8601 format.
" + }, + "VoiceConnectorGroupArn":{ + "shape":"NonEmptyString", + "documentation":"The ARN of the Voice Connector group.
" + } + }, + "documentation":"The Amazon Chime SDK Voice Connector group configuration, including associated Voice Connectors. You can include Voice Connectors from different AWS Regions in a group. This creates a fault tolerant mechanism for fallback in case of availability events.
" + }, + "VoiceConnectorGroupList":{ + "type":"list", + "member":{"shape":"VoiceConnectorGroup"} + }, + "VoiceConnectorGroupName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9 _.-]+" + }, + "VoiceConnectorItem":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "Priority" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"The Voice Connector ID.
" + }, + "Priority":{ + "shape":"VoiceConnectorItemPriority", + "documentation":"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.
" + } + }, + "documentation":"For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group.
" + }, + "VoiceConnectorItemList":{ + "type":"list", + "member":{"shape":"VoiceConnectorItem"} + }, + "VoiceConnectorItemPriority":{ + "type":"integer", + "max":99, + "min":1 + }, + "VoiceConnectorList":{ + "type":"list", + "member":{"shape":"VoiceConnector"} + }, + "VoiceConnectorName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9 _.-]+" + }, + "VoiceConnectorSettings":{ + "type":"structure", + "members":{ + "CdrBucket":{ + "shape":"String", + "documentation":"The S3 bucket that stores the Voice Connector's call detail records.
" + } + }, + "documentation":"The Amazon Chime SDK Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.
" + }, + "VoiceProfile":{ + "type":"structure", + "members":{ + "VoiceProfileId":{ + "shape":"NonEmptyString256", + "documentation":"The ID of the voice profile.
" + }, + "VoiceProfileArn":{ + "shape":"Arn", + "documentation":"The ARN of the voice profile.
" + }, + "VoiceProfileDomainId":{ + "shape":"NonEmptyString256", + "documentation":"The ID of the domain that contains the voice profile.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the voice profile was created and enrolled.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the voice profile was last updated.
" + }, + "ExpirationTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which a voice profile expires unless you re-enroll the caller via the UpdateVoiceProfile API.
The combination of a voice print and caller ID.
" + }, + "VoiceProfileDomain":{ + "type":"structure", + "members":{ + "VoiceProfileDomainId":{ + "shape":"NonEmptyString256", + "documentation":"The ID of the voice profile domain.
" + }, + "VoiceProfileDomainArn":{ + "shape":"Arn", + "documentation":"The voice profile domain's Amazon Resource Number (ARN).
" + }, + "Name":{ + "shape":"VoiceProfileDomainName", + "documentation":"The name of the voice profile domain.
" + }, + "Description":{ + "shape":"VoiceProfileDomainDescription", + "documentation":"The description of the voice profile domain.
" + }, + "ServerSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"A structure that contains the configuration settings for server-side encryption.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the voice profile domain was created.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the voice profile was last updated.
" + } + }, + "documentation":"A collection of voice profiles.
" + }, + "VoiceProfileDomainDescription":{ + "type":"string", + "max":1024, + "min":0 + }, + "VoiceProfileDomainName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9 _.-]+" + }, + "VoiceProfileDomainSummary":{ + "type":"structure", + "members":{ + "VoiceProfileDomainId":{ + "shape":"NonEmptyString256", + "documentation":"The ID of the voice profile domain summary.
" + }, + "VoiceProfileDomainArn":{ + "shape":"Arn", + "documentation":"The ARN of a voice profile in a voice profile domain summary.
" + }, + "Name":{ + "shape":"VoiceProfileDomainName", + "documentation":"The name of the voice profile domain summary.
" + }, + "Description":{ + "shape":"VoiceProfileDomainDescription", + "documentation":"Describes the voice profile domain summary.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the voice profile domain summary was created.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which the voice profile domain summary was last updated.
" + } + }, + "documentation":"A high-level overview of a voice profile domain.
" + }, + "VoiceProfileDomainSummaryList":{ + "type":"list", + "member":{"shape":"VoiceProfileDomainSummary"} + }, + "VoiceProfileSummary":{ + "type":"structure", + "members":{ + "VoiceProfileId":{ + "shape":"NonEmptyString256", + "documentation":"The ID of the voice profile in a voice profile summary.
" + }, + "VoiceProfileArn":{ + "shape":"Arn", + "documentation":"The ARN of the voice profile in a voice profile summary.
" + }, + "VoiceProfileDomainId":{ + "shape":"NonEmptyString256", + "documentation":"The ID of the voice profile domain in a voice profile summary.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which a voice profile summary was created.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which a voice profile summary was last updated.
" + }, + "ExpirationTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"Extends the life of the voice profile. You can use UpdateVoiceProfile to refresh an existing voice profile's voice print and extend the life of the summary.
A high-level summary of a voice profile.
" + }, + "VoiceProfileSummaryList":{ + "type":"list", + "member":{"shape":"VoiceProfileSummary"} + }, + "VoiceToneAnalysisTask":{ + "type":"structure", + "members":{ + "VoiceToneAnalysisTaskId":{ + "shape":"NonEmptyString256", + "documentation":"The ID of the voice tone analysis task.
" + }, + "VoiceToneAnalysisTaskStatus":{ + "shape":"NonEmptyString", + "documentation":"The status of a voice tone analysis task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.
The call details of a voice tone analysis task.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which a voice tone analysis task was created.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which a voice tone analysis task was updated.
" + }, + "StartedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The time at which a voice tone analysis task started.
" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"The status of a voice tone analysis task.
" + } + }, + "documentation":"A representation of an asynchronous request to perform voice tone analysis on a Voice Connector call.
" + } + }, + "documentation":"The Amazon Chime SDK telephony APIs in this section enable developers to create PSTN calling solutions that use Amazon Chime SDK Voice Connectors, and Amazon Chime SDK SIP media applications. Developers can also order and manage phone numbers, create and manage Voice Connectors and SIP media applications, and run voice analytics.
" +} diff --git a/testbed/boto__botocore/botocore/data/cleanrooms/2022-02-17/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/cleanrooms/2022-02-17/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..3a514d8a54d6541e162f9dc3790b5be8d1201f8c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/cleanrooms/2022-02-17/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cleanrooms-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cleanrooms-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cleanrooms.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cleanrooms.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/cleanrooms/2022-02-17/paginators-1.json b/testbed/boto__botocore/botocore/data/cleanrooms/2022-02-17/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..419570b3261ece79e3a2d38c11391239f6d7f2a6 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/cleanrooms/2022-02-17/paginators-1.json @@ -0,0 +1,112 @@ +{ + "pagination": { + "ListCollaborations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "collaborationList" + }, + "ListConfiguredTableAssociations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "configuredTableAssociationSummaries" + }, + "ListConfiguredTables": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "configuredTableSummaries" + }, + "ListMembers": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "memberSummaries" + }, + "ListMemberships": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "membershipSummaries" + }, + "ListProtectedQueries": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "protectedQueries" + }, + "ListSchemas": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "schemaSummaries" + }, + "ListAnalysisTemplates": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "analysisTemplateSummaries" + }, + "ListCollaborationAnalysisTemplates": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "collaborationAnalysisTemplateSummaries" + }, + "ListCollaborationConfiguredAudienceModelAssociations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "collaborationConfiguredAudienceModelAssociationSummaries" + }, + "ListCollaborationPrivacyBudgetTemplates": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "collaborationPrivacyBudgetTemplateSummaries" + }, + "ListCollaborationPrivacyBudgets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "collaborationPrivacyBudgetSummaries" + }, + "ListConfiguredAudienceModelAssociations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "configuredAudienceModelAssociationSummaries" + }, + "ListPrivacyBudgetTemplates": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "privacyBudgetTemplateSummaries" + }, + "ListPrivacyBudgets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "privacyBudgetSummaries" + }, + "ListCollaborationIdNamespaceAssociations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "collaborationIdNamespaceAssociationSummaries" + }, + "ListIdMappingTables": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "idMappingTableSummaries" + }, + "ListIdNamespaceAssociations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "idNamespaceAssociationSummaries" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/cleanrooms/2022-02-17/service-2.json b/testbed/boto__botocore/botocore/data/cleanrooms/2022-02-17/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..b427d20b0338114391541e30b7f1da8e4539d35d --- /dev/null +++ b/testbed/boto__botocore/botocore/data/cleanrooms/2022-02-17/service-2.json @@ -0,0 +1,8793 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-02-17", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"cleanrooms", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"AWS Clean Rooms Service", + "serviceId":"CleanRooms", + "signatureVersion":"v4", + "signingName":"cleanrooms", + "uid":"cleanrooms-2022-02-17" + }, + "operations":{ + "BatchGetCollaborationAnalysisTemplate":{ + "name":"BatchGetCollaborationAnalysisTemplate", + "http":{ + "method":"POST", + "requestUri":"/collaborations/{collaborationIdentifier}/batch-analysistemplates", + "responseCode":200 + }, + "input":{"shape":"BatchGetCollaborationAnalysisTemplateInput"}, + "output":{"shape":"BatchGetCollaborationAnalysisTemplateOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
" + }, + "BatchGetSchema":{ + "name":"BatchGetSchema", + "http":{ + "method":"POST", + "requestUri":"/collaborations/{collaborationIdentifier}/batch-schema", + "responseCode":200 + }, + "input":{"shape":"BatchGetSchemaInput"}, + "output":{"shape":"BatchGetSchemaOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves multiple schemas by their identifiers.
" + }, + "BatchGetSchemaAnalysisRule":{ + "name":"BatchGetSchemaAnalysisRule", + "http":{ + "method":"POST", + "requestUri":"/collaborations/{collaborationIdentifier}/batch-schema-analysis-rule", + "responseCode":200 + }, + "input":{"shape":"BatchGetSchemaAnalysisRuleInput"}, + "output":{"shape":"BatchGetSchemaAnalysisRuleOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves multiple analysis rule schemas.
" + }, + "CreateAnalysisTemplate":{ + "name":"CreateAnalysisTemplate", + "http":{ + "method":"POST", + "requestUri":"/memberships/{membershipIdentifier}/analysistemplates", + "responseCode":200 + }, + "input":{"shape":"CreateAnalysisTemplateInput"}, + "output":{"shape":"CreateAnalysisTemplateOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a new analysis template.
" + }, + "CreateCollaboration":{ + "name":"CreateCollaboration", + "http":{ + "method":"POST", + "requestUri":"/collaborations", + "responseCode":200 + }, + "input":{"shape":"CreateCollaborationInput"}, + "output":{"shape":"CreateCollaborationOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a new collaboration.
" + }, + "CreateConfiguredAudienceModelAssociation":{ + "name":"CreateConfiguredAudienceModelAssociation", + "http":{ + "method":"POST", + "requestUri":"/memberships/{membershipIdentifier}/configuredaudiencemodelassociations", + "responseCode":200 + }, + "input":{"shape":"CreateConfiguredAudienceModelAssociationInput"}, + "output":{"shape":"CreateConfiguredAudienceModelAssociationOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Provides the details necessary to create a configured audience model association.
" + }, + "CreateConfiguredTable":{ + "name":"CreateConfiguredTable", + "http":{ + "method":"POST", + "requestUri":"/configuredTables", + "responseCode":200 + }, + "input":{"shape":"CreateConfiguredTableInput"}, + "output":{"shape":"CreateConfiguredTableOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a new configured table resource.
", + "idempotent":true + }, + "CreateConfiguredTableAnalysisRule":{ + "name":"CreateConfiguredTableAnalysisRule", + "http":{ + "method":"POST", + "requestUri":"/configuredTables/{configuredTableIdentifier}/analysisRule", + "responseCode":200 + }, + "input":{"shape":"CreateConfiguredTableAnalysisRuleInput"}, + "output":{"shape":"CreateConfiguredTableAnalysisRuleOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.
", + "idempotent":true + }, + "CreateConfiguredTableAssociation":{ + "name":"CreateConfiguredTableAssociation", + "http":{ + "method":"POST", + "requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations", + "responseCode":200 + }, + "input":{"shape":"CreateConfiguredTableAssociationInput"}, + "output":{"shape":"CreateConfiguredTableAssociationOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a configured table association. A configured table association links a configured table with a collaboration.
" + }, + "CreateConfiguredTableAssociationAnalysisRule":{ + "name":"CreateConfiguredTableAssociationAnalysisRule", + "http":{ + "method":"POST", + "requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule", + "responseCode":200 + }, + "input":{"shape":"CreateConfiguredTableAssociationAnalysisRuleInput"}, + "output":{"shape":"CreateConfiguredTableAssociationAnalysisRuleOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a new analysis rule for an associated configured table.
", + "idempotent":true + }, + "CreateIdMappingTable":{ + "name":"CreateIdMappingTable", + "http":{ + "method":"POST", + "requestUri":"/memberships/{membershipIdentifier}/idmappingtables", + "responseCode":200 + }, + "input":{"shape":"CreateIdMappingTableInput"}, + "output":{"shape":"CreateIdMappingTableOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates an ID mapping table.
" + }, + "CreateIdNamespaceAssociation":{ + "name":"CreateIdNamespaceAssociation", + "http":{ + "method":"POST", + "requestUri":"/memberships/{membershipIdentifier}/idnamespaceassociations", + "responseCode":200 + }, + "input":{"shape":"CreateIdNamespaceAssociationInput"}, + "output":{"shape":"CreateIdNamespaceAssociationOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates an ID namespace association.
" + }, + "CreateMembership":{ + "name":"CreateMembership", + "http":{ + "method":"POST", + "requestUri":"/memberships", + "responseCode":200 + }, + "input":{"shape":"CreateMembershipInput"}, + "output":{"shape":"CreateMembershipOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a membership for a specific collaboration identifier and joins the collaboration.
" + }, + "CreatePrivacyBudgetTemplate":{ + "name":"CreatePrivacyBudgetTemplate", + "http":{ + "method":"POST", + "requestUri":"/memberships/{membershipIdentifier}/privacybudgettemplates", + "responseCode":200 + }, + "input":{"shape":"CreatePrivacyBudgetTemplateInput"}, + "output":{"shape":"CreatePrivacyBudgetTemplateOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a privacy budget template for a specified membership. Each membership can have only one privacy budget template, but it can be deleted and recreated. If you need to change the privacy budget template for a membership, use the UpdatePrivacyBudgetTemplate operation.
" + }, + "DeleteAnalysisTemplate":{ + "name":"DeleteAnalysisTemplate", + "http":{ + "method":"DELETE", + "requestUri":"/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteAnalysisTemplateInput"}, + "output":{"shape":"DeleteAnalysisTemplateOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes an analysis template.
", + "idempotent":true + }, + "DeleteCollaboration":{ + "name":"DeleteCollaboration", + "http":{ + "method":"DELETE", + "requestUri":"/collaborations/{collaborationIdentifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteCollaborationInput"}, + "output":{"shape":"DeleteCollaborationOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a collaboration. It can only be called by the collaboration owner.
", + "idempotent":true + }, + "DeleteConfiguredAudienceModelAssociation":{ + "name":"DeleteConfiguredAudienceModelAssociation", + "http":{ + "method":"DELETE", + "requestUri":"/memberships/{membershipIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteConfiguredAudienceModelAssociationInput"}, + "output":{"shape":"DeleteConfiguredAudienceModelAssociationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Provides the information necessary to delete a configured audience model association.
", + "idempotent":true + }, + "DeleteConfiguredTable":{ + "name":"DeleteConfiguredTable", + "http":{ + "method":"DELETE", + "requestUri":"/configuredTables/{configuredTableIdentifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteConfiguredTableInput"}, + "output":{"shape":"DeleteConfiguredTableOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a configured table.
", + "idempotent":true + }, + "DeleteConfiguredTableAnalysisRule":{ + "name":"DeleteConfiguredTableAnalysisRule", + "http":{ + "method":"DELETE", + "requestUri":"/configuredTables/{configuredTableIdentifier}/analysisRule/{analysisRuleType}", + "responseCode":204 + }, + "input":{"shape":"DeleteConfiguredTableAnalysisRuleInput"}, + "output":{"shape":"DeleteConfiguredTableAnalysisRuleOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a configured table analysis rule.
", + "idempotent":true + }, + "DeleteConfiguredTableAssociation":{ + "name":"DeleteConfiguredTableAssociation", + "http":{ + "method":"DELETE", + "requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteConfiguredTableAssociationInput"}, + "output":{"shape":"DeleteConfiguredTableAssociationOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a configured table association.
", + "idempotent":true + }, + "DeleteConfiguredTableAssociationAnalysisRule":{ + "name":"DeleteConfiguredTableAssociationAnalysisRule", + "http":{ + "method":"DELETE", + "requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule/{analysisRuleType}", + "responseCode":204 + }, + "input":{"shape":"DeleteConfiguredTableAssociationAnalysisRuleInput"}, + "output":{"shape":"DeleteConfiguredTableAssociationAnalysisRuleOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes an analysis rule for a configured table association.
", + "idempotent":true + }, + "DeleteIdMappingTable":{ + "name":"DeleteIdMappingTable", + "http":{ + "method":"DELETE", + "requestUri":"/memberships/{membershipIdentifier}/idmappingtables/{idMappingTableIdentifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteIdMappingTableInput"}, + "output":{"shape":"DeleteIdMappingTableOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes an ID mapping table.
", + "idempotent":true + }, + "DeleteIdNamespaceAssociation":{ + "name":"DeleteIdNamespaceAssociation", + "http":{ + "method":"DELETE", + "requestUri":"/memberships/{membershipIdentifier}/idnamespaceassociations/{idNamespaceAssociationIdentifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteIdNamespaceAssociationInput"}, + "output":{"shape":"DeleteIdNamespaceAssociationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes an ID namespace association.
", + "idempotent":true + }, + "DeleteMember":{ + "name":"DeleteMember", + "http":{ + "method":"DELETE", + "requestUri":"/collaborations/{collaborationIdentifier}/member/{accountId}", + "responseCode":204 + }, + "input":{"shape":"DeleteMemberInput"}, + "output":{"shape":"DeleteMemberOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Removes the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed member's data is inaccessible to active members of the collaboration.
", + "idempotent":true + }, + "DeleteMembership":{ + "name":"DeleteMembership", + "http":{ + "method":"DELETE", + "requestUri":"/memberships/{membershipIdentifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteMembershipInput"}, + "output":{"shape":"DeleteMembershipOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a specified membership. All resources under a membership must be deleted.
", + "idempotent":true + }, + "DeletePrivacyBudgetTemplate":{ + "name":"DeletePrivacyBudgetTemplate", + "http":{ + "method":"DELETE", + "requestUri":"/memberships/{membershipIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}", + "responseCode":204 + }, + "input":{"shape":"DeletePrivacyBudgetTemplateInput"}, + "output":{"shape":"DeletePrivacyBudgetTemplateOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a privacy budget template for a specified membership.
", + "idempotent":true + }, + "GetAnalysisTemplate":{ + "name":"GetAnalysisTemplate", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetAnalysisTemplateInput"}, + "output":{"shape":"GetAnalysisTemplateOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves an analysis template.
" + }, + "GetCollaboration":{ + "name":"GetCollaboration", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetCollaborationInput"}, + "output":{"shape":"GetCollaborationOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns metadata about a collaboration.
" + }, + "GetCollaborationAnalysisTemplate":{ + "name":"GetCollaborationAnalysisTemplate", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/analysistemplates/{analysisTemplateArn}", + "responseCode":200 + }, + "input":{"shape":"GetCollaborationAnalysisTemplateInput"}, + "output":{"shape":"GetCollaborationAnalysisTemplateOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves an analysis template within a collaboration.
" + }, + "GetCollaborationConfiguredAudienceModelAssociation":{ + "name":"GetCollaborationConfiguredAudienceModelAssociation", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetCollaborationConfiguredAudienceModelAssociationInput"}, + "output":{"shape":"GetCollaborationConfiguredAudienceModelAssociationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a configured audience model association within a collaboration.
" + }, + "GetCollaborationIdNamespaceAssociation":{ + "name":"GetCollaborationIdNamespaceAssociation", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/idnamespaceassociations/{idNamespaceAssociationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetCollaborationIdNamespaceAssociationInput"}, + "output":{"shape":"GetCollaborationIdNamespaceAssociationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves an ID namespace association from a specific collaboration.
" + }, + "GetCollaborationPrivacyBudgetTemplate":{ + "name":"GetCollaborationPrivacyBudgetTemplate", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetCollaborationPrivacyBudgetTemplateInput"}, + "output":{"shape":"GetCollaborationPrivacyBudgetTemplateOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns details about a specified privacy budget template.
" + }, + "GetConfiguredAudienceModelAssociation":{ + "name":"GetConfiguredAudienceModelAssociation", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetConfiguredAudienceModelAssociationInput"}, + "output":{"shape":"GetConfiguredAudienceModelAssociationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about a configured audience model association.
" + }, + "GetConfiguredTable":{ + "name":"GetConfiguredTable", + "http":{ + "method":"GET", + "requestUri":"/configuredTables/{configuredTableIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetConfiguredTableInput"}, + "output":{"shape":"GetConfiguredTableOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a configured table.
" + }, + "GetConfiguredTableAnalysisRule":{ + "name":"GetConfiguredTableAnalysisRule", + "http":{ + "method":"GET", + "requestUri":"/configuredTables/{configuredTableIdentifier}/analysisRule/{analysisRuleType}", + "responseCode":200 + }, + "input":{"shape":"GetConfiguredTableAnalysisRuleInput"}, + "output":{"shape":"GetConfiguredTableAnalysisRuleOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a configured table analysis rule.
" + }, + "GetConfiguredTableAssociation":{ + "name":"GetConfiguredTableAssociation", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetConfiguredTableAssociationInput"}, + "output":{"shape":"GetConfiguredTableAssociationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a configured table association.
" + }, + "GetConfiguredTableAssociationAnalysisRule":{ + "name":"GetConfiguredTableAssociationAnalysisRule", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule/{analysisRuleType}", + "responseCode":200 + }, + "input":{"shape":"GetConfiguredTableAssociationAnalysisRuleInput"}, + "output":{"shape":"GetConfiguredTableAssociationAnalysisRuleOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves the analysis rule for a configured table association.
" + }, + "GetIdMappingTable":{ + "name":"GetIdMappingTable", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/idmappingtables/{idMappingTableIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetIdMappingTableInput"}, + "output":{"shape":"GetIdMappingTableOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves an ID mapping table.
" + }, + "GetIdNamespaceAssociation":{ + "name":"GetIdNamespaceAssociation", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/idnamespaceassociations/{idNamespaceAssociationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetIdNamespaceAssociationInput"}, + "output":{"shape":"GetIdNamespaceAssociationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves an ID namespace association.
" + }, + "GetMembership":{ + "name":"GetMembership", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetMembershipInput"}, + "output":{"shape":"GetMembershipOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a specified membership for an identifier.
" + }, + "GetPrivacyBudgetTemplate":{ + "name":"GetPrivacyBudgetTemplate", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetPrivacyBudgetTemplateInput"}, + "output":{"shape":"GetPrivacyBudgetTemplateOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns details for a specified privacy budget template.
" + }, + "GetProtectedQuery":{ + "name":"GetProtectedQuery", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/protectedQueries/{protectedQueryIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetProtectedQueryInput"}, + "output":{"shape":"GetProtectedQueryOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns query processing metadata.
" + }, + "GetSchema":{ + "name":"GetSchema", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/schemas/{name}", + "responseCode":200 + }, + "input":{"shape":"GetSchemaInput"}, + "output":{"shape":"GetSchemaOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves the schema for a relation within a collaboration.
" + }, + "GetSchemaAnalysisRule":{ + "name":"GetSchemaAnalysisRule", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/schemas/{name}/analysisRule/{type}", + "responseCode":200 + }, + "input":{"shape":"GetSchemaAnalysisRuleInput"}, + "output":{"shape":"GetSchemaAnalysisRuleOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a schema analysis rule.
" + }, + "ListAnalysisTemplates":{ + "name":"ListAnalysisTemplates", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/analysistemplates", + "responseCode":200 + }, + "input":{"shape":"ListAnalysisTemplatesInput"}, + "output":{"shape":"ListAnalysisTemplatesOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists analysis templates that the caller owns.
" + }, + "ListCollaborationAnalysisTemplates":{ + "name":"ListCollaborationAnalysisTemplates", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/analysistemplates", + "responseCode":200 + }, + "input":{"shape":"ListCollaborationAnalysisTemplatesInput"}, + "output":{"shape":"ListCollaborationAnalysisTemplatesOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists analysis templates within a collaboration.
" + }, + "ListCollaborationConfiguredAudienceModelAssociations":{ + "name":"ListCollaborationConfiguredAudienceModelAssociations", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/configuredaudiencemodelassociations", + "responseCode":200 + }, + "input":{"shape":"ListCollaborationConfiguredAudienceModelAssociationsInput"}, + "output":{"shape":"ListCollaborationConfiguredAudienceModelAssociationsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists configured audience model associations within a collaboration.
" + }, + "ListCollaborationIdNamespaceAssociations":{ + "name":"ListCollaborationIdNamespaceAssociations", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/idnamespaceassociations", + "responseCode":200 + }, + "input":{"shape":"ListCollaborationIdNamespaceAssociationsInput"}, + "output":{"shape":"ListCollaborationIdNamespaceAssociationsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a list of the ID namespace associations in a collaboration.
" + }, + "ListCollaborationPrivacyBudgetTemplates":{ + "name":"ListCollaborationPrivacyBudgetTemplates", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/privacybudgettemplates", + "responseCode":200 + }, + "input":{"shape":"ListCollaborationPrivacyBudgetTemplatesInput"}, + "output":{"shape":"ListCollaborationPrivacyBudgetTemplatesOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns an array that summarizes each privacy budget template in a specified collaboration.
" + }, + "ListCollaborationPrivacyBudgets":{ + "name":"ListCollaborationPrivacyBudgets", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/privacybudgets", + "responseCode":200 + }, + "input":{"shape":"ListCollaborationPrivacyBudgetsInput"}, + "output":{"shape":"ListCollaborationPrivacyBudgetsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating account, and privacy budget details.
" + }, + "ListCollaborations":{ + "name":"ListCollaborations", + "http":{ + "method":"GET", + "requestUri":"/collaborations", + "responseCode":200 + }, + "input":{"shape":"ListCollaborationsInput"}, + "output":{"shape":"ListCollaborationsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists collaborations the caller owns, is active in, or has been invited to.
" + }, + "ListConfiguredAudienceModelAssociations":{ + "name":"ListConfiguredAudienceModelAssociations", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/configuredaudiencemodelassociations", + "responseCode":200 + }, + "input":{"shape":"ListConfiguredAudienceModelAssociationsInput"}, + "output":{"shape":"ListConfiguredAudienceModelAssociationsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists information about requested configured audience model associations.
" + }, + "ListConfiguredTableAssociations":{ + "name":"ListConfiguredTableAssociations", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations", + "responseCode":200 + }, + "input":{"shape":"ListConfiguredTableAssociationsInput"}, + "output":{"shape":"ListConfiguredTableAssociationsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists configured table associations for a membership.
" + }, + "ListConfiguredTables":{ + "name":"ListConfiguredTables", + "http":{ + "method":"GET", + "requestUri":"/configuredTables", + "responseCode":200 + }, + "input":{"shape":"ListConfiguredTablesInput"}, + "output":{"shape":"ListConfiguredTablesOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists configured tables.
" + }, + "ListIdMappingTables":{ + "name":"ListIdMappingTables", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/idmappingtables", + "responseCode":200 + }, + "input":{"shape":"ListIdMappingTablesInput"}, + "output":{"shape":"ListIdMappingTablesOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a list of ID mapping tables.
" + }, + "ListIdNamespaceAssociations":{ + "name":"ListIdNamespaceAssociations", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/idnamespaceassociations", + "responseCode":200 + }, + "input":{"shape":"ListIdNamespaceAssociationsInput"}, + "output":{"shape":"ListIdNamespaceAssociationsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a list of ID namespace associations.
" + }, + "ListMembers":{ + "name":"ListMembers", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/members", + "responseCode":200 + }, + "input":{"shape":"ListMembersInput"}, + "output":{"shape":"ListMembersOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists all members within a collaboration.
" + }, + "ListMemberships":{ + "name":"ListMemberships", + "http":{ + "method":"GET", + "requestUri":"/memberships", + "responseCode":200 + }, + "input":{"shape":"ListMembershipsInput"}, + "output":{"shape":"ListMembershipsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists all memberships resources within the caller's account.
" + }, + "ListPrivacyBudgetTemplates":{ + "name":"ListPrivacyBudgetTemplates", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/privacybudgettemplates", + "responseCode":200 + }, + "input":{"shape":"ListPrivacyBudgetTemplatesInput"}, + "output":{"shape":"ListPrivacyBudgetTemplatesOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns detailed information about the privacy budget templates in a specified membership.
" + }, + "ListPrivacyBudgets":{ + "name":"ListPrivacyBudgets", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/privacybudgets", + "responseCode":200 + }, + "input":{"shape":"ListPrivacyBudgetsInput"}, + "output":{"shape":"ListPrivacyBudgetsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns detailed information about the privacy budgets in a specified membership.
" + }, + "ListProtectedQueries":{ + "name":"ListProtectedQueries", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/protectedQueries", + "responseCode":200 + }, + "input":{"shape":"ListProtectedQueriesInput"}, + "output":{"shape":"ListProtectedQueriesOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists protected queries, sorted by the most recent query.
" + }, + "ListSchemas":{ + "name":"ListSchemas", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/schemas", + "responseCode":200 + }, + "input":{"shape":"ListSchemasInput"}, + "output":{"shape":"ListSchemasOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists the schemas for relations within a collaboration.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Lists all of the tags that have been added to a resource.
" + }, + "PopulateIdMappingTable":{ + "name":"PopulateIdMappingTable", + "http":{ + "method":"POST", + "requestUri":"/memberships/{membershipIdentifier}/idmappingtables/{idMappingTableIdentifier}/populate", + "responseCode":200 + }, + "input":{"shape":"PopulateIdMappingTableInput"}, + "output":{"shape":"PopulateIdMappingTableOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Defines the information that's necessary to populate an ID mapping table.
" + }, + "PreviewPrivacyImpact":{ + "name":"PreviewPrivacyImpact", + "http":{ + "method":"POST", + "requestUri":"/memberships/{membershipIdentifier}/previewprivacyimpact", + "responseCode":200 + }, + "input":{"shape":"PreviewPrivacyImpactInput"}, + "output":{"shape":"PreviewPrivacyImpactOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.
" + }, + "StartProtectedQuery":{ + "name":"StartProtectedQuery", + "http":{ + "method":"POST", + "requestUri":"/memberships/{membershipIdentifier}/protectedQueries", + "responseCode":200 + }, + "input":{"shape":"StartProtectedQueryInput"}, + "output":{"shape":"StartProtectedQueryOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a protected query that is started by Clean Rooms.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Tags a resource.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Removes a tag or list of tags from a resource.
" + }, + "UpdateAnalysisTemplate":{ + "name":"UpdateAnalysisTemplate", + "http":{ + "method":"PATCH", + "requestUri":"/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateAnalysisTemplateInput"}, + "output":{"shape":"UpdateAnalysisTemplateOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates the analysis template metadata.
" + }, + "UpdateCollaboration":{ + "name":"UpdateCollaboration", + "http":{ + "method":"PATCH", + "requestUri":"/collaborations/{collaborationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateCollaborationInput"}, + "output":{"shape":"UpdateCollaborationOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates collaboration metadata and can only be called by the collaboration owner.
" + }, + "UpdateConfiguredAudienceModelAssociation":{ + "name":"UpdateConfiguredAudienceModelAssociation", + "http":{ + "method":"PATCH", + "requestUri":"/memberships/{membershipIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateConfiguredAudienceModelAssociationInput"}, + "output":{"shape":"UpdateConfiguredAudienceModelAssociationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Provides the details necessary to update a configured audience model association.
" + }, + "UpdateConfiguredTable":{ + "name":"UpdateConfiguredTable", + "http":{ + "method":"PATCH", + "requestUri":"/configuredTables/{configuredTableIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateConfiguredTableInput"}, + "output":{"shape":"UpdateConfiguredTableOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates a configured table.
" + }, + "UpdateConfiguredTableAnalysisRule":{ + "name":"UpdateConfiguredTableAnalysisRule", + "http":{ + "method":"PATCH", + "requestUri":"/configuredTables/{configuredTableIdentifier}/analysisRule/{analysisRuleType}", + "responseCode":200 + }, + "input":{"shape":"UpdateConfiguredTableAnalysisRuleInput"}, + "output":{"shape":"UpdateConfiguredTableAnalysisRuleOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates a configured table analysis rule.
" + }, + "UpdateConfiguredTableAssociation":{ + "name":"UpdateConfiguredTableAssociation", + "http":{ + "method":"PATCH", + "requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateConfiguredTableAssociationInput"}, + "output":{"shape":"UpdateConfiguredTableAssociationOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates a configured table association.
" + }, + "UpdateConfiguredTableAssociationAnalysisRule":{ + "name":"UpdateConfiguredTableAssociationAnalysisRule", + "http":{ + "method":"PATCH", + "requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule/{analysisRuleType}", + "responseCode":200 + }, + "input":{"shape":"UpdateConfiguredTableAssociationAnalysisRuleInput"}, + "output":{"shape":"UpdateConfiguredTableAssociationAnalysisRuleOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates the analysis rule for a configured table association.
" + }, + "UpdateIdMappingTable":{ + "name":"UpdateIdMappingTable", + "http":{ + "method":"PATCH", + "requestUri":"/memberships/{membershipIdentifier}/idmappingtables/{idMappingTableIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateIdMappingTableInput"}, + "output":{"shape":"UpdateIdMappingTableOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Provides the details that are necessary to update an ID mapping table.
" + }, + "UpdateIdNamespaceAssociation":{ + "name":"UpdateIdNamespaceAssociation", + "http":{ + "method":"PATCH", + "requestUri":"/memberships/{membershipIdentifier}/idnamespaceassociations/{idNamespaceAssociationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateIdNamespaceAssociationInput"}, + "output":{"shape":"UpdateIdNamespaceAssociationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Provides the details that are necessary to update an ID namespace association.
" + }, + "UpdateMembership":{ + "name":"UpdateMembership", + "http":{ + "method":"PATCH", + "requestUri":"/memberships/{membershipIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateMembershipInput"}, + "output":{"shape":"UpdateMembershipOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates a membership.
" + }, + "UpdatePrivacyBudgetTemplate":{ + "name":"UpdatePrivacyBudgetTemplate", + "http":{ + "method":"PATCH", + "requestUri":"/memberships/{membershipIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdatePrivacyBudgetTemplateInput"}, + "output":{"shape":"UpdatePrivacyBudgetTemplateOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates the privacy budget template for the specified membership.
" + }, + "UpdateProtectedQuery":{ + "name":"UpdateProtectedQuery", + "http":{ + "method":"PATCH", + "requestUri":"/memberships/{membershipIdentifier}/protectedQueries/{protectedQueryIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateProtectedQueryInput"}, + "output":{"shape":"UpdateProtectedQueryOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates the processing of a currently running query.
", + "idempotent":true + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "reason":{ + "shape":"AccessDeniedExceptionReason", + "documentation":"A reason code for the exception.
" + } + }, + "documentation":"Caller does not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccessDeniedExceptionReason":{ + "type":"string", + "enum":["INSUFFICIENT_PERMISSIONS"] + }, + "AccountId":{ + "type":"string", + "max":12, + "min":12, + "pattern":"\\d+" + }, + "AdditionalAnalyses":{ + "type":"string", + "enum":[ + "ALLOWED", + "REQUIRED", + "NOT_ALLOWED" + ] + }, + "AdditionalAnalysesResourceArn":{ + "type":"string", + "max":256, + "min":0, + "pattern":"arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:([\\d]{12}|\\*):membership/[\\*\\d\\w-]+/configuredaudiencemodelassociation/[\\*\\d\\w-]+" + }, + "AggregateColumn":{ + "type":"structure", + "required":[ + "columnNames", + "function" + ], + "members":{ + "columnNames":{ + "shape":"AggregateColumnColumnNamesList", + "documentation":"Column names in configured table of aggregate columns.
" + }, + "function":{ + "shape":"AggregateFunctionName", + "documentation":"Aggregation function that can be applied to aggregate column in query.
" + } + }, + "documentation":"Column in configured table that can be used in aggregate function in query.
" + }, + "AggregateColumnColumnNamesList":{ + "type":"list", + "member":{"shape":"AnalysisRuleColumnName"}, + "min":1 + }, + "AggregateFunctionName":{ + "type":"string", + "enum":[ + "SUM", + "SUM_DISTINCT", + "COUNT", + "COUNT_DISTINCT", + "AVG" + ] + }, + "AggregationConstraint":{ + "type":"structure", + "required":[ + "columnName", + "minimum", + "type" + ], + "members":{ + "columnName":{ + "shape":"AnalysisRuleColumnName", + "documentation":"Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.
" + }, + "minimum":{ + "shape":"AggregationConstraintMinimumInteger", + "documentation":"The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.
" + }, + "type":{ + "shape":"AggregationType", + "documentation":"The type of aggregation the constraint allows. The only valid value is currently `COUNT_DISTINCT`.
" + } + }, + "documentation":"Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.
" + }, + "AggregationConstraintMinimumInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":2 + }, + "AggregationConstraints":{ + "type":"list", + "member":{"shape":"AggregationConstraint"}, + "min":1 + }, + "AggregationType":{ + "type":"string", + "enum":["COUNT_DISTINCT"] + }, + "AllowedAdditionalAnalyses":{ + "type":"list", + "member":{"shape":"AdditionalAnalysesResourceArn"}, + "max":25, + "min":0 + }, + "AllowedColumnList":{ + "type":"list", + "member":{"shape":"ColumnName"}, + "max":225, + "min":1 + }, + "AllowedResultReceivers":{ + "type":"list", + "member":{"shape":"AccountId"} + }, + "AnalysisFormat":{ + "type":"string", + "enum":["SQL"] + }, + "AnalysisMethod":{ + "type":"string", + "enum":["DIRECT_QUERY"] + }, + "AnalysisParameter":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "name":{ + "shape":"ParameterName", + "documentation":"The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.
" + }, + "type":{ + "shape":"ParameterType", + "documentation":"The type of parameter.
" + }, + "defaultValue":{ + "shape":"ParameterValue", + "documentation":"Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.
" + } + }, + "documentation":"Optional. The member who can query can provide this placeholder for a literal data value in an analysis template.
", + "sensitive":true + }, + "AnalysisParameterList":{ + "type":"list", + "member":{"shape":"AnalysisParameter"}, + "max":10, + "min":0 + }, + "AnalysisRule":{ + "type":"structure", + "required":[ + "collaborationId", + "type", + "name", + "createTime", + "updateTime", + "policy" + ], + "members":{ + "collaborationId":{ + "shape":"CollaborationIdentifier", + "documentation":"The unique ID for the associated collaboration.
" + }, + "type":{ + "shape":"AnalysisRuleType", + "documentation":"The type of analysis rule.
" + }, + "name":{ + "shape":"TableAlias", + "documentation":"The name for the analysis rule.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time the analysis rule was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time the analysis rule was last updated.
" + }, + "policy":{ + "shape":"AnalysisRulePolicy", + "documentation":"A policy that describes the associated data usage limitations.
" + } + }, + "documentation":"A specification about how data from the configured table can be used in a query.
" + }, + "AnalysisRuleAggregation":{ + "type":"structure", + "required":[ + "aggregateColumns", + "joinColumns", + "dimensionColumns", + "scalarFunctions", + "outputConstraints" + ], + "members":{ + "aggregateColumns":{ + "shape":"AnalysisRuleAggregationAggregateColumnsList", + "documentation":"The columns that query runners are allowed to use in aggregation queries.
" + }, + "joinColumns":{ + "shape":"AnalysisRuleColumnList", + "documentation":"Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.
" + }, + "joinRequired":{ + "shape":"JoinRequiredOption", + "documentation":"Control that requires member who runs query to do a join with their configured table and/or other configured table in query.
" + }, + "allowedJoinOperators":{ + "shape":"JoinOperatorsList", + "documentation":"Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND.
The columns that query runners are allowed to select, group by, or filter by.
" + }, + "scalarFunctions":{ + "shape":"ScalarFunctionsList", + "documentation":"Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.
" + }, + "outputConstraints":{ + "shape":"AggregationConstraints", + "documentation":"Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.
" + }, + "additionalAnalyses":{ + "shape":"AdditionalAnalyses", + "documentation":"An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
The additionalAnalyses parameter is currently supported for the list analysis rule (AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom).
A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.
" + }, + "AnalysisRuleAggregationAggregateColumnsList":{ + "type":"list", + "member":{"shape":"AggregateColumn"}, + "min":1 + }, + "AnalysisRuleColumnList":{ + "type":"list", + "member":{"shape":"AnalysisRuleColumnName"} + }, + "AnalysisRuleColumnName":{ + "type":"string", + "max":127, + "min":1, + "pattern":"[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?" + }, + "AnalysisRuleCustom":{ + "type":"structure", + "required":["allowedAnalyses"], + "members":{ + "allowedAnalyses":{ + "shape":"AnalysisRuleCustomAllowedAnalysesList", + "documentation":"The ARN of the analysis templates that are allowed by the custom analysis rule.
" + }, + "allowedAnalysisProviders":{ + "shape":"AnalysisRuleCustomAllowedAnalysisProvidersList", + "documentation":"The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when allowedAnalyses is ANY_QUERY.
An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
" + }, + "disallowedOutputColumns":{ + "shape":"AnalysisRuleColumnList", + "documentation":"A list of columns that aren't allowed to be shown in the query output.
" + }, + "differentialPrivacy":{ + "shape":"DifferentialPrivacyConfiguration", + "documentation":"The differential privacy configuration.
" + } + }, + "documentation":"A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.
" + }, + "AnalysisRuleCustomAllowedAnalysesList":{ + "type":"list", + "member":{"shape":"AnalysisTemplateArnOrQueryWildcard"}, + "min":0 + }, + "AnalysisRuleCustomAllowedAnalysisProvidersList":{ + "type":"list", + "member":{"shape":"AccountId"}, + "min":0 + }, + "AnalysisRuleIdMappingTable":{ + "type":"structure", + "required":[ + "joinColumns", + "queryConstraints" + ], + "members":{ + "joinColumns":{ + "shape":"AnalysisRuleIdMappingTableJoinColumnsList", + "documentation":"The columns that query runners are allowed to use in an INNER JOIN statement.
" + }, + "queryConstraints":{ + "shape":"QueryConstraintList", + "documentation":"The query constraints of the analysis rule ID mapping table.
" + }, + "dimensionColumns":{ + "shape":"AnalysisRuleColumnList", + "documentation":"The columns that query runners are allowed to select, group by, or filter by.
" + } + }, + "documentation":"Defines details for the analysis rule ID mapping table.
" + }, + "AnalysisRuleIdMappingTableJoinColumnsList":{ + "type":"list", + "member":{"shape":"AnalysisRuleColumnName"}, + "max":2, + "min":2 + }, + "AnalysisRuleList":{ + "type":"structure", + "required":[ + "joinColumns", + "listColumns" + ], + "members":{ + "joinColumns":{ + "shape":"AnalysisRuleListJoinColumnsList", + "documentation":"Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.
" + }, + "allowedJoinOperators":{ + "shape":"JoinOperatorsList", + "documentation":"The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is AND.
Columns that can be listed in the output.
" + }, + "additionalAnalyses":{ + "shape":"AdditionalAnalyses", + "documentation":"An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
" + } + }, + "documentation":"A type of analysis rule that enables row-level analysis.
" + }, + "AnalysisRuleListJoinColumnsList":{ + "type":"list", + "member":{"shape":"AnalysisRuleColumnName"}, + "min":1 + }, + "AnalysisRulePolicy":{ + "type":"structure", + "members":{ + "v1":{ + "shape":"AnalysisRulePolicyV1", + "documentation":"Controls on the query specifications that can be run on configured table.
" + } + }, + "documentation":"Controls on the query specifications that can be run on configured table.
", + "union":true + }, + "AnalysisRulePolicyV1":{ + "type":"structure", + "members":{ + "list":{ + "shape":"AnalysisRuleList", + "documentation":"Analysis rule type that enables only list queries on a configured table.
" + }, + "aggregation":{ + "shape":"AnalysisRuleAggregation", + "documentation":"Analysis rule type that enables only aggregation queries on a configured table.
" + }, + "custom":{ + "shape":"AnalysisRuleCustom", + "documentation":"Analysis rule type that enables custom SQL queries on a configured table.
" + }, + "idMappingTable":{ + "shape":"AnalysisRuleIdMappingTable", + "documentation":"The ID mapping table.
" + } + }, + "documentation":"Controls on the query specifications that can be run on configured table.
", + "union":true + }, + "AnalysisRuleType":{ + "type":"string", + "enum":[ + "AGGREGATION", + "LIST", + "CUSTOM", + "ID_MAPPING_TABLE" + ] + }, + "AnalysisRuleTypeList":{ + "type":"list", + "member":{"shape":"AnalysisRuleType"} + }, + "AnalysisSchema":{ + "type":"structure", + "members":{ + "referencedTables":{ + "shape":"QueryTables", + "documentation":"The tables referenced in the analysis schema.
" + } + }, + "documentation":"A relation within an analysis.
" + }, + "AnalysisSource":{ + "type":"structure", + "members":{ + "text":{ + "shape":"AnalysisTemplateText", + "documentation":"The query text.
" + } + }, + "documentation":"The structure that defines the body of the analysis template.
", + "sensitive":true, + "union":true + }, + "AnalysisTemplate":{ + "type":"structure", + "required":[ + "id", + "arn", + "collaborationId", + "collaborationArn", + "membershipId", + "membershipArn", + "name", + "createTime", + "updateTime", + "schema", + "format", + "source" + ], + "members":{ + "id":{ + "shape":"AnalysisTemplateIdentifier", + "documentation":"The identifier for the analysis template.
" + }, + "arn":{ + "shape":"AnalysisTemplateArn", + "documentation":"The Amazon Resource Name (ARN) of the analysis template.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique ID for the associated collaboration of the analysis template.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The unique ARN for the analysis template’s associated collaboration.
" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"The identifier of a member who created the analysis template.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The Amazon Resource Name (ARN) of the member who created the analysis template.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of the analysis template.
" + }, + "name":{ + "shape":"ResourceAlias", + "documentation":"The name of the analysis template.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time that the analysis template was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time that the analysis template was last updated.
" + }, + "schema":{ + "shape":"AnalysisSchema", + "documentation":"The entire schema object.
" + }, + "format":{ + "shape":"AnalysisFormat", + "documentation":"The format of the analysis template.
" + }, + "source":{ + "shape":"AnalysisSource", + "documentation":"The source of the analysis template.
" + }, + "analysisParameters":{ + "shape":"AnalysisParameterList", + "documentation":"The parameters of the analysis template.
" + }, + "validations":{ + "shape":"AnalysisTemplateValidationStatusDetailList", + "documentation":"Information about the validations performed on the analysis template.
" + } + }, + "documentation":"The analysis template.
" + }, + "AnalysisTemplateArn":{ + "type":"string", + "max":200, + "min":0, + "pattern":"arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/analysistemplate/[\\d\\w-]+" + }, + "AnalysisTemplateArnList":{ + "type":"list", + "member":{"shape":"AnalysisTemplateArn"}, + "max":10, + "min":1 + }, + "AnalysisTemplateArnOrQueryWildcard":{ + "type":"string", + "max":200, + "min":0, + "pattern":"(ANY_QUERY|arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/analysistemplate/[\\d\\w-]+)" + }, + "AnalysisTemplateIdentifier":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "AnalysisTemplateSummary":{ + "type":"structure", + "required":[ + "arn", + "createTime", + "id", + "name", + "updateTime", + "membershipArn", + "membershipId", + "collaborationArn", + "collaborationId" + ], + "members":{ + "arn":{ + "shape":"AnalysisTemplateArn", + "documentation":"The Amazon Resource Name (ARN) of the analysis template.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time that the analysis template summary was created.
" + }, + "id":{ + "shape":"AnalysisTemplateIdentifier", + "documentation":"The identifier of the analysis template.
" + }, + "name":{ + "shape":"ResourceAlias", + "documentation":"The name of the analysis template.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time that the analysis template summary was last updated.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The Amazon Resource Name (ARN) of the member who created the analysis template.
" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"The identifier for a membership resource.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The unique ARN for the analysis template summary’s associated collaboration.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of the analysis template.
" + } + }, + "documentation":"The metadata of the analysis template.
" + }, + "AnalysisTemplateSummaryList":{ + "type":"list", + "member":{"shape":"AnalysisTemplateSummary"} + }, + "AnalysisTemplateText":{ + "type":"string", + "max":90000, + "min":0 + }, + "AnalysisTemplateValidationStatus":{ + "type":"string", + "enum":[ + "VALID", + "INVALID", + "UNABLE_TO_VALIDATE" + ] + }, + "AnalysisTemplateValidationStatusDetail":{ + "type":"structure", + "required":[ + "type", + "status" + ], + "members":{ + "type":{ + "shape":"AnalysisTemplateValidationType", + "documentation":"The type of validation that was performed.
" + }, + "status":{ + "shape":"AnalysisTemplateValidationStatus", + "documentation":"The status of the validation.
" + }, + "reasons":{ + "shape":"AnalysisTemplateValidationStatusReasonList", + "documentation":"The reasons for the validation results.
" + } + }, + "documentation":"The status details of the analysis template validation. Clean Rooms Differential Privacy uses a general-purpose query structure to support complex SQL queries and validates whether an analysis template fits that general-purpose query structure. Validation is performed when analysis templates are created and fetched. Because analysis templates are immutable by design, we recommend that you create analysis templates after you associate the configured tables with their analysis rule to your collaboration.
For more information, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy.
" + }, + "AnalysisTemplateValidationStatusDetailList":{ + "type":"list", + "member":{"shape":"AnalysisTemplateValidationStatusDetail"} + }, + "AnalysisTemplateValidationStatusReason":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"String", + "documentation":"The validation message.
" + } + }, + "documentation":"The reasons for the validation results.
" + }, + "AnalysisTemplateValidationStatusReasonList":{ + "type":"list", + "member":{"shape":"AnalysisTemplateValidationStatusReason"} + }, + "AnalysisTemplateValidationType":{ + "type":"string", + "enum":["DIFFERENTIAL_PRIVACY"] + }, + "AnalysisType":{ + "type":"string", + "enum":[ + "DIRECT_ANALYSIS", + "ADDITIONAL_ANALYSIS" + ] + }, + "BatchGetCollaborationAnalysisTemplateError":{ + "type":"structure", + "required":[ + "arn", + "code", + "message" + ], + "members":{ + "arn":{ + "shape":"AnalysisTemplateArn", + "documentation":"The Amazon Resource Name (ARN) of the analysis template.
" + }, + "code":{ + "shape":"String", + "documentation":"An error code for the error.
" + }, + "message":{ + "shape":"String", + "documentation":"A description of why the call failed.
" + } + }, + "documentation":"Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.
" + }, + "BatchGetCollaborationAnalysisTemplateErrorList":{ + "type":"list", + "member":{"shape":"BatchGetCollaborationAnalysisTemplateError"}, + "max":10, + "min":0 + }, + "BatchGetCollaborationAnalysisTemplateInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "analysisTemplateArns" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "analysisTemplateArns":{ + "shape":"AnalysisTemplateArnList", + "documentation":"The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
" + } + } + }, + "BatchGetCollaborationAnalysisTemplateOutput":{ + "type":"structure", + "required":[ + "collaborationAnalysisTemplates", + "errors" + ], + "members":{ + "collaborationAnalysisTemplates":{ + "shape":"CollaborationAnalysisTemplateList", + "documentation":"The retrieved list of analysis templates within a collaboration.
" + }, + "errors":{ + "shape":"BatchGetCollaborationAnalysisTemplateErrorList", + "documentation":"Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.
" + } + } + }, + "BatchGetSchemaAnalysisRuleError":{ + "type":"structure", + "required":[ + "name", + "type", + "code", + "message" + ], + "members":{ + "name":{ + "shape":"TableAlias", + "documentation":"An error name for the error.
" + }, + "type":{ + "shape":"AnalysisRuleType", + "documentation":"The analysis rule type.
" + }, + "code":{ + "shape":"String", + "documentation":"An error code for the error.
" + }, + "message":{ + "shape":"String", + "documentation":"A description of why the call failed.
" + } + }, + "documentation":"An error that describes why a schema could not be fetched.
" + }, + "BatchGetSchemaAnalysisRuleErrorList":{ + "type":"list", + "member":{"shape":"BatchGetSchemaAnalysisRuleError"}, + "max":25, + "min":0 + }, + "BatchGetSchemaAnalysisRuleInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "schemaAnalysisRuleRequests" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"The unique identifier of the collaboration that contains the schema analysis rule.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "schemaAnalysisRuleRequests":{ + "shape":"SchemaAnalysisRuleRequestList", + "documentation":"The information that's necessary to retrieve a schema analysis rule.
" + } + } + }, + "BatchGetSchemaAnalysisRuleOutput":{ + "type":"structure", + "required":[ + "analysisRules", + "errors" + ], + "members":{ + "analysisRules":{ + "shape":"SchemaAnalysisRuleList", + "documentation":"The retrieved list of analysis rules.
" + }, + "errors":{ + "shape":"BatchGetSchemaAnalysisRuleErrorList", + "documentation":"Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.
" + } + } + }, + "BatchGetSchemaError":{ + "type":"structure", + "required":[ + "name", + "code", + "message" + ], + "members":{ + "name":{ + "shape":"TableAlias", + "documentation":"An error name for the error.
" + }, + "code":{ + "shape":"String", + "documentation":"An error code for the error.
" + }, + "message":{ + "shape":"String", + "documentation":"An error message for the error.
" + } + }, + "documentation":"An error describing why a schema could not be fetched.
" + }, + "BatchGetSchemaErrorList":{ + "type":"list", + "member":{"shape":"BatchGetSchemaError"}, + "max":25, + "min":0 + }, + "BatchGetSchemaInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "names" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"A unique identifier for the collaboration that the schemas belong to. Currently accepts collaboration ID.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "names":{ + "shape":"TableAliasList", + "documentation":"The names for the schema objects to retrieve.
" + } + } + }, + "BatchGetSchemaOutput":{ + "type":"structure", + "required":[ + "schemas", + "errors" + ], + "members":{ + "schemas":{ + "shape":"SchemaList", + "documentation":"The retrieved list of schemas.
" + }, + "errors":{ + "shape":"BatchGetSchemaErrorList", + "documentation":"Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.
" + } + } + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "CleanroomsArn":{ + "type":"string", + "max":100, + "min":0, + "pattern":"arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:[\\d\\w/-]+" + }, + "Collaboration":{ + "type":"structure", + "required":[ + "id", + "arn", + "name", + "creatorAccountId", + "creatorDisplayName", + "createTime", + "updateTime", + "memberStatus", + "queryLogStatus" + ], + "members":{ + "id":{ + "shape":"UUID", + "documentation":"The unique ID for the collaboration.
" + }, + "arn":{ + "shape":"CollaborationArn", + "documentation":"The unique ARN for the collaboration.
" + }, + "name":{ + "shape":"CollaborationName", + "documentation":"A human-readable identifier provided by the collaboration owner. Display names are not unique.
" + }, + "description":{ + "shape":"CollaborationDescription", + "documentation":"A description of the collaboration provided by the collaboration owner.
" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
" + }, + "creatorDisplayName":{ + "shape":"DisplayName", + "documentation":"A display name of the collaboration creator.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time when the collaboration was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time the collaboration metadata was last updated.
" + }, + "memberStatus":{ + "shape":"MemberStatus", + "documentation":"The status of a member in a collaboration.
" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"The unique ID for your membership within the collaboration.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The unique ARN for your membership within the collaboration.
" + }, + "dataEncryptionMetadata":{ + "shape":"DataEncryptionMetadata", + "documentation":"The settings for client-side encryption for cryptographic computing.
" + }, + "queryLogStatus":{ + "shape":"CollaborationQueryLogStatus", + "documentation":"An indicator as to whether query logging has been enabled or disabled for the collaboration.
" + } + }, + "documentation":"The multi-party data share environment. The collaboration contains metadata about its purpose and participants.
" + }, + "CollaborationAnalysisTemplate":{ + "type":"structure", + "required":[ + "id", + "arn", + "collaborationId", + "collaborationArn", + "creatorAccountId", + "name", + "createTime", + "updateTime", + "schema", + "format", + "source" + ], + "members":{ + "id":{ + "shape":"AnalysisTemplateIdentifier", + "documentation":"The identifier of the analysis template.
" + }, + "arn":{ + "shape":"AnalysisTemplateArn", + "documentation":"The Amazon Resource Name (ARN) of the analysis template.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The unique ARN for the analysis template’s associated collaboration.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of the analysis template.
" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
" + }, + "name":{ + "shape":"ResourceAlias", + "documentation":"The name of the analysis template.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time that the analysis template within a collaboration was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time that the analysis template in the collaboration was last updated.
" + }, + "schema":{ + "shape":"AnalysisSchema", + "documentation":"The entire schema object.
" + }, + "format":{ + "shape":"AnalysisFormat", + "documentation":"The format of the analysis template in the collaboration.
" + }, + "source":{ + "shape":"AnalysisSource", + "documentation":"The source of the analysis template within a collaboration.
" + }, + "analysisParameters":{ + "shape":"AnalysisParameterList", + "documentation":"The analysis parameters that have been specified in the analysis template.
" + }, + "validations":{ + "shape":"AnalysisTemplateValidationStatusDetailList", + "documentation":"The validations that were performed.
" + } + }, + "documentation":"The analysis template within a collaboration.
" + }, + "CollaborationAnalysisTemplateList":{ + "type":"list", + "member":{"shape":"CollaborationAnalysisTemplate"}, + "max":10, + "min":0 + }, + "CollaborationAnalysisTemplateSummary":{ + "type":"structure", + "required":[ + "arn", + "createTime", + "id", + "name", + "updateTime", + "collaborationArn", + "collaborationId", + "creatorAccountId" + ], + "members":{ + "arn":{ + "shape":"AnalysisTemplateArn", + "documentation":"The Amazon Resource Name (ARN) of the analysis template.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time that the summary of the analysis template in a collaboration was created.
" + }, + "id":{ + "shape":"AnalysisTemplateIdentifier", + "documentation":"The identifier of the analysis template.
" + }, + "name":{ + "shape":"ResourceAlias", + "documentation":"The name of the analysis template.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time that the summary of the analysis template in the collaboration was last updated.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The unique ARN for the analysis template’s associated collaboration.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of the analysis template.
" + } + }, + "documentation":"The metadata of the analysis template within a collaboration.
" + }, + "CollaborationAnalysisTemplateSummaryList":{ + "type":"list", + "member":{"shape":"CollaborationAnalysisTemplateSummary"} + }, + "CollaborationArn":{ + "type":"string", + "max":100, + "min":0, + "pattern":"arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:collaboration/[\\d\\w-]+" + }, + "CollaborationConfiguredAudienceModelAssociation":{ + "type":"structure", + "required":[ + "id", + "arn", + "collaborationId", + "collaborationArn", + "configuredAudienceModelArn", + "name", + "creatorAccountId", + "createTime", + "updateTime" + ], + "members":{ + "id":{ + "shape":"ConfiguredAudienceModelAssociationIdentifier", + "documentation":"The identifier of the configured audience model association.
" + }, + "arn":{ + "shape":"ConfiguredAudienceModelAssociationArn", + "documentation":"The Amazon Resource Name (ARN) of the configured audience model association.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"A unique identifier for the collaboration that the configured audience model associations belong to. Accepts collaboration ID.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The unique ARN for the configured audience model's associated collaboration.
" + }, + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"The Amazon Resource Name (ARN) of the configure audience model.
" + }, + "name":{ + "shape":"ConfiguredAudienceModelAssociationName", + "documentation":"The name of the configured audience model association.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of the configured audience model association.
" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"The identifier used to reference members of the collaboration. Only supports AWS account ID.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which the configured audience model association was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which the configured audience model association was updated.
" + } + }, + "documentation":"The configured audience model association within a collaboration.
" + }, + "CollaborationConfiguredAudienceModelAssociationSummary":{ + "type":"structure", + "required":[ + "arn", + "createTime", + "id", + "name", + "updateTime", + "collaborationArn", + "collaborationId", + "creatorAccountId" + ], + "members":{ + "arn":{ + "shape":"ConfiguredAudienceModelAssociationArn", + "documentation":"The Amazon Resource Name (ARN) of the configured audience model association.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which the configured audience model association was created.
" + }, + "id":{ + "shape":"ConfiguredAudienceModelAssociationIdentifier", + "documentation":"The identifier of the configured audience model association.
" + }, + "name":{ + "shape":"ConfiguredAudienceModelAssociationName", + "documentation":"The name of the configured audience model association.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which the configured audience model association was updated.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The unique ARN for the configured audience model's associated collaboration.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"A unique identifier for the collaboration that the configured audience model associations belong to. Accepts collaboration ID.
" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"The identifier used to reference members of the collaboration. Only supports AWS account ID.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of the configured audience model association.
" + } + }, + "documentation":"A summary of the configured audience model association in the collaboration.
" + }, + "CollaborationConfiguredAudienceModelAssociationSummaryList":{ + "type":"list", + "member":{"shape":"CollaborationConfiguredAudienceModelAssociationSummary"} + }, + "CollaborationDescription":{ + "type":"string", + "max":255, + "min":1, + "pattern":"(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*" + }, + "CollaborationIdNamespaceAssociation":{ + "type":"structure", + "required":[ + "id", + "arn", + "collaborationId", + "collaborationArn", + "name", + "creatorAccountId", + "createTime", + "updateTime", + "inputReferenceConfig", + "inputReferenceProperties" + ], + "members":{ + "id":{ + "shape":"IdNamespaceAssociationIdentifier", + "documentation":"The unique identifier of the collaboration ID namespace association.
" + }, + "arn":{ + "shape":"IdNamespaceAssociationArn", + "documentation":"The Amazon Resource Name (ARN) of the collaboration ID namespace association.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique identifier of the collaboration that contains the collaboration ID namespace association.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The Amazon Resource Name (ARN) of the collaboration that contains the collaboration ID namespace association.
" + }, + "name":{ + "shape":"GenericResourceName", + "documentation":"The name of the collaboration ID namespace association.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of the collaboration ID namespace association.
" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"The unique identifier of the Amazon Web Services account that created the collaboration ID namespace association.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which the collaboration ID namespace association was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which the collaboration ID namespace was updated.
" + }, + "inputReferenceConfig":{ + "shape":"IdNamespaceAssociationInputReferenceConfig", + "documentation":"The input reference configuration that's necessary to create the collaboration ID namespace association.
" + }, + "inputReferenceProperties":{ + "shape":"IdNamespaceAssociationInputReferenceProperties", + "documentation":"The input reference properties that are needed to create the collaboration ID namespace association.
" + }, + "idMappingConfig":{"shape":"IdMappingConfig"} + }, + "documentation":"Defines details for the collaboration ID namespace association.
" + }, + "CollaborationIdNamespaceAssociationSummary":{ + "type":"structure", + "required":[ + "arn", + "createTime", + "id", + "updateTime", + "collaborationArn", + "collaborationId", + "creatorAccountId", + "inputReferenceConfig", + "name", + "inputReferenceProperties" + ], + "members":{ + "arn":{ + "shape":"IdNamespaceAssociationArn", + "documentation":"The Amazon Resource Name (ARN) of the collaboration ID namespace association.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which the collaboration ID namespace association was created.
" + }, + "id":{ + "shape":"IdNamespaceAssociationIdentifier", + "documentation":"The unique identifier of the collaboration ID namespace association.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which the collaboration ID namespace association was updated.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The Amazon Resource Name (ARN) of the collaboration that contains this collaboration ID namespace association.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique identifier of the collaboration that contains this collaboration ID namespace association.
" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"The Amazon Web Services account that created this collaboration ID namespace association.
" + }, + "inputReferenceConfig":{ + "shape":"IdNamespaceAssociationInputReferenceConfig", + "documentation":"The input reference configuration that's used to create the collaboration ID namespace association.
" + }, + "name":{ + "shape":"GenericResourceName", + "documentation":"The name of the collaboration ID namespace association.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of the collaboration ID namepsace association.
" + }, + "inputReferenceProperties":{ + "shape":"IdNamespaceAssociationInputReferencePropertiesSummary", + "documentation":"The input reference properties that are used to create the collaboration ID namespace association.
" + } + }, + "documentation":"Provides summary information about the collaboration ID namespace association.
" + }, + "CollaborationIdNamespaceAssociationSummaryList":{ + "type":"list", + "member":{"shape":"CollaborationIdNamespaceAssociationSummary"} + }, + "CollaborationIdentifier":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "CollaborationName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*" + }, + "CollaborationPrivacyBudgetSummary":{ + "type":"structure", + "required":[ + "id", + "privacyBudgetTemplateId", + "privacyBudgetTemplateArn", + "collaborationId", + "collaborationArn", + "creatorAccountId", + "type", + "createTime", + "updateTime", + "budget" + ], + "members":{ + "id":{ + "shape":"UUID", + "documentation":"The unique identifier of the collaboration privacy budget.
" + }, + "privacyBudgetTemplateId":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"The unique identifier of the collaboration privacy budget template.
" + }, + "privacyBudgetTemplateArn":{ + "shape":"PrivacyBudgetTemplateArn", + "documentation":"The ARN of the collaboration privacy budget template.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique identifier of the collaboration that includes this privacy budget.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The ARN of the collaboration that includes this privacy budget.
" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"The unique identifier of the account that created this privacy budget.
" + }, + "type":{ + "shape":"PrivacyBudgetType", + "documentation":"The type of privacy budget template.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which the privacy budget was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which the privacy budget was updated.
" + }, + "budget":{ + "shape":"PrivacyBudget", + "documentation":"The includes epsilon provided and utility in terms of aggregations.
" + } + }, + "documentation":"A summary of the collaboration privacy budgets. This summary includes the collaboration information, creation information, epsilon provided, and utility in terms of aggregations.
" + }, + "CollaborationPrivacyBudgetSummaryList":{ + "type":"list", + "member":{"shape":"CollaborationPrivacyBudgetSummary"} + }, + "CollaborationPrivacyBudgetTemplate":{ + "type":"structure", + "required":[ + "id", + "arn", + "collaborationId", + "collaborationArn", + "creatorAccountId", + "createTime", + "updateTime", + "privacyBudgetType", + "autoRefresh", + "parameters" + ], + "members":{ + "id":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"The unique identifier of the collaboration privacy budget template.
" + }, + "arn":{ + "shape":"PrivacyBudgetTemplateArn", + "documentation":"The ARN of the collaboration privacy budget template.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique identifier of the collaboration that includes this collaboration privacy budget template.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The ARN of the collaboration that includes this collaboration privacy budget template.
" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"The unique identifier of the account that created this collaboration privacy budget template.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which the collaboration privacy budget template was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which the collaboration privacy budget template was updated.
" + }, + "privacyBudgetType":{ + "shape":"PrivacyBudgetType", + "documentation":"The type of privacy budget template.
" + }, + "autoRefresh":{ + "shape":"PrivacyBudgetTemplateAutoRefresh", + "documentation":"How often the privacy budget refreshes.
If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
Specifies the epsilon and noise parameters for the privacy budget template.
" + } + }, + "documentation":"An array that specifies the information for a collaboration's privacy budget template.
" + }, + "CollaborationPrivacyBudgetTemplateSummary":{ + "type":"structure", + "required":[ + "id", + "arn", + "collaborationId", + "collaborationArn", + "creatorAccountId", + "privacyBudgetType", + "createTime", + "updateTime" + ], + "members":{ + "id":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"The unique identifier of the collaboration privacy budget template.
" + }, + "arn":{ + "shape":"PrivacyBudgetTemplateArn", + "documentation":"The ARN of the collaboration privacy budget template.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique identifier of the collaboration that contains this collaboration privacy budget template.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The ARN of the collaboration that contains this collaboration privacy budget template.
" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"The unique identifier of the account that created this collaboration privacy budget template.
" + }, + "privacyBudgetType":{ + "shape":"PrivacyBudgetType", + "documentation":"The type of the privacy budget template.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which the collaboration privacy budget template was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which the collaboration privacy budget template was updated.
" + } + }, + "documentation":"A summary of the collaboration's privacy budget template. This summary includes information about who created the privacy budget template and what collaborations it belongs to.
" + }, + "CollaborationPrivacyBudgetTemplateSummaryList":{ + "type":"list", + "member":{"shape":"CollaborationPrivacyBudgetTemplateSummary"} + }, + "CollaborationQueryLogStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "CollaborationSummary":{ + "type":"structure", + "required":[ + "id", + "arn", + "name", + "creatorAccountId", + "creatorDisplayName", + "createTime", + "updateTime", + "memberStatus" + ], + "members":{ + "id":{ + "shape":"UUID", + "documentation":"The identifier for the collaboration.
" + }, + "arn":{ + "shape":"CollaborationArn", + "documentation":"The ARN of the collaboration.
" + }, + "name":{ + "shape":"CollaborationName", + "documentation":"A human-readable identifier provided by the collaboration owner. Display names are not unique.
" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
" + }, + "creatorDisplayName":{ + "shape":"DisplayName", + "documentation":"The display name of the collaboration creator.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time when the collaboration was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time the collaboration metadata was last updated.
" + }, + "memberStatus":{ + "shape":"MemberStatus", + "documentation":"The status of a member in a collaboration.
" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"The identifier of a member in a collaboration.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The ARN of a member in a collaboration.
" + } + }, + "documentation":"The metadata of the collaboration.
" + }, + "CollaborationSummaryList":{ + "type":"list", + "member":{"shape":"CollaborationSummary"} + }, + "Column":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "name":{ + "shape":"ColumnName", + "documentation":"The name of the column.
" + }, + "type":{ + "shape":"ColumnTypeString", + "documentation":"The type of the column.
" + } + }, + "documentation":"A column within a schema relation, derived from the underlying Glue table.
" + }, + "ColumnList":{ + "type":"list", + "member":{"shape":"Column"} + }, + "ColumnName":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?" + }, + "ColumnTypeString":{ + "type":"string", + "max":255, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*" + }, + "ConfigurationDetails":{ + "type":"structure", + "members":{ + "directAnalysisConfigurationDetails":{ + "shape":"DirectAnalysisConfigurationDetails", + "documentation":"The direct analysis configuration details.
" + } + }, + "documentation":"The configuration details.
", + "union":true + }, + "ConfiguredAudienceModelArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+" + }, + "ConfiguredAudienceModelAssociation":{ + "type":"structure", + "required":[ + "id", + "arn", + "configuredAudienceModelArn", + "membershipId", + "membershipArn", + "collaborationId", + "collaborationArn", + "name", + "manageResourcePolicies", + "createTime", + "updateTime" + ], + "members":{ + "id":{ + "shape":"ConfiguredAudienceModelAssociationIdentifier", + "documentation":"A unique identifier of the configured audience model association.
" + }, + "arn":{ + "shape":"ConfiguredAudienceModelAssociationArn", + "documentation":"The Amazon Resource Name (ARN) of the configured audience model association.
" + }, + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience model association.
" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"A unique identifier for the membership that contains this configured audience model association.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The Amazon Resource Name (ARN) of the membership that contains this configured audience model association.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"A unique identifier of the collaboration that contains this configured audience model association.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The Amazon Resource Name (ARN) of the collaboration that contains this configured audience model association.
" + }, + "name":{ + "shape":"ConfiguredAudienceModelAssociationName", + "documentation":"The name of the configured audience model association.
" + }, + "manageResourcePolicies":{ + "shape":"Boolean", + "documentation":"When TRUE, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When FALSE, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.
The description of the configured audience model association.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which the configured audience model association was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which the configured audience model association was updated.
" + } + }, + "documentation":"Details about the configured audience model association.
" + }, + "ConfiguredAudienceModelAssociationArn":{ + "type":"string", + "max":256, + "min":0, + "pattern":"arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/configuredaudiencemodelassociation/[\\d\\w-]+" + }, + "ConfiguredAudienceModelAssociationIdentifier":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "ConfiguredAudienceModelAssociationName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*" + }, + "ConfiguredAudienceModelAssociationSummary":{ + "type":"structure", + "required":[ + "membershipId", + "membershipArn", + "collaborationArn", + "collaborationId", + "createTime", + "updateTime", + "id", + "arn", + "name", + "configuredAudienceModelArn" + ], + "members":{ + "membershipId":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier of the membership that contains the configured audience model association.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The Amazon Resource Name (ARN) of the membership that contains the configured audience model association.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The Amazon Resource Name (ARN) of the collaboration that contains the configured audience model association.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"A unique identifier of the collaboration that configured audience model is associated with.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which the configured audience model association was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which the configured audience model association was updated.
" + }, + "id":{ + "shape":"UUID", + "documentation":"A unique identifier of the configured audience model association.
" + }, + "arn":{ + "shape":"ConfiguredAudienceModelAssociationArn", + "documentation":"The Amazon Resource Name (ARN) of the configured audience model association.
" + }, + "name":{ + "shape":"ConfiguredAudienceModelAssociationName", + "documentation":"The name of the configured audience model association.
" + }, + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience model association.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of the configured audience model association.
" + } + }, + "documentation":"A summary of the configured audience model association.
" + }, + "ConfiguredAudienceModelAssociationSummaryList":{ + "type":"list", + "member":{"shape":"ConfiguredAudienceModelAssociationSummary"} + }, + "ConfiguredTable":{ + "type":"structure", + "required":[ + "id", + "arn", + "name", + "tableReference", + "createTime", + "updateTime", + "analysisRuleTypes", + "analysisMethod", + "allowedColumns" + ], + "members":{ + "id":{ + "shape":"UUID", + "documentation":"The unique ID for the configured table.
" + }, + "arn":{ + "shape":"ConfiguredTableArn", + "documentation":"The unique ARN for the configured table.
" + }, + "name":{ + "shape":"DisplayName", + "documentation":"A name for the configured table.
" + }, + "description":{ + "shape":"TableDescription", + "documentation":"A description for the configured table.
" + }, + "tableReference":{ + "shape":"TableReference", + "documentation":"The Glue table that this configured table represents.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time the configured table was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time the configured table was last updated
" + }, + "analysisRuleTypes":{ + "shape":"ConfiguredTableAnalysisRuleTypeList", + "documentation":"The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.
" + }, + "analysisMethod":{ + "shape":"AnalysisMethod", + "documentation":"The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`.
" + }, + "allowedColumns":{ + "shape":"AllowedColumnList", + "documentation":"The columns within the underlying Glue table that can be utilized within collaborations.
" + } + }, + "documentation":"A table that has been configured for use in a collaboration.
" + }, + "ConfiguredTableAnalysisRule":{ + "type":"structure", + "required":[ + "configuredTableId", + "configuredTableArn", + "policy", + "type", + "createTime", + "updateTime" + ], + "members":{ + "configuredTableId":{ + "shape":"UUID", + "documentation":"The unique ID for the configured table.
" + }, + "configuredTableArn":{ + "shape":"ConfiguredTableArn", + "documentation":"The unique ARN for the configured table.
" + }, + "policy":{ + "shape":"ConfiguredTableAnalysisRulePolicy", + "documentation":"The policy that controls SQL query rules.
" + }, + "type":{ + "shape":"ConfiguredTableAnalysisRuleType", + "documentation":"The type of configured table analysis rule.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time the configured table analysis rule was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time the configured table analysis rule was last updated.
" + } + }, + "documentation":"A configured table analysis rule, which limits how data for this table can be used.
" + }, + "ConfiguredTableAnalysisRulePolicy":{ + "type":"structure", + "members":{ + "v1":{ + "shape":"ConfiguredTableAnalysisRulePolicyV1", + "documentation":"Controls on the query specifications that can be run on a configured table.
" + } + }, + "documentation":"Controls on the query specifications that can be run on a configured table.
", + "union":true + }, + "ConfiguredTableAnalysisRulePolicyV1":{ + "type":"structure", + "members":{ + "list":{ + "shape":"AnalysisRuleList", + "documentation":"Analysis rule type that enables only list queries on a configured table.
" + }, + "aggregation":{ + "shape":"AnalysisRuleAggregation", + "documentation":"Analysis rule type that enables only aggregation queries on a configured table.
" + }, + "custom":{"shape":"AnalysisRuleCustom"} + }, + "documentation":"Controls on the query specifications that can be run on a configured table.
", + "union":true + }, + "ConfiguredTableAnalysisRuleType":{ + "type":"string", + "enum":[ + "AGGREGATION", + "LIST", + "CUSTOM" + ] + }, + "ConfiguredTableAnalysisRuleTypeList":{ + "type":"list", + "member":{"shape":"ConfiguredTableAnalysisRuleType"} + }, + "ConfiguredTableArn":{ + "type":"string", + "max":100, + "min":0, + "pattern":"arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredtable/[\\d\\w-]+" + }, + "ConfiguredTableAssociation":{ + "type":"structure", + "required":[ + "arn", + "id", + "configuredTableId", + "configuredTableArn", + "membershipId", + "membershipArn", + "roleArn", + "name", + "createTime", + "updateTime" + ], + "members":{ + "arn":{ + "shape":"ConfiguredTableAssociationArn", + "documentation":"The unique ARN for the configured table association.
" + }, + "id":{ + "shape":"UUID", + "documentation":"The unique ID for the configured table association.
" + }, + "configuredTableId":{ + "shape":"UUID", + "documentation":"The unique ID for the configured table that the association refers to.
" + }, + "configuredTableArn":{ + "shape":"ConfiguredTableArn", + "documentation":"The unique ARN for the configured table that the association refers to.
" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"The unique ID for the membership this configured table association belongs to.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The unique ARN for the membership this configured table association belongs to.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The service will assume this role to access catalog metadata and query the table.
" + }, + "name":{ + "shape":"TableAlias", + "documentation":"The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.
" + }, + "description":{ + "shape":"TableDescription", + "documentation":"A description of the configured table association.
" + }, + "analysisRuleTypes":{ + "shape":"ConfiguredTableAssociationAnalysisRuleTypeList", + "documentation":"The analysis rule types for the configured table association.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time the configured table association was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time the configured table association was last updated.
" + } + }, + "documentation":"A configured table association links a configured table to a collaboration.
" + }, + "ConfiguredTableAssociationAnalysisRule":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "configuredTableAssociationId", + "configuredTableAssociationArn", + "policy", + "type", + "createTime", + "updateTime" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The membership identifier for the configured table association analysis rule.
" + }, + "configuredTableAssociationId":{ + "shape":"ConfiguredTableAssociationIdentifier", + "documentation":"The unique identifier for the configured table association.
" + }, + "configuredTableAssociationArn":{ + "shape":"ConfiguredTableAssociationArn", + "documentation":"The Amazon Resource Name (ARN) of the configured table association.
" + }, + "policy":{ + "shape":"ConfiguredTableAssociationAnalysisRulePolicy", + "documentation":"The policy of the configured table association analysis rule.
" + }, + "type":{ + "shape":"ConfiguredTableAssociationAnalysisRuleType", + "documentation":"The type of the configured table association analysis rule.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The creation time of the configured table association analysis rule.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The update time of the configured table association analysis rule.
" + } + }, + "documentation":"An analysis rule for a configured table association. This analysis rule specifies how data from the table can be used within its associated collaboration. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.
The list of collaboration members who are allowed to receive results of queries run with this configured table.
" + }, + "allowedAdditionalAnalyses":{ + "shape":"AllowedAdditionalAnalyses", + "documentation":"The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
The allowedAdditionalAnalyses parameter is currently supported for the list analysis rule (AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom).
The configured table association analysis rule applied to a configured table with the aggregation analysis rule.
" + }, + "ConfiguredTableAssociationAnalysisRuleCustom":{ + "type":"structure", + "members":{ + "allowedResultReceivers":{ + "shape":"AllowedResultReceivers", + "documentation":"The list of collaboration members who are allowed to receive results of queries run with this configured table.
" + }, + "allowedAdditionalAnalyses":{ + "shape":"AllowedAdditionalAnalyses", + "documentation":"The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
" + } + }, + "documentation":"The configured table association analysis rule applied to a configured table with the custom analysis rule.
" + }, + "ConfiguredTableAssociationAnalysisRuleList":{ + "type":"structure", + "members":{ + "allowedResultReceivers":{ + "shape":"AllowedResultReceivers", + "documentation":"The list of collaboration members who are allowed to receive results of queries run with this configured table.
" + }, + "allowedAdditionalAnalyses":{ + "shape":"AllowedAdditionalAnalyses", + "documentation":"The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
" + } + }, + "documentation":"The configured table association analysis rule applied to a configured table with the list analysis rule.
" + }, + "ConfiguredTableAssociationAnalysisRulePolicy":{ + "type":"structure", + "members":{ + "v1":{ + "shape":"ConfiguredTableAssociationAnalysisRulePolicyV1", + "documentation":"The policy for the configured table association analysis rule.
" + } + }, + "documentation":"Controls on the query specifications that can be run on an associated configured table.
", + "union":true + }, + "ConfiguredTableAssociationAnalysisRulePolicyV1":{ + "type":"structure", + "members":{ + "list":{ + "shape":"ConfiguredTableAssociationAnalysisRuleList", + "documentation":"Analysis rule type that enables only list queries on a configured table.
" + }, + "aggregation":{ + "shape":"ConfiguredTableAssociationAnalysisRuleAggregation", + "documentation":"Analysis rule type that enables only aggregation queries on a configured table.
" + }, + "custom":{ + "shape":"ConfiguredTableAssociationAnalysisRuleCustom", + "documentation":"Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.
" + } + }, + "documentation":"Controls on the query specifications that can be run on an associated configured table.
", + "union":true + }, + "ConfiguredTableAssociationAnalysisRuleType":{ + "type":"string", + "enum":[ + "AGGREGATION", + "LIST", + "CUSTOM" + ] + }, + "ConfiguredTableAssociationAnalysisRuleTypeList":{ + "type":"list", + "member":{"shape":"ConfiguredTableAssociationAnalysisRuleType"} + }, + "ConfiguredTableAssociationArn":{ + "type":"string", + "max":100, + "min":0, + "pattern":"arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredtableassociation/[\\d\\w-]+/[\\d\\w-]+" + }, + "ConfiguredTableAssociationIdentifier":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "ConfiguredTableAssociationSummary":{ + "type":"structure", + "required":[ + "configuredTableId", + "membershipId", + "membershipArn", + "name", + "createTime", + "updateTime", + "id", + "arn" + ], + "members":{ + "configuredTableId":{ + "shape":"UUID", + "documentation":"The unique configured table ID that this configured table association refers to.
" + }, + "membershipId":{ + "shape":"MembershipIdentifier", + "documentation":"The unique ID for the membership that the configured table association belongs to.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The unique ARN for the membership that the configured table association belongs to.
" + }, + "name":{ + "shape":"TableAlias", + "documentation":"The name of the configured table association. The table is identified by this name when running Protected Queries against the underlying data.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time the configured table association was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time the configured table association was last updated.
" + }, + "id":{ + "shape":"UUID", + "documentation":"The unique ID for the configured table association.
" + }, + "arn":{ + "shape":"ConfiguredTableAssociationArn", + "documentation":"The unique ARN for the configured table association.
" + } + }, + "documentation":"The configured table association summary for the objects listed by the request.
" + }, + "ConfiguredTableAssociationSummaryList":{ + "type":"list", + "member":{"shape":"ConfiguredTableAssociationSummary"} + }, + "ConfiguredTableIdentifier":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "ConfiguredTableSummary":{ + "type":"structure", + "required":[ + "id", + "arn", + "name", + "createTime", + "updateTime", + "analysisRuleTypes", + "analysisMethod" + ], + "members":{ + "id":{ + "shape":"ConfiguredTableIdentifier", + "documentation":"The unique ID of the configured table.
" + }, + "arn":{ + "shape":"ConfiguredTableArn", + "documentation":"The unique ARN of the configured table.
" + }, + "name":{ + "shape":"DisplayName", + "documentation":"The name of the configured table.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time the configured table was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time the configured table was last updated.
" + }, + "analysisRuleTypes":{ + "shape":"ConfiguredTableAnalysisRuleTypeList", + "documentation":"The types of analysis rules associated with this configured table.
" + }, + "analysisMethod":{ + "shape":"AnalysisMethod", + "documentation":"The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.
" + } + }, + "documentation":"The configured table summary for the objects listed by the request.
" + }, + "ConfiguredTableSummaryList":{ + "type":"list", + "member":{ + "shape":"ConfiguredTableSummary", + "documentation":"The member of the configured table summary list.
" + } + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "resourceId":{ + "shape":"String", + "documentation":"The ID of the conflicting resource.
" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"The type of the conflicting resource.
" + }, + "reason":{ + "shape":"ConflictExceptionReason", + "documentation":"A reason code for the exception.
" + } + }, + "documentation":"Updating or deleting a resource can cause an inconsistent state.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ConflictExceptionReason":{ + "type":"string", + "enum":[ + "ALREADY_EXISTS", + "SUBRESOURCES_EXIST", + "INVALID_STATE" + ] + }, + "CreateAnalysisTemplateInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "name", + "format", + "source" + ], + "members":{ + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of the analysis template.
" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The identifier for a membership resource.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "name":{ + "shape":"TableAlias", + "documentation":"The name of the analysis template.
" + }, + "format":{ + "shape":"AnalysisFormat", + "documentation":"The format of the analysis template.
" + }, + "source":{ + "shape":"AnalysisSource", + "documentation":"The information in the analysis template. Currently supports text, the query text for the analysis template.
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" + }, + "analysisParameters":{ + "shape":"AnalysisParameterList", + "documentation":"The parameters of the analysis template.
" + } + } + }, + "CreateAnalysisTemplateOutput":{ + "type":"structure", + "required":["analysisTemplate"], + "members":{ + "analysisTemplate":{ + "shape":"AnalysisTemplate", + "documentation":"The analysis template.
" + } + } + }, + "CreateCollaborationInput":{ + "type":"structure", + "required":[ + "members", + "name", + "description", + "creatorMemberAbilities", + "creatorDisplayName", + "queryLogStatus" + ], + "members":{ + "members":{ + "shape":"MemberList", + "documentation":"A list of initial members, not including the creator. This list is immutable.
" + }, + "name":{ + "shape":"CollaborationName", + "documentation":"The display name for a collaboration.
" + }, + "description":{ + "shape":"CollaborationDescription", + "documentation":"A description of the collaboration provided by the collaboration owner.
" + }, + "creatorMemberAbilities":{ + "shape":"MemberAbilities", + "documentation":"The abilities granted to the collaboration creator.
" + }, + "creatorDisplayName":{ + "shape":"DisplayName", + "documentation":"The display name of the collaboration creator.
" + }, + "dataEncryptionMetadata":{ + "shape":"DataEncryptionMetadata", + "documentation":"The settings for client-side encryption with Cryptographic Computing for Clean Rooms.
" + }, + "queryLogStatus":{ + "shape":"CollaborationQueryLogStatus", + "documentation":"An indicator as to whether query logging has been enabled or disabled for the collaboration.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" + }, + "creatorPaymentConfiguration":{ + "shape":"PaymentConfiguration", + "documentation":"The collaboration creator's payment responsibilities set by the collaboration creator.
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.
" + } + } + }, + "CreateCollaborationOutput":{ + "type":"structure", + "required":["collaboration"], + "members":{ + "collaboration":{ + "shape":"Collaboration", + "documentation":"The collaboration.
" + } + } + }, + "CreateConfiguredAudienceModelAssociationInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "configuredAudienceModelArn", + "configuredAudienceModelAssociationName", + "manageResourcePolicies" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for one of your memberships for a collaboration. The configured audience model is associated to the collaboration that this membership belongs to. Accepts a membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"A unique identifier for the configured audience model that you want to associate.
" + }, + "configuredAudienceModelAssociationName":{ + "shape":"ConfiguredAudienceModelAssociationName", + "documentation":"The name of the configured audience model association.
" + }, + "manageResourcePolicies":{ + "shape":"Boolean", + "documentation":"When TRUE, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When FALSE, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.
Setting this to TRUE requires you to have permissions to create, update, and delete the resource policy for the cleanrooms-ml resource when you call the DeleteConfiguredAudienceModelAssociation resource. In addition, if you are the collaboration creator and specify TRUE, you must have the same permissions when you call the DeleteMember and DeleteCollaboration APIs.
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"A description of the configured audience model association.
" + } + } + }, + "CreateConfiguredAudienceModelAssociationOutput":{ + "type":"structure", + "required":["configuredAudienceModelAssociation"], + "members":{ + "configuredAudienceModelAssociation":{ + "shape":"ConfiguredAudienceModelAssociation", + "documentation":"Information about the configured audience model association.
" + } + } + }, + "CreateConfiguredTableAnalysisRuleInput":{ + "type":"structure", + "required":[ + "configuredTableIdentifier", + "analysisRuleType", + "analysisRulePolicy" + ], + "members":{ + "configuredTableIdentifier":{ + "shape":"ConfiguredTableIdentifier", + "documentation":"The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID.
", + "location":"uri", + "locationName":"configuredTableIdentifier" + }, + "analysisRuleType":{ + "shape":"ConfiguredTableAnalysisRuleType", + "documentation":"The type of analysis rule.
" + }, + "analysisRulePolicy":{ + "shape":"ConfiguredTableAnalysisRulePolicy", + "documentation":"The analysis rule policy that was created for the configured table.
" + } + } + }, + "CreateConfiguredTableAnalysisRuleOutput":{ + "type":"structure", + "required":["analysisRule"], + "members":{ + "analysisRule":{ + "shape":"ConfiguredTableAnalysisRule", + "documentation":"The analysis rule that was created for the configured table.
" + } + } + }, + "CreateConfiguredTableAssociationAnalysisRuleInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "configuredTableAssociationIdentifier", + "analysisRuleType", + "analysisRulePolicy" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "configuredTableAssociationIdentifier":{ + "shape":"ConfiguredTableAssociationIdentifier", + "documentation":"The unique ID for the configured table association. Currently accepts the configured table association ID.
", + "location":"uri", + "locationName":"configuredTableAssociationIdentifier" + }, + "analysisRuleType":{ + "shape":"ConfiguredTableAssociationAnalysisRuleType", + "documentation":"The type of analysis rule.
" + }, + "analysisRulePolicy":{ + "shape":"ConfiguredTableAssociationAnalysisRulePolicy", + "documentation":"The analysis rule policy that was created for the configured table association.
" + } + } + }, + "CreateConfiguredTableAssociationAnalysisRuleOutput":{ + "type":"structure", + "required":["analysisRule"], + "members":{ + "analysisRule":{ + "shape":"ConfiguredTableAssociationAnalysisRule", + "documentation":"The analysis rule for the configured table association. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.
The name of the configured table association. This name is used to query the underlying configured table.
" + }, + "description":{ + "shape":"TableDescription", + "documentation":"A description for the configured table association.
" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for one of your memberships for a collaboration. The configured table is associated to the collaboration that this membership belongs to. Currently accepts a membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "configuredTableIdentifier":{ + "shape":"ConfiguredTableIdentifier", + "documentation":"A unique identifier for the configured table to be associated to. Currently accepts a configured table ID.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The service will assume this role to access catalog metadata and query the table.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" + } + } + }, + "CreateConfiguredTableAssociationOutput":{ + "type":"structure", + "required":["configuredTableAssociation"], + "members":{ + "configuredTableAssociation":{ + "shape":"ConfiguredTableAssociation", + "documentation":"The configured table association.
" + } + } + }, + "CreateConfiguredTableInput":{ + "type":"structure", + "required":[ + "name", + "tableReference", + "allowedColumns", + "analysisMethod" + ], + "members":{ + "name":{ + "shape":"DisplayName", + "documentation":"The name of the configured table.
" + }, + "description":{ + "shape":"TableDescription", + "documentation":"A description for the configured table.
" + }, + "tableReference":{ + "shape":"TableReference", + "documentation":"A reference to the Glue table being configured.
" + }, + "allowedColumns":{ + "shape":"AllowedColumnList", + "documentation":"The columns of the underlying table that can be used by collaborations or analysis rules.
" + }, + "analysisMethod":{ + "shape":"AnalysisMethod", + "documentation":"The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" + } + } + }, + "CreateConfiguredTableOutput":{ + "type":"structure", + "required":["configuredTable"], + "members":{ + "configuredTable":{ + "shape":"ConfiguredTable", + "documentation":"The created configured table.
" + } + } + }, + "CreateIdMappingTableInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "name", + "inputReferenceConfig" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The unique identifier of the membership that contains the ID mapping table.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "name":{ + "shape":"ResourceAlias", + "documentation":"A name for the ID mapping table.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"A description of the ID mapping table.
" + }, + "inputReferenceConfig":{ + "shape":"IdMappingTableInputReferenceConfig", + "documentation":"The input reference configuration needed to create the ID mapping table.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" + }, + "kmsKeyArn":{ + "shape":"KMSKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services KMS key. This value is used to encrypt the mapping table data that is stored by Clean Rooms.
" + } + } + }, + "CreateIdMappingTableOutput":{ + "type":"structure", + "required":["idMappingTable"], + "members":{ + "idMappingTable":{ + "shape":"IdMappingTable", + "documentation":"The ID mapping table that was created.
" + } + } + }, + "CreateIdNamespaceAssociationInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "inputReferenceConfig", + "name" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The unique identifier of the membership that contains the ID namespace association.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "inputReferenceConfig":{ + "shape":"IdNamespaceAssociationInputReferenceConfig", + "documentation":"The input reference configuration needed to create the ID namespace association.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" + }, + "name":{ + "shape":"GenericResourceName", + "documentation":"The name for the ID namespace association.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of the ID namespace association.
" + }, + "idMappingConfig":{ + "shape":"IdMappingConfig", + "documentation":"The configuration settings for the ID mapping table.
" + } + } + }, + "CreateIdNamespaceAssociationOutput":{ + "type":"structure", + "required":["idNamespaceAssociation"], + "members":{ + "idNamespaceAssociation":{ + "shape":"IdNamespaceAssociation", + "documentation":"The ID namespace association that was created.
" + } + } + }, + "CreateMembershipInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "queryLogStatus" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"The unique ID for the associated collaboration.
" + }, + "queryLogStatus":{ + "shape":"MembershipQueryLogStatus", + "documentation":"An indicator as to whether query logging has been enabled or disabled for the membership.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" + }, + "defaultResultConfiguration":{ + "shape":"MembershipProtectedQueryResultConfiguration", + "documentation":"The default protected query result configuration as specified by the member who can receive results.
" + }, + "paymentConfiguration":{ + "shape":"MembershipPaymentConfiguration", + "documentation":"The payment responsibilities accepted by the collaboration member.
Not required if the collaboration member has the member ability to run queries.
Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator.
" + } + } + }, + "CreateMembershipOutput":{ + "type":"structure", + "required":["membership"], + "members":{ + "membership":{ + "shape":"Membership", + "documentation":"The membership that was created.
" + } + } + }, + "CreatePrivacyBudgetTemplateInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "autoRefresh", + "privacyBudgetType", + "parameters" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "autoRefresh":{ + "shape":"PrivacyBudgetTemplateAutoRefresh", + "documentation":"How often the privacy budget refreshes.
If you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
Specifies the type of the privacy budget template.
" + }, + "parameters":{ + "shape":"PrivacyBudgetTemplateParametersInput", + "documentation":"Specifies your parameters for the privacy budget template.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" + } + } + }, + "CreatePrivacyBudgetTemplateOutput":{ + "type":"structure", + "required":["privacyBudgetTemplate"], + "members":{ + "privacyBudgetTemplate":{ + "shape":"PrivacyBudgetTemplate", + "documentation":"A summary of the elements in the privacy budget template.
" + } + } + }, + "DataEncryptionMetadata":{ + "type":"structure", + "required":[ + "allowCleartext", + "allowDuplicates", + "allowJoinsOnColumnsWithDifferentNames", + "preserveNulls" + ], + "members":{ + "allowCleartext":{ + "shape":"Boolean", + "documentation":"Indicates whether encrypted tables can contain cleartext data (TRUE) or are to cryptographically process every column (FALSE).
Indicates whether Fingerprint columns can contain duplicate entries (TRUE) or are to contain only non-repeated values (FALSE).
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (TRUE) or can only be joined on Fingerprint columns of the same name (FALSE).
Indicates whether NULL values are to be copied as NULL to encrypted tables (TRUE) or cryptographically processed (FALSE).
The settings for client-side encryption for cryptographic computing.
" + }, + "DeleteAnalysisTemplateInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "analysisTemplateIdentifier" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The identifier for a membership resource.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "analysisTemplateIdentifier":{ + "shape":"AnalysisTemplateIdentifier", + "documentation":"The identifier for the analysis template resource.
", + "location":"uri", + "locationName":"analysisTemplateIdentifier" + } + } + }, + "DeleteAnalysisTemplateOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteCollaborationInput":{ + "type":"structure", + "required":["collaborationIdentifier"], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"The identifier for the collaboration.
", + "location":"uri", + "locationName":"collaborationIdentifier" + } + } + }, + "DeleteCollaborationOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteConfiguredAudienceModelAssociationInput":{ + "type":"structure", + "required":[ + "configuredAudienceModelAssociationIdentifier", + "membershipIdentifier" + ], + "members":{ + "configuredAudienceModelAssociationIdentifier":{ + "shape":"ConfiguredAudienceModelAssociationIdentifier", + "documentation":"A unique identifier of the configured audience model association that you want to delete.
", + "location":"uri", + "locationName":"configuredAudienceModelAssociationIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier of the membership that contains the audience model association that you want to delete.
", + "location":"uri", + "locationName":"membershipIdentifier" + } + } + }, + "DeleteConfiguredAudienceModelAssociationOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteConfiguredTableAnalysisRuleInput":{ + "type":"structure", + "required":[ + "configuredTableIdentifier", + "analysisRuleType" + ], + "members":{ + "configuredTableIdentifier":{ + "shape":"ConfiguredTableIdentifier", + "documentation":"The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.
", + "location":"uri", + "locationName":"configuredTableIdentifier" + }, + "analysisRuleType":{ + "shape":"ConfiguredTableAnalysisRuleType", + "documentation":"The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
", + "location":"uri", + "locationName":"analysisRuleType" + } + } + }, + "DeleteConfiguredTableAnalysisRuleOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"An empty response that indicates a successful delete.
" + }, + "DeleteConfiguredTableAssociationAnalysisRuleInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "configuredTableAssociationIdentifier", + "analysisRuleType" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "configuredTableAssociationIdentifier":{ + "shape":"ConfiguredTableAssociationIdentifier", + "documentation":"The identifier for the configured table association that's related to the analysis rule that you want to delete.
", + "location":"uri", + "locationName":"configuredTableAssociationIdentifier" + }, + "analysisRuleType":{ + "shape":"ConfiguredTableAssociationAnalysisRuleType", + "documentation":"The type of the analysis rule that you want to delete.
", + "location":"uri", + "locationName":"analysisRuleType" + } + } + }, + "DeleteConfiguredTableAssociationAnalysisRuleOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteConfiguredTableAssociationInput":{ + "type":"structure", + "required":[ + "configuredTableAssociationIdentifier", + "membershipIdentifier" + ], + "members":{ + "configuredTableAssociationIdentifier":{ + "shape":"ConfiguredTableAssociationIdentifier", + "documentation":"The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.
", + "location":"uri", + "locationName":"configuredTableAssociationIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + } + } + }, + "DeleteConfiguredTableAssociationOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteConfiguredTableInput":{ + "type":"structure", + "required":["configuredTableIdentifier"], + "members":{ + "configuredTableIdentifier":{ + "shape":"ConfiguredTableIdentifier", + "documentation":"The unique ID for the configured table to delete.
", + "location":"uri", + "locationName":"configuredTableIdentifier" + } + } + }, + "DeleteConfiguredTableOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"The empty output for a successful deletion.
" + }, + "DeleteIdMappingTableInput":{ + "type":"structure", + "required":[ + "idMappingTableIdentifier", + "membershipIdentifier" + ], + "members":{ + "idMappingTableIdentifier":{ + "shape":"UUID", + "documentation":"The unique identifier of the ID mapping table that you want to delete.
", + "location":"uri", + "locationName":"idMappingTableIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The unique identifier of the membership that contains the ID mapping table that you want to delete.
", + "location":"uri", + "locationName":"membershipIdentifier" + } + } + }, + "DeleteIdMappingTableOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteIdNamespaceAssociationInput":{ + "type":"structure", + "required":[ + "idNamespaceAssociationIdentifier", + "membershipIdentifier" + ], + "members":{ + "idNamespaceAssociationIdentifier":{ + "shape":"IdNamespaceAssociationIdentifier", + "documentation":"The unique identifier of the ID namespace association that you want to delete.
", + "location":"uri", + "locationName":"idNamespaceAssociationIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The unique identifier of the membership that contains the ID namespace association that you want to delete.
", + "location":"uri", + "locationName":"membershipIdentifier" + } + } + }, + "DeleteIdNamespaceAssociationOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteMemberInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "accountId" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"The unique identifier for the associated collaboration.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "accountId":{ + "shape":"AccountId", + "documentation":"The account ID of the member to remove.
", + "location":"uri", + "locationName":"accountId" + } + } + }, + "DeleteMemberOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteMembershipInput":{ + "type":"structure", + "required":["membershipIdentifier"], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The identifier for a membership resource.
", + "location":"uri", + "locationName":"membershipIdentifier" + } + } + }, + "DeleteMembershipOutput":{ + "type":"structure", + "members":{ + } + }, + "DeletePrivacyBudgetTemplateInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "privacyBudgetTemplateIdentifier" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for one of your memberships for a collaboration. The privacy budget template is deleted from the collaboration that this membership belongs to. Accepts a membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "privacyBudgetTemplateIdentifier":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"A unique identifier for your privacy budget template.
", + "location":"uri", + "locationName":"privacyBudgetTemplateIdentifier" + } + } + }, + "DeletePrivacyBudgetTemplateOutput":{ + "type":"structure", + "members":{ + } + }, + "DifferentialPrivacyAggregationExpression":{ + "type":"string", + "min":1 + }, + "DifferentialPrivacyAggregationType":{ + "type":"string", + "enum":[ + "AVG", + "COUNT", + "COUNT_DISTINCT", + "SUM", + "STDDEV" + ] + }, + "DifferentialPrivacyColumn":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"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.
" + } + }, + "documentation":"Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect.
" + }, + "DifferentialPrivacyColumnList":{ + "type":"list", + "member":{"shape":"DifferentialPrivacyColumn"}, + "max":1, + "min":1 + }, + "DifferentialPrivacyConfiguration":{ + "type":"structure", + "required":["columns"], + "members":{ + "columns":{ + "shape":"DifferentialPrivacyColumnList", + "documentation":"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.
" + } + }, + "documentation":"Specifies the unique identifier for your users.
" + }, + "DifferentialPrivacyParameters":{ + "type":"structure", + "required":["sensitivityParameters"], + "members":{ + "sensitivityParameters":{ + "shape":"DifferentialPrivacySensitivityParametersList", + "documentation":"Provides the sensitivity parameters that you can use to better understand the total amount of noise in query results.
" + } + }, + "documentation":"An array that contains the sensitivity parameters.
" + }, + "DifferentialPrivacyPreviewAggregation":{ + "type":"structure", + "required":[ + "type", + "maxCount" + ], + "members":{ + "type":{ + "shape":"DifferentialPrivacyAggregationType", + "documentation":"The type of aggregation function.
" + }, + "maxCount":{ + "shape":"DifferentialPrivacyPreviewAggregationMaxCountInteger", + "documentation":"The maximum number of aggregations that the member who can query can run given the epsilon and noise parameters.
" + } + }, + "documentation":"Provides an estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.
" + }, + "DifferentialPrivacyPreviewAggregationList":{ + "type":"list", + "member":{"shape":"DifferentialPrivacyPreviewAggregation"} + }, + "DifferentialPrivacyPreviewAggregationMaxCountInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "DifferentialPrivacyPreviewParametersInput":{ + "type":"structure", + "required":[ + "epsilon", + "usersNoisePerQuery" + ], + "members":{ + "epsilon":{ + "shape":"Epsilon", + "documentation":"The epsilon value that you want to preview.
" + }, + "usersNoisePerQuery":{ + "shape":"UsersNoisePerQuery", + "documentation":"Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.
" + } + }, + "documentation":"The epsilon and noise parameters that you want to preview.
" + }, + "DifferentialPrivacyPrivacyBudget":{ + "type":"structure", + "required":[ + "aggregations", + "epsilon" + ], + "members":{ + "aggregations":{ + "shape":"DifferentialPrivacyPrivacyBudgetAggregationList", + "documentation":"This information includes the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations.
" + }, + "epsilon":{ + "shape":"Epsilon", + "documentation":"The epsilon value that you configured.
" + } + }, + "documentation":"Specifies the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations available.
" + }, + "DifferentialPrivacyPrivacyBudgetAggregation":{ + "type":"structure", + "required":[ + "type", + "maxCount", + "remainingCount" + ], + "members":{ + "type":{ + "shape":"DifferentialPrivacyAggregationType", + "documentation":"The different types of aggregation functions that you can perform.
" + }, + "maxCount":{ + "shape":"DifferentialPrivacyPrivacyBudgetAggregationMaxCountInteger", + "documentation":"The maximum number of aggregation functions that you can perform with the given privacy budget.
" + }, + "remainingCount":{ + "shape":"DifferentialPrivacyPrivacyBudgetAggregationRemainingCountInteger", + "documentation":"The remaining number of aggregation functions that can be run with the available privacy budget.
" + } + }, + "documentation":"Information about the total number of aggregations, as well as the remaining aggregations.
" + }, + "DifferentialPrivacyPrivacyBudgetAggregationList":{ + "type":"list", + "member":{"shape":"DifferentialPrivacyPrivacyBudgetAggregation"} + }, + "DifferentialPrivacyPrivacyBudgetAggregationMaxCountInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "DifferentialPrivacyPrivacyBudgetAggregationRemainingCountInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "DifferentialPrivacyPrivacyImpact":{ + "type":"structure", + "required":["aggregations"], + "members":{ + "aggregations":{ + "shape":"DifferentialPrivacyPreviewAggregationList", + "documentation":"The number of aggregation functions that you can perform.
" + } + }, + "documentation":"Information about the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.
" + }, + "DifferentialPrivacySensitivityParameters":{ + "type":"structure", + "required":[ + "aggregationType", + "aggregationExpression", + "userContributionLimit" + ], + "members":{ + "aggregationType":{ + "shape":"DifferentialPrivacyAggregationType", + "documentation":"The type of aggregation function that was run.
" + }, + "aggregationExpression":{ + "shape":"DifferentialPrivacyAggregationExpression", + "documentation":"The aggregation expression that was run.
" + }, + "userContributionLimit":{ + "shape":"DifferentialPrivacySensitivityParametersUserContributionLimitInteger", + "documentation":"The maximum number of rows contributed by a user in a SQL query.
" + }, + "minColumnValue":{ + "shape":"Float", + "documentation":"The lower bound of the aggregation expression.
" + }, + "maxColumnValue":{ + "shape":"Float", + "documentation":"The upper bound of the aggregation expression.
" + } + }, + "documentation":"Provides the sensitivity parameters.
" + }, + "DifferentialPrivacySensitivityParametersList":{ + "type":"list", + "member":{"shape":"DifferentialPrivacySensitivityParameters"} + }, + "DifferentialPrivacySensitivityParametersUserContributionLimitInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "DifferentialPrivacyTemplateParametersInput":{ + "type":"structure", + "required":[ + "epsilon", + "usersNoisePerQuery" + ], + "members":{ + "epsilon":{ + "shape":"Epsilon", + "documentation":"The epsilon value that you want to use.
" + }, + "usersNoisePerQuery":{ + "shape":"UsersNoisePerQuery", + "documentation":"Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.
" + } + }, + "documentation":"The epsilon and noise parameter values that you want to use for the differential privacy template.
" + }, + "DifferentialPrivacyTemplateParametersOutput":{ + "type":"structure", + "required":[ + "epsilon", + "usersNoisePerQuery" + ], + "members":{ + "epsilon":{ + "shape":"Epsilon", + "documentation":"The epsilon value that you specified.
" + }, + "usersNoisePerQuery":{ + "shape":"UsersNoisePerQuery", + "documentation":"Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.
" + } + }, + "documentation":"The epsilon and noise parameter values that were used for the differential privacy template.
" + }, + "DifferentialPrivacyTemplateUpdateParameters":{ + "type":"structure", + "members":{ + "epsilon":{ + "shape":"Epsilon", + "documentation":"The updated epsilon value that you want to use.
" + }, + "usersNoisePerQuery":{ + "shape":"UsersNoisePerQuery", + "documentation":"The updated value of noise added per query. It is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.
" + } + }, + "documentation":"The epsilon and noise parameter values that you want to update in the differential privacy template.
" + }, + "DirectAnalysisConfigurationDetails":{ + "type":"structure", + "members":{ + "receiverAccountIds":{ + "shape":"ReceiverAccountIds", + "documentation":"The account IDs for the member who received the results of a protected query.
" + } + }, + "documentation":"The direct analysis configuration details.
" + }, + "DisplayName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*" + }, + "Document":{ + "type":"structure", + "members":{ + }, + "document":true + }, + "Double":{ + "type":"double", + "box":true + }, + "Epsilon":{ + "type":"integer", + "box":true, + "max":20, + "min":1 + }, + "FilterableMemberStatus":{ + "type":"string", + "enum":[ + "INVITED", + "ACTIVE" + ] + }, + "Float":{ + "type":"float", + "box":true + }, + "GenericResourceName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*" + }, + "GetAnalysisTemplateInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "analysisTemplateIdentifier" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The identifier for a membership resource.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "analysisTemplateIdentifier":{ + "shape":"AnalysisTemplateIdentifier", + "documentation":"The identifier for the analysis template resource.
", + "location":"uri", + "locationName":"analysisTemplateIdentifier" + } + } + }, + "GetAnalysisTemplateOutput":{ + "type":"structure", + "required":["analysisTemplate"], + "members":{ + "analysisTemplate":{ + "shape":"AnalysisTemplate", + "documentation":"The analysis template.
" + } + } + }, + "GetCollaborationAnalysisTemplateInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "analysisTemplateArn" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "analysisTemplateArn":{ + "shape":"AnalysisTemplateArn", + "documentation":"The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
", + "location":"uri", + "locationName":"analysisTemplateArn" + } + } + }, + "GetCollaborationAnalysisTemplateOutput":{ + "type":"structure", + "required":["collaborationAnalysisTemplate"], + "members":{ + "collaborationAnalysisTemplate":{ + "shape":"CollaborationAnalysisTemplate", + "documentation":"The analysis template within a collaboration.
" + } + } + }, + "GetCollaborationConfiguredAudienceModelAssociationInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "configuredAudienceModelAssociationIdentifier" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "configuredAudienceModelAssociationIdentifier":{ + "shape":"ConfiguredAudienceModelAssociationIdentifier", + "documentation":"A unique identifier for the configured audience model association that you want to retrieve.
", + "location":"uri", + "locationName":"configuredAudienceModelAssociationIdentifier" + } + } + }, + "GetCollaborationConfiguredAudienceModelAssociationOutput":{ + "type":"structure", + "required":["collaborationConfiguredAudienceModelAssociation"], + "members":{ + "collaborationConfiguredAudienceModelAssociation":{ + "shape":"CollaborationConfiguredAudienceModelAssociation", + "documentation":"The metadata of the configured audience model association.
" + } + } + }, + "GetCollaborationIdNamespaceAssociationInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "idNamespaceAssociationIdentifier" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"The unique identifier of the collaboration that contains the ID namespace association that you want to retrieve.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "idNamespaceAssociationIdentifier":{ + "shape":"IdNamespaceAssociationIdentifier", + "documentation":"The unique identifier of the ID namespace association that you want to retrieve.
", + "location":"uri", + "locationName":"idNamespaceAssociationIdentifier" + } + } + }, + "GetCollaborationIdNamespaceAssociationOutput":{ + "type":"structure", + "required":["collaborationIdNamespaceAssociation"], + "members":{ + "collaborationIdNamespaceAssociation":{ + "shape":"CollaborationIdNamespaceAssociation", + "documentation":"The ID namespace association that you requested.
" + } + } + }, + "GetCollaborationInput":{ + "type":"structure", + "required":["collaborationIdentifier"], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"The identifier for the collaboration.
", + "location":"uri", + "locationName":"collaborationIdentifier" + } + } + }, + "GetCollaborationOutput":{ + "type":"structure", + "required":["collaboration"], + "members":{ + "collaboration":{ + "shape":"Collaboration", + "documentation":"The entire collaboration for this identifier.
" + } + } + }, + "GetCollaborationPrivacyBudgetTemplateInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "privacyBudgetTemplateIdentifier" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"A unique identifier for one of your collaborations.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "privacyBudgetTemplateIdentifier":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"A unique identifier for one of your privacy budget templates.
", + "location":"uri", + "locationName":"privacyBudgetTemplateIdentifier" + } + } + }, + "GetCollaborationPrivacyBudgetTemplateOutput":{ + "type":"structure", + "required":["collaborationPrivacyBudgetTemplate"], + "members":{ + "collaborationPrivacyBudgetTemplate":{ + "shape":"CollaborationPrivacyBudgetTemplate", + "documentation":"Returns the details of the privacy budget template that you requested.
" + } + } + }, + "GetConfiguredAudienceModelAssociationInput":{ + "type":"structure", + "required":[ + "configuredAudienceModelAssociationIdentifier", + "membershipIdentifier" + ], + "members":{ + "configuredAudienceModelAssociationIdentifier":{ + "shape":"ConfiguredAudienceModelAssociationIdentifier", + "documentation":"A unique identifier for the configured audience model association that you want to retrieve.
", + "location":"uri", + "locationName":"configuredAudienceModelAssociationIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for the membership that contains the configured audience model association that you want to retrieve.
", + "location":"uri", + "locationName":"membershipIdentifier" + } + } + }, + "GetConfiguredAudienceModelAssociationOutput":{ + "type":"structure", + "required":["configuredAudienceModelAssociation"], + "members":{ + "configuredAudienceModelAssociation":{ + "shape":"ConfiguredAudienceModelAssociation", + "documentation":"Information about the configured audience model association that you requested.
" + } + } + }, + "GetConfiguredTableAnalysisRuleInput":{ + "type":"structure", + "required":[ + "configuredTableIdentifier", + "analysisRuleType" + ], + "members":{ + "configuredTableIdentifier":{ + "shape":"ConfiguredTableIdentifier", + "documentation":"The unique identifier for the configured table to retrieve. Currently accepts the configured table ID.
", + "location":"uri", + "locationName":"configuredTableIdentifier" + }, + "analysisRuleType":{ + "shape":"ConfiguredTableAnalysisRuleType", + "documentation":"The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
", + "location":"uri", + "locationName":"analysisRuleType" + } + } + }, + "GetConfiguredTableAnalysisRuleOutput":{ + "type":"structure", + "required":["analysisRule"], + "members":{ + "analysisRule":{ + "shape":"ConfiguredTableAnalysisRule", + "documentation":"The entire analysis rule output.
" + } + } + }, + "GetConfiguredTableAssociationAnalysisRuleInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "configuredTableAssociationIdentifier", + "analysisRuleType" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "configuredTableAssociationIdentifier":{ + "shape":"ConfiguredTableAssociationIdentifier", + "documentation":"The identifier for the configured table association that's related to the analysis rule.
", + "location":"uri", + "locationName":"configuredTableAssociationIdentifier" + }, + "analysisRuleType":{ + "shape":"ConfiguredTableAssociationAnalysisRuleType", + "documentation":"The type of analysis rule that you want to retrieve.
", + "location":"uri", + "locationName":"analysisRuleType" + } + } + }, + "GetConfiguredTableAssociationAnalysisRuleOutput":{ + "type":"structure", + "required":["analysisRule"], + "members":{ + "analysisRule":{ + "shape":"ConfiguredTableAssociationAnalysisRule", + "documentation":"The analysis rule for the configured table association. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.
The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.
", + "location":"uri", + "locationName":"configuredTableAssociationIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + } + } + }, + "GetConfiguredTableAssociationOutput":{ + "type":"structure", + "required":["configuredTableAssociation"], + "members":{ + "configuredTableAssociation":{ + "shape":"ConfiguredTableAssociation", + "documentation":"The entire configured table association object.
" + } + } + }, + "GetConfiguredTableInput":{ + "type":"structure", + "required":["configuredTableIdentifier"], + "members":{ + "configuredTableIdentifier":{ + "shape":"ConfiguredTableIdentifier", + "documentation":"The unique ID for the configured table to retrieve.
", + "location":"uri", + "locationName":"configuredTableIdentifier" + } + } + }, + "GetConfiguredTableOutput":{ + "type":"structure", + "required":["configuredTable"], + "members":{ + "configuredTable":{ + "shape":"ConfiguredTable", + "documentation":"The retrieved configured table.
" + } + } + }, + "GetIdMappingTableInput":{ + "type":"structure", + "required":[ + "idMappingTableIdentifier", + "membershipIdentifier" + ], + "members":{ + "idMappingTableIdentifier":{ + "shape":"UUID", + "documentation":"The unique identifier of the ID mapping table identifier that you want to retrieve.
", + "location":"uri", + "locationName":"idMappingTableIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The unique identifier of the membership that contains the ID mapping table that you want to retrieve.
", + "location":"uri", + "locationName":"membershipIdentifier" + } + } + }, + "GetIdMappingTableOutput":{ + "type":"structure", + "required":["idMappingTable"], + "members":{ + "idMappingTable":{ + "shape":"IdMappingTable", + "documentation":"The ID mapping table that you requested.
" + } + } + }, + "GetIdNamespaceAssociationInput":{ + "type":"structure", + "required":[ + "idNamespaceAssociationIdentifier", + "membershipIdentifier" + ], + "members":{ + "idNamespaceAssociationIdentifier":{ + "shape":"IdNamespaceAssociationIdentifier", + "documentation":"The unique identifier of the ID namespace association that you want to retrieve.
", + "location":"uri", + "locationName":"idNamespaceAssociationIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The unique identifier of the membership that contains the ID namespace association that you want to retrieve.
", + "location":"uri", + "locationName":"membershipIdentifier" + } + } + }, + "GetIdNamespaceAssociationOutput":{ + "type":"structure", + "required":["idNamespaceAssociation"], + "members":{ + "idNamespaceAssociation":{ + "shape":"IdNamespaceAssociation", + "documentation":"The ID namespace association that you requested.
" + } + } + }, + "GetMembershipInput":{ + "type":"structure", + "required":["membershipIdentifier"], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The identifier for a membership resource.
", + "location":"uri", + "locationName":"membershipIdentifier" + } + } + }, + "GetMembershipOutput":{ + "type":"structure", + "required":["membership"], + "members":{ + "membership":{ + "shape":"Membership", + "documentation":"The membership retrieved for the provided identifier.
" + } + } + }, + "GetPrivacyBudgetTemplateInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "privacyBudgetTemplateIdentifier" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for one of your memberships for a collaboration. The privacy budget template is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "privacyBudgetTemplateIdentifier":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"A unique identifier for your privacy budget template.
", + "location":"uri", + "locationName":"privacyBudgetTemplateIdentifier" + } + } + }, + "GetPrivacyBudgetTemplateOutput":{ + "type":"structure", + "required":["privacyBudgetTemplate"], + "members":{ + "privacyBudgetTemplate":{ + "shape":"PrivacyBudgetTemplate", + "documentation":"Returns the details of the privacy budget template that you requested.
" + } + } + }, + "GetProtectedQueryInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "protectedQueryIdentifier" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The identifier for a membership in a protected query instance.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "protectedQueryIdentifier":{ + "shape":"ProtectedQueryIdentifier", + "documentation":"The identifier for a protected query instance.
", + "location":"uri", + "locationName":"protectedQueryIdentifier" + } + } + }, + "GetProtectedQueryOutput":{ + "type":"structure", + "required":["protectedQuery"], + "members":{ + "protectedQuery":{ + "shape":"ProtectedQuery", + "documentation":"The query processing metadata.
" + } + } + }, + "GetSchemaAnalysisRuleInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "name", + "type" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "name":{ + "shape":"TableAlias", + "documentation":"The name of the schema to retrieve the analysis rule for.
", + "location":"uri", + "locationName":"name" + }, + "type":{ + "shape":"AnalysisRuleType", + "documentation":"The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.
", + "location":"uri", + "locationName":"type" + } + } + }, + "GetSchemaAnalysisRuleOutput":{ + "type":"structure", + "required":["analysisRule"], + "members":{ + "analysisRule":{ + "shape":"AnalysisRule", + "documentation":"A specification about how data from the configured table can be used.
" + } + } + }, + "GetSchemaInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "name" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "name":{ + "shape":"TableAlias", + "documentation":"The name of the relation to retrieve the schema for.
", + "location":"uri", + "locationName":"name" + } + } + }, + "GetSchemaOutput":{ + "type":"structure", + "required":["schema"], + "members":{ + "schema":{ + "shape":"Schema", + "documentation":"The entire schema object.
" + } + } + }, + "GlueDatabaseName":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?" + }, + "GlueTableName":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?" + }, + "GlueTableReference":{ + "type":"structure", + "required":[ + "tableName", + "databaseName" + ], + "members":{ + "tableName":{ + "shape":"GlueTableName", + "documentation":"The name of the Glue table.
" + }, + "databaseName":{ + "shape":"GlueDatabaseName", + "documentation":"The name of the database the Glue table belongs to.
" + } + }, + "documentation":"A reference to a table within an Glue data catalog.
" + }, + "IdMappingConfig":{ + "type":"structure", + "required":["allowUseAsDimensionColumn"], + "members":{ + "allowUseAsDimensionColumn":{ + "shape":"Boolean", + "documentation":"An indicator as to whether you can use your column as a dimension column in the ID mapping table (TRUE) or not (FALSE).
Default is FALSE.
The configuration settings for the ID mapping table.
" + }, + "IdMappingTable":{ + "type":"structure", + "required":[ + "id", + "arn", + "inputReferenceConfig", + "membershipId", + "membershipArn", + "collaborationId", + "collaborationArn", + "name", + "createTime", + "updateTime", + "inputReferenceProperties" + ], + "members":{ + "id":{ + "shape":"UUID", + "documentation":"The unique identifier of the ID mapping table.
" + }, + "arn":{ + "shape":"IdMappingTableArn", + "documentation":"The Amazon Resource Name (ARN) of the ID mapping table.
" + }, + "inputReferenceConfig":{ + "shape":"IdMappingTableInputReferenceConfig", + "documentation":"The input reference configuration for the ID mapping table.
" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"The unique identifier of the membership resource for the ID mapping table.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The Amazon Resource Name (ARN) of the membership resource for the ID mapping table.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique identifier of the collaboration that contains this ID mapping table.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of the ID mapping table.
" + }, + "name":{ + "shape":"ResourceAlias", + "documentation":"The name of the ID mapping table.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which the ID mapping table was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which the ID mapping table was updated.
" + }, + "inputReferenceProperties":{ + "shape":"IdMappingTableInputReferenceProperties", + "documentation":"The input reference properties for the ID mapping table.
" + }, + "kmsKeyArn":{ + "shape":"KMSKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.
" + } + }, + "documentation":"Describes information about the ID mapping table.
" + }, + "IdMappingTableArn":{ + "type":"string", + "max":200, + "min":0, + "pattern":"arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/idmappingtable/[\\d\\w-]+" + }, + "IdMappingTableInputReferenceArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(idmappingworkflow/.*)" + }, + "IdMappingTableInputReferenceConfig":{ + "type":"structure", + "required":[ + "inputReferenceArn", + "manageResourcePolicies" + ], + "members":{ + "inputReferenceArn":{ + "shape":"IdMappingTableInputReferenceArn", + "documentation":"The Amazon Resource Name (ARN) of the referenced resource in Entity Resolution. Valid values are ID mapping workflow ARNs.
" + }, + "manageResourcePolicies":{ + "shape":"Boolean", + "documentation":"When TRUE, Clean Rooms manages permissions for the ID mapping table resource.
When FALSE, the resource owner manages permissions for the ID mapping table resource.
Provides the input reference configuration for the ID mapping table.
" + }, + "IdMappingTableInputReferenceProperties":{ + "type":"structure", + "required":["idMappingTableInputSource"], + "members":{ + "idMappingTableInputSource":{ + "shape":"IdMappingTableInputSourceList", + "documentation":"The input source of the ID mapping table.
" + } + }, + "documentation":"The input reference properties for the ID mapping table.
" + }, + "IdMappingTableInputSource":{ + "type":"structure", + "required":[ + "idNamespaceAssociationId", + "type" + ], + "members":{ + "idNamespaceAssociationId":{ + "shape":"String", + "documentation":"The unique identifier of the ID namespace association.
" + }, + "type":{ + "shape":"IdNamespaceType", + "documentation":"The type of the input source of the ID mapping table.
" + } + }, + "documentation":"The input source of the ID mapping table.
" + }, + "IdMappingTableInputSourceList":{ + "type":"list", + "member":{"shape":"IdMappingTableInputSource"}, + "max":2, + "min":2 + }, + "IdMappingTableSchemaTypeProperties":{ + "type":"structure", + "required":["idMappingTableInputSource"], + "members":{ + "idMappingTableInputSource":{ + "shape":"IdMappingTableInputSourceList", + "documentation":"Defines which ID namespace associations are used to create the ID mapping table.
" + } + }, + "documentation":"Additional properties that are specific to the type of the associated schema.
" + }, + "IdMappingTableSummary":{ + "type":"structure", + "required":[ + "collaborationArn", + "collaborationId", + "membershipId", + "membershipArn", + "createTime", + "updateTime", + "id", + "arn", + "inputReferenceConfig", + "name" + ], + "members":{ + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique identifier of the collaboration that contains this ID mapping table.
" + }, + "membershipId":{ + "shape":"MembershipIdentifier", + "documentation":"The unique identifier of the membership resource for this ID mapping table.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The Amazon Resource Name (ARN) of the membership resource for this ID mapping table.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which this ID mapping table was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which this ID mapping table was updated.
" + }, + "id":{ + "shape":"UUID", + "documentation":"The unique identifier of this ID mapping table.
" + }, + "arn":{ + "shape":"IdMappingTableArn", + "documentation":"The Amazon Resource Name (ARN) of this ID mapping table.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of this ID mapping table.
" + }, + "inputReferenceConfig":{ + "shape":"IdMappingTableInputReferenceConfig", + "documentation":"The input reference configuration for the ID mapping table.
" + }, + "name":{ + "shape":"ResourceAlias", + "documentation":"The name of this ID mapping table.
" + } + }, + "documentation":"Detailed information about the ID mapping table.
" + }, + "IdMappingTableSummaryList":{ + "type":"list", + "member":{"shape":"IdMappingTableSummary"} + }, + "IdMappingWorkflowsSupported":{ + "type":"list", + "member":{"shape":"Document"} + }, + "IdNamespaceAssociation":{ + "type":"structure", + "required":[ + "id", + "arn", + "membershipId", + "membershipArn", + "collaborationId", + "collaborationArn", + "name", + "createTime", + "updateTime", + "inputReferenceConfig", + "inputReferenceProperties" + ], + "members":{ + "id":{ + "shape":"IdNamespaceAssociationIdentifier", + "documentation":"The unique identifier for this ID namespace association.
" + }, + "arn":{ + "shape":"IdNamespaceAssociationArn", + "documentation":"The Amazon Resource Name (ARN) of the ID namespace association.
" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"The unique identifier of the membership resource for this ID namespace association.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique identifier of the collaboration that contains this ID namespace association.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.
" + }, + "name":{ + "shape":"GenericResourceName", + "documentation":"The name of this ID namespace association.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of the ID namespace association.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which the ID namespace association was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which the ID namespace association was updated.
" + }, + "inputReferenceConfig":{ + "shape":"IdNamespaceAssociationInputReferenceConfig", + "documentation":"The input reference configuration for the ID namespace association.
" + }, + "inputReferenceProperties":{ + "shape":"IdNamespaceAssociationInputReferenceProperties", + "documentation":"The input reference properties for the ID namespace association.
" + }, + "idMappingConfig":{ + "shape":"IdMappingConfig", + "documentation":"The configuration settings for the ID mapping table.
" + } + }, + "documentation":"Provides information to create the ID namespace association.
" + }, + "IdNamespaceAssociationArn":{ + "type":"string", + "max":256, + "min":0, + "pattern":"arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/idnamespaceassociation/[\\d\\w-]+" + }, + "IdNamespaceAssociationIdentifier":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "IdNamespaceAssociationInputReferenceArn":{ + "type":"string", + "max":256, + "min":0, + "pattern":"arn:aws:entityresolution:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:idnamespace/[\\d\\w-]+" + }, + "IdNamespaceAssociationInputReferenceConfig":{ + "type":"structure", + "required":[ + "inputReferenceArn", + "manageResourcePolicies" + ], + "members":{ + "inputReferenceArn":{ + "shape":"IdNamespaceAssociationInputReferenceArn", + "documentation":"The Amazon Resource Name (ARN) of the Entity Resolution resource that is being associated to the collaboration. Valid resource ARNs are from the ID namespaces that you own.
" + }, + "manageResourcePolicies":{ + "shape":"Boolean", + "documentation":"When TRUE, Clean Rooms manages permissions for the ID namespace association resource.
When FALSE, the resource owner manages permissions for the ID namespace association resource.
Provides the information for the ID namespace association input reference configuration.
" + }, + "IdNamespaceAssociationInputReferenceProperties":{ + "type":"structure", + "required":[ + "idNamespaceType", + "idMappingWorkflowsSupported" + ], + "members":{ + "idNamespaceType":{ + "shape":"IdNamespaceType", + "documentation":"The ID namespace type for this ID namespace association.
" + }, + "idMappingWorkflowsSupported":{ + "shape":"IdMappingWorkflowsSupported", + "documentation":"Defines how ID mapping workflows are supported for this ID namespace association.
" + } + }, + "documentation":"Provides the information for the ID namespace association input reference properties.
" + }, + "IdNamespaceAssociationInputReferencePropertiesSummary":{ + "type":"structure", + "required":["idNamespaceType"], + "members":{ + "idNamespaceType":{ + "shape":"IdNamespaceType", + "documentation":"The ID namespace type for this ID namespace association.
" + } + }, + "documentation":"Detailed information about the ID namespace association input reference properties.
" + }, + "IdNamespaceAssociationSummary":{ + "type":"structure", + "required":[ + "membershipId", + "membershipArn", + "collaborationArn", + "collaborationId", + "createTime", + "updateTime", + "id", + "arn", + "inputReferenceConfig", + "name", + "inputReferenceProperties" + ], + "members":{ + "membershipId":{ + "shape":"MembershipIdentifier", + "documentation":"The unique identifier of the membership resource for this ID namespace association.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique identifier of the collaboration that contains this ID namespace association.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which this ID namespace association was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which this ID namespace association has been updated.
" + }, + "id":{ + "shape":"UUID", + "documentation":"The unique identifier of this ID namespace association.
" + }, + "arn":{ + "shape":"IdNamespaceAssociationArn", + "documentation":"The Amazon Resource Name (ARN) of this ID namespace association.
" + }, + "inputReferenceConfig":{ + "shape":"IdNamespaceAssociationInputReferenceConfig", + "documentation":"The input reference configuration details for this ID namespace association.
" + }, + "name":{ + "shape":"GenericResourceName", + "documentation":"The name of the ID namespace association.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"The description of the ID namespace association.
" + }, + "inputReferenceProperties":{ + "shape":"IdNamespaceAssociationInputReferencePropertiesSummary", + "documentation":"The input reference properties for this ID namespace association.
" + } + }, + "documentation":"Detailed information about the ID namespace association.
" + }, + "IdNamespaceAssociationSummaryList":{ + "type":"list", + "member":{"shape":"IdNamespaceAssociationSummary"} + }, + "IdNamespaceType":{ + "type":"string", + "enum":[ + "SOURCE", + "TARGET" + ] + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Unexpected error during processing of request.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "JoinOperator":{ + "type":"string", + "enum":[ + "OR", + "AND" + ] + }, + "JoinOperatorsList":{ + "type":"list", + "member":{"shape":"JoinOperator"}, + "max":2, + "min":0 + }, + "JoinRequiredOption":{ + "type":"string", + "enum":["QUERY_RUNNER"] + }, + "KMSKeyArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws:kms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:key/[a-zA-Z0-9-]+" + }, + "KeyPrefix":{ + "type":"string", + "max":512, + "min":0, + "pattern":"[\\w!.=*/-]*" + }, + "ListAnalysisTemplatesInput":{ + "type":"structure", + "required":["membershipIdentifier"], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The identifier for a membership resource.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListAnalysisTemplatesOutput":{ + "type":"structure", + "required":["analysisTemplateSummaries"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
" + }, + "analysisTemplateSummaries":{ + "shape":"AnalysisTemplateSummaryList", + "documentation":"Lists analysis template metadata.
" + } + } + }, + "ListCollaborationAnalysisTemplatesInput":{ + "type":"structure", + "required":["collaborationIdentifier"], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListCollaborationAnalysisTemplatesOutput":{ + "type":"structure", + "required":["collaborationAnalysisTemplateSummaries"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
" + }, + "collaborationAnalysisTemplateSummaries":{ + "shape":"CollaborationAnalysisTemplateSummaryList", + "documentation":"The metadata of the analysis template within a collaboration.
" + } + } + }, + "ListCollaborationConfiguredAudienceModelAssociationsInput":{ + "type":"structure", + "required":["collaborationIdentifier"], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListCollaborationConfiguredAudienceModelAssociationsOutput":{ + "type":"structure", + "required":["collaborationConfiguredAudienceModelAssociationSummaries"], + "members":{ + "collaborationConfiguredAudienceModelAssociationSummaries":{ + "shape":"CollaborationConfiguredAudienceModelAssociationSummaryList", + "documentation":"The metadata of the configured audience model association within a collaboration.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
" + } + } + }, + "ListCollaborationIdNamespaceAssociationsInput":{ + "type":"structure", + "required":["collaborationIdentifier"], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"The unique identifier of the collaboration that contains the ID namespace associations that you want to retrieve.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token that's used to fetch the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.>
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListCollaborationIdNamespaceAssociationsOutput":{ + "type":"structure", + "required":["collaborationIdNamespaceAssociationSummaries"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value provided to access the next page of results.
" + }, + "collaborationIdNamespaceAssociationSummaries":{ + "shape":"CollaborationIdNamespaceAssociationSummaryList", + "documentation":"The summary information of the collaboration ID namespace associations that you requested.
" + } + } + }, + "ListCollaborationPrivacyBudgetTemplatesInput":{ + "type":"structure", + "required":["collaborationIdentifier"], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"A unique identifier for one of your collaborations.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListCollaborationPrivacyBudgetTemplatesOutput":{ + "type":"structure", + "required":["collaborationPrivacyBudgetTemplateSummaries"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
" + }, + "collaborationPrivacyBudgetTemplateSummaries":{ + "shape":"CollaborationPrivacyBudgetTemplateSummaryList", + "documentation":"An array that summarizes the collaboration privacy budget templates. The summary includes collaboration information, creation information, the privacy budget type.
" + } + } + }, + "ListCollaborationPrivacyBudgetsInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "privacyBudgetType" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"A unique identifier for one of your collaborations.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "privacyBudgetType":{ + "shape":"PrivacyBudgetType", + "documentation":"Specifies the type of the privacy budget.
", + "location":"querystring", + "locationName":"privacyBudgetType" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListCollaborationPrivacyBudgetsOutput":{ + "type":"structure", + "required":["collaborationPrivacyBudgetSummaries"], + "members":{ + "collaborationPrivacyBudgetSummaries":{ + "shape":"CollaborationPrivacyBudgetSummaryList", + "documentation":"Summaries of the collaboration privacy budgets.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
" + } + } + }, + "ListCollaborationsInput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", + "location":"querystring", + "locationName":"maxResults" + }, + "memberStatus":{ + "shape":"FilterableMemberStatus", + "documentation":"The caller's status in a collaboration.
", + "location":"querystring", + "locationName":"memberStatus" + } + } + }, + "ListCollaborationsOutput":{ + "type":"structure", + "required":["collaborationList"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
" + }, + "collaborationList":{ + "shape":"CollaborationSummaryList", + "documentation":"The list of collaborations.
" + } + } + }, + "ListConfiguredAudienceModelAssociationsInput":{ + "type":"structure", + "required":["membershipIdentifier"], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for a membership that contains the configured audience model associations that you want to retrieve.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListConfiguredAudienceModelAssociationsOutput":{ + "type":"structure", + "required":["configuredAudienceModelAssociationSummaries"], + "members":{ + "configuredAudienceModelAssociationSummaries":{ + "shape":"ConfiguredAudienceModelAssociationSummaryList", + "documentation":"Summaries of the configured audience model associations that you requested.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value provided to access the next page of results.
" + } + } + }, + "ListConfiguredTableAssociationsInput":{ + "type":"structure", + "required":["membershipIdentifier"], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListConfiguredTableAssociationsOutput":{ + "type":"structure", + "required":["configuredTableAssociationSummaries"], + "members":{ + "configuredTableAssociationSummaries":{ + "shape":"ConfiguredTableAssociationSummaryList", + "documentation":"The retrieved list of configured table associations.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
" + } + } + }, + "ListConfiguredTablesInput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListConfiguredTablesOutput":{ + "type":"structure", + "required":["configuredTableSummaries"], + "members":{ + "configuredTableSummaries":{ + "shape":"ConfiguredTableSummaryList", + "documentation":"The configured tables listed by the request.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
" + } + } + }, + "ListIdMappingTablesInput":{ + "type":"structure", + "required":["membershipIdentifier"], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The unique identifier of the membership that contains the ID mapping tables that you want to view.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token that's used to fetch the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListIdMappingTablesOutput":{ + "type":"structure", + "required":["idMappingTableSummaries"], + "members":{ + "idMappingTableSummaries":{ + "shape":"IdMappingTableSummaryList", + "documentation":"The summary information of the ID mapping tables that you requested.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value provided to access the next page of results.
" + } + } + }, + "ListIdNamespaceAssociationsInput":{ + "type":"structure", + "required":["membershipIdentifier"], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The unique identifier of the membership that contains the ID namespace association that you want to view.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token that's used to fetch the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListIdNamespaceAssociationsOutput":{ + "type":"structure", + "required":["idNamespaceAssociationSummaries"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value provided to access the next page of results.
" + }, + "idNamespaceAssociationSummaries":{ + "shape":"IdNamespaceAssociationSummaryList", + "documentation":"The summary information of the ID namespace associations that you requested.
" + } + } + }, + "ListMembersInput":{ + "type":"structure", + "required":["collaborationIdentifier"], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"The identifier of the collaboration in which the members are listed.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListMembersOutput":{ + "type":"structure", + "required":["memberSummaries"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
" + }, + "memberSummaries":{ + "shape":"MemberSummaryList", + "documentation":"The list of members returned by the ListMembers operation.
" + } + } + }, + "ListMembershipsInput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call.
", + "location":"querystring", + "locationName":"maxResults" + }, + "status":{ + "shape":"MembershipStatus", + "documentation":"A filter which will return only memberships in the specified status.
", + "location":"querystring", + "locationName":"status" + } + } + }, + "ListMembershipsOutput":{ + "type":"structure", + "required":["membershipSummaries"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
" + }, + "membershipSummaries":{ + "shape":"MembershipSummaryList", + "documentation":"The list of memberships returned from the ListMemberships operation.
" + } + } + }, + "ListPrivacyBudgetTemplatesInput":{ + "type":"structure", + "required":["membershipIdentifier"], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for one of your memberships for a collaboration. The privacy budget templates are retrieved from the collaboration that this membership belongs to. Accepts a membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListPrivacyBudgetTemplatesOutput":{ + "type":"structure", + "required":["privacyBudgetTemplateSummaries"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
" + }, + "privacyBudgetTemplateSummaries":{ + "shape":"PrivacyBudgetTemplateSummaryList", + "documentation":"An array that summarizes the privacy budget templates. The summary includes collaboration information, creation information, and privacy budget type.
" + } + } + }, + "ListPrivacyBudgetsInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "privacyBudgetType" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for one of your memberships for a collaboration. The privacy budget is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "privacyBudgetType":{ + "shape":"PrivacyBudgetType", + "documentation":"The privacy budget type.
", + "location":"querystring", + "locationName":"privacyBudgetType" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListPrivacyBudgetsOutput":{ + "type":"structure", + "required":["privacyBudgetSummaries"], + "members":{ + "privacyBudgetSummaries":{ + "shape":"PrivacyBudgetSummaryList", + "documentation":"An array that summarizes the privacy budgets. The summary includes collaboration information, membership information, privacy budget template information, and privacy budget details.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
" + } + } + }, + "ListProtectedQueriesInput":{ + "type":"structure", + "required":["membershipIdentifier"], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The identifier for the membership in the collaboration.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "status":{ + "shape":"ProtectedQueryStatus", + "documentation":"A filter on the status of the protected query.
", + "location":"querystring", + "locationName":"status" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service can return a nextToken even if the maximum results has not been met.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListProtectedQueriesOutput":{ + "type":"structure", + "required":["protectedQueries"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
" + }, + "protectedQueries":{ + "shape":"ProtectedQuerySummaryList", + "documentation":"A list of protected queries.
" + } + } + }, + "ListSchemasInput":{ + "type":"structure", + "required":["collaborationIdentifier"], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "schemaType":{ + "shape":"SchemaType", + "documentation":"If present, filter schemas by schema type. The only valid schema type is currently `TABLE`.
", + "location":"querystring", + "locationName":"schemaType" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum size of the results that is returned per call.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListSchemasOutput":{ + "type":"structure", + "required":["schemaSummaries"], + "members":{ + "schemaSummaries":{ + "shape":"SchemaSummaryList", + "documentation":"The retrieved list of schemas.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token value retrieved from a previous call to access the next page of results.
" + } + } + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"CleanroomsArn", + "documentation":"The Amazon Resource Name (ARN) associated with the resource you want to list tags on.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"A map of objects specifying each key name and value.
" + } + } + }, + "Long":{ + "type":"long", + "box":true + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MemberAbilities":{ + "type":"list", + "member":{"shape":"MemberAbility"} + }, + "MemberAbility":{ + "type":"string", + "enum":[ + "CAN_QUERY", + "CAN_RECEIVE_RESULTS" + ] + }, + "MemberList":{ + "type":"list", + "member":{"shape":"MemberSpecification"}, + "max":9, + "min":0 + }, + "MemberSpecification":{ + "type":"structure", + "required":[ + "accountId", + "memberAbilities", + "displayName" + ], + "members":{ + "accountId":{ + "shape":"AccountId", + "documentation":"The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
" + }, + "memberAbilities":{ + "shape":"MemberAbilities", + "documentation":"The abilities granted to the collaboration member.
" + }, + "displayName":{ + "shape":"DisplayName", + "documentation":"The member's display name.
" + }, + "paymentConfiguration":{ + "shape":"PaymentConfiguration", + "documentation":"The collaboration member's payment responsibilities set by the collaboration creator.
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.
" + } + }, + "documentation":"Basic metadata used to construct a new member.
" + }, + "MemberStatus":{ + "type":"string", + "enum":[ + "INVITED", + "ACTIVE", + "LEFT", + "REMOVED" + ] + }, + "MemberSummary":{ + "type":"structure", + "required":[ + "accountId", + "status", + "displayName", + "abilities", + "createTime", + "updateTime", + "paymentConfiguration" + ], + "members":{ + "accountId":{ + "shape":"AccountId", + "documentation":"The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
" + }, + "status":{ + "shape":"MemberStatus", + "documentation":"The status of the member.
" + }, + "displayName":{ + "shape":"DisplayName", + "documentation":"The member's display name.
" + }, + "abilities":{ + "shape":"MemberAbilities", + "documentation":"The abilities granted to the collaboration member.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time when the member was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time the member metadata was last updated.
" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"The unique ID for the member's associated membership, if present.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The unique ARN for the member's associated membership, if present.
" + }, + "paymentConfiguration":{ + "shape":"PaymentConfiguration", + "documentation":"The collaboration member's payment responsibilities set by the collaboration creator.
" + } + }, + "documentation":"The member object listed by the request.
" + }, + "MemberSummaryList":{ + "type":"list", + "member":{"shape":"MemberSummary"} + }, + "Membership":{ + "type":"structure", + "required":[ + "id", + "arn", + "collaborationArn", + "collaborationId", + "collaborationCreatorAccountId", + "collaborationCreatorDisplayName", + "collaborationName", + "createTime", + "updateTime", + "status", + "memberAbilities", + "queryLogStatus", + "paymentConfiguration" + ], + "members":{ + "id":{ + "shape":"UUID", + "documentation":"The unique ID of the membership.
" + }, + "arn":{ + "shape":"MembershipArn", + "documentation":"The unique ARN for the membership.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The unique ARN for the membership's associated collaboration.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique ID for the membership's collaboration.
" + }, + "collaborationCreatorAccountId":{ + "shape":"AccountId", + "documentation":"The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
" + }, + "collaborationCreatorDisplayName":{ + "shape":"DisplayName", + "documentation":"The display name of the collaboration creator.
" + }, + "collaborationName":{ + "shape":"CollaborationName", + "documentation":"The name of the membership's collaboration.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time when the membership was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time the membership metadata was last updated.
" + }, + "status":{ + "shape":"MembershipStatus", + "documentation":"The status of the membership.
" + }, + "memberAbilities":{ + "shape":"MemberAbilities", + "documentation":"The abilities granted to the collaboration member.
" + }, + "queryLogStatus":{ + "shape":"MembershipQueryLogStatus", + "documentation":"An indicator as to whether query logging has been enabled or disabled for the membership.
" + }, + "defaultResultConfiguration":{ + "shape":"MembershipProtectedQueryResultConfiguration", + "documentation":"The default protected query result configuration as specified by the member who can receive results.
" + }, + "paymentConfiguration":{ + "shape":"MembershipPaymentConfiguration", + "documentation":"The payment responsibilities accepted by the collaboration member.
" + } + }, + "documentation":"The membership object.
" + }, + "MembershipArn":{ + "type":"string", + "max":100, + "min":0, + "pattern":"arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+" + }, + "MembershipIdentifier":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "MembershipPaymentConfiguration":{ + "type":"structure", + "required":["queryCompute"], + "members":{ + "queryCompute":{ + "shape":"MembershipQueryComputePaymentConfig", + "documentation":"The payment responsibilities accepted by the collaboration member for query compute costs.
" + } + }, + "documentation":"An object representing the payment responsibilities accepted by the collaboration member.
" + }, + "MembershipProtectedQueryOutputConfiguration":{ + "type":"structure", + "members":{ + "s3":{"shape":"ProtectedQueryS3OutputConfiguration"} + }, + "documentation":"Contains configurations for protected query results.
", + "union":true + }, + "MembershipProtectedQueryResultConfiguration":{ + "type":"structure", + "required":["outputConfiguration"], + "members":{ + "outputConfiguration":{ + "shape":"MembershipProtectedQueryOutputConfiguration", + "documentation":"Configuration for protected query results.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.
" + } + }, + "documentation":"Contains configurations for protected query results.
" + }, + "MembershipQueryComputePaymentConfig":{ + "type":"structure", + "required":["isResponsible"], + "members":{ + "isResponsible":{ + "shape":"Boolean", + "documentation":"Indicates whether the collaboration member has accepted to pay for query compute costs (TRUE) or has not accepted to pay for query compute costs (FALSE).
If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for query compute costs.
If you set the value to TRUE but you are not responsible to pay for query compute costs.
An object representing the payment responsibilities accepted by the collaboration member for query compute costs.
" + }, + "MembershipQueryLogStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "MembershipStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "REMOVED", + "COLLABORATION_DELETED" + ] + }, + "MembershipSummary":{ + "type":"structure", + "required":[ + "id", + "arn", + "collaborationArn", + "collaborationId", + "collaborationCreatorAccountId", + "collaborationCreatorDisplayName", + "collaborationName", + "createTime", + "updateTime", + "status", + "memberAbilities", + "paymentConfiguration" + ], + "members":{ + "id":{ + "shape":"UUID", + "documentation":"The unique ID for the membership's collaboration.
" + }, + "arn":{ + "shape":"MembershipArn", + "documentation":"The unique ARN for the membership.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The unique ARN for the membership's associated collaboration.
" + }, + "collaborationId":{ + "shape":"CollaborationIdentifier", + "documentation":"The unique ID for the membership's collaboration.
" + }, + "collaborationCreatorAccountId":{ + "shape":"AccountId", + "documentation":"The identifier of the Amazon Web Services principal that created the collaboration. Currently only supports Amazon Web Services account ID.
" + }, + "collaborationCreatorDisplayName":{ + "shape":"DisplayName", + "documentation":"The display name of the collaboration creator.
" + }, + "collaborationName":{ + "shape":"CollaborationName", + "documentation":"The name for the membership's collaboration.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time when the membership was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time the membership metadata was last updated.
" + }, + "status":{ + "shape":"MembershipStatus", + "documentation":"The status of the membership.
" + }, + "memberAbilities":{ + "shape":"MemberAbilities", + "documentation":"The abilities granted to the collaboration member.
" + }, + "paymentConfiguration":{ + "shape":"MembershipPaymentConfiguration", + "documentation":"The payment responsibilities accepted by the collaboration member.
" + } + }, + "documentation":"The membership object listed by the request.
" + }, + "MembershipSummaryList":{ + "type":"list", + "member":{"shape":"MembershipSummary"} + }, + "PaginationToken":{ + "type":"string", + "max":10240, + "min":0 + }, + "ParameterMap":{ + "type":"map", + "key":{"shape":"ParameterName"}, + "value":{"shape":"ParameterValue"} + }, + "ParameterName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[0-9a-zA-Z_]+" + }, + "ParameterType":{ + "type":"string", + "enum":[ + "SMALLINT", + "INTEGER", + "BIGINT", + "DECIMAL", + "REAL", + "DOUBLE_PRECISION", + "BOOLEAN", + "CHAR", + "VARCHAR", + "DATE", + "TIMESTAMP", + "TIMESTAMPTZ", + "TIME", + "TIMETZ", + "VARBYTE" + ] + }, + "ParameterValue":{ + "type":"string", + "max":250, + "min":0 + }, + "PaymentConfiguration":{ + "type":"structure", + "required":["queryCompute"], + "members":{ + "queryCompute":{ + "shape":"QueryComputePaymentConfig", + "documentation":"The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
" + } + }, + "documentation":"An object representing the collaboration member's payment responsibilities set by the collaboration creator.
" + }, + "PopulateIdMappingTableInput":{ + "type":"structure", + "required":[ + "idMappingTableIdentifier", + "membershipIdentifier" + ], + "members":{ + "idMappingTableIdentifier":{ + "shape":"UUID", + "documentation":"The unique identifier of the ID mapping table that you want to populate.
", + "location":"uri", + "locationName":"idMappingTableIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The unique identifier of the membership that contains the ID mapping table that you want to populate.
", + "location":"uri", + "locationName":"membershipIdentifier" + } + } + }, + "PopulateIdMappingTableOutput":{ + "type":"structure", + "required":["idMappingJobId"], + "members":{ + "idMappingJobId":{ + "shape":"UUID", + "documentation":"The unique identifier of the mapping job that will populate the ID mapping table.
" + } + } + }, + "PreviewPrivacyImpactInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "parameters" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for one of your memberships for a collaboration. Accepts a membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "parameters":{ + "shape":"PreviewPrivacyImpactParametersInput", + "documentation":"Specifies the desired epsilon and noise parameters to preview.
" + } + } + }, + "PreviewPrivacyImpactOutput":{ + "type":"structure", + "required":["privacyImpact"], + "members":{ + "privacyImpact":{ + "shape":"PrivacyImpact", + "documentation":"An estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters. This does not change the privacy budget.
" + } + } + }, + "PreviewPrivacyImpactParametersInput":{ + "type":"structure", + "members":{ + "differentialPrivacy":{ + "shape":"DifferentialPrivacyPreviewParametersInput", + "documentation":"An array that specifies the epsilon and noise parameters.
" + } + }, + "documentation":"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.
", + "union":true + }, + "PrivacyBudget":{ + "type":"structure", + "members":{ + "differentialPrivacy":{ + "shape":"DifferentialPrivacyPrivacyBudget", + "documentation":"An object that specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.
" + } + }, + "documentation":"The epsilon parameter value and number of each aggregation function that you can perform.
", + "union":true + }, + "PrivacyBudgetSummary":{ + "type":"structure", + "required":[ + "id", + "privacyBudgetTemplateId", + "privacyBudgetTemplateArn", + "membershipId", + "membershipArn", + "collaborationId", + "collaborationArn", + "type", + "createTime", + "updateTime", + "budget" + ], + "members":{ + "id":{ + "shape":"UUID", + "documentation":"The unique identifier of the privacy budget.
" + }, + "privacyBudgetTemplateId":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"The unique identifier of the privacy budget template.
" + }, + "privacyBudgetTemplateArn":{ + "shape":"PrivacyBudgetTemplateArn", + "documentation":"The ARN of the privacy budget template.
" + }, + "membershipId":{ + "shape":"MembershipIdentifier", + "documentation":"The identifier for a membership resource.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The Amazon Resource Name (ARN) of the member who created the privacy budget summary.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique identifier of the collaboration that contains this privacy budget.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The ARN of the collaboration that contains this privacy budget.
" + }, + "type":{ + "shape":"PrivacyBudgetType", + "documentation":"Specifies the type of the privacy budget.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which the privacy budget was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which the privacy budget was updated.
" + }, + "budget":{ + "shape":"PrivacyBudget", + "documentation":"The provided privacy budget.
" + } + }, + "documentation":"An array that summaries the specified privacy budget. This summary includes collaboration information, creation information, membership information, and privacy budget information.
" + }, + "PrivacyBudgetSummaryList":{ + "type":"list", + "member":{"shape":"PrivacyBudgetSummary"} + }, + "PrivacyBudgetTemplate":{ + "type":"structure", + "required":[ + "id", + "arn", + "membershipId", + "membershipArn", + "collaborationId", + "collaborationArn", + "createTime", + "updateTime", + "privacyBudgetType", + "autoRefresh", + "parameters" + ], + "members":{ + "id":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"The unique identifier of the privacy budget template.
" + }, + "arn":{ + "shape":"PrivacyBudgetTemplateArn", + "documentation":"The ARN of the privacy budget template.
" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"The identifier for a membership resource.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The Amazon Resource Name (ARN) of the member who created the privacy budget template.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique ID of the collaboration that contains this privacy budget template.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The ARN of the collaboration that contains this privacy budget template.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which the privacy budget template was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which the privacy budget template was updated.
" + }, + "privacyBudgetType":{ + "shape":"PrivacyBudgetType", + "documentation":"Specifies the type of the privacy budget template.
" + }, + "autoRefresh":{ + "shape":"PrivacyBudgetTemplateAutoRefresh", + "documentation":"How often the privacy budget refreshes.
If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
Specifies the epsilon and noise parameters for the privacy budget template.
" + } + }, + "documentation":"An object that defines the privacy budget template.
" + }, + "PrivacyBudgetTemplateArn":{ + "type":"string", + "max":100, + "min":0, + "pattern":"arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:privacybudgettemplate/[\\d\\w-]+" + }, + "PrivacyBudgetTemplateAutoRefresh":{ + "type":"string", + "enum":[ + "CALENDAR_MONTH", + "NONE" + ] + }, + "PrivacyBudgetTemplateIdentifier":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "PrivacyBudgetTemplateParametersInput":{ + "type":"structure", + "members":{ + "differentialPrivacy":{ + "shape":"DifferentialPrivacyTemplateParametersInput", + "documentation":"An object that specifies the epsilon and noise parameters.
" + } + }, + "documentation":"The epsilon and noise parameters that you want to use for the privacy budget template.
", + "union":true + }, + "PrivacyBudgetTemplateParametersOutput":{ + "type":"structure", + "members":{ + "differentialPrivacy":{ + "shape":"DifferentialPrivacyTemplateParametersOutput", + "documentation":"The epsilon and noise parameters.
" + } + }, + "documentation":"The epsilon and noise parameters that were used in the privacy budget template.
", + "union":true + }, + "PrivacyBudgetTemplateSummary":{ + "type":"structure", + "required":[ + "id", + "arn", + "membershipId", + "membershipArn", + "collaborationId", + "collaborationArn", + "privacyBudgetType", + "createTime", + "updateTime" + ], + "members":{ + "id":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"The unique identifier of the privacy budget template.
" + }, + "arn":{ + "shape":"PrivacyBudgetTemplateArn", + "documentation":"The ARN of the privacy budget template.
" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"The identifier for a membership resource.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The Amazon Resource Name (ARN) of the member who created the privacy budget template.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique ID of the collaboration that contains this privacy budget template.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The ARN of the collaboration that contains this privacy budget template.
" + }, + "privacyBudgetType":{ + "shape":"PrivacyBudgetType", + "documentation":"The type of the privacy budget template.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which the privacy budget template was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The most recent time at which the privacy budget template was updated.
" + } + }, + "documentation":"A summary of the privacy budget template. The summary includes membership information, collaboration information, and creation information.
" + }, + "PrivacyBudgetTemplateSummaryList":{ + "type":"list", + "member":{"shape":"PrivacyBudgetTemplateSummary"} + }, + "PrivacyBudgetTemplateUpdateParameters":{ + "type":"structure", + "members":{ + "differentialPrivacy":{ + "shape":"DifferentialPrivacyTemplateUpdateParameters", + "documentation":"An object that specifies the new values for the epsilon and noise parameters.
" + } + }, + "documentation":"The epsilon and noise parameters that you want to update in the privacy budget template.
", + "union":true + }, + "PrivacyBudgetType":{ + "type":"string", + "enum":["DIFFERENTIAL_PRIVACY"] + }, + "PrivacyImpact":{ + "type":"structure", + "members":{ + "differentialPrivacy":{ + "shape":"DifferentialPrivacyPrivacyImpact", + "documentation":"An object that lists the number and type of aggregation functions you can perform.
" + } + }, + "documentation":"Provides an estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.
", + "union":true + }, + "ProtectedQuery":{ + "type":"structure", + "required":[ + "id", + "membershipId", + "membershipArn", + "createTime", + "status" + ], + "members":{ + "id":{ + "shape":"UUID", + "documentation":"The identifier for a protected query instance.
" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"The identifier for the membership.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The ARN of the membership.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time at which the protected query was created.
" + }, + "sqlParameters":{ + "shape":"ProtectedQuerySQLParameters", + "documentation":"The protected query SQL parameters.
" + }, + "status":{ + "shape":"ProtectedQueryStatus", + "documentation":"The status of the query.
" + }, + "resultConfiguration":{ + "shape":"ProtectedQueryResultConfiguration", + "documentation":"Contains any details needed to write the query results.
" + }, + "statistics":{ + "shape":"ProtectedQueryStatistics", + "documentation":"Statistics about protected query execution.
" + }, + "result":{ + "shape":"ProtectedQueryResult", + "documentation":"The result of the protected query.
" + }, + "error":{ + "shape":"ProtectedQueryError", + "documentation":"An error thrown by the protected query.
" + }, + "differentialPrivacy":{ + "shape":"DifferentialPrivacyParameters", + "documentation":"The sensitivity parameters of the differential privacy results of the protected query.
" + } + }, + "documentation":"The parameters for an Clean Rooms protected query.
" + }, + "ProtectedQueryError":{ + "type":"structure", + "required":[ + "message", + "code" + ], + "members":{ + "message":{ + "shape":"String", + "documentation":"A description of why the query failed.
" + }, + "code":{ + "shape":"String", + "documentation":"An error code for the error.
" + } + }, + "documentation":"Details of errors thrown by the protected query.
" + }, + "ProtectedQueryIdentifier":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "ProtectedQueryMemberOutputConfiguration":{ + "type":"structure", + "required":["accountId"], + "members":{ + "accountId":{ + "shape":"AccountId", + "documentation":"The unique identifier for the account.
" + } + }, + "documentation":"Contains configuration details for the protected query member output.
" + }, + "ProtectedQueryMemberOutputList":{ + "type":"list", + "member":{"shape":"ProtectedQuerySingleMemberOutput"} + }, + "ProtectedQueryOutput":{ + "type":"structure", + "members":{ + "s3":{ + "shape":"ProtectedQueryS3Output", + "documentation":"If present, the output for a protected query with an `S3` output type.
" + }, + "memberList":{ + "shape":"ProtectedQueryMemberOutputList", + "documentation":"The list of member Amazon Web Services account(s) that received the results of the query.
" + } + }, + "documentation":"Contains details about the protected query output.
", + "union":true + }, + "ProtectedQueryOutputConfiguration":{ + "type":"structure", + "members":{ + "s3":{ + "shape":"ProtectedQueryS3OutputConfiguration", + "documentation":"Required configuration for a protected query with an s3 output type.
Required configuration for a protected query with a member output type.
Contains configuration details for protected query output.
", + "union":true + }, + "ProtectedQueryResult":{ + "type":"structure", + "required":["output"], + "members":{ + "output":{ + "shape":"ProtectedQueryOutput", + "documentation":"The output of the protected query.
" + } + }, + "documentation":"Details about the query results.
" + }, + "ProtectedQueryResultConfiguration":{ + "type":"structure", + "required":["outputConfiguration"], + "members":{ + "outputConfiguration":{ + "shape":"ProtectedQueryOutputConfiguration", + "documentation":"Configuration for protected query results.
" + } + }, + "documentation":"Contains configurations for protected query results.
" + }, + "ProtectedQueryS3Output":{ + "type":"structure", + "required":["location"], + "members":{ + "location":{ + "shape":"String", + "documentation":"The S3 location of the result.
" + } + }, + "documentation":"Contains output information for protected queries with an S3 output type.
" + }, + "ProtectedQueryS3OutputConfiguration":{ + "type":"structure", + "required":[ + "resultFormat", + "bucket" + ], + "members":{ + "resultFormat":{ + "shape":"ResultFormat", + "documentation":"Intended file format of the result.
" + }, + "bucket":{ + "shape":"ProtectedQueryS3OutputConfigurationBucketString", + "documentation":"The S3 bucket to unload the protected query results.
" + }, + "keyPrefix":{ + "shape":"KeyPrefix", + "documentation":"The S3 prefix to unload the protected query results.
" + } + }, + "documentation":"Contains the configuration to write the query results to S3.
" + }, + "ProtectedQueryS3OutputConfigurationBucketString":{ + "type":"string", + "max":63, + "min":3, + "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])$).*" + }, + "ProtectedQuerySQLParameters":{ + "type":"structure", + "members":{ + "queryString":{ + "shape":"ProtectedQuerySQLParametersQueryStringString", + "documentation":"The query string to be submitted.
" + }, + "analysisTemplateArn":{ + "shape":"AnalysisTemplateArn", + "documentation":"The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
" + }, + "parameters":{ + "shape":"ParameterMap", + "documentation":"The protected query SQL parameters.
" + } + }, + "documentation":"The parameters for the SQL type Protected Query.
", + "sensitive":true + }, + "ProtectedQuerySQLParametersQueryStringString":{ + "type":"string", + "max":500000, + "min":0 + }, + "ProtectedQuerySingleMemberOutput":{ + "type":"structure", + "required":["accountId"], + "members":{ + "accountId":{ + "shape":"AccountId", + "documentation":"The Amazon Web Services account ID of the member in the collaboration who can receive results for the query.
" + } + }, + "documentation":"Details about the member who received the query result.
" + }, + "ProtectedQueryStatistics":{ + "type":"structure", + "members":{ + "totalDurationInMillis":{ + "shape":"Long", + "documentation":"The duration of the protected query, from creation until query completion.
" + } + }, + "documentation":"Contains statistics about the execution of the protected query.
" + }, + "ProtectedQueryStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "STARTED", + "CANCELLED", + "CANCELLING", + "FAILED", + "SUCCESS", + "TIMED_OUT" + ] + }, + "ProtectedQuerySummary":{ + "type":"structure", + "required":[ + "id", + "membershipId", + "membershipArn", + "createTime", + "status", + "receiverConfigurations" + ], + "members":{ + "id":{ + "shape":"UUID", + "documentation":"The unique ID of the protected query.
" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"The unique ID for the membership that initiated the protected query.
" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"The unique ARN for the membership that initiated the protected query.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time the protected query was created.
" + }, + "status":{ + "shape":"ProtectedQueryStatus", + "documentation":"The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`, `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.
" + }, + "receiverConfigurations":{ + "shape":"ReceiverConfigurationsList", + "documentation":"The receiver configuration.
" + } + }, + "documentation":"The protected query summary for the objects listed by the request.
" + }, + "ProtectedQuerySummaryList":{ + "type":"list", + "member":{"shape":"ProtectedQuerySummary"} + }, + "ProtectedQueryType":{ + "type":"string", + "enum":["SQL"] + }, + "QueryComputePaymentConfig":{ + "type":"structure", + "required":["isResponsible"], + "members":{ + "isResponsible":{ + "shape":"Boolean", + "documentation":"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.
An object representing the collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
" + }, + "QueryConstraint":{ + "type":"structure", + "members":{ + "requireOverlap":{ + "shape":"QueryConstraintRequireOverlap", + "documentation":"An array of column names that specifies which columns are required in the JOIN statement.
" + } + }, + "documentation":"Provides any necessary query constraint information.
", + "union":true + }, + "QueryConstraintList":{ + "type":"list", + "member":{"shape":"QueryConstraint"}, + "max":1, + "min":0 + }, + "QueryConstraintRequireOverlap":{ + "type":"structure", + "members":{ + "columns":{ + "shape":"AnalysisRuleColumnList", + "documentation":"The columns that are required to overlap.
" + } + }, + "documentation":"Provides the name of the columns that are required to overlap.
" + }, + "QueryTables":{ + "type":"list", + "member":{"shape":"TableAlias"} + }, + "ReceiverAccountIds":{ + "type":"list", + "member":{"shape":"AccountId"} + }, + "ReceiverConfiguration":{ + "type":"structure", + "required":["analysisType"], + "members":{ + "analysisType":{ + "shape":"AnalysisType", + "documentation":" The type of analysis for the protected query. The results of the query can be analyzed directly (DIRECT_ANALYSIS) or used as input into additional analyses (ADDITIONAL_ANALYSIS), such as a query that is a seed for a lookalike ML model.
The configuration details of the receiver configuration.
" + } + }, + "documentation":"The receiver configuration for a protected query.
" + }, + "ReceiverConfigurationsList":{ + "type":"list", + "member":{"shape":"ReceiverConfiguration"} + }, + "ResourceAlias":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?" + }, + "ResourceDescription":{ + "type":"string", + "max":255, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{"shape":"String"}, + "resourceId":{ + "shape":"String", + "documentation":"The Id of the missing resource.
" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"The type of the missing resource.
" + } + }, + "documentation":"Request references a resource which does not exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceType":{ + "type":"string", + "enum":[ + "CONFIGURED_TABLE", + "COLLABORATION", + "MEMBERSHIP", + "CONFIGURED_TABLE_ASSOCIATION" + ] + }, + "ResultFormat":{ + "type":"string", + "enum":[ + "CSV", + "PARQUET" + ] + }, + "RoleArn":{ + "type":"string", + "max":512, + "min":32, + "pattern":"arn:aws:iam::[\\w]+:role/[\\w+=./@-]+" + }, + "ScalarFunctions":{ + "type":"string", + "enum":[ + "ABS", + "CAST", + "CEILING", + "COALESCE", + "CONVERT", + "CURRENT_DATE", + "DATEADD", + "EXTRACT", + "FLOOR", + "GETDATE", + "LN", + "LOG", + "LOWER", + "ROUND", + "RTRIM", + "SQRT", + "SUBSTRING", + "TO_CHAR", + "TO_DATE", + "TO_NUMBER", + "TO_TIMESTAMP", + "TRIM", + "TRUNC", + "UPPER" + ] + }, + "ScalarFunctionsList":{ + "type":"list", + "member":{"shape":"ScalarFunctions"} + }, + "Schema":{ + "type":"structure", + "required":[ + "columns", + "partitionKeys", + "analysisRuleTypes", + "creatorAccountId", + "name", + "collaborationId", + "collaborationArn", + "description", + "createTime", + "updateTime", + "type", + "schemaStatusDetails" + ], + "members":{ + "columns":{ + "shape":"ColumnList", + "documentation":"The columns for the relation this schema represents.
" + }, + "partitionKeys":{ + "shape":"ColumnList", + "documentation":"The partition keys for the dataset underlying this schema.
" + }, + "analysisRuleTypes":{ + "shape":"AnalysisRuleTypeList", + "documentation":"The analysis rule types associated with the schema. Currently, only one entry is present.
" + }, + "analysisMethod":{ + "shape":"AnalysisMethod", + "documentation":"The analysis method for the schema. The only valid value is currently DIRECT_QUERY.
" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"The unique account ID for the Amazon Web Services account that owns the schema.
" + }, + "name":{ + "shape":"TableAlias", + "documentation":"A name for the schema. The schema relation is referred to by this name when queried by a protected query.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique ID for the collaboration that the schema belongs to.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The unique ARN for the collaboration that the schema belongs to.
" + }, + "description":{ + "shape":"TableDescription", + "documentation":"A description for the schema.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time the schema was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time the schema was last updated.
" + }, + "type":{ + "shape":"SchemaType", + "documentation":"The type of schema. The only valid value is currently `TABLE`.
" + }, + "schemaStatusDetails":{ + "shape":"SchemaStatusDetailList", + "documentation":"Details about the status of the schema. Currently, only one entry is present.
" + }, + "schemaTypeProperties":{ + "shape":"SchemaTypeProperties", + "documentation":"The schema type properties.
" + } + }, + "documentation":"A schema is a relation within a collaboration.
" + }, + "SchemaAnalysisRuleList":{ + "type":"list", + "member":{"shape":"AnalysisRule"}, + "max":25, + "min":0 + }, + "SchemaAnalysisRuleRequest":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "name":{ + "shape":"TableAlias", + "documentation":"The name of the analysis rule schema that you are requesting.
" + }, + "type":{ + "shape":"AnalysisRuleType", + "documentation":"The type of analysis rule schema that you are requesting.
" + } + }, + "documentation":"Defines the information that's necessary to retrieve an analysis rule schema. Schema analysis rules are uniquely identified by a combination of the schema name and the analysis rule type for a given collaboration.
" + }, + "SchemaAnalysisRuleRequestList":{ + "type":"list", + "member":{"shape":"SchemaAnalysisRuleRequest"}, + "max":25, + "min":1 + }, + "SchemaConfiguration":{ + "type":"string", + "enum":["DIFFERENTIAL_PRIVACY"] + }, + "SchemaConfigurationList":{ + "type":"list", + "member":{"shape":"SchemaConfiguration"} + }, + "SchemaList":{ + "type":"list", + "member":{"shape":"Schema"}, + "max":25, + "min":0 + }, + "SchemaStatus":{ + "type":"string", + "enum":[ + "READY", + "NOT_READY" + ] + }, + "SchemaStatusDetail":{ + "type":"structure", + "required":[ + "status", + "analysisType" + ], + "members":{ + "status":{ + "shape":"SchemaStatus", + "documentation":"The status of the schema, indicating if it is ready to query.
" + }, + "reasons":{ + "shape":"SchemaStatusReasonList", + "documentation":"The reasons why the schema status is set to its current state.
" + }, + "analysisRuleType":{ + "shape":"AnalysisRuleType", + "documentation":"The analysis rule type for which the schema status has been evaluated.
" + }, + "configurations":{ + "shape":"SchemaConfigurationList", + "documentation":"The configuration details of the schema analysis rule for the given type.
" + }, + "analysisType":{ + "shape":"AnalysisType", + "documentation":"The type of analysis that can be performed on the schema.
A schema can have an analysisType of DIRECT_ANALYSIS, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.
Information about the schema status.
A status of READY means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.
The schema status reason code.
" + }, + "message":{ + "shape":"String", + "documentation":"An explanation of the schema status reason code.
" + } + }, + "documentation":"A reason why the schema status is set to its current value.
" + }, + "SchemaStatusReasonCode":{ + "type":"string", + "enum":[ + "ANALYSIS_RULE_MISSING", + "ANALYSIS_TEMPLATES_NOT_CONFIGURED", + "ANALYSIS_PROVIDERS_NOT_CONFIGURED", + "DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED", + "ID_MAPPING_TABLE_NOT_POPULATED", + "COLLABORATION_ANALYSIS_RULE_NOT_CONFIGURED", + "ADDITIONAL_ANALYSES_NOT_CONFIGURED", + "RESULT_RECEIVERS_NOT_CONFIGURED", + "ADDITIONAL_ANALYSES_NOT_ALLOWED", + "RESULT_RECEIVERS_NOT_ALLOWED", + "ANALYSIS_RULE_TYPES_NOT_COMPATIBLE" + ] + }, + "SchemaStatusReasonList":{ + "type":"list", + "member":{"shape":"SchemaStatusReason"} + }, + "SchemaSummary":{ + "type":"structure", + "required":[ + "name", + "type", + "creatorAccountId", + "createTime", + "updateTime", + "collaborationId", + "collaborationArn", + "analysisRuleTypes" + ], + "members":{ + "name":{ + "shape":"TableAlias", + "documentation":"The name for the schema object.
" + }, + "type":{ + "shape":"SchemaType", + "documentation":"The type of schema object. The only valid schema type is currently `TABLE`.
" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"The unique account ID for the Amazon Web Services account that owns the schema.
" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"The time the schema object was created.
" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"The time the schema object was last updated.
" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"The unique ID for the collaboration that the schema belongs to.
" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"The unique ARN for the collaboration that the schema belongs to.
" + }, + "analysisRuleTypes":{ + "shape":"AnalysisRuleTypeList", + "documentation":"The types of analysis rules that are associated with this schema object.
" + }, + "analysisMethod":{ + "shape":"AnalysisMethod", + "documentation":"The analysis method for the associated schema. The only valid value is currently `DIRECT_QUERY`.
" + } + }, + "documentation":"The schema summary for the objects listed by the request.
" + }, + "SchemaSummaryList":{ + "type":"list", + "member":{"shape":"SchemaSummary"} + }, + "SchemaType":{ + "type":"string", + "enum":[ + "TABLE", + "ID_MAPPING_TABLE" + ] + }, + "SchemaTypeProperties":{ + "type":"structure", + "members":{ + "idMappingTable":{ + "shape":"IdMappingTableSchemaTypeProperties", + "documentation":"The ID mapping table for the schema type properties.
" + } + }, + "documentation":"Information about the schema type properties.
", + "union":true + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "message", + "quotaName", + "quotaValue" + ], + "members":{ + "message":{"shape":"String"}, + "quotaName":{ + "shape":"String", + "documentation":"The name of the quota.
" + }, + "quotaValue":{ + "shape":"Double", + "documentation":"The value of the quota.
" + } + }, + "documentation":"Request denied because service quota has been exceeded.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "StartProtectedQueryInput":{ + "type":"structure", + "required":[ + "type", + "membershipIdentifier", + "sqlParameters" + ], + "members":{ + "type":{ + "shape":"ProtectedQueryType", + "documentation":"The type of the protected query to be started.
" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for the membership to run this query against. Currently accepts a membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "sqlParameters":{ + "shape":"ProtectedQuerySQLParameters", + "documentation":"The protected SQL query parameters.
" + }, + "resultConfiguration":{ + "shape":"ProtectedQueryResultConfiguration", + "documentation":"The details needed to write the query results.
" + } + } + }, + "StartProtectedQueryOutput":{ + "type":"structure", + "required":["protectedQuery"], + "members":{ + "protectedQuery":{ + "shape":"ProtectedQuery", + "documentation":"The protected query.
" + } + } + }, + "String":{"type":"string"}, + "TableAlias":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?" + }, + "TableAliasList":{ + "type":"list", + "member":{"shape":"TableAlias"}, + "max":25, + "min":1 + }, + "TableDescription":{ + "type":"string", + "max":255, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*" + }, + "TableReference":{ + "type":"structure", + "members":{ + "glue":{ + "shape":"GlueTableReference", + "documentation":"If present, a reference to the Glue table referred to by this table reference.
" + } + }, + "documentation":"A pointer to the dataset that underlies this table. Currently, this can only be an Glue table.
", + "union":true + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "documentation":"Map of tags assigned to a resource
", + "max":200, + "min":0 + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"CleanroomsArn", + "documentation":"The Amazon Resource Name (ARN) associated with the resource you want to tag.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A map of objects specifying each key name and value.
" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TargetProtectedQueryStatus":{ + "type":"string", + "enum":["CANCELLED"] + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "UUID":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"CleanroomsArn", + "documentation":"The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeys", + "documentation":"A list of key names of tags to be removed.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateAnalysisTemplateInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "analysisTemplateIdentifier" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The identifier for a membership resource.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "analysisTemplateIdentifier":{ + "shape":"AnalysisTemplateIdentifier", + "documentation":"The identifier for the analysis template resource.
", + "location":"uri", + "locationName":"analysisTemplateIdentifier" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"A new description for the analysis template.
" + } + } + }, + "UpdateAnalysisTemplateOutput":{ + "type":"structure", + "required":["analysisTemplate"], + "members":{ + "analysisTemplate":{ + "shape":"AnalysisTemplate", + "documentation":"The analysis template.
" + } + } + }, + "UpdateCollaborationInput":{ + "type":"structure", + "required":["collaborationIdentifier"], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"The identifier for the collaboration.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "name":{ + "shape":"CollaborationName", + "documentation":"A human-readable identifier provided by the collaboration owner. Display names are not unique.
" + }, + "description":{ + "shape":"CollaborationDescription", + "documentation":"A description of the collaboration.
" + } + } + }, + "UpdateCollaborationOutput":{ + "type":"structure", + "required":["collaboration"], + "members":{ + "collaboration":{ + "shape":"Collaboration", + "documentation":"The entire collaboration that has been updated.
" + } + } + }, + "UpdateConfiguredAudienceModelAssociationInput":{ + "type":"structure", + "required":[ + "configuredAudienceModelAssociationIdentifier", + "membershipIdentifier" + ], + "members":{ + "configuredAudienceModelAssociationIdentifier":{ + "shape":"ConfiguredAudienceModelAssociationIdentifier", + "documentation":"A unique identifier for the configured audience model association that you want to update.
", + "location":"uri", + "locationName":"configuredAudienceModelAssociationIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier of the membership that contains the configured audience model association that you want to update.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"A new description for the configured audience model association.
" + }, + "name":{ + "shape":"ConfiguredAudienceModelAssociationName", + "documentation":"A new name for the configured audience model association.
" + } + } + }, + "UpdateConfiguredAudienceModelAssociationOutput":{ + "type":"structure", + "required":["configuredAudienceModelAssociation"], + "members":{ + "configuredAudienceModelAssociation":{ + "shape":"ConfiguredAudienceModelAssociation", + "documentation":"Details about the configured audience model association that you updated.
" + } + } + }, + "UpdateConfiguredTableAnalysisRuleInput":{ + "type":"structure", + "required":[ + "configuredTableIdentifier", + "analysisRuleType", + "analysisRulePolicy" + ], + "members":{ + "configuredTableIdentifier":{ + "shape":"ConfiguredTableIdentifier", + "documentation":"The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.
", + "location":"uri", + "locationName":"configuredTableIdentifier" + }, + "analysisRuleType":{ + "shape":"ConfiguredTableAnalysisRuleType", + "documentation":"The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
", + "location":"uri", + "locationName":"analysisRuleType" + }, + "analysisRulePolicy":{ + "shape":"ConfiguredTableAnalysisRulePolicy", + "documentation":"The new analysis rule policy for the configured table analysis rule.
" + } + } + }, + "UpdateConfiguredTableAnalysisRuleOutput":{ + "type":"structure", + "required":["analysisRule"], + "members":{ + "analysisRule":{ + "shape":"ConfiguredTableAnalysisRule", + "documentation":"The entire updated analysis rule.
" + } + } + }, + "UpdateConfiguredTableAssociationAnalysisRuleInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "configuredTableAssociationIdentifier", + "analysisRuleType", + "analysisRulePolicy" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "configuredTableAssociationIdentifier":{ + "shape":"ConfiguredTableAssociationIdentifier", + "documentation":"The identifier for the configured table association to update.
", + "location":"uri", + "locationName":"configuredTableAssociationIdentifier" + }, + "analysisRuleType":{ + "shape":"ConfiguredTableAssociationAnalysisRuleType", + "documentation":"The analysis rule type that you want to update.
", + "location":"uri", + "locationName":"analysisRuleType" + }, + "analysisRulePolicy":{ + "shape":"ConfiguredTableAssociationAnalysisRulePolicy", + "documentation":"The updated analysis rule policy for the configured table association.
" + } + } + }, + "UpdateConfiguredTableAssociationAnalysisRuleOutput":{ + "type":"structure", + "required":["analysisRule"], + "members":{ + "analysisRule":{ + "shape":"ConfiguredTableAssociationAnalysisRule", + "documentation":" The updated analysis rule for the configured table association. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.
The unique identifier for the configured table association to update. Currently accepts the configured table association ID.
", + "location":"uri", + "locationName":"configuredTableAssociationIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The unique ID for the membership that the configured table association belongs to.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "description":{ + "shape":"TableDescription", + "documentation":"A new description for the configured table association.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The service will assume this role to access catalog metadata and query the table.
" + } + } + }, + "UpdateConfiguredTableAssociationOutput":{ + "type":"structure", + "required":["configuredTableAssociation"], + "members":{ + "configuredTableAssociation":{ + "shape":"ConfiguredTableAssociation", + "documentation":"The entire updated configured table association.
" + } + } + }, + "UpdateConfiguredTableInput":{ + "type":"structure", + "required":["configuredTableIdentifier"], + "members":{ + "configuredTableIdentifier":{ + "shape":"ConfiguredTableIdentifier", + "documentation":"The identifier for the configured table to update. Currently accepts the configured table ID.
", + "location":"uri", + "locationName":"configuredTableIdentifier" + }, + "name":{ + "shape":"DisplayName", + "documentation":"A new name for the configured table.
" + }, + "description":{ + "shape":"TableDescription", + "documentation":"A new description for the configured table.
" + } + } + }, + "UpdateConfiguredTableOutput":{ + "type":"structure", + "required":["configuredTable"], + "members":{ + "configuredTable":{ + "shape":"ConfiguredTable", + "documentation":"The updated configured table.
" + } + } + }, + "UpdateIdMappingTableInput":{ + "type":"structure", + "required":[ + "idMappingTableIdentifier", + "membershipIdentifier" + ], + "members":{ + "idMappingTableIdentifier":{ + "shape":"UUID", + "documentation":"The unique identifier of the ID mapping table that you want to update.
", + "location":"uri", + "locationName":"idMappingTableIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The unique identifier of the membership that contains the ID mapping table that you want to update.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"A new description for the ID mapping table.
" + }, + "kmsKeyArn":{ + "shape":"KMSKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.
" + } + } + }, + "UpdateIdMappingTableOutput":{ + "type":"structure", + "required":["idMappingTable"], + "members":{ + "idMappingTable":{ + "shape":"IdMappingTable", + "documentation":"The updated ID mapping table.
" + } + } + }, + "UpdateIdNamespaceAssociationInput":{ + "type":"structure", + "required":[ + "idNamespaceAssociationIdentifier", + "membershipIdentifier" + ], + "members":{ + "idNamespaceAssociationIdentifier":{ + "shape":"IdNamespaceAssociationIdentifier", + "documentation":"The unique identifier of the ID namespace association that you want to update.
", + "location":"uri", + "locationName":"idNamespaceAssociationIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The unique identifier of the membership that contains the ID namespace association that you want to update.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "name":{ + "shape":"GenericResourceName", + "documentation":"A new name for the ID namespace association.
" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"A new description for the ID namespace association.
" + }, + "idMappingConfig":{ + "shape":"IdMappingConfig", + "documentation":"The configuration settings for the ID mapping table.
" + } + } + }, + "UpdateIdNamespaceAssociationOutput":{ + "type":"structure", + "required":["idNamespaceAssociation"], + "members":{ + "idNamespaceAssociation":{ + "shape":"IdNamespaceAssociation", + "documentation":"The updated ID namespace association.
" + } + } + }, + "UpdateMembershipInput":{ + "type":"structure", + "required":["membershipIdentifier"], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The unique identifier of the membership.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "queryLogStatus":{ + "shape":"MembershipQueryLogStatus", + "documentation":"An indicator as to whether query logging has been enabled or disabled for the membership.
" + }, + "defaultResultConfiguration":{ + "shape":"MembershipProtectedQueryResultConfiguration", + "documentation":"The default protected query result configuration as specified by the member who can receive results.
" + } + } + }, + "UpdateMembershipOutput":{ + "type":"structure", + "required":["membership"], + "members":{ + "membership":{"shape":"Membership"} + } + }, + "UpdatePrivacyBudgetTemplateInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "privacyBudgetTemplateIdentifier", + "privacyBudgetType" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"A unique identifier for one of your memberships for a collaboration. The privacy budget template is updated in the collaboration that this membership belongs to. Accepts a membership ID.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "privacyBudgetTemplateIdentifier":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"A unique identifier for your privacy budget template that you want to update.
", + "location":"uri", + "locationName":"privacyBudgetTemplateIdentifier" + }, + "privacyBudgetType":{ + "shape":"PrivacyBudgetType", + "documentation":"Specifies the type of the privacy budget template.
" + }, + "parameters":{ + "shape":"PrivacyBudgetTemplateUpdateParameters", + "documentation":"Specifies the epsilon and noise parameters for the privacy budget template.
" + } + } + }, + "UpdatePrivacyBudgetTemplateOutput":{ + "type":"structure", + "required":["privacyBudgetTemplate"], + "members":{ + "privacyBudgetTemplate":{ + "shape":"PrivacyBudgetTemplate", + "documentation":"Summary of the privacy budget template.
" + } + } + }, + "UpdateProtectedQueryInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "protectedQueryIdentifier", + "targetStatus" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"The identifier for a member of a protected query instance.
", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "protectedQueryIdentifier":{ + "shape":"ProtectedQueryIdentifier", + "documentation":"The identifier for a protected query instance.
", + "location":"uri", + "locationName":"protectedQueryIdentifier" + }, + "targetStatus":{ + "shape":"TargetProtectedQueryStatus", + "documentation":"The target status of a query. Used to update the execution status of a currently running query.
" + } + } + }, + "UpdateProtectedQueryOutput":{ + "type":"structure", + "required":["protectedQuery"], + "members":{ + "protectedQuery":{ + "shape":"ProtectedQuery", + "documentation":"The protected query output.
" + } + } + }, + "UsersNoisePerQuery":{ + "type":"integer", + "box":true, + "max":100, + "min":10 + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "reason":{ + "shape":"ValidationExceptionReason", + "documentation":"A reason code for the exception.
" + }, + "fieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"Validation errors for specific input parameters.
" + } + }, + "documentation":"The input fails to satisfy the specified constraints.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "name", + "message" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of the input parameter.
" + }, + "message":{ + "shape":"String", + "documentation":"A message for the input validation error.
" + } + }, + "documentation":"Describes validation errors for specific input parameters.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "FIELD_VALIDATION_FAILED", + "INVALID_CONFIGURATION", + "INVALID_QUERY", + "IAM_SYNCHRONIZATION_DELAY" + ] + } + }, + "documentation":"Welcome to the Clean Rooms API Reference.
Clean Rooms is an Amazon Web Services service that helps multiple parties to join their data together in a secure collaboration workspace. In the collaboration, members who can query and receive results can get insights into the collective datasets without either party getting access to the other party's raw data.
To learn more about Clean Rooms concepts, procedures, and best practices, see the Clean Rooms User Guide.
To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the Clean Rooms SQL Reference.
" +} diff --git a/testbed/boto__botocore/botocore/data/cleanrooms/2022-02-17/waiters-2.json b/testbed/boto__botocore/botocore/data/cleanrooms/2022-02-17/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..13f60ee66be6a3d75208653e2bd7b563561adacc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/cleanrooms/2022-02-17/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/testbed/boto__botocore/botocore/data/cloudtrail-data/2021-08-11/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/cloudtrail-data/2021-08-11/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..a8833b95e164ed1ffea891025b89bbc2d8bc98e8 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/cloudtrail-data/2021-08-11/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cloudtrail-data-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cloudtrail-data-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cloudtrail-data.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cloudtrail-data.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/cloudtrail-data/2021-08-11/paginators-1.json b/testbed/boto__botocore/botocore/data/cloudtrail-data/2021-08-11/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..ea142457a6a77d6e6a54942329f1199bc2f2a60c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/cloudtrail-data/2021-08-11/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/testbed/boto__botocore/botocore/data/cloudtrail-data/2021-08-11/service-2.json b/testbed/boto__botocore/botocore/data/cloudtrail-data/2021-08-11/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..c84ead633d9029bdfa6a4b1f419212ad96dd924c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/cloudtrail-data/2021-08-11/service-2.json @@ -0,0 +1,236 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-08-11", + "endpointPrefix":"cloudtrail-data", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"AWS CloudTrail Data Service", + "serviceId":"CloudTrail Data", + "signatureVersion":"v4", + "signingName":"cloudtrail-data", + "uid":"cloudtrail-data-2021-08-11" + }, + "operations":{ + "PutAuditEvents":{ + "name":"PutAuditEvents", + "http":{ + "method":"POST", + "requestUri":"/PutAuditEvents", + "responseCode":200 + }, + "input":{"shape":"PutAuditEventsRequest"}, + "output":{"shape":"PutAuditEventsResponse"}, + "errors":[ + {"shape":"ChannelInsufficientPermission"}, + {"shape":"ChannelNotFound"}, + {"shape":"InvalidChannelARN"}, + {"shape":"ChannelUnsupportedSchema"}, + {"shape":"DuplicatedAuditEventId"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"Ingests your application events into CloudTrail Lake. A required parameter, auditEvents, accepts the JSON records (also called payload) of events that you want CloudTrail to ingest. You can add up to 100 of these events (or up to 1 MB) per PutAuditEvents request.
The content of an audit event that comes from the event, such as userIdentity, userAgent, and eventSource.
A checksum is a base64-SHA256 algorithm that helps you verify that CloudTrail receives the event that matches with the checksum. Calculate the checksum by running a command like the following:
printf %s $eventdata | openssl dgst -binary -sha256 | base64
The original event ID from the source event.
" + } + }, + "documentation":"An event from a source outside of Amazon Web Services that you want CloudTrail to log.
" + }, + "AuditEventResultEntries":{ + "type":"list", + "member":{"shape":"AuditEventResultEntry"}, + "max":100, + "min":0 + }, + "AuditEventResultEntry":{ + "type":"structure", + "required":[ + "eventID", + "id" + ], + "members":{ + "eventID":{ + "shape":"Uuid", + "documentation":"The event ID assigned by CloudTrail.
" + }, + "id":{ + "shape":"Uuid", + "documentation":"The original event ID from the source event.
" + } + }, + "documentation":"A response that includes successful and failed event results.
" + }, + "AuditEvents":{ + "type":"list", + "member":{"shape":"AuditEvent"}, + "max":100, + "min":1 + }, + "ChannelArn":{ + "type":"string", + "pattern":"^arn:.*$" + }, + "ChannelInsufficientPermission":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The caller's account ID must be the same as the channel owner's account ID.
", + "exception":true + }, + "ChannelNotFound":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The channel could not be found.
", + "exception":true + }, + "ChannelUnsupportedSchema":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The schema type of the event is not supported.
", + "exception":true + }, + "DuplicatedAuditEventId":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Two or more entries in the request have the same event ID.
", + "exception":true + }, + "ErrorCode":{ + "type":"string", + "max":128, + "min":1 + }, + "ErrorMessage":{ + "type":"string", + "max":1024, + "min":1 + }, + "ExternalId":{ + "type":"string", + "max":1224, + "min":2, + "pattern":"^[\\w+=,.@:\\/-]*$" + }, + "InvalidChannelARN":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The specified channel ARN is not a valid channel ARN.
", + "exception":true + }, + "PutAuditEventsRequest":{ + "type":"structure", + "required":[ + "auditEvents", + "channelArn" + ], + "members":{ + "auditEvents":{ + "shape":"AuditEvents", + "documentation":"The JSON payload of events that you want to ingest. You can also point to the JSON event payload in a file.
" + }, + "channelArn":{ + "shape":"ChannelArn", + "documentation":"The ARN or ID (the ARN suffix) of a channel.
", + "location":"querystring", + "locationName":"channelArn" + }, + "externalId":{ + "shape":"ExternalId", + "documentation":"A unique identifier that is conditionally required when the channel's resource policy includes an external ID. This value can be any string, such as a passphrase or account number.
", + "location":"querystring", + "locationName":"externalId" + } + } + }, + "PutAuditEventsResponse":{ + "type":"structure", + "required":[ + "failed", + "successful" + ], + "members":{ + "failed":{ + "shape":"ResultErrorEntries", + "documentation":"Lists events in the provided event payload that could not be ingested into CloudTrail, and includes the error code and error message returned for events that could not be ingested.
" + }, + "successful":{ + "shape":"AuditEventResultEntries", + "documentation":"Lists events in the provided event payload that were successfully ingested into CloudTrail.
" + } + } + }, + "ResultErrorEntries":{ + "type":"list", + "member":{"shape":"ResultErrorEntry"}, + "max":100, + "min":0 + }, + "ResultErrorEntry":{ + "type":"structure", + "required":[ + "errorCode", + "errorMessage", + "id" + ], + "members":{ + "errorCode":{ + "shape":"ErrorCode", + "documentation":"The error code for events that could not be ingested by CloudTrail. Possible error codes include: FieldTooLong, FieldNotFound, InvalidChecksum, InvalidData, InvalidRecipient, InvalidEventSource, AccountNotSubscribed, Throttling, and InternalFailure.
The message that describes the error for events that could not be ingested by CloudTrail.
" + }, + "id":{ + "shape":"Uuid", + "documentation":"The original event ID from the source event that could not be ingested by CloudTrail.
" + } + }, + "documentation":"Includes the error code and error message for events that could not be ingested by CloudTrail.
" + }, + "String":{"type":"string"}, + "UnsupportedOperationException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The operation requested is not supported in this region or account.
", + "exception":true + }, + "Uuid":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[-_A-Za-z0-9]+$" + } + }, + "documentation":"The CloudTrail Data Service lets you ingest events into CloudTrail from any source in your hybrid environments, such as in-house or SaaS applications hosted on-premises or in the cloud, virtual machines, or containers. You can store, access, analyze, troubleshoot and take action on this data without maintaining multiple log aggregators and reporting tools. After you run PutAuditEvents to ingest your application activity into CloudTrail, you can use CloudTrail Lake to search, query, and analyze the data that is logged from your applications.
Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password. It is associated with your user identity for use across all spaces and projects in Amazon CodeCatalyst. You use PATs to access CodeCatalyst from resources that include integrated development environments (IDEs) and Git-based source repositories. PATs represent you in Amazon CodeCatalyst and you can manage them in your user settings.For more information, see Managing personal access tokens in Amazon CodeCatalyst.
" + }, + "CreateDevEnvironment":{ + "name":"CreateDevEnvironment", + "http":{ + "method":"PUT", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments", + "responseCode":201 + }, + "input":{"shape":"CreateDevEnvironmentRequest"}, + "output":{"shape":"CreateDevEnvironmentResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project.
When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these defaults apply to a Dev Environment created programmatically.
Creates a project in a specified space.
", + "idempotent":true + }, + "CreateSourceRepository":{ + "name":"CreateSourceRepository", + "http":{ + "method":"PUT", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories/{name}", + "responseCode":201 + }, + "input":{"shape":"CreateSourceRepositoryRequest"}, + "output":{"shape":"CreateSourceRepositoryResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates an empty Git-based source repository in a specified project. The repository is created with an initial empty commit with a default branch named main.
Creates a branch in a specified source repository in Amazon CodeCatalyst.
This API only creates a branch in a source repository hosted in Amazon CodeCatalyst. You cannot use this API to create a branch in a linked repository.
Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.
", + "idempotent":true + }, + "DeleteDevEnvironment":{ + "name":"DeleteDevEnvironment", + "http":{ + "method":"DELETE", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}", + "responseCode":200 + }, + "input":{"shape":"DeleteDevEnvironmentRequest"}, + "output":{"shape":"DeleteDevEnvironmentResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a Dev Environment.
", + "idempotent":true + }, + "DeleteProject":{ + "name":"DeleteProject", + "http":{ + "method":"DELETE", + "requestUri":"/v1/spaces/{spaceName}/projects/{name}", + "responseCode":200 + }, + "input":{"shape":"DeleteProjectRequest"}, + "output":{"shape":"DeleteProjectResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a project in a space.
", + "idempotent":true + }, + "DeleteSourceRepository":{ + "name":"DeleteSourceRepository", + "http":{ + "method":"DELETE", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories/{name}", + "responseCode":200 + }, + "input":{"shape":"DeleteSourceRepositoryRequest"}, + "output":{"shape":"DeleteSourceRepositoryResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a source repository in Amazon CodeCatalyst. You cannot use this API to delete a linked repository. It can only be used to delete a Amazon CodeCatalyst source repository.
", + "idempotent":true + }, + "DeleteSpace":{ + "name":"DeleteSpace", + "http":{ + "method":"DELETE", + "requestUri":"/v1/spaces/{name}", + "responseCode":200 + }, + "input":{"shape":"DeleteSpaceRequest"}, + "output":{"shape":"DeleteSpaceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a space.
Deleting a space cannot be undone. Additionally, since space names must be unique across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.
Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.
" + }, + "GetProject":{ + "name":"GetProject", + "http":{ + "method":"GET", + "requestUri":"/v1/spaces/{spaceName}/projects/{name}", + "responseCode":200 + }, + "input":{"shape":"GetProjectRequest"}, + "output":{"shape":"GetProjectResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about a project.
" + }, + "GetSourceRepository":{ + "name":"GetSourceRepository", + "http":{ + "method":"GET", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories/{name}", + "responseCode":200 + }, + "input":{"shape":"GetSourceRepositoryRequest"}, + "output":{"shape":"GetSourceRepositoryResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about a source repository.
" + }, + "GetSourceRepositoryCloneUrls":{ + "name":"GetSourceRepositoryCloneUrls", + "http":{ + "method":"GET", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories/{sourceRepositoryName}/cloneUrls", + "responseCode":200 + }, + "input":{"shape":"GetSourceRepositoryCloneUrlsRequest"}, + "output":{"shape":"GetSourceRepositoryCloneUrlsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about the URLs that can be used with a Git client to clone a source repository.
" + }, + "GetSpace":{ + "name":"GetSpace", + "http":{ + "method":"GET", + "requestUri":"/v1/spaces/{name}", + "responseCode":200 + }, + "input":{"shape":"GetSpaceRequest"}, + "output":{"shape":"GetSpaceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about an space.
" + }, + "GetSubscription":{ + "name":"GetSubscription", + "http":{ + "method":"GET", + "requestUri":"/v1/spaces/{spaceName}/subscription", + "responseCode":200 + }, + "input":{"shape":"GetSubscriptionRequest"}, + "output":{"shape":"GetSubscriptionResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
" + }, + "GetUserDetails":{ + "name":"GetUserDetails", + "http":{ + "method":"GET", + "requestUri":"/userDetails", + "responseCode":200 + }, + "input":{"shape":"GetUserDetailsRequest"}, + "output":{"shape":"GetUserDetailsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about a user.
" + }, + "GetWorkflow":{ + "name":"GetWorkflow", + "http":{ + "method":"GET", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/workflows/{id}", + "responseCode":200 + }, + "input":{"shape":"GetWorkflowRequest"}, + "output":{"shape":"GetWorkflowResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about a workflow.
" + }, + "GetWorkflowRun":{ + "name":"GetWorkflowRun", + "http":{ + "method":"GET", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/workflowRuns/{id}", + "responseCode":200 + }, + "input":{"shape":"GetWorkflowRunRequest"}, + "output":{"shape":"GetWorkflowRunResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about a specified run of a workflow.
" + }, + "ListAccessTokens":{ + "name":"ListAccessTokens", + "http":{ + "method":"POST", + "requestUri":"/v1/accessTokens", + "responseCode":200 + }, + "input":{"shape":"ListAccessTokensRequest"}, + "output":{"shape":"ListAccessTokensResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your Amazon Web Services Builder ID.
" + }, + "ListDevEnvironmentSessions":{ + "name":"ListDevEnvironmentSessions", + "http":{ + "method":"POST", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{devEnvironmentId}/sessions", + "responseCode":200 + }, + "input":{"shape":"ListDevEnvironmentSessionsRequest"}, + "output":{"shape":"ListDevEnvironmentSessionsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of active sessions for a Dev Environment in a project.
" + }, + "ListDevEnvironments":{ + "name":"ListDevEnvironments", + "http":{ + "method":"POST", + "requestUri":"/v1/spaces/{spaceName}/devEnvironments", + "responseCode":200 + }, + "input":{"shape":"ListDevEnvironmentsRequest"}, + "output":{"shape":"ListDevEnvironmentsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of Dev Environments in a project.
" + }, + "ListEventLogs":{ + "name":"ListEventLogs", + "http":{ + "method":"POST", + "requestUri":"/v1/spaces/{spaceName}/eventLogs", + "responseCode":200 + }, + "input":{"shape":"ListEventLogsRequest"}, + "output":{"shape":"ListEventLogsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of events that occurred during a specific time in a space. You can use these events to audit user and system activity in a space. For more information, see Monitoring in the Amazon CodeCatalyst User Guide.
ListEventLogs guarantees events for the last 30 days in a given space. You can also view and retrieve a list of management events over the last 90 days for Amazon CodeCatalyst in the CloudTrail console by viewing Event history, or by creating a trail to create and maintain a record of events that extends past 90 days. For more information, see Working with CloudTrail Event History and Working with CloudTrail trails.
Retrieves a list of projects.
" + }, + "ListSourceRepositories":{ + "name":"ListSourceRepositories", + "http":{ + "method":"POST", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories", + "responseCode":200 + }, + "input":{"shape":"ListSourceRepositoriesRequest"}, + "output":{"shape":"ListSourceRepositoriesResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of source repositories in a project.
" + }, + "ListSourceRepositoryBranches":{ + "name":"ListSourceRepositoryBranches", + "http":{ + "method":"POST", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories/{sourceRepositoryName}/branches", + "responseCode":200 + }, + "input":{"shape":"ListSourceRepositoryBranchesRequest"}, + "output":{"shape":"ListSourceRepositoryBranchesResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of branches in a specified source repository.
" + }, + "ListSpaces":{ + "name":"ListSpaces", + "http":{ + "method":"POST", + "requestUri":"/v1/spaces", + "responseCode":200 + }, + "input":{"shape":"ListSpacesRequest"}, + "output":{"shape":"ListSpacesResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of spaces.
" + }, + "ListWorkflowRuns":{ + "name":"ListWorkflowRuns", + "http":{ + "method":"POST", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/workflowRuns", + "responseCode":200 + }, + "input":{"shape":"ListWorkflowRunsRequest"}, + "output":{"shape":"ListWorkflowRunsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of workflow runs of a specified workflow.
" + }, + "ListWorkflows":{ + "name":"ListWorkflows", + "http":{ + "method":"POST", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/workflows", + "responseCode":200 + }, + "input":{"shape":"ListWorkflowsRequest"}, + "output":{"shape":"ListWorkflowsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of workflows in a specified project.
" + }, + "StartDevEnvironment":{ + "name":"StartDevEnvironment", + "http":{ + "method":"PUT", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/start", + "responseCode":200 + }, + "input":{"shape":"StartDevEnvironmentRequest"}, + "output":{"shape":"StartDevEnvironmentResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Starts a specified Dev Environment and puts it into an active state.
", + "idempotent":true + }, + "StartDevEnvironmentSession":{ + "name":"StartDevEnvironmentSession", + "http":{ + "method":"PUT", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/session", + "responseCode":200 + }, + "input":{"shape":"StartDevEnvironmentSessionRequest"}, + "output":{"shape":"StartDevEnvironmentSessionResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Starts a session for a specified Dev Environment.
" + }, + "StartWorkflowRun":{ + "name":"StartWorkflowRun", + "http":{ + "method":"PUT", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/workflowRuns", + "responseCode":200 + }, + "input":{"shape":"StartWorkflowRunRequest"}, + "output":{"shape":"StartWorkflowRunResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Begins a run of a specified workflow.
", + "idempotent":true + }, + "StopDevEnvironment":{ + "name":"StopDevEnvironment", + "http":{ + "method":"PUT", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/stop", + "responseCode":200 + }, + "input":{"shape":"StopDevEnvironmentRequest"}, + "output":{"shape":"StopDevEnvironmentResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.
", + "idempotent":true + }, + "StopDevEnvironmentSession":{ + "name":"StopDevEnvironmentSession", + "http":{ + "method":"DELETE", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/session/{sessionId}", + "responseCode":200 + }, + "input":{"shape":"StopDevEnvironmentSessionRequest"}, + "output":{"shape":"StopDevEnvironmentSessionResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Stops a session for a specified Dev Environment.
", + "idempotent":true + }, + "UpdateDevEnvironment":{ + "name":"UpdateDevEnvironment", + "http":{ + "method":"PATCH", + "requestUri":"/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}", + "responseCode":200 + }, + "input":{"shape":"UpdateDevEnvironmentRequest"}, + "output":{"shape":"UpdateDevEnvironmentResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.
", + "idempotent":true + }, + "UpdateProject":{ + "name":"UpdateProject", + "http":{ + "method":"PATCH", + "requestUri":"/v1/spaces/{spaceName}/projects/{name}", + "responseCode":200 + }, + "input":{"shape":"UpdateProjectRequest"}, + "output":{"shape":"UpdateProjectResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Changes one or more values for a project.
", + "idempotent":true + }, + "UpdateSpace":{ + "name":"UpdateSpace", + "http":{ + "method":"PATCH", + "requestUri":"/v1/spaces/{name}", + "responseCode":200 + }, + "input":{"shape":"UpdateSpaceRequest"}, + "output":{"shape":"UpdateSpaceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Changes one or more values for a space.
", + "idempotent":true + }, + "VerifySession":{ + "name":"VerifySession", + "http":{ + "method":"GET", + "requestUri":"/session", + "responseCode":200 + }, + "output":{"shape":"VerifySessionResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Verifies whether the calling user has a valid Amazon CodeCatalyst login and session. If successful, this returns the ID of the user in Amazon CodeCatalyst.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccessTokenId":{ + "type":"string", + "max":36, + "min":1 + }, + "AccessTokenName":{ + "type":"string", + "max":100, + "min":1 + }, + "AccessTokenSecret":{ + "type":"string", + "max":4000, + "min":1, + "sensitive":true + }, + "AccessTokenSummaries":{ + "type":"list", + "member":{"shape":"AccessTokenSummary"} + }, + "AccessTokenSummary":{ + "type":"structure", + "required":[ + "id", + "name" + ], + "members":{ + "id":{ + "shape":"AccessTokenId", + "documentation":"The system-generated ID of the personal access token.
" + }, + "name":{ + "shape":"AccessTokenName", + "documentation":"The friendly name of the personal access token.
" + }, + "expiresTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time when the personal access token will expire, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + } + }, + "documentation":"Information about a specified personal access token (PAT).
" + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ClientToken":{ + "type":"string", + "max":1024, + "min":1 + }, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "EQ", + "GT", + "GE", + "LT", + "LE", + "BEGINS_WITH" + ] + }, + "ConflictException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateAccessTokenRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"AccessTokenName", + "documentation":"The friendly name of the personal access token.
" + }, + "expiresTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + } + } + }, + "CreateAccessTokenResponse":{ + "type":"structure", + "required":[ + "secret", + "name", + "expiresTime", + "accessTokenId" + ], + "members":{ + "secret":{ + "shape":"AccessTokenSecret", + "documentation":"The secret value of the personal access token.
" + }, + "name":{ + "shape":"AccessTokenName", + "documentation":"The friendly name of the personal access token.
" + }, + "expiresTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in RFC 3339. If not specified, the default is one year from creation.
" + }, + "accessTokenId":{ + "shape":"AccessTokenId", + "documentation":"The system-generated unique ID of the access token.
" + } + } + }, + "CreateDevEnvironmentRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "instanceType", + "persistentStorage" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "repositories":{ + "shape":"RepositoriesInput", + "documentation":"The source repository that contains the branch to clone into the Dev Environment.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.
" + }, + "alias":{ + "shape":"CreateDevEnvironmentRequestAliasString", + "documentation":"The user-defined alias for a Dev Environment.
" + }, + "ides":{ + "shape":"IdeConfigurationList", + "documentation":"Information about the integrated development environment (IDE) configured for a Dev Environment.
An IDE is required to create a Dev Environment. For Dev Environment creation, this field contains configuration information and must be provided.
The Amazon EC2 instace type to use for the Dev Environment.
" + }, + "inactivityTimeoutMinutes":{ + "shape":"InactivityTimeoutMinutes", + "documentation":"The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.
" + }, + "persistentStorage":{ + "shape":"PersistentStorageConfiguration", + "documentation":"Information about the amount of storage allocated to the Dev Environment.
By default, a Dev Environment is configured to have 16GB of persistent storage when created from the Amazon CodeCatalyst console, but there is no default when programmatically creating a Dev Environment. Valid values for persistent storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.
The name of the connection that will be used to connect to Amazon VPC, if any.
" + } + } + }, + "CreateDevEnvironmentRequestAliasString":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*" + }, + "CreateDevEnvironmentResponse":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment.
" + }, + "vpcConnectionName":{ + "shape":"NameString", + "documentation":"The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.
" + } + } + }, + "CreateProjectRequest":{ + "type":"structure", + "required":[ + "spaceName", + "displayName" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "displayName":{ + "shape":"ProjectDisplayName", + "documentation":"The friendly name of the project that will be displayed to users.
" + }, + "description":{ + "shape":"ProjectDescription", + "documentation":"The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.
" + } + } + }, + "CreateProjectResponse":{ + "type":"structure", + "required":["name"], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "name":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "displayName":{ + "shape":"String", + "documentation":"The friendly name of the project.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the project.
" + } + } + }, + "CreateSourceRepositoryBranchRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "sourceRepositoryName", + "name" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "sourceRepositoryName":{ + "shape":"SourceRepositoryNameString", + "documentation":"The name of the repository where you want to create a branch.
", + "location":"uri", + "locationName":"sourceRepositoryName" + }, + "name":{ + "shape":"SourceRepositoryBranchString", + "documentation":"The name for the branch you're creating.
", + "location":"uri", + "locationName":"name" + }, + "headCommitId":{ + "shape":"String", + "documentation":"The commit ID in an existing branch from which you want to create the new branch.
" + } + } + }, + "CreateSourceRepositoryBranchResponse":{ + "type":"structure", + "members":{ + "ref":{ + "shape":"SourceRepositoryBranchRefString", + "documentation":"The Git reference name of the branch.
" + }, + "name":{ + "shape":"SourceRepositoryBranchString", + "documentation":"The name of the newly created branch.
" + }, + "lastUpdatedTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + }, + "headCommitId":{ + "shape":"String", + "documentation":"The commit ID of the tip of the newly created branch.
" + } + } + }, + "CreateSourceRepositoryRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "name" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "name":{ + "shape":"SourceRepositoryNameString", + "documentation":"The name of the source repository. For more information about name requirements, see Quotas for source repositories.
", + "location":"uri", + "locationName":"name" + }, + "description":{ + "shape":"SourceRepositoryDescriptionString", + "documentation":"The description of the source repository.
" + } + } + }, + "CreateSourceRepositoryResponse":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "name" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "name":{ + "shape":"SourceRepositoryNameString", + "documentation":"The name of the source repository.
" + }, + "description":{ + "shape":"SourceRepositoryDescriptionString", + "documentation":"The description of the source repository.
" + } + } + }, + "DeleteAccessTokenRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"AccessTokenId", + "documentation":"The ID of the personal access token to delete. You can find the IDs of all PATs associated with your Amazon Web Services Builder ID in a space by calling ListAccessTokens.
", + "location":"uri", + "locationName":"id" + } + } + }, + "DeleteAccessTokenResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteDevEnvironmentRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment you want to delete. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.
", + "location":"uri", + "locationName":"id" + } + } + }, + "DeleteDevEnvironmentResponse":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the deleted Dev Environment.
" + } + } + }, + "DeleteProjectRequest":{ + "type":"structure", + "required":[ + "spaceName", + "name" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "name":{ + "shape":"NameString", + "documentation":"The name of the project in the space. To retrieve a list of project names, use ListProjects.
", + "location":"uri", + "locationName":"name" + } + } + }, + "DeleteProjectResponse":{ + "type":"structure", + "required":[ + "spaceName", + "name" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "name":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "displayName":{ + "shape":"String", + "documentation":"The friendly name displayed to users of the project in Amazon CodeCatalyst.
" + } + } + }, + "DeleteSourceRepositoryRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "name" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "name":{ + "shape":"SourceRepositoryNameString", + "documentation":"The name of the source repository.
", + "location":"uri", + "locationName":"name" + } + } + }, + "DeleteSourceRepositoryResponse":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "name" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "name":{ + "shape":"SourceRepositoryNameString", + "documentation":"The name of the repository.
" + } + } + }, + "DeleteSpaceRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"NameString", + "documentation":"The name of the space. To retrieve a list of space names, use ListSpaces.
", + "location":"uri", + "locationName":"name" + } + } + }, + "DeleteSpaceResponse":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "displayName":{ + "shape":"String", + "documentation":"The friendly name of the space displayed to users of the space in Amazon CodeCatalyst.
" + } + } + }, + "DevEnvironmentAccessDetails":{ + "type":"structure", + "required":[ + "streamUrl", + "tokenValue" + ], + "members":{ + "streamUrl":{ + "shape":"SensitiveString", + "documentation":"The URL used to send commands to and from the Dev Environment.
" + }, + "tokenValue":{ + "shape":"SensitiveString", + "documentation":"An encrypted token value that contains session and caller information used to authenticate the connection.
" + } + }, + "documentation":"Information about connection details for a Dev Environment.
", + "sensitive":true + }, + "DevEnvironmentRepositorySummaries":{ + "type":"list", + "member":{"shape":"DevEnvironmentRepositorySummary"} + }, + "DevEnvironmentRepositorySummary":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "repositoryName":{ + "shape":"SourceRepositoryNameString", + "documentation":"The name of the source repository.
" + }, + "branchName":{ + "shape":"SourceRepositoryBranchString", + "documentation":"The name of the branch in a source repository cloned into the Dev Environment.
" + } + }, + "documentation":"Information about the source repsitory for a Dev Environment.
" + }, + "DevEnvironmentSessionConfiguration":{ + "type":"structure", + "required":["sessionType"], + "members":{ + "sessionType":{ + "shape":"DevEnvironmentSessionType", + "documentation":"The type of the session.
" + }, + "executeCommandSessionConfiguration":{ + "shape":"ExecuteCommandSessionConfiguration", + "documentation":"Information about optional commands that will be run on the Dev Environment when the SSH session begins.
" + } + }, + "documentation":"Information about the configuration of a Dev Environment session.
" + }, + "DevEnvironmentSessionSummary":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "devEnvironmentId", + "startedTime", + "id" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "devEnvironmentId":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment.
" + }, + "startedTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time the session started, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
" + }, + "id":{ + "shape":"DevEnvironmentSessionSummaryIdString", + "documentation":"The system-generated unique ID of the Dev Environment session.
" + } + }, + "documentation":"Information about active sessions for a Dev Environment.
" + }, + "DevEnvironmentSessionSummaryIdString":{ + "type":"string", + "max":96, + "min":1 + }, + "DevEnvironmentSessionType":{ + "type":"string", + "enum":[ + "SSM", + "SSH" + ] + }, + "DevEnvironmentSessionsSummaryList":{ + "type":"list", + "member":{"shape":"DevEnvironmentSessionSummary"} + }, + "DevEnvironmentStatus":{ + "type":"string", + "enum":[ + "PENDING", + "RUNNING", + "STARTING", + "STOPPING", + "STOPPED", + "FAILED", + "DELETING", + "DELETED" + ] + }, + "DevEnvironmentSummary":{ + "type":"structure", + "required":[ + "id", + "lastUpdatedTime", + "creatorId", + "status", + "repositories", + "instanceType", + "inactivityTimeoutMinutes", + "persistentStorage" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID for the Dev Environment.
" + }, + "lastUpdatedTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + }, + "creatorId":{ + "shape":"DevEnvironmentSummaryCreatorIdString", + "documentation":"The system-generated unique ID of the user who created the Dev Environment.
" + }, + "status":{ + "shape":"DevEnvironmentStatus", + "documentation":"The status of the Dev Environment.
" + }, + "statusReason":{ + "shape":"StatusReason", + "documentation":"The reason for the status.
" + }, + "repositories":{ + "shape":"DevEnvironmentRepositorySummaries", + "documentation":"Information about the repositories that will be cloned into the Dev Environment. If no rvalue is specified, no repository is cloned.
" + }, + "alias":{ + "shape":"DevEnvironmentSummaryAliasString", + "documentation":"The user-specified alias for the Dev Environment.
" + }, + "ides":{ + "shape":"Ides", + "documentation":"Information about the integrated development environment (IDE) configured for a Dev Environment.
" + }, + "instanceType":{ + "shape":"InstanceType", + "documentation":"The Amazon EC2 instace type used for the Dev Environment.
" + }, + "inactivityTimeoutMinutes":{ + "shape":"InactivityTimeoutMinutes", + "documentation":"The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Dev Environments consume compute minutes when running.
" + }, + "persistentStorage":{ + "shape":"PersistentStorage", + "documentation":"Information about the configuration of persistent storage for the Dev Environment.
" + }, + "vpcConnectionName":{ + "shape":"NameString", + "documentation":"The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.
" + } + }, + "documentation":"Information about a Dev Environment.
" + }, + "DevEnvironmentSummaryAliasString":{ + "type":"string", + "max":128, + "min":0 + }, + "DevEnvironmentSummaryCreatorIdString":{ + "type":"string", + "max":1024, + "min":0 + }, + "DevEnvironmentSummaryList":{ + "type":"list", + "member":{"shape":"DevEnvironmentSummary"} + }, + "EmailAddress":{ + "type":"structure", + "members":{ + "email":{ + "shape":"String", + "documentation":"The email address.
" + }, + "verified":{ + "shape":"Boolean", + "documentation":"Whether the email address has been verified.
" + } + }, + "documentation":"Information about an email address.
" + }, + "EventLogEntries":{ + "type":"list", + "member":{"shape":"EventLogEntry"} + }, + "EventLogEntry":{ + "type":"structure", + "required":[ + "id", + "eventName", + "eventType", + "eventCategory", + "eventSource", + "eventTime", + "operationType", + "userIdentity" + ], + "members":{ + "id":{ + "shape":"String", + "documentation":"The system-generated unique ID of the event.
" + }, + "eventName":{ + "shape":"String", + "documentation":"The name of the event.
" + }, + "eventType":{ + "shape":"String", + "documentation":"The type of the event.
" + }, + "eventCategory":{ + "shape":"String", + "documentation":"The category for the event.
" + }, + "eventSource":{ + "shape":"String", + "documentation":"The source of the event.
" + }, + "eventTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time the event took place, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + }, + "operationType":{ + "shape":"OperationType", + "documentation":"The type of the event.
" + }, + "userIdentity":{ + "shape":"UserIdentity", + "documentation":"The system-generated unique ID of the user whose actions are recorded in the event.
" + }, + "projectInformation":{ + "shape":"ProjectInformation", + "documentation":"Information about the project where the event occurred.
" + }, + "requestId":{ + "shape":"String", + "documentation":"The system-generated unique ID of the request.
" + }, + "requestPayload":{ + "shape":"EventPayload", + "documentation":"Information about the payload of the request.
" + }, + "responsePayload":{ + "shape":"EventPayload", + "documentation":"Information about the payload of the response, if any.
" + }, + "errorCode":{ + "shape":"String", + "documentation":"The code of the error, if any.
" + }, + "sourceIpAddress":{ + "shape":"String", + "documentation":"The IP address of the user whose actions are recorded in the event.
" + }, + "userAgent":{ + "shape":"String", + "documentation":"The user agent whose actions are recorded in the event.
" + } + }, + "documentation":"Information about an entry in an event log of Amazon CodeCatalyst activity.
" + }, + "EventPayload":{ + "type":"structure", + "members":{ + "contentType":{ + "shape":"String", + "documentation":"The type of content in the event payload.
" + }, + "data":{ + "shape":"String", + "documentation":"The data included in the event payload.
" + } + }, + "documentation":"Information about the payload of an event recording Amazon CodeCatalyst activity.
" + }, + "ExecuteCommandSessionConfiguration":{ + "type":"structure", + "required":["command"], + "members":{ + "command":{ + "shape":"ExecuteCommandSessionConfigurationCommandString", + "documentation":"The command used at the beginning of the SSH session to a Dev Environment.
" + }, + "arguments":{ + "shape":"ExecuteCommandSessionConfigurationArguments", + "documentation":"An array of arguments containing arguments and members.
" + } + }, + "documentation":"Information about the commands that will be run on a Dev Environment when an SSH session begins.
" + }, + "ExecuteCommandSessionConfigurationArguments":{ + "type":"list", + "member":{"shape":"ExecuteCommandSessionConfigurationArgumentsMemberString"} + }, + "ExecuteCommandSessionConfigurationArgumentsMemberString":{ + "type":"string", + "max":255, + "min":1 + }, + "ExecuteCommandSessionConfigurationCommandString":{ + "type":"string", + "max":255, + "min":1 + }, + "Filter":{ + "type":"structure", + "required":[ + "key", + "values" + ], + "members":{ + "key":{ + "shape":"String", + "documentation":"A key that can be used to sort results.
" + }, + "values":{ + "shape":"StringList", + "documentation":"The values of the key.
" + }, + "comparisonOperator":{ + "shape":"String", + "documentation":"The operator used to compare the fields.
" + } + }, + "documentation":"Information about a filter used to limit results of a query.
" + }, + "FilterKey":{ + "type":"string", + "enum":[ + "hasAccessTo", + "name" + ] + }, + "Filters":{ + "type":"list", + "member":{"shape":"Filter"} + }, + "GetDevEnvironmentRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.
", + "location":"uri", + "locationName":"id" + } + } + }, + "GetDevEnvironmentResponse":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id", + "lastUpdatedTime", + "creatorId", + "status", + "repositories", + "instanceType", + "inactivityTimeoutMinutes", + "persistentStorage" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment.
" + }, + "lastUpdatedTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + }, + "creatorId":{ + "shape":"GetDevEnvironmentResponseCreatorIdString", + "documentation":"The system-generated unique ID of the user who created the Dev Environment.
" + }, + "status":{ + "shape":"DevEnvironmentStatus", + "documentation":"The current status of the Dev Environment.
" + }, + "statusReason":{ + "shape":"StatusReason", + "documentation":"The reason for the status.
" + }, + "repositories":{ + "shape":"DevEnvironmentRepositorySummaries", + "documentation":"The source repository that contains the branch cloned into the Dev Environment.
" + }, + "alias":{ + "shape":"GetDevEnvironmentResponseAliasString", + "documentation":"The user-specified alias for the Dev Environment.
" + }, + "ides":{ + "shape":"Ides", + "documentation":"Information about the integrated development environment (IDE) configured for the Dev Environment.
" + }, + "instanceType":{ + "shape":"InstanceType", + "documentation":"The Amazon EC2 instace type to use for the Dev Environment.
" + }, + "inactivityTimeoutMinutes":{ + "shape":"InactivityTimeoutMinutes", + "documentation":"The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.
" + }, + "persistentStorage":{ + "shape":"PersistentStorage", + "documentation":"Information about the amount of storage allocated to the Dev Environment. By default, a Dev Environment is configured to have 16GB of persistent storage.
" + }, + "vpcConnectionName":{ + "shape":"NameString", + "documentation":"The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.
" + } + } + }, + "GetDevEnvironmentResponseAliasString":{ + "type":"string", + "max":128, + "min":0 + }, + "GetDevEnvironmentResponseCreatorIdString":{ + "type":"string", + "max":1024, + "min":0 + }, + "GetProjectRequest":{ + "type":"structure", + "required":[ + "spaceName", + "name" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "name":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"name" + } + } + }, + "GetProjectResponse":{ + "type":"structure", + "required":["name"], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the project in the space.
" + }, + "displayName":{ + "shape":"String", + "documentation":"The friendly name of the project displayed to users in Amazon CodeCatalyst.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the project.
" + } + } + }, + "GetSourceRepositoryCloneUrlsRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "sourceRepositoryName" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "sourceRepositoryName":{ + "shape":"SourceRepositoryNameString", + "documentation":"The name of the source repository.
", + "location":"uri", + "locationName":"sourceRepositoryName" + } + } + }, + "GetSourceRepositoryCloneUrlsResponse":{ + "type":"structure", + "required":["https"], + "members":{ + "https":{ + "shape":"String", + "documentation":"The HTTPS URL to use when cloning the source repository.
" + } + } + }, + "GetSourceRepositoryRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "name" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "name":{ + "shape":"SourceRepositoryNameString", + "documentation":"The name of the source repository.
", + "location":"uri", + "locationName":"name" + } + } + }, + "GetSourceRepositoryResponse":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "name", + "lastUpdatedTime", + "createdTime" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "name":{ + "shape":"SourceRepositoryNameString", + "documentation":"The name of the source repository.
" + }, + "description":{ + "shape":"SourceRepositoryDescriptionString", + "documentation":"The description of the source repository.
" + }, + "lastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + }, + "createdTime":{ + "shape":"Timestamp", + "documentation":"The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + } + } + }, + "GetSpaceRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"name" + } + } + }, + "GetSpaceResponse":{ + "type":"structure", + "required":[ + "name", + "regionName" + ], + "members":{ + "name":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "regionName":{ + "shape":"RegionString", + "documentation":"The Amazon Web Services Region where the space exists.
" + }, + "displayName":{ + "shape":"String", + "documentation":"The friendly name of the space displayed to users.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the space.
" + } + } + }, + "GetSubscriptionRequest":{ + "type":"structure", + "required":["spaceName"], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + } + } + }, + "GetSubscriptionResponse":{ + "type":"structure", + "members":{ + "subscriptionType":{ + "shape":"String", + "documentation":"The type of the billing plan for the space.
" + }, + "awsAccountName":{ + "shape":"NameString", + "documentation":"The display name of the Amazon Web Services account used for billing for the space.
" + }, + "pendingSubscriptionType":{ + "shape":"String", + "documentation":"The type of the billing plan that the space will be changed to at the start of the next billing cycle. This applies only to changes that reduce the functionality available for the space. Billing plan changes that increase functionality are applied immediately. For more information, see Pricing.
" + }, + "pendingSubscriptionStartTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The day and time the pending change will be applied to the space, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + } + } + }, + "GetUserDetailsRequest":{ + "type":"structure", + "members":{ + "id":{ + "shape":"GetUserDetailsRequestIdString", + "documentation":"The system-generated unique ID of the user.
", + "location":"querystring", + "locationName":"id" + }, + "userName":{ + "shape":"GetUserDetailsRequestUserNameString", + "documentation":"The name of the user as displayed in Amazon CodeCatalyst.
", + "location":"querystring", + "locationName":"userName" + } + } + }, + "GetUserDetailsRequestIdString":{ + "type":"string", + "max":256, + "min":1 + }, + "GetUserDetailsRequestUserNameString":{ + "type":"string", + "max":100, + "min":3, + "pattern":"[a-zA-Z0-9_.-]{3,100}" + }, + "GetUserDetailsResponse":{ + "type":"structure", + "members":{ + "userId":{ + "shape":"String", + "documentation":"The system-generated unique ID of the user.
" + }, + "userName":{ + "shape":"String", + "documentation":"The name of the user as displayed in Amazon CodeCatalyst.
" + }, + "displayName":{ + "shape":"String", + "documentation":"The friendly name displayed for the user in Amazon CodeCatalyst.
" + }, + "primaryEmail":{ + "shape":"EmailAddress", + "documentation":"The email address provided by the user when they signed up.
" + }, + "version":{ + "shape":"String", + "documentation":"" + } + } + }, + "GetWorkflowRequest":{ + "type":"structure", + "required":[ + "spaceName", + "id", + "projectName" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "id":{ + "shape":"Uuid", + "documentation":"The ID of the workflow. To rerieve a list of workflow IDs, use ListWorkflows.
", + "location":"uri", + "locationName":"id" + }, + "projectName":{ + "shape":"GetWorkflowRequestProjectNameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + } + } + }, + "GetWorkflowRequestProjectNameString":{ + "type":"string", + "min":1, + "pattern":"[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*" + }, + "GetWorkflowResponse":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id", + "name", + "definition", + "createdTime", + "lastUpdatedTime", + "runMode", + "status" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "id":{ + "shape":"Uuid", + "documentation":"The ID of the workflow.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the workflow.
" + }, + "sourceRepositoryName":{ + "shape":"SourceRepositoryNameString", + "documentation":"The name of the source repository where the workflow YAML is stored.
" + }, + "sourceBranchName":{ + "shape":"SourceRepositoryBranchString", + "documentation":"The name of the branch that contains the workflow YAML.
" + }, + "definition":{ + "shape":"WorkflowDefinition", + "documentation":"Information about the workflow definition file for the workflow.
" + }, + "createdTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
" + }, + "lastUpdatedTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
" + }, + "runMode":{ + "shape":"WorkflowRunMode", + "documentation":"The behavior to use when multiple workflows occur at the same time. For more information, see https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html in the Amazon CodeCatalyst User Guide.
" + }, + "status":{ + "shape":"WorkflowStatus", + "documentation":"The status of the workflow.
" + } + } + }, + "GetWorkflowRunRequest":{ + "type":"structure", + "required":[ + "spaceName", + "id", + "projectName" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "id":{ + "shape":"Uuid", + "documentation":"The ID of the workflow run. To retrieve a list of workflow run IDs, use ListWorkflowRuns.
", + "location":"uri", + "locationName":"id" + }, + "projectName":{ + "shape":"GetWorkflowRunRequestProjectNameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + } + } + }, + "GetWorkflowRunRequestProjectNameString":{ + "type":"string", + "min":1, + "pattern":"[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*" + }, + "GetWorkflowRunResponse":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id", + "workflowId", + "status", + "startTime", + "lastUpdatedTime" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "id":{ + "shape":"Uuid", + "documentation":"The ID of the workflow run.
" + }, + "workflowId":{ + "shape":"Uuid", + "documentation":"The ID of the workflow.
" + }, + "status":{ + "shape":"WorkflowRunStatus", + "documentation":"The status of the workflow run.
" + }, + "statusReasons":{ + "shape":"WorkflowRunStatusReasons", + "documentation":"Information about the reasons for the status of the workflow run.
" + }, + "startTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
" + }, + "endTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + }, + "lastUpdatedTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time the workflow run status was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
" + } + } + }, + "Ide":{ + "type":"structure", + "members":{ + "runtime":{ + "shape":"IdeRuntimeString", + "documentation":"A link to the IDE runtime image.
" + }, + "name":{ + "shape":"IdeNameString", + "documentation":"The name of the IDE.
" + } + }, + "documentation":"Information about an integrated development environment (IDE) used in a Dev Environment.
" + }, + "IdeConfiguration":{ + "type":"structure", + "members":{ + "runtime":{ + "shape":"IdeConfigurationRuntimeString", + "documentation":"A link to the IDE runtime image.
This parameter is not required for VSCode.
The name of the IDE. Valid values include Cloud9, IntelliJ, PyCharm, GoLand, and VSCode.
Information about the configuration of an integrated development environment (IDE) for a Dev Environment.
" + }, + "IdeConfigurationList":{ + "type":"list", + "member":{"shape":"IdeConfiguration"}, + "max":1, + "min":0 + }, + "IdeConfigurationNameString":{ + "type":"string", + "max":128, + "min":1 + }, + "IdeConfigurationRuntimeString":{ + "type":"string", + "max":400, + "min":1 + }, + "IdeNameString":{ + "type":"string", + "max":128, + "min":1 + }, + "IdeRuntimeString":{ + "type":"string", + "max":400, + "min":1 + }, + "Ides":{ + "type":"list", + "member":{"shape":"Ide"}, + "max":1, + "min":0 + }, + "InactivityTimeoutMinutes":{ + "type":"integer", + "max":1200, + "min":0 + }, + "InstanceType":{ + "type":"string", + "enum":[ + "dev.standard1.small", + "dev.standard1.medium", + "dev.standard1.large", + "dev.standard1.xlarge" + ] + }, + "ListAccessTokensRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListAccessTokensRequestMaxResultsInteger", + "documentation":"The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
A token returned from a call to this API to indicate the next batch of results to return, if any.
" + } + } + }, + "ListAccessTokensRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":10 + }, + "ListAccessTokensRequestNextTokenString":{ + "type":"string", + "max":10000, + "min":1 + }, + "ListAccessTokensResponse":{ + "type":"structure", + "required":["items"], + "members":{ + "items":{ + "shape":"AccessTokenSummaries", + "documentation":"A list of personal access tokens (PATs) associated with the calling user identity.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
" + } + } + }, + "ListDevEnvironmentSessionsRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "devEnvironmentId" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "devEnvironmentId":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment.
", + "location":"uri", + "locationName":"devEnvironmentId" + }, + "nextToken":{ + "shape":"ListDevEnvironmentSessionsRequestNextTokenString", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
" + }, + "maxResults":{ + "shape":"ListDevEnvironmentSessionsRequestMaxResultsInteger", + "documentation":"The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
Information about each session retrieved in the list.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
" + } + } + }, + "ListDevEnvironmentsRequest":{ + "type":"structure", + "required":["spaceName"], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "filters":{ + "shape":"Filters", + "documentation":"Information about filters to apply to narrow the results returned in the list.
" + }, + "nextToken":{ + "shape":"ListDevEnvironmentsRequestNextTokenString", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
" + }, + "maxResults":{ + "shape":"ListDevEnvironmentsRequestMaxResultsInteger", + "documentation":"The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
Information about the Dev Environments in a project.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
" + } + } + }, + "ListEventLogsRequest":{ + "type":"structure", + "required":[ + "spaceName", + "startTime", + "endTime" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "startTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time when you want to start retrieving events, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + }, + "endTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time after which you do not want any events retrieved, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + }, + "eventName":{ + "shape":"String", + "documentation":"The name of the event.
" + }, + "nextToken":{ + "shape":"ListEventLogsRequestNextTokenString", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
" + }, + "maxResults":{ + "shape":"ListEventLogsRequestMaxResultsInteger", + "documentation":"The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
A token returned from a call to this API to indicate the next batch of results to return, if any.
" + }, + "items":{ + "shape":"EventLogEntries", + "documentation":"Information about each event retrieved in the list.
" + } + } + }, + "ListProjectsRequest":{ + "type":"structure", + "required":["spaceName"], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "nextToken":{ + "shape":"ListProjectsRequestNextTokenString", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
" + }, + "maxResults":{ + "shape":"ListProjectsRequestMaxResultsInteger", + "documentation":"The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
Information about filters to apply to narrow the results returned in the list.
" + } + } + }, + "ListProjectsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListProjectsRequestNextTokenString":{ + "type":"string", + "max":10000, + "min":1 + }, + "ListProjectsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
" + }, + "items":{ + "shape":"ProjectSummaries", + "documentation":"Information about the projects.
" + } + } + }, + "ListSourceRepositoriesItem":{ + "type":"structure", + "required":[ + "id", + "name", + "lastUpdatedTime", + "createdTime" + ], + "members":{ + "id":{ + "shape":"SourceRepositoryIdString", + "documentation":"The system-generated unique ID of the source repository.
" + }, + "name":{ + "shape":"SourceRepositoryNameString", + "documentation":"The name of the source repository.
" + }, + "description":{ + "shape":"SourceRepositoryDescriptionString", + "documentation":"The description of the repository, if any.
" + }, + "lastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + }, + "createdTime":{ + "shape":"Timestamp", + "documentation":"The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + } + }, + "documentation":"Information about a source repository returned in a list of source repositories.
" + }, + "ListSourceRepositoriesItems":{ + "type":"list", + "member":{"shape":"ListSourceRepositoriesItem"} + }, + "ListSourceRepositoriesRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "nextToken":{ + "shape":"ListSourceRepositoriesRequestNextTokenString", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
" + }, + "maxResults":{ + "shape":"ListSourceRepositoriesRequestMaxResultsInteger", + "documentation":"The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
Information about the source repositories.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
" + } + } + }, + "ListSourceRepositoryBranchesItem":{ + "type":"structure", + "members":{ + "ref":{ + "shape":"SourceRepositoryBranchRefString", + "documentation":"The Git reference name of the branch.
" + }, + "name":{ + "shape":"SourceRepositoryBranchString", + "documentation":"The name of the branch.
" + }, + "lastUpdatedTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + }, + "headCommitId":{ + "shape":"String", + "documentation":"The commit ID of the tip of the branch at the time of the request, also known as the head commit.
" + } + }, + "documentation":"Information about a branch of a source repository returned in a list of branches.
" + }, + "ListSourceRepositoryBranchesItems":{ + "type":"list", + "member":{"shape":"ListSourceRepositoryBranchesItem"} + }, + "ListSourceRepositoryBranchesRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "sourceRepositoryName" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "sourceRepositoryName":{ + "shape":"SourceRepositoryNameString", + "documentation":"The name of the source repository.
", + "location":"uri", + "locationName":"sourceRepositoryName" + }, + "nextToken":{ + "shape":"ListSourceRepositoryBranchesRequestNextTokenString", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
" + }, + "maxResults":{ + "shape":"ListSourceRepositoryBranchesRequestMaxResultsInteger", + "documentation":"The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
A token returned from a call to this API to indicate the next batch of results to return, if any.
" + }, + "items":{ + "shape":"ListSourceRepositoryBranchesItems", + "documentation":"Information about the source branches.
" + } + } + }, + "ListSpacesRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"ListSpacesRequestNextTokenString", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
" + } + } + }, + "ListSpacesRequestNextTokenString":{ + "type":"string", + "max":10000, + "min":1 + }, + "ListSpacesResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
" + }, + "items":{ + "shape":"SpaceSummaries", + "documentation":"Information about the spaces.
" + } + } + }, + "ListWorkflowRunsRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "workflowId":{ + "shape":"Uuid", + "documentation":"The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.
", + "location":"querystring", + "locationName":"workflowId" + }, + "projectName":{ + "shape":"ListWorkflowRunsRequestProjectNameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "nextToken":{ + "shape":"ListWorkflowRunsRequestNextTokenString", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"ListWorkflowRunsRequestMaxResultsInteger", + "documentation":"The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
Information used to sort the items in the returned list.
" + } + } + }, + "ListWorkflowRunsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "ListWorkflowRunsRequestNextTokenString":{ + "type":"string", + "max":2048, + "min":1 + }, + "ListWorkflowRunsRequestProjectNameString":{ + "type":"string", + "min":1, + "pattern":"[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*" + }, + "ListWorkflowRunsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
" + }, + "items":{ + "shape":"WorkflowRunSummaries", + "documentation":"Information about the runs of a workflow.
" + } + } + }, + "ListWorkflowsRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName" + ], + "members":{ + "spaceName":{ + "shape":"ListWorkflowsRequestSpaceNameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "nextToken":{ + "shape":"ListWorkflowsRequestNextTokenString", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"ListWorkflowsRequestMaxResultsInteger", + "documentation":"The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
Information used to sort the items in the returned list.
" + } + } + }, + "ListWorkflowsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListWorkflowsRequestNextTokenString":{ + "type":"string", + "max":2048, + "min":1 + }, + "ListWorkflowsRequestSpaceNameString":{ + "type":"string", + "min":1, + "pattern":"[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*" + }, + "ListWorkflowsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"A token returned from a call to this API to indicate the next batch of results to return, if any.
" + }, + "items":{ + "shape":"WorkflowSummaries", + "documentation":"Information about the workflows in a project.
" + } + } + }, + "NameString":{ + "type":"string", + "max":63, + "min":3, + "pattern":"[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*" + }, + "OperationType":{ + "type":"string", + "enum":[ + "READONLY", + "MUTATION" + ] + }, + "PersistentStorage":{ + "type":"structure", + "required":["sizeInGiB"], + "members":{ + "sizeInGiB":{ + "shape":"PersistentStorageSizeInGiBInteger", + "documentation":"The size of the persistent storage in gigabytes (specifically GiB).
Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.
Information about the persistent storage for a Dev Environment.
" + }, + "PersistentStorageConfiguration":{ + "type":"structure", + "required":["sizeInGiB"], + "members":{ + "sizeInGiB":{ + "shape":"PersistentStorageConfigurationSizeInGiBInteger", + "documentation":"The size of the persistent storage in gigabytes (specifically GiB).
Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.
Information about the configuration of persistent storage for a Dev Environment.
" + }, + "PersistentStorageConfigurationSizeInGiBInteger":{ + "type":"integer", + "box":true, + "max":64, + "min":0 + }, + "PersistentStorageSizeInGiBInteger":{ + "type":"integer", + "box":true, + "max":64, + "min":0 + }, + "ProjectDescription":{ + "type":"string", + "max":200, + "min":0, + "pattern":"[a-zA-Z0-9]+(?:[-_a-zA-Z0-9.,;:/\\+=?&$% ])*" + }, + "ProjectDisplayName":{ + "type":"string", + "max":63, + "min":3, + "pattern":"[a-zA-Z0-9]+(?:[-_\\. ][a-zA-Z0-9]+)*" + }, + "ProjectInformation":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of the project in the space.
" + }, + "projectId":{ + "shape":"String", + "documentation":"The system-generated unique ID of the project.
" + } + }, + "documentation":"Information about a project in a space.
" + }, + "ProjectListFilter":{ + "type":"structure", + "required":[ + "key", + "values" + ], + "members":{ + "key":{ + "shape":"FilterKey", + "documentation":"A key that can be used to sort results.
" + }, + "values":{ + "shape":"StringList", + "documentation":"The values of the key.
" + }, + "comparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"The operator used to compare the fields.
" + } + }, + "documentation":"nformation about the filter used to narrow the results returned in a list of projects.
" + }, + "ProjectListFilters":{ + "type":"list", + "member":{"shape":"ProjectListFilter"} + }, + "ProjectSummaries":{ + "type":"list", + "member":{"shape":"ProjectSummary"} + }, + "ProjectSummary":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of the project in the space.
" + }, + "displayName":{ + "shape":"String", + "documentation":"The friendly name displayed to users of the project in Amazon CodeCatalyst.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the project.
" + } + }, + "documentation":"Information about a project.
" + }, + "RegionString":{ + "type":"string", + "max":16, + "min":3, + "pattern":"(us(?:-gov)?|af|ap|ca|cn|eu|sa)-(central|(?:north|south)?(?:east|west)?)-(\\d+)" + }, + "RepositoriesInput":{ + "type":"list", + "member":{"shape":"RepositoryInput"} + }, + "RepositoryInput":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "repositoryName":{ + "shape":"SourceRepositoryNameString", + "documentation":"The name of the source repository.
" + }, + "branchName":{ + "shape":"SourceRepositoryBranchString", + "documentation":"The name of the branch in a source repository.
" + } + }, + "documentation":"Information about a repository that will be cloned to a Dev Environment.
" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SensitiveString":{ + "type":"string", + "sensitive":true + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SourceRepositoryBranchRefString":{ + "type":"string", + "max":255, + "min":1 + }, + "SourceRepositoryBranchString":{ + "type":"string", + "max":100, + "min":1 + }, + "SourceRepositoryDescriptionString":{ + "type":"string", + "max":255, + "min":1 + }, + "SourceRepositoryIdString":{ + "type":"string", + "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}" + }, + "SourceRepositoryNameString":{ + "type":"string", + "max":100, + "min":1, + "pattern":"(?!.*[.]git$)[\\w\\-.]*" + }, + "SpaceDescription":{ + "type":"string", + "max":200, + "min":0, + "pattern":"[a-zA-Z0-9]+(?:[-_a-zA-Z0-9.,;:/\\+=?&$% ])*" + }, + "SpaceSummaries":{ + "type":"list", + "member":{"shape":"SpaceSummary"} + }, + "SpaceSummary":{ + "type":"structure", + "required":[ + "name", + "regionName" + ], + "members":{ + "name":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "regionName":{ + "shape":"RegionString", + "documentation":"The Amazon Web Services Region where the space exists.
" + }, + "displayName":{ + "shape":"String", + "documentation":"The friendly name of the space displayed to users.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the space.
" + } + }, + "documentation":"Information about an space.
" + }, + "StartDevEnvironmentRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment.
", + "location":"uri", + "locationName":"id" + }, + "ides":{ + "shape":"IdeConfigurationList", + "documentation":"Information about the integrated development environment (IDE) configured for a Dev Environment.
" + }, + "instanceType":{ + "shape":"InstanceType", + "documentation":"The Amazon EC2 instace type to use for the Dev Environment.
" + }, + "inactivityTimeoutMinutes":{ + "shape":"InactivityTimeoutMinutes", + "documentation":"The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.
" + } + } + }, + "StartDevEnvironmentResponse":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id", + "status" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment.
" + }, + "status":{ + "shape":"DevEnvironmentStatus", + "documentation":"The status of the Dev Environment.
" + } + } + }, + "StartDevEnvironmentSessionRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id", + "sessionConfiguration" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment.
", + "location":"uri", + "locationName":"id" + }, + "sessionConfiguration":{"shape":"DevEnvironmentSessionConfiguration"} + } + }, + "StartDevEnvironmentSessionResponse":{ + "type":"structure", + "required":[ + "accessDetails", + "spaceName", + "projectName", + "id" + ], + "members":{ + "accessDetails":{"shape":"DevEnvironmentAccessDetails"}, + "sessionId":{ + "shape":"StartDevEnvironmentSessionResponseSessionIdString", + "documentation":"The system-generated unique ID of the Dev Environment session.
" + }, + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment.
" + } + } + }, + "StartDevEnvironmentSessionResponseSessionIdString":{ + "type":"string", + "max":96, + "min":1 + }, + "StartWorkflowRunRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "workflowId" + ], + "members":{ + "spaceName":{ + "shape":"StartWorkflowRunRequestSpaceNameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"StartWorkflowRunRequestProjectNameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "workflowId":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.
", + "location":"querystring", + "locationName":"workflowId" + }, + "clientToken":{ + "shape":"StartWorkflowRunRequestClientTokenString", + "documentation":"A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.
", + "idempotencyToken":true + } + } + }, + "StartWorkflowRunRequestClientTokenString":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*" + }, + "StartWorkflowRunRequestProjectNameString":{ + "type":"string", + "min":1, + "pattern":"[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*" + }, + "StartWorkflowRunRequestSpaceNameString":{ + "type":"string", + "min":1, + "pattern":"[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*" + }, + "StartWorkflowRunResponse":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id", + "workflowId" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the workflow run.
" + }, + "workflowId":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the workflow.
" + } + } + }, + "StatusReason":{ + "type":"string", + "max":1024, + "min":0 + }, + "StopDevEnvironmentRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment.
", + "location":"uri", + "locationName":"id" + } + } + }, + "StopDevEnvironmentResponse":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id", + "status" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment.
" + }, + "status":{ + "shape":"DevEnvironmentStatus", + "documentation":"The status of the Dev Environment.
" + } + } + }, + "StopDevEnvironmentSessionRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id", + "sessionId" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment. To obtain this ID, use ListDevEnvironments.
", + "location":"uri", + "locationName":"id" + }, + "sessionId":{ + "shape":"StopDevEnvironmentSessionRequestSessionIdString", + "documentation":"The system-generated unique ID of the Dev Environment session. This ID is returned by StartDevEnvironmentSession.
", + "location":"uri", + "locationName":"sessionId" + } + } + }, + "StopDevEnvironmentSessionRequestSessionIdString":{ + "type":"string", + "max":96, + "min":1 + }, + "StopDevEnvironmentSessionResponse":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id", + "sessionId" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment.
" + }, + "sessionId":{ + "shape":"StopDevEnvironmentSessionResponseSessionIdString", + "documentation":"The system-generated unique ID of the Dev Environment session.
" + } + } + }, + "StopDevEnvironmentSessionResponseSessionIdString":{ + "type":"string", + "max":96, + "min":1 + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "SyntheticTimestamp_date_time":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":false} + }, + "Timestamp":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "UpdateDevEnvironmentRequest":{ + "type":"structure", + "required":[ + "spaceName", + "projectName", + "id" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
", + "location":"uri", + "locationName":"projectName" + }, + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment.
", + "location":"uri", + "locationName":"id" + }, + "alias":{ + "shape":"UpdateDevEnvironmentRequestAliasString", + "documentation":"The user-specified alias for the Dev Environment. Changing this value will not cause a restart.
" + }, + "ides":{ + "shape":"IdeConfigurationList", + "documentation":"Information about the integrated development environment (IDE) configured for a Dev Environment.
" + }, + "instanceType":{ + "shape":"InstanceType", + "documentation":"The Amazon EC2 instace type to use for the Dev Environment.
Changing this value will cause a restart of the Dev Environment if it is running.
The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.
Changing this value will cause a restart of the Dev Environment if it is running.
A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.
" + } + } + }, + "UpdateDevEnvironmentRequestAliasString":{ + "type":"string", + "max":128, + "min":0, + "pattern":"$|^[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*" + }, + "UpdateDevEnvironmentResponse":{ + "type":"structure", + "required":[ + "id", + "spaceName", + "projectName" + ], + "members":{ + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the Dev Environment.
" + }, + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "projectName":{ + "shape":"NameString", + "documentation":"The name of the project in the space.
" + }, + "alias":{ + "shape":"UpdateDevEnvironmentResponseAliasString", + "documentation":"The user-specified alias for the Dev Environment.
" + }, + "ides":{ + "shape":"IdeConfigurationList", + "documentation":"Information about the integrated development environment (IDE) configured for the Dev Environment.
" + }, + "instanceType":{ + "shape":"InstanceType", + "documentation":"The Amazon EC2 instace type to use for the Dev Environment.
" + }, + "inactivityTimeoutMinutes":{ + "shape":"InactivityTimeoutMinutes", + "documentation":"The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.
" + } + } + }, + "UpdateDevEnvironmentResponseAliasString":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*" + }, + "UpdateProjectRequest":{ + "type":"structure", + "required":[ + "spaceName", + "name" + ], + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"spaceName" + }, + "name":{ + "shape":"NameString", + "documentation":"The name of the project.
", + "location":"uri", + "locationName":"name" + }, + "description":{ + "shape":"ProjectDescription", + "documentation":"The description of the project.
" + } + } + }, + "UpdateProjectResponse":{ + "type":"structure", + "members":{ + "spaceName":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "name":{ + "shape":"NameString", + "documentation":"The name of the project.
" + }, + "displayName":{ + "shape":"String", + "documentation":"The friendly name of the project displayed to users in Amazon CodeCatalyst.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the project.
" + } + } + }, + "UpdateSpaceRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"NameString", + "documentation":"The name of the space.
", + "location":"uri", + "locationName":"name" + }, + "description":{ + "shape":"SpaceDescription", + "documentation":"The description of the space.
" + } + } + }, + "UpdateSpaceResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"NameString", + "documentation":"The name of the space.
" + }, + "displayName":{ + "shape":"String", + "documentation":"The friendly name of the space displayed to users in Amazon CodeCatalyst.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the space.
" + } + } + }, + "UserIdentity":{ + "type":"structure", + "required":[ + "userType", + "principalId" + ], + "members":{ + "userType":{ + "shape":"UserType", + "documentation":"The role assigned to the user in a Amazon CodeCatalyst space or project when the event occurred.
" + }, + "principalId":{ + "shape":"String", + "documentation":"The ID of the Amazon CodeCatalyst service principal.
" + }, + "userName":{ + "shape":"String", + "documentation":"The display name of the user in Amazon CodeCatalyst.
" + }, + "awsAccountId":{ + "shape":"String", + "documentation":"The Amazon Web Services account number of the user in Amazon Web Services, if any.
" + } + }, + "documentation":"Information about a user whose activity is recorded in an event for a space.
" + }, + "UserType":{ + "type":"string", + "enum":[ + "USER", + "AWS_ACCOUNT", + "UNKNOWN" + ] + }, + "Uuid":{ + "type":"string", + "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}" + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "VerifySessionResponse":{ + "type":"structure", + "members":{ + "identity":{ + "shape":"VerifySessionResponseIdentityString", + "documentation":"The system-generated unique ID of the user in Amazon CodeCatalyst.
" + } + } + }, + "VerifySessionResponseIdentityString":{ + "type":"string", + "max":256, + "min":1 + }, + "WorkflowDefinition":{ + "type":"structure", + "required":["path"], + "members":{ + "path":{ + "shape":"String", + "documentation":"The path to the workflow definition file stored in the source repository for the project, including the file name.
" + } + }, + "documentation":"Information about a workflow definition file.
" + }, + "WorkflowDefinitionSummary":{ + "type":"structure", + "required":["path"], + "members":{ + "path":{ + "shape":"String", + "documentation":"The path to the workflow definition file stored in the source repository for the project, including the file name.
" + } + }, + "documentation":"Information about a workflow definition.
" + }, + "WorkflowRunMode":{ + "type":"string", + "enum":[ + "QUEUED", + "PARALLEL", + "SUPERSEDED" + ] + }, + "WorkflowRunSortCriteria":{ + "type":"structure", + "members":{ + }, + "documentation":"Information used to sort workflow runs in the returned list.
" + }, + "WorkflowRunSortCriteriaList":{ + "type":"list", + "member":{"shape":"WorkflowRunSortCriteria"}, + "max":1, + "min":0 + }, + "WorkflowRunStatus":{ + "type":"string", + "enum":[ + "SUCCEEDED", + "FAILED", + "STOPPED", + "SUPERSEDED", + "CANCELLED", + "NOT_RUN", + "VALIDATING", + "PROVISIONING", + "IN_PROGRESS", + "STOPPING", + "ABANDONED" + ] + }, + "WorkflowRunStatusReason":{ + "type":"structure", + "members":{ + }, + "documentation":"Information about the status of a workflow run.
" + }, + "WorkflowRunStatusReasons":{ + "type":"list", + "member":{"shape":"WorkflowRunStatusReason"} + }, + "WorkflowRunSummaries":{ + "type":"list", + "member":{"shape":"WorkflowRunSummary"} + }, + "WorkflowRunSummary":{ + "type":"structure", + "required":[ + "id", + "workflowId", + "workflowName", + "status", + "startTime", + "lastUpdatedTime" + ], + "members":{ + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the workflow run.
" + }, + "workflowId":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of the workflow.
" + }, + "workflowName":{ + "shape":"String", + "documentation":"The name of the workflow.
" + }, + "status":{ + "shape":"WorkflowRunStatus", + "documentation":"The status of the workflow run.
" + }, + "statusReasons":{ + "shape":"WorkflowRunStatusReasons", + "documentation":"The reasons for the workflow run status.
" + }, + "startTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
" + }, + "endTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
" + }, + "lastUpdatedTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
" + } + }, + "documentation":"Information about a workflow run.
" + }, + "WorkflowSortCriteria":{ + "type":"structure", + "members":{ + }, + "documentation":"Information used to sort workflows in the returned list.
" + }, + "WorkflowSortCriteriaList":{ + "type":"list", + "member":{"shape":"WorkflowSortCriteria"}, + "max":1, + "min":0 + }, + "WorkflowStatus":{ + "type":"string", + "enum":[ + "INVALID", + "ACTIVE" + ] + }, + "WorkflowSummaries":{ + "type":"list", + "member":{"shape":"WorkflowSummary"} + }, + "WorkflowSummary":{ + "type":"structure", + "required":[ + "id", + "name", + "sourceRepositoryName", + "sourceBranchName", + "definition", + "createdTime", + "lastUpdatedTime", + "runMode", + "status" + ], + "members":{ + "id":{ + "shape":"Uuid", + "documentation":"The system-generated unique ID of a workflow.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the workflow.
" + }, + "sourceRepositoryName":{ + "shape":"SourceRepositoryNameString", + "documentation":"The name of the source repository where the workflow definition file is stored.
" + }, + "sourceBranchName":{ + "shape":"SourceRepositoryBranchString", + "documentation":"The name of the branch of the source repository where the workflow definition file is stored.
" + }, + "definition":{ + "shape":"WorkflowDefinitionSummary", + "documentation":"Information about the workflow definition file.
" + }, + "createdTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
" + }, + "lastUpdatedTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
" + }, + "runMode":{ + "shape":"WorkflowRunMode", + "documentation":"The run mode of the workflow.
" + }, + "status":{ + "shape":"WorkflowStatus", + "documentation":"The status of the workflow.
" + } + }, + "documentation":"Information about a workflow.
" + } + }, + "documentation":"Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst API to work with the following objects.
Spaces, by calling the following:
DeleteSpace, which deletes a space.
GetSpace, which returns information about a space.
GetSubscription, which returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
ListSpaces, which retrieves a list of spaces.
UpdateSpace, which changes one or more values for a space.
Projects, by calling the following:
CreateProject which creates a project in a specified space.
GetProject, which returns information about a project.
ListProjects, which retrieves a list of projects in a space.
Users, by calling the following:
GetUserDetails, which returns information about a user in Amazon CodeCatalyst.
Source repositories, by calling the following:
CreateSourceRepository, which creates an empty Git-based source repository in a specified project.
CreateSourceRepositoryBranch, which creates a branch in a specified repository where you can work on code.
DeleteSourceRepository, which deletes a source repository.
GetSourceRepository, which returns information about a source repository.
GetSourceRepositoryCloneUrls, which returns information about the URLs that can be used with a Git client to clone a source repository.
ListSourceRepositories, which retrieves a list of source repositories in a project.
ListSourceRepositoryBranches, which retrieves a list of branches in a source repository.
Dev Environments and the Amazon Web Services Toolkits, by calling the following:
CreateDevEnvironment, which creates a Dev Environment, where you can quickly work on the code stored in the source repositories of your project.
DeleteDevEnvironment, which deletes a Dev Environment.
GetDevEnvironment, which returns information about a Dev Environment.
ListDevEnvironments, which retrieves a list of Dev Environments in a project.
ListDevEnvironmentSessions, which retrieves a list of active Dev Environment sessions in a project.
StartDevEnvironment, which starts a specified Dev Environment and puts it into an active state.
StartDevEnvironmentSession, which starts a session to a specified Dev Environment.
StopDevEnvironment, which stops a specified Dev Environment and puts it into an stopped state.
StopDevEnvironmentSession, which stops a session for a specified Dev Environment.
UpdateDevEnvironment, which changes one or more values for a Dev Environment.
Workflows, by calling the following:
GetWorkflow, which returns information about a workflow.
GetWorkflowRun, which returns information about a specified run of a workflow.
ListWorkflowRuns, which retrieves a list of runs of a specified workflow.
ListWorkflows, which retrieves a list of workflows in a specified project.
StartWorkflowRun, which starts a run of a specified workflow.
Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:
CreateAccessToken, which creates a personal access token (PAT) for the current user.
DeleteAccessToken, which deletes a specified personal access token (PAT).
ListAccessTokens, which lists all personal access tokens (PATs) associated with a user.
ListEventLogs, which retrieves a list of events that occurred during a specified time period in a space.
VerifySession, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.
If you are using the Amazon CodeCatalyst APIs with an SDK or the CLI, you must configure your computer to work with Amazon CodeCatalyst and single sign-on (SSO). For more information, see Setting up to use the CLI with Amazon CodeCatalyst and the SSO documentation for your SDK.
Returns a list of requested findings from standard scans.
" + }, + "CreateScan":{ + "name":"CreateScan", + "http":{ + "method":"POST", + "requestUri":"/scans", + "responseCode":200 + }, + "input":{"shape":"CreateScanRequest"}, + "output":{"shape":"CreateScanResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Use to create a scan using code uploaded to an Amazon S3 bucket.
" + }, + "CreateUploadUrl":{ + "name":"CreateUploadUrl", + "http":{ + "method":"POST", + "requestUri":"/uploadUrl", + "responseCode":200 + }, + "input":{"shape":"CreateUploadUrlRequest"}, + "output":{"shape":"CreateUploadUrlResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Generates a pre-signed URL, request headers used to upload a code resource, and code artifact identifier for the uploaded resource.
You can upload your code resource to the URL with the request headers using any HTTP client.
" + }, + "GetAccountConfiguration":{ + "name":"GetAccountConfiguration", + "http":{ + "method":"GET", + "requestUri":"/accountConfiguration/get", + "responseCode":200 + }, + "input":{"shape":"GetAccountConfigurationRequest"}, + "output":{"shape":"GetAccountConfigurationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Use to get the encryption configuration for an account.
" + }, + "GetFindings":{ + "name":"GetFindings", + "http":{ + "method":"GET", + "requestUri":"/findings/{scanName}", + "responseCode":200 + }, + "input":{"shape":"GetFindingsRequest"}, + "output":{"shape":"GetFindingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a list of all findings generated by a particular scan.
" + }, + "GetMetricsSummary":{ + "name":"GetMetricsSummary", + "http":{ + "method":"GET", + "requestUri":"/metrics/summary", + "responseCode":200 + }, + "input":{"shape":"GetMetricsSummaryRequest"}, + "output":{"shape":"GetMetricsSummaryResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a summary of metrics for an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings.
" + }, + "GetScan":{ + "name":"GetScan", + "http":{ + "method":"GET", + "requestUri":"/scans/{scanName}", + "responseCode":200 + }, + "input":{"shape":"GetScanRequest"}, + "output":{"shape":"GetScanResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns details about a scan, including whether or not a scan has completed.
" + }, + "ListFindingsMetrics":{ + "name":"ListFindingsMetrics", + "http":{ + "method":"GET", + "requestUri":"/metrics/findings", + "responseCode":200 + }, + "input":{"shape":"ListFindingsMetricsRequest"}, + "output":{"shape":"ListFindingsMetricsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns metrics about all findings in an account within a specified time range.
" + }, + "ListScans":{ + "name":"ListScans", + "http":{ + "method":"GET", + "requestUri":"/scans", + "responseCode":200 + }, + "input":{"shape":"ListScansRequest"}, + "output":{"shape":"ListScansResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a list of all scans in an account. Does not return EXPRESS scans.
Returns a list of all tags associated with a scan.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Use to add one or more tags to an existing scan.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Use to remove one or more tags from an existing scan.
", + "idempotent":true + }, + "UpdateAccountConfiguration":{ + "name":"UpdateAccountConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/updateAccountConfiguration", + "responseCode":200 + }, + "input":{"shape":"UpdateAccountConfigurationRequest"}, + "output":{"shape":"UpdateAccountConfigurationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Use to update the encryption configuration for an account.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":[ + "errorCode", + "message" + ], + "members":{ + "errorCode":{ + "shape":"String", + "documentation":"The identifier for the error.
" + }, + "message":{ + "shape":"String", + "documentation":"Description of the error.
" + }, + "resourceId":{ + "shape":"String", + "documentation":"The identifier for the resource you don't have access to.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The type of resource you don't have access to.
" + } + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccountFindingsMetric":{ + "type":"structure", + "members":{ + "closedFindings":{ + "shape":"FindingMetricsValuePerSeverity", + "documentation":"The number of closed findings of each severity on the specified date.
" + }, + "date":{ + "shape":"Timestamp", + "documentation":"The date from which the findings metrics were retrieved.
" + }, + "meanTimeToClose":{ + "shape":"FindingMetricsValuePerSeverity", + "documentation":"The average time in days it takes to close findings of each severity as of a specified date.
" + }, + "newFindings":{ + "shape":"FindingMetricsValuePerSeverity", + "documentation":"The number of new findings of each severity on the specified date.
" + }, + "openFindings":{ + "shape":"FindingMetricsValuePerSeverity", + "documentation":"The number of open findings of each severity as of the specified date.
" + } + }, + "documentation":"A summary of findings metrics for an account on a specified date.
" + }, + "AnalysisType":{ + "type":"string", + "enum":[ + "Security", + "All" + ] + }, + "BatchGetFindingsError":{ + "type":"structure", + "required":[ + "errorCode", + "findingId", + "message", + "scanName" + ], + "members":{ + "errorCode":{ + "shape":"ErrorCode", + "documentation":"A code associated with the type of error.
" + }, + "findingId":{ + "shape":"String", + "documentation":"The finding ID of the finding that was not fetched.
" + }, + "message":{ + "shape":"String", + "documentation":"Describes the error.
" + }, + "scanName":{ + "shape":"ScanName", + "documentation":"The name of the scan that generated the finding.
" + } + }, + "documentation":"Contains information about the error that caused a finding to fail to be retrieved.
" + }, + "BatchGetFindingsErrors":{ + "type":"list", + "member":{"shape":"BatchGetFindingsError"} + }, + "BatchGetFindingsRequest":{ + "type":"structure", + "required":["findingIdentifiers"], + "members":{ + "findingIdentifiers":{ + "shape":"FindingIdentifiers", + "documentation":"A list of finding identifiers. Each identifier consists of a scanName and a findingId. You retrieve the findingId when you call GetFindings.
A list of errors for individual findings which were not fetched. Each BatchGetFindingsError contains the scanName, findingId, errorCode and error message.
A list of all findings which were successfully fetched.
" + } + } + }, + "CategoriesWithMostFindings":{ + "type":"list", + "member":{"shape":"CategoryWithFindingNum"}, + "max":5, + "min":0 + }, + "CategoryWithFindingNum":{ + "type":"structure", + "members":{ + "categoryName":{ + "shape":"String", + "documentation":"The name of the finding category. A finding category is determined by the detector that detected the finding.
" + }, + "findingNumber":{ + "shape":"Integer", + "documentation":"The number of open findings in the category.
" + } + }, + "documentation":"Information about a finding category with open findings.
" + }, + "ClientToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[\\S]+$" + }, + "CodeLine":{ + "type":"structure", + "members":{ + "content":{ + "shape":"String", + "documentation":"The code that contains a vulnerability.
" + }, + "number":{ + "shape":"Integer", + "documentation":"The code line number.
" + } + }, + "documentation":"The line of code where a finding was detected.
" + }, + "CodeSnippet":{ + "type":"list", + "member":{"shape":"CodeLine"} + }, + "ConflictException":{ + "type":"structure", + "required":[ + "errorCode", + "message", + "resourceId", + "resourceType" + ], + "members":{ + "errorCode":{ + "shape":"String", + "documentation":"The identifier for the error.
" + }, + "message":{ + "shape":"String", + "documentation":"Description of the error.
" + }, + "resourceId":{ + "shape":"String", + "documentation":"The identifier for the service resource associated with the request.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The type of resource associated with the request.
" + } + }, + "documentation":"The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateScanRequest":{ + "type":"structure", + "required":[ + "resourceId", + "scanName" + ], + "members":{ + "analysisType":{ + "shape":"AnalysisType", + "documentation":"The type of analysis you want CodeGuru Security to perform in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings. Defaults to Security type if missing.
The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.
", + "idempotencyToken":true + }, + "resourceId":{ + "shape":"ResourceId", + "documentation":"The identifier for the resource object to be scanned.
" + }, + "scanName":{ + "shape":"ScanName", + "documentation":"The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD scan type.
The type of scan, either Standard or Express. Defaults to Standard type if missing.
Express scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard scans have standard resource limits and use the full set of detectors to analyze your code.
An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:
A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.
An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
The identifier for the resource object that contains resources that were scanned.
" + }, + "runId":{ + "shape":"Uuid", + "documentation":"UUID that identifies the individual scan run.
" + }, + "scanName":{ + "shape":"ScanName", + "documentation":"The name of the scan.
" + }, + "scanNameArn":{ + "shape":"ScanNameArn", + "documentation":"The ARN for the scan name.
" + }, + "scanState":{ + "shape":"ScanState", + "documentation":"The current state of the scan. Returns either InProgress, Successful, or Failed.
The name of the scan that will use the uploaded resource. CodeGuru Security uses the unique scan name to track revisions across multiple scans of the same resource. Use this scanName when you call CreateScan on the code resource you upload to this URL.
The identifier for the uploaded code resource. Pass this to CreateScan to use the uploaded resources.
A set of key-value pairs that contain the required headers when uploading your resource.
" + }, + "s3Url":{ + "shape":"S3Url", + "documentation":"A pre-signed S3 URL. You can upload the code file you want to scan with the required requestHeaders using any HTTP client.
The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption, returns empty.
" + } + }, + "documentation":"Information about the encryption configuration for an account. Required to call UpdateAccountConfiguration.
A list of CodeLine objects that describe where the security vulnerability appears in your code.
The last line number of the code snippet where the security vulnerability appears in your code.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the file.
" + }, + "path":{ + "shape":"String", + "documentation":"The path to the resource with the security vulnerability.
" + }, + "startLine":{ + "shape":"Integer", + "documentation":"The first line number of the code snippet where the security vulnerability appears in your code.
" + } + }, + "documentation":"Information about the location of security vulnerabilities that Amazon CodeGuru Security detected in your code.
" + }, + "Finding":{ + "type":"structure", + "members":{ + "createdAt":{ + "shape":"Timestamp", + "documentation":"The time when the finding was created.
" + }, + "description":{ + "shape":"String", + "documentation":"A description of the finding.
" + }, + "detectorId":{ + "shape":"String", + "documentation":"The identifier for the detector that detected the finding in your code. A detector is a defined rule based on industry standards and AWS best practices.
" + }, + "detectorName":{ + "shape":"String", + "documentation":"The name of the detector that identified the security vulnerability in your code.
" + }, + "detectorTags":{ + "shape":"DetectorTags", + "documentation":"One or more tags or categorizations that are associated with a detector. These tags are defined by type, programming language, or other classification such as maintainability or consistency.
" + }, + "generatorId":{ + "shape":"String", + "documentation":"The identifier for the component that generated a finding such as AmazonCodeGuruSecurity.
" + }, + "id":{ + "shape":"String", + "documentation":"The identifier for a finding.
" + }, + "remediation":{ + "shape":"Remediation", + "documentation":"An object that contains the details about how to remediate a finding.
" + }, + "resource":{ + "shape":"Resource", + "documentation":"The resource where Amazon CodeGuru Security detected a finding.
" + }, + "ruleId":{ + "shape":"String", + "documentation":"The identifier for the rule that generated the finding.
" + }, + "severity":{ + "shape":"Severity", + "documentation":"The severity of the finding. Severity can be critical, high, medium, low, or informational. For information on severity levels, see Finding severity in the Amazon CodeGuru Security User Guide.
" + }, + "status":{ + "shape":"Status", + "documentation":"The status of the finding. A finding status can be open or closed.
" + }, + "title":{ + "shape":"String", + "documentation":"The title of the finding.
" + }, + "type":{ + "shape":"String", + "documentation":"The type of finding.
" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"The time when the finding was last updated. Findings are updated when you remediate them or when the finding code location changes.
" + }, + "vulnerability":{ + "shape":"Vulnerability", + "documentation":"An object that describes the detected security vulnerability.
" + } + }, + "documentation":"Information about a finding that was detected in your code.
" + }, + "FindingIdentifier":{ + "type":"structure", + "required":[ + "findingId", + "scanName" + ], + "members":{ + "findingId":{ + "shape":"String", + "documentation":"The identifier for a finding.
" + }, + "scanName":{ + "shape":"String", + "documentation":"The name of the scan that generated the finding.
" + } + }, + "documentation":"An object that contains information about a finding and the scan that generated it.
" + }, + "FindingIdentifiers":{ + "type":"list", + "member":{"shape":"FindingIdentifier"}, + "max":25, + "min":1 + }, + "FindingMetricsValuePerSeverity":{ + "type":"structure", + "members":{ + "critical":{ + "shape":"Double", + "documentation":"A numeric value corresponding to a critical finding.
" + }, + "high":{ + "shape":"Double", + "documentation":"A numeric value corresponding to a high severity finding.
" + }, + "info":{ + "shape":"Double", + "documentation":"A numeric value corresponding to an informational finding.
" + }, + "low":{ + "shape":"Double", + "documentation":"A numeric value corresponding to a low severity finding.
" + }, + "medium":{ + "shape":"Double", + "documentation":"A numeric value corresponding to a medium severity finding.
" + } + }, + "documentation":"A numeric value corresponding to the severity of a finding, such as the number of open findings or the average time it takes to close findings of a given severity.
" + }, + "Findings":{ + "type":"list", + "member":{"shape":"Finding"} + }, + "FindingsMetricList":{ + "type":"list", + "member":{"shape":"AccountFindingsMetric"} + }, + "GetAccountConfigurationRequest":{ + "type":"structure", + "members":{ + } + }, + "GetAccountConfigurationResponse":{ + "type":"structure", + "required":["encryptionConfig"], + "members":{ + "encryptionConfig":{ + "shape":"EncryptionConfig", + "documentation":"An EncryptionConfig object that contains the KMS key ARN that is used for encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify your own key, call UpdateAccountConfiguration. If you do not specify a customer-managed key, returns empty.
The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 1000 results.
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
The name of the scan you want to retrieve findings from.
", + "location":"uri", + "locationName":"scanName" + }, + "status":{ + "shape":"Status", + "documentation":"The status of the findings you want to get. Pass either Open, Closed, or All.
A list of findings generated by the specified scan.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token. You can use this in future calls to GetFindings to continue listing results after the current page.
The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years.
", + "location":"querystring", + "locationName":"date" + } + } + }, + "GetMetricsSummaryResponse":{ + "type":"structure", + "members":{ + "metricsSummary":{ + "shape":"MetricsSummary", + "documentation":"The summary metrics from the specified date.
" + } + } + }, + "GetScanRequest":{ + "type":"structure", + "required":["scanName"], + "members":{ + "runId":{ + "shape":"Uuid", + "documentation":"UUID that identifies the individual scan run you want to view details about. You retrieve this when you call the CreateScan operation. Defaults to the latest scan run if missing.
The name of the scan you want to view details about.
", + "location":"uri", + "locationName":"scanName" + } + } + }, + "GetScanResponse":{ + "type":"structure", + "required":[ + "analysisType", + "createdAt", + "runId", + "scanName", + "scanState" + ], + "members":{ + "analysisType":{ + "shape":"AnalysisType", + "documentation":"The type of analysis CodeGuru Security performed in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings.
The time the scan was created.
" + }, + "errorMessage":{ + "shape":"ErrorMessage", + "documentation":"Details about the error that causes a scan to fail to be retrieved.
" + }, + "numberOfRevisions":{ + "shape":"Long", + "documentation":"The number of times a scan has been re-run on a revised resource.
" + }, + "runId":{ + "shape":"Uuid", + "documentation":"UUID that identifies the individual scan run.
" + }, + "scanName":{ + "shape":"ScanName", + "documentation":"The name of the scan.
" + }, + "scanNameArn":{ + "shape":"ScanNameArn", + "documentation":"The ARN for the scan name.
" + }, + "scanState":{ + "shape":"ScanState", + "documentation":"The current state of the scan. Returns either InProgress, Successful, or Failed.
The time when the scan was last updated. Only available for STANDARD scan types.
The internal error encountered by the server.
" + }, + "message":{ + "shape":"String", + "documentation":"Description of the error.
" + } + }, + "documentation":"The server encountered an internal error and is unable to complete the request.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "KmsKeyArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^arn:aws:kms:[\\S]+:[\\d]{12}:key\\/(([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|(mrk-[0-9a-zA-Z]{32}))$" + }, + "ListFindingsMetricsRequest":{ + "type":"structure", + "required":[ + "endDate", + "startDate" + ], + "members":{ + "endDate":{ + "shape":"Timestamp", + "documentation":"The end date of the interval which you want to retrieve metrics from. Round to the nearest day.
", + "location":"querystring", + "locationName":"endDate" + }, + "maxResults":{ + "shape":"ListFindingsMetricsRequestMaxResultsInteger", + "documentation":"The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 1000 results.
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
The start date of the interval which you want to retrieve metrics from. Rounds to the nearest day.
", + "location":"querystring", + "locationName":"startDate" + } + } + }, + "ListFindingsMetricsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "ListFindingsMetricsResponse":{ + "type":"structure", + "members":{ + "findingsMetrics":{ + "shape":"FindingsMetricList", + "documentation":"A list of AccountFindingsMetric objects retrieved from the specified time interval.
A pagination token. You can use this in future calls to ListFindingMetrics to continue listing results after the current page.
The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 100 results.
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
A pagination token. You can use this in future calls to ListScans to continue listing results after the current page.
A list of ScanSummary objects with information about all scans in an account.
The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.
An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:
A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.
An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
A list of CategoryWithFindingNum objects for the top 5 finding categories with the most findings.
The date from which the metrics summary information was retrieved.
" + }, + "openFindings":{ + "shape":"FindingMetricsValuePerSeverity", + "documentation":"The number of open findings of each severity.
" + }, + "scansWithMostOpenCriticalFindings":{ + "shape":"ScansWithMostOpenCriticalFindings", + "documentation":"A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings.
A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings.
A summary of metrics for an account as of a specified date.
" + }, + "NextToken":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^[\\S]+$" + }, + "Recommendation":{ + "type":"structure", + "members":{ + "text":{ + "shape":"String", + "documentation":"The recommended course of action to remediate the finding.
" + }, + "url":{ + "shape":"String", + "documentation":"The URL address to the recommendation for remediating the finding.
" + } + }, + "documentation":"Information about the recommended course of action to remediate a finding.
" + }, + "ReferenceUrls":{ + "type":"list", + "member":{"shape":"String"} + }, + "RelatedVulnerabilities":{ + "type":"list", + "member":{"shape":"String"} + }, + "Remediation":{ + "type":"structure", + "members":{ + "recommendation":{ + "shape":"Recommendation", + "documentation":"An object that contains information about the recommended course of action to remediate a finding.
" + }, + "suggestedFixes":{ + "shape":"SuggestedFixes", + "documentation":"A list of SuggestedFix objects. Each object contains information about a suggested code fix to remediate the finding.
Information about how to remediate a finding.
" + }, + "RequestHeaderMap":{ + "type":"map", + "key":{"shape":"HeaderKey"}, + "value":{"shape":"HeaderValue"}, + "sensitive":true + }, + "Resource":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"The scanName of the scan that was run on the resource.
The identifier for a section of the resource.
" + } + }, + "documentation":"Information about a resource that contains a finding.
" + }, + "ResourceId":{ + "type":"structure", + "members":{ + "codeArtifactId":{ + "shape":"Uuid", + "documentation":"The identifier for the code file uploaded to the resource object. Returned by CreateUploadUrl when you upload resources to be scanned.
The identifier for a resource object that contains resources to scan. Specifying a codeArtifactId is required to create a scan.
", + "union":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "errorCode", + "message", + "resourceId", + "resourceType" + ], + "members":{ + "errorCode":{ + "shape":"String", + "documentation":"The identifier for the error.
" + }, + "message":{ + "shape":"String", + "documentation":"Description of the error.
" + }, + "resourceId":{ + "shape":"String", + "documentation":"The identifier for the resource that was not found.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The type of resource that was not found.
" + } + }, + "documentation":"The resource specified in the request was not found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "S3Url":{ + "type":"string", + "min":1, + "sensitive":true + }, + "ScanName":{ + "type":"string", + "max":140, + "min":1, + "pattern":"^[a-zA-Z0-9-_$:.]*$" + }, + "ScanNameArn":{ + "type":"string", + "max":300, + "min":1, + "pattern":"^arn:aws:codeguru-security:[\\S]+:[\\d]{12}:scans\\/[a-zA-Z0-9-_$:.]*$" + }, + "ScanNameWithFindingNum":{ + "type":"structure", + "members":{ + "findingNumber":{ + "shape":"Integer", + "documentation":"The number of findings generated by a scan.
" + }, + "scanName":{ + "shape":"String", + "documentation":"The name of the scan.
" + } + }, + "documentation":"Information about the number of findings generated by a scan.
" + }, + "ScanState":{ + "type":"string", + "enum":[ + "InProgress", + "Successful", + "Failed" + ] + }, + "ScanSummaries":{ + "type":"list", + "member":{"shape":"ScanSummary"} + }, + "ScanSummary":{ + "type":"structure", + "required":[ + "createdAt", + "runId", + "scanName", + "scanState" + ], + "members":{ + "createdAt":{ + "shape":"Timestamp", + "documentation":"The time when the scan was created.
" + }, + "runId":{ + "shape":"Uuid", + "documentation":"The identifier for the scan run.
" + }, + "scanName":{ + "shape":"ScanName", + "documentation":"The name of the scan.
" + }, + "scanNameArn":{ + "shape":"ScanNameArn", + "documentation":"The ARN for the scan name.
" + }, + "scanState":{ + "shape":"ScanState", + "documentation":"The state of the scan. A scan can be In Progress, Complete, or Failed.
The time the scan was last updated. A scan is updated when it is re-run.
" + } + }, + "documentation":"Information about a scan.
" + }, + "ScanType":{ + "type":"string", + "enum":[ + "Standard", + "Express" + ] + }, + "ScansWithMostOpenCriticalFindings":{ + "type":"list", + "member":{"shape":"ScanNameWithFindingNum"}, + "max":3, + "min":0 + }, + "ScansWithMostOpenFindings":{ + "type":"list", + "member":{"shape":"ScanNameWithFindingNum"}, + "max":3, + "min":0 + }, + "Severity":{ + "type":"string", + "enum":[ + "Critical", + "High", + "Medium", + "Low", + "Info" + ] + }, + "Status":{ + "type":"string", + "enum":[ + "Closed", + "Open", + "All" + ] + }, + "String":{"type":"string"}, + "SuggestedFix":{ + "type":"structure", + "members":{ + "code":{ + "shape":"String", + "documentation":"The suggested code fix. If applicable, includes code patch to replace your source code.
" + }, + "description":{ + "shape":"String", + "documentation":"A description of the suggested code fix and why it is being suggested.
" + } + }, + "documentation":"Information about the suggested code fix to remediate a finding.
" + }, + "SuggestedFixes":{ + "type":"list", + "member":{"shape":"SuggestedFix"} + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ScanNameArn", + "documentation":"The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.
An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:
A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.
An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
The identifier for the error.
" + }, + "message":{ + "shape":"String", + "documentation":"Description of the error.
" + }, + "quotaCode":{ + "shape":"String", + "documentation":"The identifier for the originating quota.
" + }, + "serviceCode":{ + "shape":"String", + "documentation":"The identifier for the originating service.
" + } + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":true} + }, + "Timestamp":{"type":"timestamp"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ScanNameArn", + "documentation":"The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.
A list of keys for each tag you want to remove from a scan.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateAccountConfigurationRequest":{ + "type":"structure", + "required":["encryptionConfig"], + "members":{ + "encryptionConfig":{ + "shape":"EncryptionConfig", + "documentation":"The customer-managed KMS key ARN you want to use for encryption. If not specified, CodeGuru Security will use an AWS-managed key for encryption. If you previously specified a customer-managed KMS key and want CodeGuru Security to use an AWS-managed key for encryption instead, pass nothing.
" + } + } + }, + "UpdateAccountConfigurationResponse":{ + "type":"structure", + "required":["encryptionConfig"], + "members":{ + "encryptionConfig":{ + "shape":"EncryptionConfig", + "documentation":"An EncryptionConfig object that contains the KMS key ARN that is used for encryption. If you did not specify a customer-managed KMS key in the request, returns empty.
The identifier for the error.
" + }, + "fieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"The field that caused the error, if applicable.
" + }, + "message":{ + "shape":"String", + "documentation":"Description of the error.
" + }, + "reason":{ + "shape":"ValidationExceptionReason", + "documentation":"The reason the request failed validation.
" + } + }, + "documentation":"The input fails to satisfy the specified constraints.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "message", + "name" + ], + "members":{ + "message":{ + "shape":"String", + "documentation":"Describes the exception.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the exception.
" + } + }, + "documentation":"Information about a validation exception.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "unknownOperation", + "cannotParse", + "fieldValidationFailed", + "other", + "lambdaCodeShaMisMatch" + ] + }, + "Vulnerability":{ + "type":"structure", + "members":{ + "filePath":{ + "shape":"FilePath", + "documentation":"An object that describes the location of the detected security vulnerability in your code.
" + }, + "id":{ + "shape":"String", + "documentation":"The identifier for the vulnerability.
" + }, + "itemCount":{ + "shape":"Integer", + "documentation":"The number of times the vulnerability appears in your code.
", + "deprecated":true, + "deprecatedMessage":"This shape is not used." + }, + "referenceUrls":{ + "shape":"ReferenceUrls", + "documentation":"One or more URL addresses that contain details about a vulnerability.
" + }, + "relatedVulnerabilities":{ + "shape":"RelatedVulnerabilities", + "documentation":"One or more vulnerabilities that are related to the vulnerability being described.
" + } + }, + "documentation":"Information about a security vulnerability that Amazon CodeGuru Security detected.
" + } + }, + "documentation":"Amazon CodeGuru Security is in preview release and is subject to change.
This section provides documentation for the Amazon CodeGuru Security API operations. CodeGuru Security is a service that uses program analysis and machine learning to detect security policy violations and vulnerabilities, and recommends ways to address these security risks.
By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the Amazon CodeGuru Security User Guide.
" +} diff --git a/testbed/boto__botocore/botocore/data/connectcampaigns/2021-01-30/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/connectcampaigns/2021-01-30/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..b61acb5d39d7d32317733298c2bb7abe9053a4fd --- /dev/null +++ b/testbed/boto__botocore/botocore/data/connectcampaigns/2021-01-30/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://connect-campaigns-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://connect-campaigns-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://connect-campaigns.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://connect-campaigns.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/connectcampaigns/2021-01-30/paginators-1.json b/testbed/boto__botocore/botocore/data/connectcampaigns/2021-01-30/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..6ab04512590255f738d1222e013252a0bdfc5a4d --- /dev/null +++ b/testbed/boto__botocore/botocore/data/connectcampaigns/2021-01-30/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListCampaigns": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "campaignSummaryList" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/connectcampaigns/2021-01-30/service-2.json b/testbed/boto__botocore/botocore/data/connectcampaigns/2021-01-30/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..252bd4b771105eb3746acd631bb780498db27fd3 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/connectcampaigns/2021-01-30/service-2.json @@ -0,0 +1,1444 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-01-30", + "endpointPrefix":"connect-campaigns", + "jsonVersion":"1.1", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"AmazonConnectCampaignService", + "serviceId":"ConnectCampaigns", + "signatureVersion":"v4", + "signingName":"connect-campaigns", + "uid":"connectcampaigns-2021-01-30" + }, + "operations":{ + "CreateCampaign":{ + "name":"CreateCampaign", + "http":{ + "method":"PUT", + "requestUri":"/campaigns", + "responseCode":200 + }, + "input":{"shape":"CreateCampaignRequest"}, + "output":{"shape":"CreateCampaignResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Creates a campaign for the specified Amazon Connect account. This API is idempotent.
", + "idempotent":true + }, + "DeleteCampaign":{ + "name":"DeleteCampaign", + "http":{ + "method":"DELETE", + "requestUri":"/campaigns/{id}", + "responseCode":200 + }, + "input":{"shape":"DeleteCampaignRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a campaign from the specified Amazon Connect account.
", + "idempotent":true + }, + "DeleteConnectInstanceConfig":{ + "name":"DeleteConnectInstanceConfig", + "http":{ + "method":"DELETE", + "requestUri":"/connect-instance/{connectInstanceId}/config", + "responseCode":200 + }, + "input":{"shape":"DeleteConnectInstanceConfigRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidStateException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Deletes a connect instance config from the specified AWS account.
", + "idempotent":true + }, + "DeleteInstanceOnboardingJob":{ + "name":"DeleteInstanceOnboardingJob", + "http":{ + "method":"DELETE", + "requestUri":"/connect-instance/{connectInstanceId}/onboarding", + "responseCode":200 + }, + "input":{"shape":"DeleteInstanceOnboardingJobRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidStateException"} + ], + "documentation":"Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
", + "idempotent":true + }, + "DescribeCampaign":{ + "name":"DescribeCampaign", + "http":{ + "method":"GET", + "requestUri":"/campaigns/{id}", + "responseCode":200 + }, + "input":{"shape":"DescribeCampaignRequest"}, + "output":{"shape":"DescribeCampaignResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Describes the specific campaign.
" + }, + "GetCampaignState":{ + "name":"GetCampaignState", + "http":{ + "method":"GET", + "requestUri":"/campaigns/{id}/state", + "responseCode":200 + }, + "input":{"shape":"GetCampaignStateRequest"}, + "output":{"shape":"GetCampaignStateResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get state of a campaign for the specified Amazon Connect account.
" + }, + "GetCampaignStateBatch":{ + "name":"GetCampaignStateBatch", + "http":{ + "method":"POST", + "requestUri":"/campaigns-state", + "responseCode":200 + }, + "input":{"shape":"GetCampaignStateBatchRequest"}, + "output":{"shape":"GetCampaignStateBatchResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get state of campaigns for the specified Amazon Connect account.
" + }, + "GetConnectInstanceConfig":{ + "name":"GetConnectInstanceConfig", + "http":{ + "method":"GET", + "requestUri":"/connect-instance/{connectInstanceId}/config", + "responseCode":200 + }, + "input":{"shape":"GetConnectInstanceConfigRequest"}, + "output":{"shape":"GetConnectInstanceConfigResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Get the specific Connect instance config.
" + }, + "GetInstanceOnboardingJobStatus":{ + "name":"GetInstanceOnboardingJobStatus", + "http":{ + "method":"GET", + "requestUri":"/connect-instance/{connectInstanceId}/onboarding", + "responseCode":200 + }, + "input":{"shape":"GetInstanceOnboardingJobStatusRequest"}, + "output":{"shape":"GetInstanceOnboardingJobStatusResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Get the specific instance onboarding job status.
" + }, + "ListCampaigns":{ + "name":"ListCampaigns", + "http":{ + "method":"POST", + "requestUri":"/campaigns-summary", + "responseCode":200 + }, + "input":{"shape":"ListCampaignsRequest"}, + "output":{"shape":"ListCampaignsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Provides summary information about the campaigns under the specified Amazon Connect account.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{arn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List tags for a resource.
", + "idempotent":true + }, + "PauseCampaign":{ + "name":"PauseCampaign", + "http":{ + "method":"POST", + "requestUri":"/campaigns/{id}/pause", + "responseCode":200 + }, + "input":{"shape":"PauseCampaignRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InvalidCampaignStateException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Pauses a campaign for the specified Amazon Connect account.
" + }, + "PutDialRequestBatch":{ + "name":"PutDialRequestBatch", + "http":{ + "method":"PUT", + "requestUri":"/campaigns/{id}/dial-requests", + "responseCode":200 + }, + "input":{"shape":"PutDialRequestBatchRequest"}, + "output":{"shape":"PutDialRequestBatchResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InvalidCampaignStateException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
", + "idempotent":true + }, + "ResumeCampaign":{ + "name":"ResumeCampaign", + "http":{ + "method":"POST", + "requestUri":"/campaigns/{id}/resume", + "responseCode":200 + }, + "input":{"shape":"ResumeCampaignRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InvalidCampaignStateException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Stops a campaign for the specified Amazon Connect account.
" + }, + "StartCampaign":{ + "name":"StartCampaign", + "http":{ + "method":"POST", + "requestUri":"/campaigns/{id}/start", + "responseCode":200 + }, + "input":{"shape":"StartCampaignRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InvalidCampaignStateException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Starts a campaign for the specified Amazon Connect account.
" + }, + "StartInstanceOnboardingJob":{ + "name":"StartInstanceOnboardingJob", + "http":{ + "method":"PUT", + "requestUri":"/connect-instance/{connectInstanceId}/onboarding", + "responseCode":200 + }, + "input":{"shape":"StartInstanceOnboardingJobRequest"}, + "output":{"shape":"StartInstanceOnboardingJobResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Onboard the specific Amazon Connect instance to Connect Campaigns.
", + "idempotent":true + }, + "StopCampaign":{ + "name":"StopCampaign", + "http":{ + "method":"POST", + "requestUri":"/campaigns/{id}/stop", + "responseCode":200 + }, + "input":{"shape":"StopCampaignRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InvalidCampaignStateException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Stops a campaign for the specified Amazon Connect account.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{arn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Tag a resource.
", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{arn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Untag a resource.
", + "idempotent":true + }, + "UpdateCampaignDialerConfig":{ + "name":"UpdateCampaignDialerConfig", + "http":{ + "method":"POST", + "requestUri":"/campaigns/{id}/dialer-config", + "responseCode":200 + }, + "input":{"shape":"UpdateCampaignDialerConfigRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates the dialer config of a campaign. This API is idempotent.
", + "idempotent":true + }, + "UpdateCampaignName":{ + "name":"UpdateCampaignName", + "http":{ + "method":"POST", + "requestUri":"/campaigns/{id}/name", + "responseCode":200 + }, + "input":{"shape":"UpdateCampaignNameRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates the name of a campaign. This API is idempotent.
", + "idempotent":true + }, + "UpdateCampaignOutboundCallConfig":{ + "name":"UpdateCampaignOutboundCallConfig", + "http":{ + "method":"POST", + "requestUri":"/campaigns/{id}/outbound-call-config", + "responseCode":200 + }, + "input":{"shape":"UpdateCampaignOutboundCallConfigRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Updates the outbound call config of a campaign. This API is idempotent.
", + "idempotent":true + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "xAmzErrorType":{ + "shape":"XAmazonErrorType", + "location":"header", + "locationName":"x-amzn-ErrorType" + } + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AgentlessDialerConfig":{ + "type":"structure", + "members":{ + "dialingCapacity":{"shape":"DialingCapacity"} + }, + "documentation":"Agentless Dialer config
" + }, + "AnswerMachineDetectionConfig":{ + "type":"structure", + "required":["enableAnswerMachineDetection"], + "members":{ + "enableAnswerMachineDetection":{ + "shape":"Boolean", + "documentation":"Enable or disable answering machine detection
" + }, + "awaitAnswerMachinePrompt":{ + "shape":"Boolean", + "documentation":"Enable or disable await answer machine prompt
" + } + }, + "documentation":"Answering Machine Detection config
" + }, + "Arn":{ + "type":"string", + "documentation":"Arn
", + "max":500, + "min":20, + "pattern":"arn:.*" + }, + "AttributeName":{ + "type":"string", + "documentation":"The key of the attribute. Attribute keys can include only alphanumeric, dash, and underscore characters.
", + "max":32767, + "min":0, + "pattern":"[a-zA-Z0-9\\-_]+" + }, + "AttributeValue":{ + "type":"string", + "documentation":"The value of the attribute.
", + "max":32767, + "min":0, + "pattern":".*" + }, + "Attributes":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"}, + "documentation":"A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
", + "sensitive":true + }, + "BandwidthAllocation":{ + "type":"double", + "documentation":"The bandwidth allocation of a queue resource.
", + "box":true, + "max":1, + "min":0 + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "Campaign":{ + "type":"structure", + "required":[ + "id", + "arn", + "name", + "connectInstanceId", + "dialerConfig", + "outboundCallConfig" + ], + "members":{ + "id":{"shape":"CampaignId"}, + "arn":{"shape":"CampaignArn"}, + "name":{"shape":"CampaignName"}, + "connectInstanceId":{"shape":"InstanceId"}, + "dialerConfig":{"shape":"DialerConfig"}, + "outboundCallConfig":{"shape":"OutboundCallConfig"}, + "tags":{"shape":"TagMap"} + }, + "documentation":"An Amazon Connect campaign.
" + }, + "CampaignArn":{ + "type":"string", + "documentation":"The resource name of an Amazon Connect campaign.
", + "max":500, + "min":20 + }, + "CampaignFilters":{ + "type":"structure", + "members":{ + "instanceIdFilter":{"shape":"InstanceIdFilter"} + }, + "documentation":"Filter model by type
" + }, + "CampaignId":{ + "type":"string", + "documentation":"Identifier representing a Campaign
", + "max":256, + "min":0, + "pattern":"[\\S]*" + }, + "CampaignName":{ + "type":"string", + "documentation":"The name of an Amazon Connect Campaign name.
", + "max":127, + "min":1 + }, + "CampaignState":{ + "type":"string", + "documentation":"State of a campaign
", + "enum":[ + "Initialized", + "Running", + "Paused", + "Stopped", + "Failed" + ] + }, + "CampaignSummary":{ + "type":"structure", + "required":[ + "id", + "arn", + "name", + "connectInstanceId" + ], + "members":{ + "id":{"shape":"CampaignId"}, + "arn":{"shape":"CampaignArn"}, + "name":{"shape":"CampaignName"}, + "connectInstanceId":{"shape":"InstanceId"} + }, + "documentation":"An Amazon Connect campaign summary.
" + }, + "CampaignSummaryList":{ + "type":"list", + "member":{"shape":"CampaignSummary"}, + "documentation":"A list of Amazon Connect campaigns.
" + }, + "ClientToken":{ + "type":"string", + "documentation":"Client provided parameter used for idempotency. Its value must be unique for each request.
", + "max":200, + "min":0, + "pattern":"[a-zA-Z0-9_\\-.]*" + }, + "ConflictException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "xAmzErrorType":{ + "shape":"XAmazonErrorType", + "location":"header", + "locationName":"x-amzn-ErrorType" + } + }, + "documentation":"The request could not be processed because of conflict in the current state of the resource.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ContactFlowId":{ + "type":"string", + "documentation":"The identifier of the contact flow for the outbound call.
", + "max":500, + "min":0 + }, + "CreateCampaignRequest":{ + "type":"structure", + "required":[ + "name", + "connectInstanceId", + "dialerConfig", + "outboundCallConfig" + ], + "members":{ + "name":{"shape":"CampaignName"}, + "connectInstanceId":{"shape":"InstanceId"}, + "dialerConfig":{"shape":"DialerConfig"}, + "outboundCallConfig":{"shape":"OutboundCallConfig"}, + "tags":{"shape":"TagMap"} + }, + "documentation":"The request for Create Campaign API.
" + }, + "CreateCampaignResponse":{ + "type":"structure", + "members":{ + "id":{"shape":"CampaignId"}, + "arn":{"shape":"CampaignArn"}, + "tags":{"shape":"TagMap"} + }, + "documentation":"The response for Create Campaign API
" + }, + "DeleteCampaignRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"CampaignId", + "location":"uri", + "locationName":"id" + } + }, + "documentation":"DeleteCampaignRequest
" + }, + "DeleteConnectInstanceConfigRequest":{ + "type":"structure", + "required":["connectInstanceId"], + "members":{ + "connectInstanceId":{ + "shape":"InstanceId", + "location":"uri", + "locationName":"connectInstanceId" + } + }, + "documentation":"DeleteCampaignRequest
" + }, + "DeleteInstanceOnboardingJobRequest":{ + "type":"structure", + "required":["connectInstanceId"], + "members":{ + "connectInstanceId":{ + "shape":"InstanceId", + "location":"uri", + "locationName":"connectInstanceId" + } + }, + "documentation":"The request for DeleteInstanceOnboardingJob API.
" + }, + "DescribeCampaignRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"CampaignId", + "location":"uri", + "locationName":"id" + } + }, + "documentation":"DescribeCampaignRequests
" + }, + "DescribeCampaignResponse":{ + "type":"structure", + "members":{ + "campaign":{"shape":"Campaign"} + }, + "documentation":"DescribeCampaignResponse
" + }, + "DestinationPhoneNumber":{ + "type":"string", + "documentation":"The phone number of the customer, in E.164 format.
", + "max":20, + "min":0, + "pattern":"[\\d\\-+]*", + "sensitive":true + }, + "DialRequest":{ + "type":"structure", + "required":[ + "clientToken", + "phoneNumber", + "expirationTime", + "attributes" + ], + "members":{ + "clientToken":{"shape":"ClientToken"}, + "phoneNumber":{"shape":"DestinationPhoneNumber"}, + "expirationTime":{"shape":"TimeStamp"}, + "attributes":{"shape":"Attributes"} + }, + "documentation":"A dial request for a campaign.
" + }, + "DialRequestId":{ + "type":"string", + "documentation":"Identifier representing a Dial request
", + "max":256, + "min":0, + "pattern":"[a-zA-Z0-9_\\-.]*" + }, + "DialRequestList":{ + "type":"list", + "member":{"shape":"DialRequest"}, + "documentation":"A list of dial requests.
", + "max":25, + "min":1 + }, + "DialerConfig":{ + "type":"structure", + "members":{ + "progressiveDialerConfig":{"shape":"ProgressiveDialerConfig"}, + "predictiveDialerConfig":{"shape":"PredictiveDialerConfig"}, + "agentlessDialerConfig":{"shape":"AgentlessDialerConfig"} + }, + "documentation":"The possible types of dialer config parameters
", + "union":true + }, + "DialingCapacity":{ + "type":"double", + "documentation":"Allocates dialing capacity for this campaign between multiple active campaigns
", + "box":true, + "max":1, + "min":0.01 + }, + "Enabled":{ + "type":"boolean", + "documentation":"Boolean to indicate if custom encryption has been enabled.
" + }, + "EncryptionConfig":{ + "type":"structure", + "required":["enabled"], + "members":{ + "enabled":{"shape":"Enabled"}, + "encryptionType":{"shape":"EncryptionType"}, + "keyArn":{"shape":"EncryptionKey"} + }, + "documentation":"Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported
" + }, + "EncryptionKey":{ + "type":"string", + "documentation":"KMS key id/arn for encryption config.
", + "max":500, + "min":0 + }, + "EncryptionType":{ + "type":"string", + "documentation":"Server-side encryption type.
", + "enum":["KMS"] + }, + "FailedCampaignStateResponse":{ + "type":"structure", + "members":{ + "campaignId":{"shape":"CampaignId"}, + "failureCode":{"shape":"GetCampaignStateBatchFailureCode"} + }, + "documentation":"Failed response of campaign state
" + }, + "FailedCampaignStateResponseList":{ + "type":"list", + "member":{"shape":"FailedCampaignStateResponse"}, + "documentation":"List of failed requests of campaign state
", + "max":25, + "min":0 + }, + "FailedRequest":{ + "type":"structure", + "members":{ + "clientToken":{"shape":"ClientToken"}, + "id":{"shape":"DialRequestId"}, + "failureCode":{"shape":"FailureCode"} + }, + "documentation":"A failed request identified by the unique client token.
" + }, + "FailedRequestList":{ + "type":"list", + "member":{"shape":"FailedRequest"}, + "documentation":"A list of failed requests.
", + "max":25, + "min":0 + }, + "FailureCode":{ + "type":"string", + "documentation":"A predefined code indicating the error that caused the failure.
", + "enum":[ + "InvalidInput", + "RequestThrottled", + "UnknownError" + ] + }, + "GetCampaignStateBatchFailureCode":{ + "type":"string", + "documentation":"A predefined code indicating the error that caused the failure in getting state of campaigns
", + "enum":[ + "ResourceNotFound", + "UnknownError" + ] + }, + "GetCampaignStateBatchRequest":{ + "type":"structure", + "required":["campaignIds"], + "members":{ + "campaignIds":{"shape":"GetCampaignStateBatchRequestCampaignIdsList"} + }, + "documentation":"GetCampaignStateBatchRequest
" + }, + "GetCampaignStateBatchRequestCampaignIdsList":{ + "type":"list", + "member":{"shape":"CampaignId"}, + "documentation":"List of CampaignId
", + "max":25, + "min":1 + }, + "GetCampaignStateBatchResponse":{ + "type":"structure", + "members":{ + "successfulRequests":{"shape":"SuccessfulCampaignStateResponseList"}, + "failedRequests":{"shape":"FailedCampaignStateResponseList"} + }, + "documentation":"GetCampaignStateBatchResponse
" + }, + "GetCampaignStateRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"CampaignId", + "location":"uri", + "locationName":"id" + } + }, + "documentation":"GetCampaignStateRequest
" + }, + "GetCampaignStateResponse":{ + "type":"structure", + "members":{ + "state":{"shape":"CampaignState"} + }, + "documentation":"GetCampaignStateResponse
" + }, + "GetConnectInstanceConfigRequest":{ + "type":"structure", + "required":["connectInstanceId"], + "members":{ + "connectInstanceId":{ + "shape":"InstanceId", + "location":"uri", + "locationName":"connectInstanceId" + } + }, + "documentation":"GetConnectInstanceConfigRequest
" + }, + "GetConnectInstanceConfigResponse":{ + "type":"structure", + "members":{ + "connectInstanceConfig":{"shape":"InstanceConfig"} + }, + "documentation":"GetConnectInstanceConfigResponse
" + }, + "GetInstanceOnboardingJobStatusRequest":{ + "type":"structure", + "required":["connectInstanceId"], + "members":{ + "connectInstanceId":{ + "shape":"InstanceId", + "location":"uri", + "locationName":"connectInstanceId" + } + }, + "documentation":"GetInstanceOnboardingJobStatusRequest
" + }, + "GetInstanceOnboardingJobStatusResponse":{ + "type":"structure", + "members":{ + "connectInstanceOnboardingJobStatus":{"shape":"InstanceOnboardingJobStatus"} + }, + "documentation":"GetInstanceOnboardingJobStatusResponse
" + }, + "InstanceConfig":{ + "type":"structure", + "required":[ + "connectInstanceId", + "serviceLinkedRoleArn", + "encryptionConfig" + ], + "members":{ + "connectInstanceId":{"shape":"InstanceId"}, + "serviceLinkedRoleArn":{"shape":"ServiceLinkedRoleArn"}, + "encryptionConfig":{"shape":"EncryptionConfig"} + }, + "documentation":"Instance config object
" + }, + "InstanceId":{ + "type":"string", + "documentation":"Amazon Connect Instance Id
", + "max":256, + "min":0, + "pattern":"[a-zA-Z0-9_\\-.]*" + }, + "InstanceIdFilter":{ + "type":"structure", + "required":[ + "value", + "operator" + ], + "members":{ + "value":{"shape":"InstanceId"}, + "operator":{"shape":"InstanceIdFilterOperator"} + }, + "documentation":"Connect instance identifier filter
" + }, + "InstanceIdFilterOperator":{ + "type":"string", + "documentation":"Operators for Connect instance identifier filter
", + "enum":["Eq"] + }, + "InstanceOnboardingJobFailureCode":{ + "type":"string", + "documentation":"Enumeration of the possible failure codes for instance onboarding job
", + "enum":[ + "EVENT_BRIDGE_ACCESS_DENIED", + "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED", + "IAM_ACCESS_DENIED", + "KMS_ACCESS_DENIED", + "KMS_KEY_NOT_FOUND", + "INTERNAL_FAILURE" + ] + }, + "InstanceOnboardingJobStatus":{ + "type":"structure", + "required":[ + "connectInstanceId", + "status" + ], + "members":{ + "connectInstanceId":{"shape":"InstanceId"}, + "status":{"shape":"InstanceOnboardingJobStatusCode"}, + "failureCode":{"shape":"InstanceOnboardingJobFailureCode"} + }, + "documentation":"Instance onboarding job status object
" + }, + "InstanceOnboardingJobStatusCode":{ + "type":"string", + "documentation":"Enumeration of the possible states for instance onboarding job
", + "enum":[ + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ] + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "xAmzErrorType":{ + "shape":"XAmazonErrorType", + "location":"header", + "locationName":"x-amzn-ErrorType" + } + }, + "documentation":"Request processing failed because of an error or failure with the service.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "InvalidCampaignStateException":{ + "type":"structure", + "required":[ + "state", + "message" + ], + "members":{ + "state":{"shape":"CampaignState"}, + "message":{"shape":"String"}, + "xAmzErrorType":{ + "shape":"XAmazonErrorType", + "location":"header", + "locationName":"x-amzn-ErrorType" + } + }, + "documentation":"The request could not be processed because of conflict in the current state of the campaign.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "InvalidStateException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "xAmzErrorType":{ + "shape":"XAmazonErrorType", + "location":"header", + "locationName":"x-amzn-ErrorType" + } + }, + "documentation":"The request could not be processed because of conflict in the current state.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ListCampaignsRequest":{ + "type":"structure", + "members":{ + "maxResults":{"shape":"MaxResults"}, + "nextToken":{"shape":"NextToken"}, + "filters":{"shape":"CampaignFilters"} + }, + "documentation":"ListCampaignsRequest
" + }, + "ListCampaignsResponse":{ + "type":"structure", + "members":{ + "nextToken":{"shape":"NextToken"}, + "campaignSummaryList":{"shape":"CampaignSummaryList"} + }, + "documentation":"ListCampaignsResponse
" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"Arn", + "location":"uri", + "locationName":"arn" + } + }, + "documentation":"ListTagsForResource
" + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{"shape":"TagMap"} + }, + "documentation":"ListTagsForResponse
" + }, + "MaxResults":{ + "type":"integer", + "documentation":"The maximum number of results to return per page.
", + "box":true, + "max":50, + "min":1 + }, + "NextToken":{ + "type":"string", + "documentation":"The token for the next set of results.
", + "max":1000, + "min":0 + }, + "OutboundCallConfig":{ + "type":"structure", + "required":["connectContactFlowId"], + "members":{ + "connectContactFlowId":{"shape":"ContactFlowId"}, + "connectSourcePhoneNumber":{"shape":"SourcePhoneNumber"}, + "connectQueueId":{"shape":"QueueId"}, + "answerMachineDetectionConfig":{"shape":"AnswerMachineDetectionConfig"} + }, + "documentation":"The configuration used for outbound calls.
" + }, + "PauseCampaignRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"CampaignId", + "location":"uri", + "locationName":"id" + } + }, + "documentation":"PauseCampaignRequest
" + }, + "PredictiveDialerConfig":{ + "type":"structure", + "required":["bandwidthAllocation"], + "members":{ + "bandwidthAllocation":{"shape":"BandwidthAllocation"}, + "dialingCapacity":{"shape":"DialingCapacity"} + }, + "documentation":"Predictive Dialer config
" + }, + "ProgressiveDialerConfig":{ + "type":"structure", + "required":["bandwidthAllocation"], + "members":{ + "bandwidthAllocation":{"shape":"BandwidthAllocation"}, + "dialingCapacity":{"shape":"DialingCapacity"} + }, + "documentation":"Progressive Dialer config
" + }, + "PutDialRequestBatchRequest":{ + "type":"structure", + "required":[ + "id", + "dialRequests" + ], + "members":{ + "id":{ + "shape":"CampaignId", + "location":"uri", + "locationName":"id" + }, + "dialRequests":{"shape":"DialRequestList"} + }, + "documentation":"PutDialRequestBatchRequest
" + }, + "PutDialRequestBatchResponse":{ + "type":"structure", + "members":{ + "successfulRequests":{"shape":"SuccessfulRequestList"}, + "failedRequests":{"shape":"FailedRequestList"} + }, + "documentation":"PutDialRequestBatchResponse
" + }, + "QueueId":{ + "type":"string", + "documentation":"The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
", + "max":500, + "min":0 + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "xAmzErrorType":{ + "shape":"XAmazonErrorType", + "location":"header", + "locationName":"x-amzn-ErrorType" + } + }, + "documentation":"The specified resource was not found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResumeCampaignRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"CampaignId", + "location":"uri", + "locationName":"id" + } + }, + "documentation":"ResumeCampaignRequest
" + }, + "ServiceLinkedRoleArn":{ + "type":"string", + "documentation":"Service linked role arn
", + "max":256, + "min":0 + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "xAmzErrorType":{ + "shape":"XAmazonErrorType", + "location":"header", + "locationName":"x-amzn-ErrorType" + } + }, + "documentation":"Request would cause a service quota to be exceeded.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SourcePhoneNumber":{ + "type":"string", + "documentation":"The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
", + "max":100, + "min":0 + }, + "StartCampaignRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"CampaignId", + "location":"uri", + "locationName":"id" + } + }, + "documentation":"StartCampaignRequest
" + }, + "StartInstanceOnboardingJobRequest":{ + "type":"structure", + "required":[ + "connectInstanceId", + "encryptionConfig" + ], + "members":{ + "connectInstanceId":{ + "shape":"InstanceId", + "location":"uri", + "locationName":"connectInstanceId" + }, + "encryptionConfig":{"shape":"EncryptionConfig"} + }, + "documentation":"The request for StartInstanceOnboardingJob API.
" + }, + "StartInstanceOnboardingJobResponse":{ + "type":"structure", + "members":{ + "connectInstanceOnboardingJobStatus":{"shape":"InstanceOnboardingJobStatus"} + }, + "documentation":"The response for StartInstanceOnboardingJob API.
" + }, + "StopCampaignRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"CampaignId", + "location":"uri", + "locationName":"id" + } + }, + "documentation":"StopCampaignRequest
" + }, + "String":{"type":"string"}, + "SuccessfulCampaignStateResponse":{ + "type":"structure", + "members":{ + "campaignId":{"shape":"CampaignId"}, + "state":{"shape":"CampaignState"} + }, + "documentation":"Successful response of campaign state
" + }, + "SuccessfulCampaignStateResponseList":{ + "type":"list", + "member":{"shape":"SuccessfulCampaignStateResponse"}, + "documentation":"List of successful response of campaign state
", + "max":25, + "min":0 + }, + "SuccessfulRequest":{ + "type":"structure", + "members":{ + "clientToken":{"shape":"ClientToken"}, + "id":{"shape":"DialRequestId"} + }, + "documentation":"A successful request identified by the unique client token.
" + }, + "SuccessfulRequestList":{ + "type":"list", + "member":{"shape":"SuccessfulRequest"}, + "documentation":"A list of successful requests identified by the unique client token.
", + "max":25, + "min":0 + }, + "TagKey":{ + "type":"string", + "documentation":"Tag key.
", + "max":128, + "min":1, + "pattern":"(?!aws:)[a-zA-Z+-=._:/]+" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "documentation":"List of tag keys.
", + "max":50, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "documentation":"Tag map with key and value.
" + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "arn", + "tags" + ], + "members":{ + "arn":{ + "shape":"Arn", + "location":"uri", + "locationName":"arn" + }, + "tags":{"shape":"TagMap"} + }, + "documentation":"TagResourceRequest
" + }, + "TagValue":{ + "type":"string", + "documentation":"Tag value.
", + "max":256, + "min":0 + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "xAmzErrorType":{ + "shape":"XAmazonErrorType", + "location":"header", + "locationName":"x-amzn-ErrorType" + } + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":false} + }, + "TimeStamp":{ + "type":"timestamp", + "documentation":"Timestamp with no UTC offset or timezone
", + "timestampFormat":"iso8601" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "arn", + "tagKeys" + ], + "members":{ + "arn":{ + "shape":"Arn", + "location":"uri", + "locationName":"arn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "location":"querystring", + "locationName":"tagKeys" + } + }, + "documentation":"UntagResourceRequest
" + }, + "UpdateCampaignDialerConfigRequest":{ + "type":"structure", + "required":[ + "id", + "dialerConfig" + ], + "members":{ + "id":{ + "shape":"CampaignId", + "location":"uri", + "locationName":"id" + }, + "dialerConfig":{"shape":"DialerConfig"} + }, + "documentation":"UpdateCampaignDialerConfigRequest
" + }, + "UpdateCampaignNameRequest":{ + "type":"structure", + "required":[ + "id", + "name" + ], + "members":{ + "id":{ + "shape":"CampaignId", + "location":"uri", + "locationName":"id" + }, + "name":{"shape":"CampaignName"} + }, + "documentation":"UpdateCampaignNameRequest
" + }, + "UpdateCampaignOutboundCallConfigRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"CampaignId", + "location":"uri", + "locationName":"id" + }, + "connectContactFlowId":{"shape":"ContactFlowId"}, + "connectSourcePhoneNumber":{"shape":"SourcePhoneNumber"}, + "answerMachineDetectionConfig":{"shape":"AnswerMachineDetectionConfig"} + }, + "documentation":"UpdateCampaignOutboundCallConfigRequest
" + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "xAmzErrorType":{ + "shape":"XAmazonErrorType", + "location":"header", + "locationName":"x-amzn-ErrorType" + } + }, + "documentation":"The input fails to satisfy the constraints specified by an AWS service.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "XAmazonErrorType":{ + "type":"string", + "documentation":"A header that defines the error encountered while processing the request.
" + } + }, + "documentation":"Provide APIs to create and manage Amazon Connect Campaigns.
" +} diff --git a/testbed/boto__botocore/botocore/data/connectcases/2022-10-03/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/connectcases/2022-10-03/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..010cf2720c7267e407bef61c53babb4226d4f2eb --- /dev/null +++ b/testbed/boto__botocore/botocore/data/connectcases/2022-10-03/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cases-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cases-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cases.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cases.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/connectcases/2022-10-03/paginators-1.json b/testbed/boto__botocore/botocore/data/connectcases/2022-10-03/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..6ce244da4fa9ffe9c14be0742f8941a671bb7eaa --- /dev/null +++ b/testbed/boto__botocore/botocore/data/connectcases/2022-10-03/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "SearchCases": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "cases" + }, + "SearchRelatedItems": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "relatedItems" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/connectcases/2022-10-03/service-2.json b/testbed/boto__botocore/botocore/data/connectcases/2022-10-03/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..5974e1856d21c0bcc896854979e426f75a12a21a --- /dev/null +++ b/testbed/boto__botocore/botocore/data/connectcases/2022-10-03/service-2.json @@ -0,0 +1,3444 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-10-03", + "endpointPrefix":"cases", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"ConnectCases", + "serviceFullName":"Amazon Connect Cases", + "serviceId":"ConnectCases", + "signatureVersion":"v4", + "signingName":"cases", + "uid":"connectcases-2022-10-03" + }, + "operations":{ + "BatchGetField":{ + "name":"BatchGetField", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/fields-batch", + "responseCode":200 + }, + "input":{"shape":"BatchGetFieldRequest"}, + "output":{"shape":"BatchGetFieldResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns the description for the list of fields in the request parameters.
" + }, + "BatchPutFieldOptions":{ + "name":"BatchPutFieldOptions", + "http":{ + "method":"PUT", + "requestUri":"/domains/{domainId}/fields/{fieldId}/options", + "responseCode":200 + }, + "input":{"shape":"BatchPutFieldOptionsRequest"}, + "output":{"shape":"BatchPutFieldOptionsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates and updates a set of field options for a single select field in a Cases domain.
", + "idempotent":true + }, + "CreateCase":{ + "name":"CreateCase", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/cases", + "responseCode":200 + }, + "input":{"shape":"CreateCaseRequest"}, + "output":{"shape":"CreateCaseResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ], + "documentation":"If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide
<p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul> Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.
This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases.
</important> Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.
", + "idempotent":true + }, + "CreateLayout":{ + "name":"CreateLayout", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/layouts", + "responseCode":200 + }, + "input":{"shape":"CreateLayoutRequest"}, + "output":{"shape":"CreateLayoutResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:
Fields to display to the users
Field ordering
Title and Status fields cannot be part of layouts since they are not configurable.
Creates a related item (comments, tasks, and contacts) and associates it with a case.
A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts.
If you provide a value for performedBy.userArn you must also have DescribeUser permission on the ARN of the user that you provide.
</note> Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.
", + "idempotent":true + }, + "DeleteDomain":{ + "name":"DeleteDomain", + "http":{ + "method":"DELETE", + "requestUri":"/domains/{domainId}", + "responseCode":200 + }, + "input":{"shape":"DeleteDomainRequest"}, + "output":{"shape":"DeleteDomainResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes a Cases domain.
<note> <p>After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html">DeleteIntegrationAssociation</a>.</p> </note> Deletes a field from a cases template. You can delete up to 100 fields per domain.
After a field is deleted:
You can still retrieve the field by calling BatchGetField.
You cannot update a deleted field by calling UpdateField; it throws a ValidationException.
Deleted fields are not included in the ListFields response.
Calling CreateCase with a deleted field throws a ValidationException denoting which field IDs in the request have been deleted.
Calling GetCase with a deleted field ID returns the deleted field's value if one exists.
Calling UpdateCase with a deleted field ID throws a ValidationException if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using emptyValue: {}) the field's value from the case.
GetTemplate does not return field IDs for deleted fields.
GetLayout does not return field IDs for deleted fields.
Calling SearchCases with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria.
Calling SearchCases with a searchTerm value that matches a deleted field's value on a case returns the case in the response.
Calling BatchPutFieldOptions with a deleted field ID throw a ValidationException.
Calling GetCaseEventConfiguration does not return field IDs for deleted fields.
Deletes a layout from a cases template. You can delete up to 100 layouts per domain.
<p>After a layout is deleted:</p> <ul> <li> <p>You can still retrieve the layout by calling <code>GetLayout</code>.</p> </li> <li> <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p> </li> </ul> Deletes a cases template. You can delete up to 100 templates per domain.
<p>After a cases template is deleted:</p> <ul> <li> <p>You can still retrieve the template by calling <code>GetTemplate</code>.</p> </li> <li> <p>You cannot update the template. </p> </li> <li> <p>You cannot create a case by using the deleted template.</p> </li> <li> <p>Deleted templates are not included in the <code>ListTemplates</code> response.</p> </li> </ul> Returns information about a specific case if it exists.
" + }, + "GetCaseAuditEvents":{ + "name":"GetCaseAuditEvents", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/cases/{caseId}/audit-history", + "responseCode":200 + }, + "input":{"shape":"GetCaseAuditEventsRequest"}, + "output":{"shape":"GetCaseAuditEventsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns the audit history about a specific case if it exists.
" + }, + "GetCaseEventConfiguration":{ + "name":"GetCaseEventConfiguration", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/case-event-configuration", + "responseCode":200 + }, + "input":{"shape":"GetCaseEventConfigurationRequest"}, + "output":{"shape":"GetCaseEventConfigurationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns the case event publishing configuration.
" + }, + "GetDomain":{ + "name":"GetDomain", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}", + "responseCode":200 + }, + "input":{"shape":"GetDomainRequest"}, + "output":{"shape":"GetDomainResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about a specific domain if it exists.
" + }, + "GetLayout":{ + "name":"GetLayout", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/layouts/{layoutId}", + "responseCode":200 + }, + "input":{"shape":"GetLayoutRequest"}, + "output":{"shape":"GetLayoutResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns the details for the requested layout.
" + }, + "GetTemplate":{ + "name":"GetTemplate", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/templates/{templateId}", + "responseCode":200 + }, + "input":{"shape":"GetTemplateRequest"}, + "output":{"shape":"GetTemplateResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns the details for the requested template.
" + }, + "ListCasesForContact":{ + "name":"ListCasesForContact", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/list-cases-for-contact", + "responseCode":200 + }, + "input":{"shape":"ListCasesForContactRequest"}, + "output":{"shape":"ListCasesForContactResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists cases for a given contact.
" + }, + "ListDomains":{ + "name":"ListDomains", + "http":{ + "method":"POST", + "requestUri":"/domains-list", + "responseCode":200 + }, + "input":{"shape":"ListDomainsRequest"}, + "output":{"shape":"ListDomainsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
" + }, + "ListFieldOptions":{ + "name":"ListFieldOptions", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/fields/{fieldId}/options-list", + "responseCode":200 + }, + "input":{"shape":"ListFieldOptionsRequest"}, + "output":{"shape":"ListFieldOptionsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists all of the field options for a field identifier in the domain.
" + }, + "ListFields":{ + "name":"ListFields", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/fields-list", + "responseCode":200 + }, + "input":{"shape":"ListFieldsRequest"}, + "output":{"shape":"ListFieldsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists all fields in a Cases domain.
" + }, + "ListLayouts":{ + "name":"ListLayouts", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/layouts-list", + "responseCode":200 + }, + "input":{"shape":"ListLayoutsRequest"}, + "output":{"shape":"ListLayoutsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{arn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists tags for a resource.
", + "idempotent":true + }, + "ListTemplates":{ + "name":"ListTemplates", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/templates-list", + "responseCode":200 + }, + "input":{"shape":"ListTemplatesRequest"}, + "output":{"shape":"ListTemplatesResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
" + }, + "PutCaseEventConfiguration":{ + "name":"PutCaseEventConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/domains/{domainId}/case-event-configuration", + "responseCode":200 + }, + "input":{"shape":"PutCaseEventConfigurationRequest"}, + "output":{"shape":"PutCaseEventConfigurationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Adds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Amazon Connect Administrator Guide
" + }, + "SearchCases":{ + "name":"SearchCases", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/cases-search", + "responseCode":200 + }, + "input":{"shape":"SearchCasesRequest"}, + "output":{"shape":"SearchCasesResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.
For customer_id you must provide the full customer profile ARN in this format: arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID.
Searches for related items that are associated with a case.
If no filters are provided, this returns all related items associated with a case.
Adds tags to a resource.
", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{arn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Untags a resource.
", + "idempotent":true + }, + "UpdateCase":{ + "name":"UpdateCase", + "http":{ + "method":"PUT", + "requestUri":"/domains/{domainId}/cases/{caseId}", + "responseCode":200 + }, + "input":{"shape":"UpdateCaseRequest"}, + "output":{"shape":"UpdateCaseResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide
<p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p> Updates the properties of an existing field.
", + "idempotent":true + }, + "UpdateLayout":{ + "name":"UpdateLayout", + "http":{ + "method":"PUT", + "requestUri":"/domains/{domainId}/layouts/{layoutId}", + "responseCode":200 + }, + "input":{"shape":"UpdateLayoutRequest"}, + "output":{"shape":"UpdateLayoutResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Updates the attributes of an existing layout.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
A ValidationException is returned when you add non-existent fieldIds to a layout.
Title and Status fields cannot be part of layouts because they are not configurable.
Updates the attributes of an existing template. The template attributes that can be modified include name, description, layoutConfiguration, requiredFields, and status. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.
You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "Arn":{ + "type":"string", + "max":500, + "min":1 + }, + "AssociationTime":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "AuditEvent":{ + "type":"structure", + "required":[ + "eventId", + "fields", + "performedTime", + "type" + ], + "members":{ + "eventId":{ + "shape":"AuditEventId", + "documentation":"Unique identifier of a case audit history event.
" + }, + "fields":{ + "shape":"AuditEventFieldList", + "documentation":"A list of Case Audit History event fields.
" + }, + "performedBy":{ + "shape":"AuditEventPerformedBy", + "documentation":"Information of the user which performed the audit.
" + }, + "performedTime":{ + "shape":"AuditEventDateTime", + "documentation":"Time at which an Audit History event took place.
" + }, + "relatedItemType":{ + "shape":"RelatedItemType", + "documentation":"The Type of the related item.
" + }, + "type":{ + "shape":"AuditEventType", + "documentation":"The Type of an audit history event.
" + } + }, + "documentation":"Represents the content of a particular audit event.
" + }, + "AuditEventDateTime":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "AuditEventField":{ + "type":"structure", + "required":[ + "eventFieldId", + "newValue" + ], + "members":{ + "eventFieldId":{ + "shape":"AuditEventFieldId", + "documentation":"Unique identifier of field in an Audit History entry.
" + }, + "newValue":{ + "shape":"AuditEventFieldValueUnion", + "documentation":"Union of potential field value types.
" + }, + "oldValue":{ + "shape":"AuditEventFieldValueUnion", + "documentation":"Union of potential field value types.
" + } + }, + "documentation":"Fields for audit event.
" + }, + "AuditEventFieldId":{ + "type":"string", + "max":500, + "min":1 + }, + "AuditEventFieldList":{ + "type":"list", + "member":{"shape":"AuditEventField"} + }, + "AuditEventFieldValueUnion":{ + "type":"structure", + "members":{ + "booleanValue":{ + "shape":"Boolean", + "documentation":"Can be either null, or have a Boolean value type. Only one value can be provided.
" + }, + "doubleValue":{ + "shape":"Double", + "documentation":"Can be either null, or have a Double value type. Only one value can be provided.
" + }, + "emptyValue":{"shape":"EmptyFieldValue"}, + "stringValue":{ + "shape":"AuditEventFieldValueUnionStringValueString", + "documentation":"Can be either null, or have a String value type. Only one value can be provided.
" + }, + "userArnValue":{ + "shape":"String", + "documentation":"Can be either null, or have a String value type formatted as an ARN. Only one value can be provided.
" + } + }, + "documentation":"Object to store union of Field values.
", + "union":true + }, + "AuditEventFieldValueUnionStringValueString":{ + "type":"string", + "max":500, + "min":0 + }, + "AuditEventId":{ + "type":"string", + "max":500, + "min":1 + }, + "AuditEventPerformedBy":{ + "type":"structure", + "required":["iamPrincipalArn"], + "members":{ + "iamPrincipalArn":{ + "shape":"IamPrincipalArn", + "documentation":"Unique identifier of an IAM role.
" + }, + "user":{"shape":"UserUnion"} + }, + "documentation":"Information of the user which performed the audit.
" + }, + "AuditEventType":{ + "type":"string", + "enum":[ + "Case.Created", + "Case.Updated", + "RelatedItem.Created" + ] + }, + "BasicLayout":{ + "type":"structure", + "members":{ + "moreInfo":{ + "shape":"LayoutSections", + "documentation":"This represents sections in a tab of the page layout.
" + }, + "topPanel":{ + "shape":"LayoutSections", + "documentation":"This represents sections in a panel of the page layout.
" + } + }, + "documentation":"Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of agent application.
The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "fields":{ + "shape":"BatchGetFieldIdentifierList", + "documentation":"A list of unique field identifiers.
" + } + } + }, + "BatchGetFieldResponse":{ + "type":"structure", + "required":[ + "errors", + "fields" + ], + "members":{ + "errors":{ + "shape":"BatchGetFieldResponseErrorsList", + "documentation":"A list of field errors.
" + }, + "fields":{ + "shape":"BatchGetFieldResponseFieldsList", + "documentation":"A list of detailed field information.
" + } + } + }, + "BatchGetFieldResponseErrorsList":{ + "type":"list", + "member":{"shape":"FieldError"}, + "max":50, + "min":0 + }, + "BatchGetFieldResponseFieldsList":{ + "type":"list", + "member":{"shape":"GetFieldResponse"}, + "max":50, + "min":0 + }, + "BatchPutFieldOptionsRequest":{ + "type":"structure", + "required":[ + "domainId", + "fieldId", + "options" + ], + "members":{ + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "fieldId":{ + "shape":"FieldId", + "documentation":"The unique identifier of a field.
", + "location":"uri", + "locationName":"fieldId" + }, + "options":{ + "shape":"BatchPutFieldOptionsRequestOptionsList", + "documentation":"A list of FieldOption objects.
A list of field errors.
" + } + } + }, + "BatchPutFieldOptionsResponseErrorsList":{ + "type":"list", + "member":{"shape":"FieldOptionError"}, + "max":50, + "min":0 + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "CaseArn":{ + "type":"string", + "max":500, + "min":1 + }, + "CaseEventIncludedData":{ + "type":"structure", + "required":["fields"], + "members":{ + "fields":{ + "shape":"CaseEventIncludedDataFieldsList", + "documentation":"List of field identifiers.
" + } + }, + "documentation":"Details of what case data is published through the case event stream.
" + }, + "CaseEventIncludedDataFieldsList":{ + "type":"list", + "member":{"shape":"FieldIdentifier"}, + "max":200, + "min":0 + }, + "CaseFilter":{ + "type":"structure", + "members":{ + "andAll":{ + "shape":"CaseFilterAndAllList", + "documentation":"Provides \"and all\" filtering.
" + }, + "field":{ + "shape":"FieldFilter", + "documentation":"A list of fields to filter on.
" + }, + "not":{"shape":"CaseFilter"}, + "orAll":{ + "shape":"CaseFilterOrAllList", + "documentation":"Provides \"or all\" filtering.
" + } + }, + "documentation":"A filter for cases. Only one value can be provided.
", + "union":true + }, + "CaseFilterAndAllList":{ + "type":"list", + "member":{"shape":"CaseFilter"}, + "max":10, + "min":0 + }, + "CaseFilterOrAllList":{ + "type":"list", + "member":{"shape":"CaseFilter"}, + "max":10, + "min":0 + }, + "CaseId":{ + "type":"string", + "max":500, + "min":1 + }, + "CaseSummary":{ + "type":"structure", + "required":[ + "caseId", + "templateId" + ], + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"A unique identifier of the case.
" + }, + "templateId":{ + "shape":"TemplateId", + "documentation":"A unique identifier of a template.
" + } + }, + "documentation":"Case summary information.
" + }, + "Channel":{ + "type":"string", + "max":100, + "min":1 + }, + "CommentBody":{ + "type":"string", + "max":3000, + "min":1 + }, + "CommentBodyTextType":{ + "type":"string", + "enum":["Text/Plain"] + }, + "CommentContent":{ + "type":"structure", + "required":[ + "body", + "contentType" + ], + "members":{ + "body":{ + "shape":"CommentBody", + "documentation":"Text in the body of a Comment on a case.
Type of the text in the box of a Comment on a case.
Represents the content of a Comment to be returned to agents.
A filter for related items of type Comment.
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ConnectedToSystemTime":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "Contact":{ + "type":"structure", + "required":["contactArn"], + "members":{ + "contactArn":{ + "shape":"ContactArn", + "documentation":"A unique identifier of a contact in Amazon Connect.
" + } + }, + "documentation":"An object that represents an Amazon Connect contact object.
" + }, + "ContactArn":{ + "type":"string", + "max":500, + "min":1 + }, + "ContactContent":{ + "type":"structure", + "required":[ + "channel", + "connectedToSystemTime", + "contactArn" + ], + "members":{ + "channel":{ + "shape":"Channel", + "documentation":"A list of channels to filter on for related items of type Contact.
The difference between the InitiationTimestamp and the DisconnectTimestamp of the contact.
A unique identifier of a contact in Amazon Connect.
" + } + }, + "documentation":"An object that represents a content of an Amazon Connect contact object.
" + }, + "ContactFilter":{ + "type":"structure", + "members":{ + "channel":{ + "shape":"ContactFilterChannelList", + "documentation":"A list of channels to filter on for related items of type Contact.
A unique identifier of a contact in Amazon Connect.
" + } + }, + "documentation":"A filter for related items of type Contact.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "idempotencyToken":true + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "fields":{ + "shape":"CreateCaseRequestFieldsList", + "documentation":"An array of objects with field ID (matching ListFields/DescribeField) and value union data.
" + }, + "performedBy":{"shape":"UserUnion"}, + "templateId":{ + "shape":"TemplateId", + "documentation":"A unique identifier of a template.
" + } + } + }, + "CreateCaseRequestClientTokenString":{ + "type":"string", + "max":64, + "min":0 + }, + "CreateCaseRequestFieldsList":{ + "type":"list", + "member":{"shape":"FieldValue"}, + "max":100, + "min":0 + }, + "CreateCaseResponse":{ + "type":"structure", + "required":[ + "caseArn", + "caseId" + ], + "members":{ + "caseArn":{ + "shape":"CaseArn", + "documentation":"The Amazon Resource Name (ARN) of the case.
" + }, + "caseId":{ + "shape":"CaseId", + "documentation":"A unique identifier of the case.
" + } + } + }, + "CreateDomainRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"DomainName", + "documentation":"The name for your Cases domain. It must be unique for your Amazon Web Services account.
" + } + } + }, + "CreateDomainResponse":{ + "type":"structure", + "required":[ + "domainArn", + "domainId", + "domainStatus" + ], + "members":{ + "domainArn":{ + "shape":"DomainArn", + "documentation":"The Amazon Resource Name (ARN) for the Cases domain.
" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
" + }, + "domainStatus":{ + "shape":"DomainStatus", + "documentation":"The status of the domain.
" + } + } + }, + "CreateFieldRequest":{ + "type":"structure", + "required":[ + "domainId", + "name", + "type" + ], + "members":{ + "description":{ + "shape":"FieldDescription", + "documentation":"The description of the field.
" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "name":{ + "shape":"FieldName", + "documentation":"The name of the field.
" + }, + "type":{ + "shape":"FieldType", + "documentation":"Defines the data type, some system constraints, and default display of the field.
" + } + } + }, + "CreateFieldResponse":{ + "type":"structure", + "required":[ + "fieldArn", + "fieldId" + ], + "members":{ + "fieldArn":{ + "shape":"FieldArn", + "documentation":"The Amazon Resource Name (ARN) of the field.
" + }, + "fieldId":{ + "shape":"FieldId", + "documentation":"The unique identifier of a field.
" + } + } + }, + "CreateLayoutRequest":{ + "type":"structure", + "required":[ + "content", + "domainId", + "name" + ], + "members":{ + "content":{ + "shape":"LayoutContent", + "documentation":"Information about which fields will be present in the layout, and information about the order of the fields.
" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "name":{ + "shape":"LayoutName", + "documentation":"The name of the layout. It must be unique for the Cases domain.
" + } + } + }, + "CreateLayoutResponse":{ + "type":"structure", + "required":[ + "layoutArn", + "layoutId" + ], + "members":{ + "layoutArn":{ + "shape":"LayoutArn", + "documentation":"The Amazon Resource Name (ARN) of the newly created layout.
" + }, + "layoutId":{ + "shape":"LayoutId", + "documentation":"The unique identifier of the layout.
" + } + } + }, + "CreateRelatedItemRequest":{ + "type":"structure", + "required":[ + "caseId", + "content", + "domainId", + "type" + ], + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"A unique identifier of the case.
", + "location":"uri", + "locationName":"caseId" + }, + "content":{ + "shape":"RelatedItemInputContent", + "documentation":"The content of a related item to be created.
" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "performedBy":{ + "shape":"UserUnion", + "documentation":"Represents the creator of the related item.
" + }, + "type":{ + "shape":"RelatedItemType", + "documentation":"The type of a related item.
" + } + } + }, + "CreateRelatedItemResponse":{ + "type":"structure", + "required":[ + "relatedItemArn", + "relatedItemId" + ], + "members":{ + "relatedItemArn":{ + "shape":"RelatedItemArn", + "documentation":"The Amazon Resource Name (ARN) of the related item.
" + }, + "relatedItemId":{ + "shape":"RelatedItemId", + "documentation":"The unique identifier of the related item.
" + } + } + }, + "CreateTemplateRequest":{ + "type":"structure", + "required":[ + "domainId", + "name" + ], + "members":{ + "description":{ + "shape":"TemplateDescription", + "documentation":"A brief description of the template.
" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "layoutConfiguration":{ + "shape":"LayoutConfiguration", + "documentation":"Configuration of layouts associated to the template.
" + }, + "name":{ + "shape":"TemplateName", + "documentation":"A name for the template. It must be unique per domain.
" + }, + "requiredFields":{ + "shape":"RequiredFieldList", + "documentation":"A list of fields that must contain a value for a case to be successfully created with this template.
" + }, + "status":{ + "shape":"TemplateStatus", + "documentation":"The status of the template.
" + } + } + }, + "CreateTemplateResponse":{ + "type":"structure", + "required":[ + "templateArn", + "templateId" + ], + "members":{ + "templateArn":{ + "shape":"TemplateArn", + "documentation":"The Amazon Resource Name (ARN) of the newly created template.
" + }, + "templateId":{ + "shape":"TemplateId", + "documentation":"A unique identifier of a template.
" + } + } + }, + "CreatedTime":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "DeleteDomainRequest":{ + "type":"structure", + "required":["domainId"], + "members":{ + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + } + } + }, + "DeleteDomainResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteFieldRequest":{ + "type":"structure", + "required":[ + "domainId", + "fieldId" + ], + "members":{ + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "fieldId":{ + "shape":"FieldId", + "documentation":"Unique identifier of the field.
", + "location":"uri", + "locationName":"fieldId" + } + } + }, + "DeleteFieldResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteLayoutRequest":{ + "type":"structure", + "required":[ + "domainId", + "layoutId" + ], + "members":{ + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "layoutId":{ + "shape":"LayoutId", + "documentation":"The unique identifier of the layout.
", + "location":"uri", + "locationName":"layoutId" + } + } + }, + "DeleteLayoutResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteTemplateRequest":{ + "type":"structure", + "required":[ + "domainId", + "templateId" + ], + "members":{ + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "templateId":{ + "shape":"TemplateId", + "documentation":"A unique identifier of a template.
", + "location":"uri", + "locationName":"templateId" + } + } + }, + "DeleteTemplateResponse":{ + "type":"structure", + "members":{ + } + }, + "Deleted":{"type":"boolean"}, + "DomainArn":{ + "type":"string", + "max":500, + "min":1 + }, + "DomainId":{ + "type":"string", + "max":500, + "min":1 + }, + "DomainName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^.*[\\S]$" + }, + "DomainStatus":{ + "type":"string", + "enum":[ + "Active", + "CreationInProgress", + "CreationFailed" + ] + }, + "DomainSummary":{ + "type":"structure", + "required":[ + "domainArn", + "domainId", + "name" + ], + "members":{ + "domainArn":{ + "shape":"DomainArn", + "documentation":"The Amazon Resource Name (ARN) of the domain.
" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the domain.
" + }, + "name":{ + "shape":"DomainName", + "documentation":"The name of the domain.
" + } + }, + "documentation":"Object for the summarized details of the domain.
" + }, + "DomainSummaryList":{ + "type":"list", + "member":{"shape":"DomainSummary"} + }, + "Double":{ + "type":"double", + "box":true + }, + "EmptyFieldValue":{ + "type":"structure", + "members":{ + }, + "documentation":"An empty value. You cannot set EmptyFieldValue on a field that is required on a case template.
This structure will never have any data members. It signifies an empty value on a case field.
" + }, + "EventBridgeConfiguration":{ + "type":"structure", + "required":["enabled"], + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"Indicates whether the to broadcast case event data to the customer.
" + }, + "includedData":{ + "shape":"EventIncludedData", + "documentation":"Details of what case and related item data is published through the case event stream.
" + } + }, + "documentation":"Configuration to enable EventBridge case event delivery and determine what data is delivered.
" + }, + "EventIncludedData":{ + "type":"structure", + "members":{ + "caseData":{ + "shape":"CaseEventIncludedData", + "documentation":"Details of what case data is published through the case event stream.
" + }, + "relatedItemData":{ + "shape":"RelatedItemEventIncludedData", + "documentation":"Details of what related item data is published through the case event stream.
" + } + }, + "documentation":"Details of what case and related item data is published through the case event stream.
" + }, + "FieldArn":{ + "type":"string", + "max":500, + "min":1 + }, + "FieldDescription":{ + "type":"string", + "max":255, + "min":0 + }, + "FieldError":{ + "type":"structure", + "required":[ + "errorCode", + "id" + ], + "members":{ + "errorCode":{ + "shape":"String", + "documentation":"The error code from getting a field.
" + }, + "id":{ + "shape":"FieldId", + "documentation":"The field identifier that caused the error.
" + }, + "message":{ + "shape":"String", + "documentation":"The error message from getting a field.
" + } + }, + "documentation":"Object for errors on fields.
" + }, + "FieldFilter":{ + "type":"structure", + "members":{ + "contains":{ + "shape":"FieldValue", + "documentation":"Object containing field identifier and value information.
" + }, + "equalTo":{ + "shape":"FieldValue", + "documentation":"Object containing field identifier and value information.
" + }, + "greaterThan":{ + "shape":"FieldValue", + "documentation":"Object containing field identifier and value information.
" + }, + "greaterThanOrEqualTo":{ + "shape":"FieldValue", + "documentation":"Object containing field identifier and value information.
" + }, + "lessThan":{ + "shape":"FieldValue", + "documentation":"Object containing field identifier and value information.
" + }, + "lessThanOrEqualTo":{ + "shape":"FieldValue", + "documentation":"Object containing field identifier and value information.
" + } + }, + "documentation":"A filter for fields. Only one value can be provided.
", + "union":true + }, + "FieldGroup":{ + "type":"structure", + "required":["fields"], + "members":{ + "fields":{ + "shape":"FieldGroupFieldsList", + "documentation":"Represents an ordered list containing field related information.
" + }, + "name":{ + "shape":"FieldGroupNameString", + "documentation":"Name of the field group.
" + } + }, + "documentation":"Object for a group of fields and associated properties.
" + }, + "FieldGroupFieldsList":{ + "type":"list", + "member":{"shape":"FieldItem"}, + "max":100, + "min":0 + }, + "FieldGroupNameString":{ + "type":"string", + "max":100, + "min":0 + }, + "FieldId":{ + "type":"string", + "max":500, + "min":1 + }, + "FieldIdentifier":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"FieldId", + "documentation":"Unique identifier of a field.
" + } + }, + "documentation":"Object for unique identifier of a field.
" + }, + "FieldItem":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"FieldId", + "documentation":"Unique identifier of a field.
" + } + }, + "documentation":"Object for field related information.
" + }, + "FieldName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^.*[\\S]$" + }, + "FieldNamespace":{ + "type":"string", + "enum":[ + "System", + "Custom" + ] + }, + "FieldOption":{ + "type":"structure", + "required":[ + "active", + "name", + "value" + ], + "members":{ + "active":{ + "shape":"Boolean", + "documentation":"Describes whether the FieldOption is active (displayed) or inactive.
FieldOptionName has max length 100 and disallows trailing spaces.
FieldOptionValue has max length 100 and must be alphanumeric with hyphens and underscores.
Object for field Options information.
" + }, + "FieldOptionError":{ + "type":"structure", + "required":[ + "errorCode", + "message", + "value" + ], + "members":{ + "errorCode":{ + "shape":"String", + "documentation":"Error code from creating or updating field option.
" + }, + "message":{ + "shape":"String", + "documentation":"Error message from creating or updating field option.
" + }, + "value":{ + "shape":"FieldOptionValue", + "documentation":"The field option value that caused the error.
" + } + }, + "documentation":"Object for field Options errors.
" + }, + "FieldOptionName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^.*[\\S]$" + }, + "FieldOptionValue":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^.*[\\S]$" + }, + "FieldOptionsList":{ + "type":"list", + "member":{"shape":"FieldOption"} + }, + "FieldSummary":{ + "type":"structure", + "required":[ + "fieldArn", + "fieldId", + "name", + "namespace", + "type" + ], + "members":{ + "fieldArn":{ + "shape":"FieldArn", + "documentation":"The Amazon Resource Name (ARN) of the field.
" + }, + "fieldId":{ + "shape":"FieldId", + "documentation":"The unique identifier of a field.
" + }, + "name":{ + "shape":"FieldName", + "documentation":"Name of the field.
" + }, + "namespace":{ + "shape":"FieldNamespace", + "documentation":"The namespace of a field.
" + }, + "type":{ + "shape":"FieldType", + "documentation":"The type of a field.
" + } + }, + "documentation":"Object for the summarized details of the field.
" + }, + "FieldType":{ + "type":"string", + "enum":[ + "Text", + "Number", + "Boolean", + "DateTime", + "SingleSelect", + "Url", + "User" + ] + }, + "FieldValue":{ + "type":"structure", + "required":[ + "id", + "value" + ], + "members":{ + "id":{ + "shape":"FieldId", + "documentation":"Unique identifier of a field.
" + }, + "value":{ + "shape":"FieldValueUnion", + "documentation":"Union of potential field value types.
" + } + }, + "documentation":"Object for case field values.
" + }, + "FieldValueUnion":{ + "type":"structure", + "members":{ + "booleanValue":{ + "shape":"Boolean", + "documentation":"Can be either null, or have a Boolean value type. Only one value can be provided.
" + }, + "doubleValue":{ + "shape":"Double", + "documentation":"Can be either null, or have a Double number value type. Only one value can be provided.
" + }, + "emptyValue":{ + "shape":"EmptyFieldValue", + "documentation":"An empty value.
" + }, + "stringValue":{ + "shape":"FieldValueUnionStringValueString", + "documentation":"String value type.
" + }, + "userArnValue":{ + "shape":"String", + "documentation":"Represents the user that performed the audit.
" + } + }, + "documentation":"Object to store union of Field values.
The Summary system field accepts 1500 characters while all other fields accept 500 characters.
The Amazon Resource Name (ARN) of a File in Amazon Connect.
" + } + }, + "documentation":"An object that represents a content of an Amazon Connect file object.
" + }, + "FileFilter":{ + "type":"structure", + "members":{ + "fileArn":{ + "shape":"FileArn", + "documentation":"The Amazon Resource Name (ARN) of the file.
" + } + }, + "documentation":"A filter for related items of type File.
A unique identifier of the case.
", + "location":"uri", + "locationName":"caseId" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "maxResults":{ + "shape":"GetCaseAuditEventsRequestMaxResultsInteger", + "documentation":"The maximum number of audit events to return. The current maximum supported value is 25. This is also the default when no other value is provided.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
" + } + } + }, + "GetCaseAuditEventsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":25, + "min":1 + }, + "GetCaseAuditEventsResponse":{ + "type":"structure", + "required":["auditEvents"], + "members":{ + "auditEvents":{ + "shape":"GetCaseAuditEventsResponseAuditEventsList", + "documentation":"A list of case audits where each represents a particular edit of the case.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. This is null if there are no more results to return.
" + } + } + }, + "GetCaseAuditEventsResponseAuditEventsList":{ + "type":"list", + "member":{"shape":"AuditEvent"}, + "max":25, + "min":0 + }, + "GetCaseEventConfigurationRequest":{ + "type":"structure", + "required":["domainId"], + "members":{ + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + } + } + }, + "GetCaseEventConfigurationResponse":{ + "type":"structure", + "required":["eventBridge"], + "members":{ + "eventBridge":{ + "shape":"EventBridgeConfiguration", + "documentation":"Configuration to enable EventBridge case event delivery and determine what data is delivered.
" + } + } + }, + "GetCaseRequest":{ + "type":"structure", + "required":[ + "caseId", + "domainId", + "fields" + ], + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"A unique identifier of the case.
", + "location":"uri", + "locationName":"caseId" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "fields":{ + "shape":"GetCaseRequestFieldsList", + "documentation":"A list of unique field identifiers.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
" + } + } + }, + "GetCaseRequestFieldsList":{ + "type":"list", + "member":{"shape":"FieldIdentifier"}, + "max":100, + "min":1 + }, + "GetCaseResponse":{ + "type":"structure", + "required":[ + "fields", + "templateId" + ], + "members":{ + "fields":{ + "shape":"GetCaseResponseFieldsList", + "documentation":"A list of detailed field information.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. This is null if there are no more results to return.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" + }, + "templateId":{ + "shape":"TemplateId", + "documentation":"A unique identifier of a template.
" + } + } + }, + "GetCaseResponseFieldsList":{ + "type":"list", + "member":{"shape":"FieldValue"}, + "max":100, + "min":0 + }, + "GetDomainRequest":{ + "type":"structure", + "required":["domainId"], + "members":{ + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + } + } + }, + "GetDomainResponse":{ + "type":"structure", + "required":[ + "createdTime", + "domainArn", + "domainId", + "domainStatus", + "name" + ], + "members":{ + "createdTime":{ + "shape":"CreatedTime", + "documentation":"The timestamp when the Cases domain was created.
" + }, + "domainArn":{ + "shape":"DomainArn", + "documentation":"The Amazon Resource Name (ARN) for the Cases domain.
" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
" + }, + "domainStatus":{ + "shape":"DomainStatus", + "documentation":"The status of the Cases domain.
" + }, + "name":{ + "shape":"DomainName", + "documentation":"The name of the Cases domain.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" + } + } + }, + "GetFieldResponse":{ + "type":"structure", + "required":[ + "fieldArn", + "fieldId", + "name", + "namespace", + "type" + ], + "members":{ + "createdTime":{ + "shape":"CreatedTime", + "documentation":"Timestamp at which the resource was created.
" + }, + "deleted":{ + "shape":"Deleted", + "documentation":"Denotes whether or not the resource has been deleted.
" + }, + "description":{ + "shape":"FieldDescription", + "documentation":"Description of the field.
" + }, + "fieldArn":{ + "shape":"FieldArn", + "documentation":"The Amazon Resource Name (ARN) of the field.
" + }, + "fieldId":{ + "shape":"FieldId", + "documentation":"Unique identifier of the field.
" + }, + "lastModifiedTime":{ + "shape":"LastModifiedTime", + "documentation":"Timestamp at which the resource was created or last modified.
" + }, + "name":{ + "shape":"FieldName", + "documentation":"Name of the field.
" + }, + "namespace":{ + "shape":"FieldNamespace", + "documentation":"Namespace of the field.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" + }, + "type":{ + "shape":"FieldType", + "documentation":"Type of the field.
" + } + }, + "documentation":"Object to store detailed field information.
" + }, + "GetLayoutRequest":{ + "type":"structure", + "required":[ + "domainId", + "layoutId" + ], + "members":{ + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "layoutId":{ + "shape":"LayoutId", + "documentation":"The unique identifier of the layout.
", + "location":"uri", + "locationName":"layoutId" + } + } + }, + "GetLayoutResponse":{ + "type":"structure", + "required":[ + "content", + "layoutArn", + "layoutId", + "name" + ], + "members":{ + "content":{ + "shape":"LayoutContent", + "documentation":"Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.
" + }, + "createdTime":{ + "shape":"CreatedTime", + "documentation":"Timestamp at which the resource was created.
" + }, + "deleted":{ + "shape":"Deleted", + "documentation":"Denotes whether or not the resource has been deleted.
" + }, + "lastModifiedTime":{ + "shape":"LastModifiedTime", + "documentation":"Timestamp at which the resource was created or last modified.
" + }, + "layoutArn":{ + "shape":"LayoutArn", + "documentation":"The Amazon Resource Name (ARN) of the newly created layout.
" + }, + "layoutId":{ + "shape":"LayoutId", + "documentation":"The unique identifier of the layout.
" + }, + "name":{ + "shape":"LayoutName", + "documentation":"The name of the layout. It must be unique.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" + } + } + }, + "GetTemplateRequest":{ + "type":"structure", + "required":[ + "domainId", + "templateId" + ], + "members":{ + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "templateId":{ + "shape":"TemplateId", + "documentation":"A unique identifier of a template.
", + "location":"uri", + "locationName":"templateId" + } + } + }, + "GetTemplateResponse":{ + "type":"structure", + "required":[ + "name", + "status", + "templateArn", + "templateId" + ], + "members":{ + "createdTime":{ + "shape":"CreatedTime", + "documentation":"Timestamp at which the resource was created.
" + }, + "deleted":{ + "shape":"Deleted", + "documentation":"Denotes whether or not the resource has been deleted.
" + }, + "description":{ + "shape":"TemplateDescription", + "documentation":"A brief description of the template.
" + }, + "lastModifiedTime":{ + "shape":"LastModifiedTime", + "documentation":"Timestamp at which the resource was created or last modified.
" + }, + "layoutConfiguration":{ + "shape":"LayoutConfiguration", + "documentation":"Configuration of layouts associated to the template.
" + }, + "name":{ + "shape":"TemplateName", + "documentation":"The name of the template.
" + }, + "requiredFields":{ + "shape":"RequiredFieldList", + "documentation":"A list of fields that must contain a value for a case to be successfully created with this template.
" + }, + "status":{ + "shape":"TemplateStatus", + "documentation":"The status of the template.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" + }, + "templateArn":{ + "shape":"TemplateArn", + "documentation":"The Amazon Resource Name (ARN) of the template.
" + }, + "templateId":{ + "shape":"TemplateId", + "documentation":"A unique identifier of a template.
" + } + } + }, + "IamPrincipalArn":{ + "type":"string", + "max":500, + "min":1 + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "retryAfterSeconds":{ + "shape":"Integer", + "documentation":"Advice to clients on when the call can be safely retried.
", + "location":"header", + "locationName":"Retry-After" + } + }, + "documentation":"We couldn't process your request because of an issue with the server. Try again later.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "LastModifiedTime":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "LayoutArn":{ + "type":"string", + "max":500, + "min":1 + }, + "LayoutConfiguration":{ + "type":"structure", + "members":{ + "defaultLayout":{ + "shape":"LayoutId", + "documentation":"Unique identifier of a layout.
" + } + }, + "documentation":"Object to store configuration of layouts associated to the template.
" + }, + "LayoutContent":{ + "type":"structure", + "members":{ + "basic":{ + "shape":"BasicLayout", + "documentation":"Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of Cases user interface.
Object to store union of different versions of layout content.
", + "union":true + }, + "LayoutId":{ + "type":"string", + "max":500, + "min":1 + }, + "LayoutName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^.*[\\S]$" + }, + "LayoutSections":{ + "type":"structure", + "members":{ + "sections":{"shape":"SectionsList"} + }, + "documentation":"Ordered list containing different kinds of sections that can be added. A LayoutSections object can only contain one section.
" + }, + "LayoutSummary":{ + "type":"structure", + "required":[ + "layoutArn", + "layoutId", + "name" + ], + "members":{ + "layoutArn":{ + "shape":"LayoutArn", + "documentation":"The Amazon Resource Name (ARN) of the layout.
" + }, + "layoutId":{ + "shape":"LayoutId", + "documentation":"The unique identifier for of the layout.
" + }, + "name":{ + "shape":"LayoutName", + "documentation":"The name of the layout.
" + } + }, + "documentation":"Object for the summarized details of the layout.
" + }, + "LayoutSummaryList":{ + "type":"list", + "member":{"shape":"LayoutSummary"} + }, + "ListCasesForContactRequest":{ + "type":"structure", + "required":[ + "contactArn", + "domainId" + ], + "members":{ + "contactArn":{ + "shape":"ContactArn", + "documentation":"A unique identifier of a contact in Amazon Connect.
" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "maxResults":{ + "shape":"ListCasesForContactRequestMaxResultsInteger", + "documentation":"The maximum number of results to return per page.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
" + } + } + }, + "ListCasesForContactRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, + "ListCasesForContactResponse":{ + "type":"structure", + "required":["cases"], + "members":{ + "cases":{ + "shape":"ListCasesForContactResponseCasesList", + "documentation":"A list of Case summary information.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. This is null if there are no more results to return.
" + } + } + }, + "ListCasesForContactResponseCasesList":{ + "type":"list", + "member":{"shape":"CaseSummary"}, + "max":10, + "min":0 + }, + "ListDomainsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListDomainsRequestMaxResultsInteger", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListDomainsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, + "ListDomainsResponse":{ + "type":"structure", + "required":["domains"], + "members":{ + "domains":{ + "shape":"DomainSummaryList", + "documentation":"The Cases domain.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. This is null if there are no more results to return.
" + } + } + }, + "ListFieldOptionsRequest":{ + "type":"structure", + "required":[ + "domainId", + "fieldId" + ], + "members":{ + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "fieldId":{ + "shape":"FieldId", + "documentation":"The unique identifier of a field.
", + "location":"uri", + "locationName":"fieldId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + }, + "values":{ + "shape":"ValuesList", + "documentation":"A list of FieldOption values to filter on for ListFieldOptions.
The token for the next set of results. This is null if there are no more results to return.
" + }, + "options":{ + "shape":"FieldOptionsList", + "documentation":"A list of FieldOption objects.
The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListFieldsResponse":{ + "type":"structure", + "required":["fields"], + "members":{ + "fields":{ + "shape":"ListFieldsResponseFieldsList", + "documentation":"List of detailed field information.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. This is null if there are no more results to return.
" + } + } + }, + "ListFieldsResponseFieldsList":{ + "type":"list", + "member":{"shape":"FieldSummary"}, + "max":100, + "min":0 + }, + "ListLayoutsRequest":{ + "type":"structure", + "required":["domainId"], + "members":{ + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListLayoutsResponse":{ + "type":"structure", + "required":["layouts"], + "members":{ + "layouts":{ + "shape":"LayoutSummaryList", + "documentation":"The layouts for the domain.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. This is null if there are no more results to return.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN)
", + "location":"uri", + "locationName":"arn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"Tags", + "documentation":"A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" + } + } + }, + "ListTemplatesRequest":{ + "type":"structure", + "required":["domainId"], + "members":{ + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + }, + "status":{ + "shape":"TemplateStatusFilters", + "documentation":"A list of status values to filter on.
", + "location":"querystring", + "locationName":"status" + } + } + }, + "ListTemplatesResponse":{ + "type":"structure", + "required":["templates"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. This is null if there are no more results to return.
" + }, + "templates":{ + "shape":"ListTemplatesResponseTemplatesList", + "documentation":"List of template summary objects.
" + } + } + }, + "ListTemplatesResponseTemplatesList":{ + "type":"list", + "member":{"shape":"TemplateSummary"}, + "max":100, + "min":0 + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "NextToken":{ + "type":"string", + "max":9000, + "min":0 + }, + "Order":{ + "type":"string", + "enum":[ + "Asc", + "Desc" + ] + }, + "PutCaseEventConfigurationRequest":{ + "type":"structure", + "required":[ + "domainId", + "eventBridge" + ], + "members":{ + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "eventBridge":{ + "shape":"EventBridgeConfiguration", + "documentation":"Configuration to enable EventBridge case event delivery and determine what data is delivered.
" + } + } + }, + "PutCaseEventConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "RelatedItemArn":{ + "type":"string", + "max":500, + "min":1 + }, + "RelatedItemContent":{ + "type":"structure", + "members":{ + "comment":{ + "shape":"CommentContent", + "documentation":"Represents the content of a comment to be returned to agents.
" + }, + "contact":{ + "shape":"ContactContent", + "documentation":"Represents the content of a contact to be returned to agents.
" + }, + "file":{ + "shape":"FileContent", + "documentation":"Represents the content of a File to be returned to agents.
" + } + }, + "documentation":"Represents the content of a particular type of related item.
", + "union":true + }, + "RelatedItemEventIncludedData":{ + "type":"structure", + "required":["includeContent"], + "members":{ + "includeContent":{ + "shape":"Boolean", + "documentation":"Details of what related item data is published through the case event stream.
" + } + }, + "documentation":"Details of what related item data is published through the case event stream.
" + }, + "RelatedItemId":{ + "type":"string", + "max":500, + "min":1 + }, + "RelatedItemInputContent":{ + "type":"structure", + "members":{ + "comment":{ + "shape":"CommentContent", + "documentation":"Represents the content of a comment to be returned to agents.
" + }, + "contact":{ + "shape":"Contact", + "documentation":"Object representing a contact in Amazon Connect as an API request field.
" + }, + "file":{ + "shape":"FileContent", + "documentation":"A file of related items.
" + } + }, + "documentation":"Represents the content of a related item to be created.
", + "union":true + }, + "RelatedItemType":{ + "type":"string", + "enum":[ + "Contact", + "Comment", + "File" + ] + }, + "RelatedItemTypeFilter":{ + "type":"structure", + "members":{ + "comment":{ + "shape":"CommentFilter", + "documentation":"A filter for related items of type Comment.
A filter for related items of type Contact.
A filter for related items of this type of File.
The list of types of related items and their parameters to use for filtering.
", + "union":true + }, + "RequiredField":{ + "type":"structure", + "required":["fieldId"], + "members":{ + "fieldId":{ + "shape":"FieldId", + "documentation":"Unique identifier of a field.
" + } + }, + "documentation":"List of fields that must have a value provided to create a case.
" + }, + "RequiredFieldList":{ + "type":"list", + "member":{"shape":"RequiredField"}, + "max":100, + "min":0 + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{"shape":"String"}, + "resourceId":{ + "shape":"String", + "documentation":"Unique identifier of the resource affected.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"Type of the resource affected.
" + } + }, + "documentation":"We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SearchCasesRequest":{ + "type":"structure", + "required":["domainId"], + "members":{ + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "fields":{ + "shape":"SearchCasesRequestFieldsList", + "documentation":"The list of field identifiers to be returned as part of the response.
" + }, + "filter":{ + "shape":"CaseFilter", + "documentation":"A list of filter objects.
" + }, + "maxResults":{ + "shape":"SearchCasesRequestMaxResultsInteger", + "documentation":"The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
" + }, + "searchTerm":{ + "shape":"SearchCasesRequestSearchTermString", + "documentation":"A word or phrase used to perform a quick search.
" + }, + "sorts":{ + "shape":"SearchCasesRequestSortsList", + "documentation":"A list of sorts where each sort specifies a field and their sort order to be applied to the results.
" + } + } + }, + "SearchCasesRequestFieldsList":{ + "type":"list", + "member":{"shape":"FieldIdentifier"}, + "max":10, + "min":0 + }, + "SearchCasesRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":25, + "min":1 + }, + "SearchCasesRequestSearchTermString":{ + "type":"string", + "max":255, + "min":0 + }, + "SearchCasesRequestSortsList":{ + "type":"list", + "member":{"shape":"Sort"}, + "max":2, + "min":0 + }, + "SearchCasesResponse":{ + "type":"structure", + "required":["cases"], + "members":{ + "cases":{ + "shape":"SearchCasesResponseCasesList", + "documentation":"A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.
The token for the next set of results. This is null if there are no more results to return.
" + } + } + }, + "SearchCasesResponseCasesList":{ + "type":"list", + "member":{"shape":"SearchCasesResponseItem"}, + "max":25, + "min":0 + }, + "SearchCasesResponseItem":{ + "type":"structure", + "required":[ + "caseId", + "fields", + "templateId" + ], + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"A unique identifier of the case.
" + }, + "fields":{ + "shape":"SearchCasesResponseItemFieldsList", + "documentation":"List of case field values.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" + }, + "templateId":{ + "shape":"TemplateId", + "documentation":"A unique identifier of a template.
" + } + }, + "documentation":"A list of items that represent cases.
" + }, + "SearchCasesResponseItemFieldsList":{ + "type":"list", + "member":{"shape":"FieldValue"}, + "max":10, + "min":0 + }, + "SearchRelatedItemsRequest":{ + "type":"structure", + "required":[ + "caseId", + "domainId" + ], + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"A unique identifier of the case.
", + "location":"uri", + "locationName":"caseId" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "filters":{ + "shape":"SearchRelatedItemsRequestFiltersList", + "documentation":"The list of types of related items and their parameters to use for filtering.
" + }, + "maxResults":{ + "shape":"SearchRelatedItemsRequestMaxResultsInteger", + "documentation":"The maximum number of results to return per page.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
" + } + } + }, + "SearchRelatedItemsRequestFiltersList":{ + "type":"list", + "member":{"shape":"RelatedItemTypeFilter"}, + "max":10, + "min":0 + }, + "SearchRelatedItemsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":25, + "min":1 + }, + "SearchRelatedItemsResponse":{ + "type":"structure", + "required":["relatedItems"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. This is null if there are no more results to return.
" + }, + "relatedItems":{ + "shape":"SearchRelatedItemsResponseRelatedItemsList", + "documentation":"A list of items related to a case.
" + } + } + }, + "SearchRelatedItemsResponseItem":{ + "type":"structure", + "required":[ + "associationTime", + "content", + "relatedItemId", + "type" + ], + "members":{ + "associationTime":{ + "shape":"AssociationTime", + "documentation":"Time at which a related item was associated with a case.
" + }, + "content":{ + "shape":"RelatedItemContent", + "documentation":"Represents the content of a particular type of related item.
" + }, + "performedBy":{ + "shape":"UserUnion", + "documentation":"Represents the creator of the related item.
" + }, + "relatedItemId":{ + "shape":"RelatedItemId", + "documentation":"Unique identifier of a related item.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" + }, + "type":{ + "shape":"RelatedItemType", + "documentation":"Type of a related item.
" + } + }, + "documentation":"A list of items that represent RelatedItems.
" + }, + "SearchRelatedItemsResponseRelatedItemsList":{ + "type":"list", + "member":{"shape":"SearchRelatedItemsResponseItem"}, + "max":25, + "min":0 + }, + "Section":{ + "type":"structure", + "members":{ + "fieldGroup":{ + "shape":"FieldGroup", + "documentation":"Consists of a group of fields and associated properties.
" + } + }, + "documentation":"This represents a sections within a panel or tab of the page layout.
", + "union":true + }, + "SectionsList":{ + "type":"list", + "member":{"shape":"Section"}, + "documentation":"Ordered list containing different kinds of sections that can be added.
", + "max":1, + "min":0 + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "Sort":{ + "type":"structure", + "required":[ + "fieldId", + "sortOrder" + ], + "members":{ + "fieldId":{ + "shape":"FieldId", + "documentation":"Unique identifier of a field.
" + }, + "sortOrder":{ + "shape":"Order", + "documentation":"A structured set of sort terms
" + } + }, + "documentation":"A structured set of sort terms.
" + }, + "String":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "arn", + "tags" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN)
", + "location":"uri", + "locationName":"arn" + }, + "tags":{ + "shape":"Tags", + "documentation":"A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" + } + } + }, + "Tags":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "TemplateArn":{ + "type":"string", + "max":500, + "min":1 + }, + "TemplateDescription":{ + "type":"string", + "max":255, + "min":0 + }, + "TemplateId":{ + "type":"string", + "max":500, + "min":1 + }, + "TemplateName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^.*[\\S]$" + }, + "TemplateStatus":{ + "type":"string", + "enum":[ + "Active", + "Inactive" + ] + }, + "TemplateStatusFilters":{ + "type":"list", + "member":{"shape":"TemplateStatus"}, + "max":2, + "min":1 + }, + "TemplateSummary":{ + "type":"structure", + "required":[ + "name", + "status", + "templateArn", + "templateId" + ], + "members":{ + "name":{ + "shape":"TemplateName", + "documentation":"The template name.
" + }, + "status":{ + "shape":"TemplateStatus", + "documentation":"The status of the template.
" + }, + "templateArn":{ + "shape":"TemplateArn", + "documentation":"The Amazon Resource Name (ARN) of the template.
" + }, + "templateId":{ + "shape":"TemplateId", + "documentation":"The unique identifier for the template.
" + } + }, + "documentation":"Template summary information.
" + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The rate has been exceeded for this API. Please try again after a few minutes.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":false} + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "arn", + "tagKeys" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN)
", + "location":"uri", + "locationName":"arn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"List of tag keys.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UpdateCaseRequest":{ + "type":"structure", + "required":[ + "caseId", + "domainId", + "fields" + ], + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"A unique identifier of the case.
", + "location":"uri", + "locationName":"caseId" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "fields":{ + "shape":"UpdateCaseRequestFieldsList", + "documentation":"An array of objects with fieldId (matching ListFields/DescribeField) and value union data, structured identical to CreateCase.
The description of a field.
" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "fieldId":{ + "shape":"FieldId", + "documentation":"The unique identifier of a field.
", + "location":"uri", + "locationName":"fieldId" + }, + "name":{ + "shape":"FieldName", + "documentation":"The name of the field.
" + } + } + }, + "UpdateFieldResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateLayoutRequest":{ + "type":"structure", + "required":[ + "domainId", + "layoutId" + ], + "members":{ + "content":{ + "shape":"LayoutContent", + "documentation":"Information about which fields will be present in the layout, the order of the fields.
" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "layoutId":{ + "shape":"LayoutId", + "documentation":"The unique identifier of the layout.
", + "location":"uri", + "locationName":"layoutId" + }, + "name":{ + "shape":"LayoutName", + "documentation":"The name of the layout. It must be unique per domain.
" + } + } + }, + "UpdateLayoutResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateTemplateRequest":{ + "type":"structure", + "required":[ + "domainId", + "templateId" + ], + "members":{ + "description":{ + "shape":"TemplateDescription", + "documentation":"A brief description of the template.
" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"The unique identifier of the Cases domain.
", + "location":"uri", + "locationName":"domainId" + }, + "layoutConfiguration":{ + "shape":"LayoutConfiguration", + "documentation":"Configuration of layouts associated to the template.
" + }, + "name":{ + "shape":"TemplateName", + "documentation":"The name of the template. It must be unique per domain.
" + }, + "requiredFields":{ + "shape":"RequiredFieldList", + "documentation":"A list of fields that must contain a value for a case to be successfully created with this template.
" + }, + "status":{ + "shape":"TemplateStatus", + "documentation":"The status of the template.
" + }, + "templateId":{ + "shape":"TemplateId", + "documentation":"A unique identifier for the template.
", + "location":"uri", + "locationName":"templateId" + } + } + }, + "UpdateTemplateResponse":{ + "type":"structure", + "members":{ + } + }, + "UserArn":{ + "type":"string", + "max":500, + "min":1 + }, + "UserUnion":{ + "type":"structure", + "members":{ + "userArn":{ + "shape":"UserArn", + "documentation":"Represents the Amazon Connect ARN of the user.
" + } + }, + "documentation":"Represents the identity of the person who performed the action.
", + "union":true + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request isn't valid. Check the syntax and try again.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Value":{ + "type":"string", + "max":100, + "min":0 + }, + "ValuesList":{ + "type":"list", + "member":{"shape":"Value"}, + "max":1, + "min":0 + } + }, + "documentation":"With Amazon Connect Cases, your agents can track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. A case represents a customer issue. It records the issue, the steps and interactions taken to resolve the issue, and the outcome. For more information, see Amazon Connect Cases in the Amazon Connect Administrator Guide.
" +} diff --git a/testbed/boto__botocore/botocore/data/controlcatalog/2018-05-10/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/controlcatalog/2018-05-10/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..11d979e06155abd00f90d83a0ac70b79918c0b9e --- /dev/null +++ b/testbed/boto__botocore/botocore/data/controlcatalog/2018-05-10/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlcatalog-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlcatalog-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlcatalog.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlcatalog.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/controlcatalog/2018-05-10/service-2.json b/testbed/boto__botocore/botocore/data/controlcatalog/2018-05-10/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..5dc6c918de2e79c2f013fbb353df89cc0c6b7d3b --- /dev/null +++ b/testbed/boto__botocore/botocore/data/controlcatalog/2018-05-10/service-2.json @@ -0,0 +1,659 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-05-10", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"controlcatalog", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"AWS Control Catalog", + "serviceId":"ControlCatalog", + "signatureVersion":"v4", + "signingName":"controlcatalog", + "uid":"controlcatalog-2018-05-10" + }, + "operations":{ + "GetControl":{ + "name":"GetControl", + "http":{ + "method":"POST", + "requestUri":"/get-control", + "responseCode":200 + }, + "input":{"shape":"GetControlRequest"}, + "output":{"shape":"GetControlResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported. Input a value for the ControlArn parameter, in ARN form. GetControl accepts controltower or controlcatalog control ARNs as input. Returns a controlcatalog ARN format.
In the API response, controls that have the value GLOBAL in the Scope field do not show the DeployableRegions field, because it does not apply. Controls that have the value REGIONAL in the Scope field return a value for the DeployableRegions field, as shown in the example.
Returns a paginated list of common controls from the Amazon Web Services Control Catalog.
You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls.
" + }, + "ListControls":{ + "name":"ListControls", + "http":{ + "method":"POST", + "requestUri":"/list-controls", + "responseCode":200 + }, + "input":{"shape":"ListControlsRequest"}, + "output":{"shape":"ListControlsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a paginated list of all available controls in the Amazon Web Services Control Catalog library. Allows you to discover available controls. The list of controls is given as structures of type controlSummary. The ARN is returned in the global controlcatalog format, as shown in the examples.
" + }, + "ListDomains":{ + "name":"ListDomains", + "http":{ + "method":"POST", + "requestUri":"/domains", + "responseCode":200 + }, + "input":{"shape":"ListDomainsRequest"}, + "output":{"shape":"ListDomainsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a paginated list of domains from the Amazon Web Services Control Catalog.
" + }, + "ListObjectives":{ + "name":"ListObjectives", + "http":{ + "method":"POST", + "requestUri":"/objectives", + "responseCode":200 + }, + "input":{"shape":"ListObjectivesRequest"}, + "output":{"shape":"ListObjectivesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a paginated list of objectives from the Amazon Web Services Control Catalog.
You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AssociatedDomainSummary":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"DomainArn", + "documentation":"The Amazon Resource Name (ARN) of the related domain.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the related domain.
" + } + }, + "documentation":"A summary of the domain that a common control or an objective belongs to.
" + }, + "AssociatedObjectiveSummary":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"ObjectiveArn", + "documentation":"The Amazon Resource Name (ARN) of the related objective.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the related objective.
" + } + }, + "documentation":"A summary of the objective that a common control supports.
" + }, + "CommonControlArn":{ + "type":"string", + "max":2048, + "min":41, + "pattern":"arn:(aws(?:[-a-z]*)?):controlcatalog:::common-control/[0-9a-z]+" + }, + "CommonControlFilter":{ + "type":"structure", + "members":{ + "Objectives":{ + "shape":"ObjectiveResourceFilterList", + "documentation":"The objective that's used as filter criteria.
You can use this parameter to specify one objective ARN at a time. Passing multiple ARNs in the CommonControlFilter isn’t currently supported.
An optional filter that narrows the results to a specific objective.
" + }, + "CommonControlSummary":{ + "type":"structure", + "required":[ + "Arn", + "Name", + "Description", + "Domain", + "Objective", + "CreateTime", + "LastUpdateTime" + ], + "members":{ + "Arn":{ + "shape":"CommonControlArn", + "documentation":"The Amazon Resource Name (ARN) that identifies the common control.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the common control.
" + }, + "Description":{ + "shape":"String", + "documentation":"The description of the common control.
" + }, + "Domain":{ + "shape":"AssociatedDomainSummary", + "documentation":"The domain that the common control belongs to.
" + }, + "Objective":{ + "shape":"AssociatedObjectiveSummary", + "documentation":"The objective that the common control belongs to.
" + }, + "CreateTime":{ + "shape":"Timestamp", + "documentation":"The time when the common control was created.
" + }, + "LastUpdateTime":{ + "shape":"Timestamp", + "documentation":"The time when the common control was most recently updated.
" + } + }, + "documentation":"A summary of metadata for a common control.
" + }, + "CommonControlSummaryList":{ + "type":"list", + "member":{"shape":"CommonControlSummary"} + }, + "ControlArn":{ + "type":"string", + "max":2048, + "min":34, + "pattern":"arn:(aws(?:[-a-z]*)?):(controlcatalog|controltower):[a-zA-Z0-9-]*::control/[0-9a-zA-Z_\\-]+" + }, + "ControlBehavior":{ + "type":"string", + "enum":[ + "PREVENTIVE", + "PROACTIVE", + "DETECTIVE" + ] + }, + "ControlScope":{ + "type":"string", + "enum":[ + "GLOBAL", + "REGIONAL" + ] + }, + "ControlSummary":{ + "type":"structure", + "required":[ + "Arn", + "Name", + "Description" + ], + "members":{ + "Arn":{ + "shape":"ControlArn", + "documentation":"The Amazon Resource Name (ARN) of the control.
" + }, + "Name":{ + "shape":"String", + "documentation":"The display name of the control.
" + }, + "Description":{ + "shape":"String", + "documentation":"A description of the control, as it may appear in the console. Describes the functionality of the control.
" + } + }, + "documentation":"Overview of information about a control.
" + }, + "Controls":{ + "type":"list", + "member":{"shape":"ControlSummary"} + }, + "DeployableRegions":{ + "type":"list", + "member":{"shape":"RegionCode"} + }, + "DomainArn":{ + "type":"string", + "max":2048, + "min":33, + "pattern":"arn:(aws(?:[-a-z]*)?):controlcatalog:::domain/[0-9a-z]+" + }, + "DomainResourceFilter":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"DomainArn", + "documentation":"The Amazon Resource Name (ARN) of the domain.
" + } + }, + "documentation":"The domain resource that's being used as a filter.
" + }, + "DomainResourceFilterList":{ + "type":"list", + "member":{"shape":"DomainResourceFilter"} + }, + "DomainSummary":{ + "type":"structure", + "required":[ + "Arn", + "Name", + "Description", + "CreateTime", + "LastUpdateTime" + ], + "members":{ + "Arn":{ + "shape":"DomainArn", + "documentation":"The Amazon Resource Name (ARN) that identifies the domain.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the domain.
" + }, + "Description":{ + "shape":"String", + "documentation":"The description of the domain.
" + }, + "CreateTime":{ + "shape":"Timestamp", + "documentation":"The time when the domain was created.
" + }, + "LastUpdateTime":{ + "shape":"Timestamp", + "documentation":"The time when the domain was most recently updated.
" + } + }, + "documentation":"A summary of metadata for a domain.
" + }, + "DomainSummaryList":{ + "type":"list", + "member":{"shape":"DomainSummary"} + }, + "GetControlRequest":{ + "type":"structure", + "required":["ControlArn"], + "members":{ + "ControlArn":{ + "shape":"ControlArn", + "documentation":"The Amazon Resource Name (ARN) of the control. It has one of the following formats:
Global format
arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}
Or Regional format
arn:{PARTITION}:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}
Here is a more general pattern that covers Amazon Web Services Control Tower and Control Catalog ARNs:
^arn:(aws(?:[-a-z]*)?):(controlcatalog|controltower):[a-zA-Z0-9-]*::control/[0-9a-zA-Z_\\\\-]+$
The Amazon Resource Name (ARN) of the control.
" + }, + "Name":{ + "shape":"String", + "documentation":"The display name of the control.
" + }, + "Description":{ + "shape":"String", + "documentation":"A description of what the control does.
" + }, + "Behavior":{ + "shape":"ControlBehavior", + "documentation":"A term that identifies the control's functional behavior. One of Preventive, Deteictive, Proactive
An internal service error occurred during the processing of your request. Try again later.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "ListCommonControlsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxListCommonControlsResults", + "documentation":"The maximum number of results on a page or for an API request call.
", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token that's used to fetch the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "CommonControlFilter":{ + "shape":"CommonControlFilter", + "documentation":"An optional filter that narrows the results to a specific objective.
This filter allows you to specify one objective ARN at a time. Passing multiple ARNs in the CommonControlFilter isn’t currently supported.
The list of common controls that the ListCommonControls API returns.
The pagination token that's used to fetch the next set of results.
" + } + } + }, + "ListControlsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token that's used to fetch the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxListControlsResults", + "documentation":"The maximum number of results on a page or for an API request call.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListControlsResponse":{ + "type":"structure", + "required":["Controls"], + "members":{ + "Controls":{ + "shape":"Controls", + "documentation":"Returns a list of controls, given as structures of type controlSummary.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token that's used to fetch the next set of results.
" + } + } + }, + "ListDomainsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxListDomainsResults", + "documentation":"The maximum number of results on a page or for an API request call.
", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token that's used to fetch the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListDomainsResponse":{ + "type":"structure", + "required":["Domains"], + "members":{ + "Domains":{ + "shape":"DomainSummaryList", + "documentation":"The list of domains that the ListDomains API returns.
The pagination token that's used to fetch the next set of results.
" + } + } + }, + "ListObjectivesRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxListObjectivesResults", + "documentation":"The maximum number of results on a page or for an API request call.
", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token that's used to fetch the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "ObjectiveFilter":{ + "shape":"ObjectiveFilter", + "documentation":"An optional filter that narrows the results to a specific domain.
This filter allows you to specify one domain ARN at a time. Passing multiple ARNs in the ObjectiveFilter isn’t currently supported.
The list of objectives that the ListObjectives API returns.
The pagination token that's used to fetch the next set of results.
" + } + } + }, + "MaxListCommonControlsResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MaxListControlsResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MaxListDomainsResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MaxListObjectivesResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ObjectiveArn":{ + "type":"string", + "max":2048, + "min":36, + "pattern":"arn:(aws(?:[-a-z]*)?):controlcatalog:::objective/[0-9a-z]+" + }, + "ObjectiveFilter":{ + "type":"structure", + "members":{ + "Domains":{ + "shape":"DomainResourceFilterList", + "documentation":"The domain that's used as filter criteria.
You can use this parameter to specify one domain ARN at a time. Passing multiple ARNs in the ObjectiveFilter isn’t currently supported.
An optional filter that narrows the list of objectives to a specific domain.
" + }, + "ObjectiveResourceFilter":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"ObjectiveArn", + "documentation":"The Amazon Resource Name (ARN) of the objective.
" + } + }, + "documentation":"The objective resource that's being used as a filter.
" + }, + "ObjectiveResourceFilterList":{ + "type":"list", + "member":{"shape":"ObjectiveResourceFilter"} + }, + "ObjectiveSummary":{ + "type":"structure", + "required":[ + "Arn", + "Name", + "Description", + "Domain", + "CreateTime", + "LastUpdateTime" + ], + "members":{ + "Arn":{ + "shape":"ObjectiveArn", + "documentation":"The Amazon Resource Name (ARN) that identifies the objective.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the objective.
" + }, + "Description":{ + "shape":"String", + "documentation":"The description of the objective.
" + }, + "Domain":{ + "shape":"AssociatedDomainSummary", + "documentation":"The domain that the objective belongs to.
" + }, + "CreateTime":{ + "shape":"Timestamp", + "documentation":"The time when the objective was created.
" + }, + "LastUpdateTime":{ + "shape":"Timestamp", + "documentation":"The time when the objective was most recently updated.
" + } + }, + "documentation":"A summary of metadata for an objective.
" + }, + "ObjectiveSummaryList":{ + "type":"list", + "member":{"shape":"ObjectiveSummary"} + }, + "PaginationToken":{ + "type":"string", + "max":1024, + "min":0 + }, + "RegionCode":{ + "type":"string", + "pattern":"[a-zA-Z0-9-]{1,128}" + }, + "RegionConfiguration":{ + "type":"structure", + "required":["Scope"], + "members":{ + "Scope":{ + "shape":"ControlScope", + "documentation":"The coverage of the control, if deployed. Scope is an enumerated type, with value Regional, or Global. A control with Global scope is effective in all Amazon Web Services Regions, regardless of the Region from which it is enabled, or to which it is deployed. A control implemented by an SCP is usually Global in scope. A control with Regional scope has operations that are restricted specifically to the Region from which it is enabled and to which it is deployed. Controls implemented by Config rules and CloudFormation hooks usually are Regional in scope. Security Hub controls usually are Regional in scope.
Regions in which the control is available to be deployed.
" + } + }, + "documentation":"Returns information about the control, including the scope of the control, if enabled, and the Regions in which the control currently is available for deployment.
If you are applying controls through an Amazon Web Services Control Tower landing zone environment, remember that the values returned in the RegionConfiguration API operation are not related to the governed Regions in your landing zone. For example, if you are governing Regions A,B,and C while the control is available in Regions A, B, C, and D, you'd see a response with DeployableRegions of A, B, C, and D for a control with REGIONAL scope, even though you may not intend to deploy the control in Region D, because you do not govern it through your landing zone.
The requested resource does not exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"}, + "ThrottlingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":true} + }, + "Timestamp":{"type":"timestamp"}, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request has invalid or missing parameters.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + }, + "documentation":"Welcome to the Amazon Web Services Control Catalog API reference. This guide is for developers who need detailed information about how to programmatically identify and filter the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types that are supported by Amazon Web Services Control Catalog.
Use the following links to get started with the Amazon Web Services Control Catalog API:
Actions: An alphabetical list of all Control Catalog API operations.
Data types: An alphabetical list of all Control Catalog data types.
Common parameters: Parameters that all operations can use.
Common errors: Client and server errors that all operations can return.
Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
" + }, + "DeleteLandingZone":{ + "name":"DeleteLandingZone", + "http":{ + "method":"POST", + "requestUri":"/delete-landingzone", + "responseCode":200 + }, + "input":{"shape":"DeleteLandingZoneInput"}, + "output":{"shape":"DeleteLandingZoneOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.
", + "idempotent":true + }, + "DisableBaseline":{ + "name":"DisableBaseline", + "http":{ + "method":"POST", + "requestUri":"/disable-baseline", + "responseCode":200 + }, + "input":{"shape":"DisableBaselineInput"}, + "output":{"shape":"DisableBaselineOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .
" + }, + "EnableBaseline":{ + "name":"EnableBaseline", + "http":{ + "method":"POST", + "requestUri":"/enable-baseline", + "responseCode":200 + }, + "input":{"shape":"EnableBaselineInput"}, + "output":{"shape":"EnableBaselineOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .
" + }, + "GetBaseline":{ + "name":"GetBaseline", + "http":{ + "method":"POST", + "requestUri":"/get-baseline", + "responseCode":200 + }, + "input":{"shape":"GetBaselineInput"}, + "output":{"shape":"GetBaselineOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Controls Reference Guide .
Retrieve details of an EnabledBaseline resource by specifying its identifier.
Retrieves details about an enabled control. For usage examples, see the Controls Reference Guide .
" + }, + "GetLandingZone":{ + "name":"GetLandingZone", + "http":{ + "method":"POST", + "requestUri":"/get-landingzone", + "responseCode":200 + }, + "input":{"shape":"GetLandingZoneInput"}, + "output":{"shape":"GetLandingZoneOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns details about the landing zone. Displays a message in case of error.
" + }, + "GetLandingZoneOperation":{ + "name":"GetLandingZoneOperation", + "http":{ + "method":"POST", + "requestUri":"/get-landingzone-operation", + "responseCode":200 + }, + "input":{"shape":"GetLandingZoneOperationInput"}, + "output":{"shape":"GetLandingZoneOperationOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.
" + }, + "ListBaselines":{ + "name":"ListBaselines", + "http":{ + "method":"POST", + "requestUri":"/list-baselines", + "responseCode":200 + }, + "input":{"shape":"ListBaselinesInput"}, + "output":{"shape":"ListBaselinesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .
" + }, + "ListControlOperations":{ + "name":"ListControlOperations", + "http":{ + "method":"POST", + "requestUri":"/list-control-operations", + "responseCode":200 + }, + "input":{"shape":"ListControlOperationsInput"}, + "output":{"shape":"ListControlOperationsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.
" + }, + "ListEnabledBaselines":{ + "name":"ListEnabledBaselines", + "http":{ + "method":"POST", + "requestUri":"/list-enabled-baselines", + "responseCode":200 + }, + "input":{"shape":"ListEnabledBaselinesInput"}, + "output":{"shape":"ListEnabledBaselinesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources. For usage examples, see the Amazon Web Services Control Tower User Guide .
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the Controls Reference Guide .
" + }, + "ListLandingZoneOperations":{ + "name":"ListLandingZoneOperations", + "http":{ + "method":"POST", + "requestUri":"/list-landingzone-operations", + "responseCode":200 + }, + "input":{"shape":"ListLandingZoneOperationsInput"}, + "output":{"shape":"ListLandingZoneOperationsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Lists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.
" + }, + "ListLandingZones":{ + "name":"ListLandingZones", + "http":{ + "method":"POST", + "requestUri":"/list-landingzones", + "responseCode":200 + }, + "input":{"shape":"ListLandingZonesInput"}, + "output":{"shape":"ListLandingZonesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns the landing zone ARN for the landing zone deployed in your managed account. This API also creates an ARN for existing accounts that do not yet have a landing zone ARN.
Returns one landing zone ARN.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide .
" + }, + "ResetEnabledBaseline":{ + "name":"ResetEnabledBaseline", + "http":{ + "method":"POST", + "requestUri":"/reset-enabled-baseline", + "responseCode":200 + }, + "input":{"shape":"ResetEnabledBaselineInput"}, + "output":{"shape":"ResetEnabledBaselineOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in the original configuration, which you specified in the manifest file. Nothing in the manifest file's original landing zone configuration is changed during the reset process, by default. This API is not the same as a rollback of a landing zone version, which is not a supported operation.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":204 + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Applies tags to a resource. For usage examples, see the Controls Reference Guide .
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":204 + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Removes tags from a resource. For usage examples, see the Controls Reference Guide .
" + }, + "UpdateEnabledBaseline":{ + "name":"UpdateEnabledBaseline", + "http":{ + "method":"POST", + "requestUri":"/update-enabled-baseline", + "responseCode":200 + }, + "input":{"shape":"UpdateEnabledBaselineInput"}, + "output":{"shape":"UpdateEnabledBaselineOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .
Updates the configuration of an already enabled control.
If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.
If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower updates the control to match any valid parameters that you supply.
If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling DisableControl and again calling EnableControl, or you can run an extending governance operation. For usage examples, see the Controls Reference Guide .
This API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "Arn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[0-9a-zA-Z_\\-:\\/]+$" + }, + "BaselineArn":{ + "type":"string", + "pattern":"^arn:[a-z-]+:controltower:[a-z0-9-]*:[0-9]{0,12}:baseline/[A-Z0-9]{16}$" + }, + "BaselineOperation":{ + "type":"structure", + "members":{ + "endTime":{ + "shape":"Timestamp", + "documentation":"The end time of the operation (if applicable), in ISO 8601 format.
" + }, + "operationIdentifier":{ + "shape":"OperationIdentifier", + "documentation":"The identifier of the specified operation.
" + }, + "operationType":{ + "shape":"BaselineOperationType", + "documentation":"An enumerated type (enum) with possible values of ENABLE_BASELINE, DISABLE_BASELINE, UPDATE_ENABLED_BASELINE, or RESET_ENABLED_BASELINE.
The start time of the operation, in ISO 8601 format.
" + }, + "status":{ + "shape":"BaselineOperationStatus", + "documentation":"An enumerated type (enum) with possible values of SUCCEEDED, FAILED, or IN_PROGRESS.
A status message that gives more information about the operation's status, if applicable.
" + } + }, + "documentation":"An object of shape BaselineOperation, returning details about the specified Baseline operation ID.
The full ARN of a Baseline.
" + }, + "description":{ + "shape":"String", + "documentation":"A summary description of a Baseline.
" + }, + "name":{ + "shape":"String", + "documentation":"The human-readable name of a Baseline.
" + } + }, + "documentation":"Returns a summary of information about a Baseline object.
Updating or deleting the resource can cause an inconsistent state.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ControlIdentifier":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[0-9a-zA-Z_\\-:\\/]+$" + }, + "ControlIdentifiers":{ + "type":"list", + "member":{"shape":"ControlIdentifier"}, + "max":1, + "min":1 + }, + "ControlOperation":{ + "type":"structure", + "members":{ + "controlIdentifier":{ + "shape":"ControlIdentifier", + "documentation":"The controlIdentifier of the control for the operation.
The controlIdentifier of the enabled control.
The time that the operation finished.
" + }, + "operationIdentifier":{ + "shape":"OperationIdentifier", + "documentation":"The identifier of the specified operation.
" + }, + "operationType":{ + "shape":"ControlOperationType", + "documentation":"One of ENABLE_CONTROL or DISABLE_CONTROL.
The time that the operation began.
" + }, + "status":{ + "shape":"ControlOperationStatus", + "documentation":"One of IN_PROGRESS, SUCEEDED, or FAILED.
If the operation result is FAILED, this string contains a message explaining why the operation failed.
The target upon which the control operation is working.
" + } + }, + "documentation":"An operation performed by the control.
" + }, + "ControlOperationFilter":{ + "type":"structure", + "members":{ + "controlIdentifiers":{ + "shape":"ControlIdentifiers", + "documentation":"The set of controlIdentifier returned by the filter.
The set of ControlOperation objects returned by the filter.
The set controlIdentifier of enabled controls selected by the filter.
Lists the status of control operations.
" + }, + "targetIdentifiers":{ + "shape":"TargetIdentifiers", + "documentation":"The set of targetIdentifier objects returned by the filter.
A filter object that lets you call ListControlOperations with a specific filter.
The controlIdentifier of a control.
The controlIdentifier of an enabled control.
The time at which the control operation was completed.
" + }, + "operationIdentifier":{ + "shape":"OperationIdentifier", + "documentation":"The unique identifier of a control operation.
" + }, + "operationType":{ + "shape":"ControlOperationType", + "documentation":"The type of operation.
" + }, + "startTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time at which a control operation began.
" + }, + "status":{ + "shape":"ControlOperationStatus", + "documentation":"The status of the specified control operation.
" + }, + "statusMessage":{ + "shape":"String", + "documentation":"A speficic message displayed as part of the control status.
" + }, + "targetIdentifier":{ + "shape":"TargetIdentifier", + "documentation":"The unique identifier of the target of a control operation.
" + } + }, + "documentation":"A summary of information about the specified control operation.
" + }, + "ControlOperationType":{ + "type":"string", + "enum":[ + "ENABLE_CONTROL", + "DISABLE_CONTROL", + "UPDATE_ENABLED_CONTROL" + ] + }, + "ControlOperationTypes":{ + "type":"list", + "member":{"shape":"ControlOperationType"}, + "max":1, + "min":1 + }, + "ControlOperations":{ + "type":"list", + "member":{"shape":"ControlOperationSummary"} + }, + "CreateLandingZoneInput":{ + "type":"structure", + "required":[ + "manifest", + "version" + ], + "members":{ + "manifest":{ + "shape":"Manifest", + "documentation":"The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"Tags to be applied to the landing zone.
" + }, + "version":{ + "shape":"LandingZoneVersion", + "documentation":"The landing zone version, for example, 3.0.
" + } + } + }, + "CreateLandingZoneOutput":{ + "type":"structure", + "required":[ + "arn", + "operationIdentifier" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The ARN of the landing zone resource.
" + }, + "operationIdentifier":{ + "shape":"OperationIdentifier", + "documentation":"A unique identifier assigned to a CreateLandingZone operation. You can use this identifier as an input of GetLandingZoneOperation to check the operation's status.
The unique identifier of the landing zone.
" + } + } + }, + "DeleteLandingZoneOutput":{ + "type":"structure", + "required":["operationIdentifier"], + "members":{ + "operationIdentifier":{ + "shape":"OperationIdentifier", + "documentation":">A unique identifier assigned to a DeleteLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation's status.
Identifier of the EnabledBaseline resource to be deactivated, in ARN format.
The ID (in UUID format) of the asynchronous DisableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.
The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
" + } + } + }, + "Document":{ + "type":"structure", + "members":{ + }, + "document":true + }, + "DriftStatus":{ + "type":"string", + "enum":[ + "DRIFTED", + "IN_SYNC", + "NOT_CHECKING", + "UNKNOWN" + ] + }, + "DriftStatusSummary":{ + "type":"structure", + "members":{ + "driftStatus":{ + "shape":"DriftStatus", + "documentation":"The drift status of the enabled control.
Valid values:
DRIFTED: The enabledControl deployed in this configuration doesn’t match the configuration that Amazon Web Services Control Tower expected.
IN_SYNC: The enabledControl deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.
NOT_CHECKING: Amazon Web Services Control Tower does not check drift for this enabled control. Drift is not supported for the control type.
UNKNOWN: Amazon Web Services Control Tower is not able to check the drift status for the enabled control.
The drift summary of the enabled control.
Amazon Web Services Control Tower expects the enabled control configuration to include all supported and governed Regions. If the enabled control differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control.
" + }, + "DriftStatuses":{ + "type":"list", + "member":{"shape":"DriftStatus"}, + "max":1, + "min":1 + }, + "EnableBaselineInput":{ + "type":"structure", + "required":[ + "baselineIdentifier", + "baselineVersion", + "targetIdentifier" + ], + "members":{ + "baselineIdentifier":{ + "shape":"Arn", + "documentation":"The ARN of the baseline to be enabled.
" + }, + "baselineVersion":{ + "shape":"BaselineVersion", + "documentation":"The specific version to be enabled of the specified baseline.
" + }, + "parameters":{ + "shape":"EnabledBaselineParameters", + "documentation":"A list of key-value objects that specify enablement parameters, where key is a string and value is a document of any type.
Tags associated with input to EnableBaseline.
The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets.
" + } + } + }, + "EnableBaselineOutput":{ + "type":"structure", + "required":[ + "arn", + "operationIdentifier" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The ARN of the EnabledBaseline resource.
The ID (in UUID format) of the asynchronous EnableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.
A list of input parameter values, which are specified to configure the control when you enable it.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"Tags to be applied to the EnabledControl resource.
The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The ARN of the EnabledControl resource.
The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
" + } + } + }, + "EnabledBaselineBaselineIdentifiers":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":5, + "min":1 + }, + "EnabledBaselineDetails":{ + "type":"structure", + "required":[ + "arn", + "baselineIdentifier", + "statusSummary", + "targetIdentifier" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The ARN of the EnabledBaseline resource.
The specific Baseline enabled as part of the EnabledBaseline resource.
The enabled version of the Baseline.
Shows the parameters that are applied when enabling this Baseline.
The target on which to enable the Baseline.
Details of the EnabledBaseline resource.
Identifiers for the Baseline objects returned as part of the filter operation.
Identifiers for the targets of the Baseline filter operation.
A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
A string denoting the parameter key.
" + }, + "value":{ + "shape":"EnabledBaselineParameterDocument", + "documentation":"A low-level Document object of any type (for example, a Java Object).
A key-value parameter to an EnabledBaseline resource.
A string denoting the parameter key.
" + }, + "value":{ + "shape":"EnabledBaselineParameterDocument", + "documentation":"A low-level document object of any type (for example, a Java Object).
" + } + }, + "documentation":"Summary of an applied parameter to an EnabledBaseline resource.
The ARN of the EnabledBaseline resource
The specific baseline that is enabled as part of the EnabledBaseline resource.
The enabled version of the baseline.
" + }, + "statusSummary":{"shape":"EnablementStatusSummary"}, + "targetIdentifier":{ + "shape":"String", + "documentation":"The target upon which the baseline is enabled.
" + } + }, + "documentation":"Returns a summary of information about an EnabledBaseline object.
The ARN of the enabled control.
" + }, + "controlIdentifier":{ + "shape":"ControlIdentifier", + "documentation":"The control identifier of the enabled control. For information on how to find the controlIdentifier, see the overview page.
The drift status of the enabled control.
" + }, + "parameters":{ + "shape":"EnabledControlParameterSummaries", + "documentation":"Array of EnabledControlParameter objects.
The deployment summary of the enabled control.
" + }, + "targetIdentifier":{ + "shape":"TargetIdentifier", + "documentation":"The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
Target Amazon Web Services Regions for the enabled control.
" + } + }, + "documentation":"Information about the enabled control.
" + }, + "EnabledControlFilter":{ + "type":"structure", + "members":{ + "controlIdentifiers":{ + "shape":"ControlIdentifiers", + "documentation":"The set of controlIdentifier returned by the filter.
A list of DriftStatus items.
A list of EnablementStatus items.
A structure that returns a set of control identifiers, the control status for each control in the set, and the drift status for each control in the set.
" + }, + "EnabledControlIdentifiers":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":1, + "min":1 + }, + "EnabledControlParameter":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"String", + "documentation":"The key of a key/value pair.
" + }, + "value":{ + "shape":"Document", + "documentation":"The value of a key/value pair.
" + } + }, + "documentation":"A key/value pair, where Key is of type String and Value is of type Document.
The key of a key/value pair.
" + }, + "value":{ + "shape":"Document", + "documentation":"The value of a key/value pair.
" + } + }, + "documentation":"Returns a summary of information about the parameters of an enabled control.
" + }, + "EnabledControlParameters":{ + "type":"list", + "member":{"shape":"EnabledControlParameter"} + }, + "EnabledControlSummary":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The ARN of the enabled control.
" + }, + "controlIdentifier":{ + "shape":"ControlIdentifier", + "documentation":"The controlIdentifier of the enabled control.
The drift status of the enabled control.
" + }, + "statusSummary":{ + "shape":"EnablementStatusSummary", + "documentation":"A short description of the status of the enabled control.
" + }, + "targetIdentifier":{ + "shape":"TargetIdentifier", + "documentation":"The ARN of the organizational unit.
" + } + }, + "documentation":"Returns a summary of information about an enabled control.
" + }, + "EnabledControls":{ + "type":"list", + "member":{"shape":"EnabledControlSummary"} + }, + "EnablementStatus":{ + "type":"string", + "enum":[ + "SUCCEEDED", + "FAILED", + "UNDER_CHANGE" + ] + }, + "EnablementStatusSummary":{ + "type":"structure", + "members":{ + "lastOperationIdentifier":{ + "shape":"OperationIdentifier", + "documentation":"The last operation identifier for the enabled resource.
" + }, + "status":{ + "shape":"EnablementStatus", + "documentation":"The deployment status of the enabled resource.
Valid values:
SUCCEEDED: The EnabledControl or EnabledBaseline configuration was deployed successfully.
UNDER_CHANGE: The EnabledControl or EnabledBaseline configuration is changing.
FAILED: The EnabledControl or EnabledBaseline configuration failed to deploy.
The deployment summary of an EnabledControl or EnabledBaseline resource.
The ARN of the Baseline resource to be retrieved.
The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset).
" + } + } + }, + "GetBaselineOperationOutput":{ + "type":"structure", + "required":["baselineOperation"], + "members":{ + "baselineOperation":{ + "shape":"BaselineOperation", + "documentation":"A baselineOperation object that shows information about the specified operation ID.
The baseline ARN.
" + }, + "description":{ + "shape":"String", + "documentation":"A description of the baseline.
" + }, + "name":{ + "shape":"String", + "documentation":"A user-friendly name for the baseline.
" + } + } + }, + "GetControlOperationInput":{ + "type":"structure", + "required":["operationIdentifier"], + "members":{ + "operationIdentifier":{ + "shape":"OperationIdentifier", + "documentation":"The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
" + } + } + }, + "GetControlOperationOutput":{ + "type":"structure", + "required":["controlOperation"], + "members":{ + "controlOperation":{ + "shape":"ControlOperation", + "documentation":"An operation performed by the control.
" + } + } + }, + "GetEnabledBaselineInput":{ + "type":"structure", + "required":["enabledBaselineIdentifier"], + "members":{ + "enabledBaselineIdentifier":{ + "shape":"Arn", + "documentation":"Identifier of the EnabledBaseline resource to be retrieved, in ARN format.
Details of the EnabledBaseline resource.
The controlIdentifier of the enabled control.
Information about the enabled control.
" + } + } + }, + "GetLandingZoneInput":{ + "type":"structure", + "required":["landingZoneIdentifier"], + "members":{ + "landingZoneIdentifier":{ + "shape":"String", + "documentation":"The unique identifier of the landing zone.
" + } + } + }, + "GetLandingZoneOperationInput":{ + "type":"structure", + "required":["operationIdentifier"], + "members":{ + "operationIdentifier":{ + "shape":"OperationIdentifier", + "documentation":"A unique identifier assigned to a landing zone operation.
" + } + } + }, + "GetLandingZoneOperationOutput":{ + "type":"structure", + "required":["operationDetails"], + "members":{ + "operationDetails":{ + "shape":"LandingZoneOperationDetail", + "documentation":"Details about a landing zone operation.
" + } + } + }, + "GetLandingZoneOutput":{ + "type":"structure", + "required":["landingZone"], + "members":{ + "landingZone":{ + "shape":"LandingZoneDetail", + "documentation":"Information about the landing zone.
" + } + } + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"An unexpected error occurred during processing of a request.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "LandingZoneDetail":{ + "type":"structure", + "required":[ + "manifest", + "version" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The ARN of the landing zone.
" + }, + "driftStatus":{ + "shape":"LandingZoneDriftStatusSummary", + "documentation":"The drift status of the landing zone.
" + }, + "latestAvailableVersion":{ + "shape":"LandingZoneVersion", + "documentation":"The latest available version of the landing zone.
" + }, + "manifest":{ + "shape":"Manifest", + "documentation":"The landing zone manifest JSON text file that specifies the landing zone configurations.
" + }, + "status":{ + "shape":"LandingZoneStatus", + "documentation":"The landing zone deployment status. One of ACTIVE, PROCESSING, FAILED.
The landing zone's current deployed version.
" + } + }, + "documentation":"Information about the landing zone.
" + }, + "LandingZoneDriftStatus":{ + "type":"string", + "enum":[ + "DRIFTED", + "IN_SYNC" + ] + }, + "LandingZoneDriftStatusSummary":{ + "type":"structure", + "members":{ + "status":{ + "shape":"LandingZoneDriftStatus", + "documentation":"The drift status of the landing zone.
Valid values:
DRIFTED: The landing zone deployed in this configuration does not match the configuration that Amazon Web Services Control Tower expected.
IN_SYNC: The landing zone deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.
The drift status summary of the landing zone.
If the landing zone differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the landing zone.
" + }, + "LandingZoneOperationDetail":{ + "type":"structure", + "members":{ + "endTime":{ + "shape":"Timestamp", + "documentation":"The landing zone operation end time.
" + }, + "operationIdentifier":{ + "shape":"OperationIdentifier", + "documentation":"The operationIdentifier of the landing zone operation.
The landing zone operation type.
Valid values:
DELETE: The DeleteLandingZone operation.
CREATE: The CreateLandingZone operation.
UPDATE: The UpdateLandingZone operation.
RESET: The ResetLandingZone operation.
The landing zone operation start time.
" + }, + "status":{ + "shape":"LandingZoneOperationStatus", + "documentation":"Valid values:
SUCCEEDED: The landing zone operation succeeded.
IN_PROGRESS: The landing zone operation is in progress.
FAILED: The landing zone operation failed.
If the operation result is FAILED, this string contains a message explaining why the operation failed.
" + } + }, + "documentation":"Information about a landing zone operation.
" + }, + "LandingZoneOperationFilter":{ + "type":"structure", + "members":{ + "statuses":{ + "shape":"LandingZoneOperationStatuses", + "documentation":"The statuses of the set of landing zone operations selected by the filter.
" + }, + "types":{ + "shape":"LandingZoneOperationTypes", + "documentation":"The set of landing zone operation types selected by the filter.
" + } + }, + "documentation":"A filter object that lets you call ListLandingZoneOperations with a specific filter.
The operationIdentifier of the landing zone operation.
The type of the landing zone operation.
" + }, + "status":{ + "shape":"LandingZoneOperationStatus", + "documentation":"The status of the landing zone operation.
" + } + }, + "documentation":"Returns a summary of information about a landing zone operation.
" + }, + "LandingZoneOperationType":{ + "type":"string", + "enum":[ + "DELETE", + "CREATE", + "UPDATE", + "RESET" + ] + }, + "LandingZoneOperationTypes":{ + "type":"list", + "member":{"shape":"LandingZoneOperationType"}, + "max":1, + "min":1 + }, + "LandingZoneOperations":{ + "type":"list", + "member":{"shape":"LandingZoneOperationSummary"} + }, + "LandingZoneStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "PROCESSING", + "FAILED" + ] + }, + "LandingZoneSummary":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The ARN of the landing zone.
" + } + }, + "documentation":"Returns a summary of information about a landing zone.
" + }, + "LandingZoneVersion":{ + "type":"string", + "max":10, + "min":3, + "pattern":"^\\d+.\\d+$" + }, + "ListBaselinesInput":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListBaselinesMaxResults", + "documentation":"The maximum number of results to be shown.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"A pagination token.
" + } + } + }, + "ListBaselinesMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":4 + }, + "ListBaselinesOutput":{ + "type":"structure", + "required":["baselines"], + "members":{ + "baselines":{ + "shape":"Baselines", + "documentation":"A list of Baseline object details.
A pagination token.
" + } + } + }, + "ListControlOperationsInput":{ + "type":"structure", + "members":{ + "filter":{ + "shape":"ControlOperationFilter", + "documentation":"An input filter for the ListControlOperations API that lets you select the types of control operations to view.
The maximum number of results to be shown.
" + }, + "nextToken":{ + "shape":"ListControlOperationsNextToken", + "documentation":"A pagination token.
" + } + } + }, + "ListControlOperationsMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListControlOperationsNextToken":{ + "type":"string", + "pattern":"\\S+" + }, + "ListControlOperationsOutput":{ + "type":"structure", + "required":["controlOperations"], + "members":{ + "controlOperations":{ + "shape":"ControlOperations", + "documentation":"Returns a list of output from control operations.
" + }, + "nextToken":{ + "shape":"ListControlOperationsNextToken", + "documentation":"A pagination token.
" + } + } + }, + "ListEnabledBaselinesInput":{ + "type":"structure", + "members":{ + "filter":{ + "shape":"EnabledBaselineFilter", + "documentation":"A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
The maximum number of results to be shown.
" + }, + "nextToken":{ + "shape":"ListEnabledBaselinesNextToken", + "documentation":"A pagination token.
" + } + } + }, + "ListEnabledBaselinesMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":5 + }, + "ListEnabledBaselinesNextToken":{ + "type":"string", + "pattern":"\\S+" + }, + "ListEnabledBaselinesOutput":{ + "type":"structure", + "required":["enabledBaselines"], + "members":{ + "enabledBaselines":{ + "shape":"EnabledBaselines", + "documentation":"Retuens a list of summaries of EnabledBaseline resources.
A pagination token.
" + } + } + }, + "ListEnabledControlsInput":{ + "type":"structure", + "members":{ + "filter":{ + "shape":"EnabledControlFilter", + "documentation":"An input filter for the ListEnabledControls API that lets you select the types of control operations to view.
How many results to return per API call.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"The token to continue the list from a previous API call with the same parameters.
" + }, + "targetIdentifier":{ + "shape":"TargetIdentifier", + "documentation":"The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"Retrieves the next page of results. If the string is empty, the response is the end of the results.
" + } + } + }, + "ListLandingZoneOperationsInput":{ + "type":"structure", + "members":{ + "filter":{ + "shape":"LandingZoneOperationFilter", + "documentation":"An input filter for the ListLandingZoneOperations API that lets you select the types of landing zone operations to view.
How many results to return per API call.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"The token to continue the list from a previous API call with the same parameters.
" + } + } + }, + "ListLandingZoneOperationsMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListLandingZoneOperationsOutput":{ + "type":"structure", + "required":["landingZoneOperations"], + "members":{ + "landingZoneOperations":{ + "shape":"LandingZoneOperations", + "documentation":"Lists landing zone operations.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"Retrieves the next page of results. If the string is empty, the response is the end of the results.
" + } + } + }, + "ListLandingZonesInput":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListLandingZonesMaxResults", + "documentation":"The maximum number of returned landing zone ARNs, which is one.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"The token to continue the list from a previous API call with the same parameters.
" + } + } + }, + "ListLandingZonesMaxResults":{ + "type":"integer", + "box":true, + "max":1, + "min":1 + }, + "ListLandingZonesOutput":{ + "type":"structure", + "required":["landingZones"], + "members":{ + "landingZones":{ + "shape":"ListLandingZonesOutputLandingZonesList", + "documentation":"The ARN of the landing zone.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"Retrieves the next page of results. If the string is empty, the response is the end of the results.
" + } + } + }, + "ListLandingZonesOutputLandingZonesList":{ + "type":"list", + "member":{"shape":"LandingZoneSummary"}, + "max":1, + "min":0 + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The ARN of the resource.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"A list of tags, as key:value strings.
The Amazon Web Services Region name.
" + } + }, + "documentation":"An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed.
The expected Regions are based on the Regions that are governed by the landing zone. In certain cases, a control is not actually enabled in the Region as expected, such as during drift, or mixed governance.
" + }, + "RegionName":{ + "type":"string", + "max":50, + "min":1 + }, + "ResetEnabledBaselineInput":{ + "type":"structure", + "required":["enabledBaselineIdentifier"], + "members":{ + "enabledBaselineIdentifier":{ + "shape":"Arn", + "documentation":"Specifies the ID of the EnabledBaseline resource to be re-enabled, in ARN format.
The ID (in UUID format) of the asynchronous ResetEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The unique identifier of the landing zone.
" + } + } + }, + "ResetLandingZoneOutput":{ + "type":"structure", + "required":["operationIdentifier"], + "members":{ + "operationIdentifier":{ + "shape":"OperationIdentifier", + "documentation":"A unique identifier assigned to a ResetLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation's status.
The request references a resource that does not exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"}, + "SyntheticTimestamp_date_time":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":0 + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The ARN of the resource to be tagged.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"Tags to be applied to the resource.
" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TargetIdentifier":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[0-9a-zA-Z_\\-:\\/]+$" + }, + "TargetIdentifiers":{ + "type":"list", + "member":{"shape":"TargetIdentifier"}, + "max":1, + "min":1 + }, + "TargetRegions":{ + "type":"list", + "member":{"shape":"Region"} + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "quotaCode":{ + "shape":"String", + "documentation":"The ID of the service quota that was exceeded.
" + }, + "retryAfterSeconds":{ + "shape":"Integer", + "documentation":"The number of seconds the caller should wait before retrying.
", + "location":"header", + "locationName":"Retry-After" + }, + "serviceCode":{ + "shape":"String", + "documentation":"The ID of the service that is associated with the error.
" + } + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":true} + }, + "Timestamp":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The ARN of the resource.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeys", + "documentation":"Tag keys to be removed from the resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateEnabledBaselineInput":{ + "type":"structure", + "required":[ + "baselineVersion", + "enabledBaselineIdentifier" + ], + "members":{ + "baselineVersion":{ + "shape":"BaselineVersion", + "documentation":"Specifies the new Baseline version, to which the EnabledBaseline should be updated.
Specifies the EnabledBaseline resource to be updated.
Parameters to apply when making an update.
" + } + } + }, + "UpdateEnabledBaselineOutput":{ + "type":"structure", + "required":["operationIdentifier"], + "members":{ + "operationIdentifier":{ + "shape":"OperationIdentifier", + "documentation":"The ID (in UUID format) of the asynchronous UpdateEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The ARN of the enabled control that will be updated.
" + }, + "parameters":{ + "shape":"EnabledControlParameters", + "documentation":"A key/value pair, where Key is of type String and Value is of type Document.
The operation identifier for this UpdateEnabledControl operation.
The unique identifier of the landing zone.
" + }, + "manifest":{ + "shape":"Manifest", + "documentation":"The manifest file (JSON) is a text file that describes your Amazon Web Services resources. For an example, review Launch your landing zone. The example manifest file contains each of the available parameters. The schema for the landing zone's JSON manifest file is not published, by design.
" + }, + "version":{ + "shape":"LandingZoneVersion", + "documentation":"The landing zone version, for example, 3.2.
" + } + } + }, + "UpdateLandingZoneOutput":{ + "type":"structure", + "required":["operationIdentifier"], + "members":{ + "operationIdentifier":{ + "shape":"OperationIdentifier", + "documentation":"A unique identifier assigned to a UpdateLandingZone operation. You can use this identifier as an input of GetLandingZoneOperation to check the operation's status.
The input does not satisfy the constraints specified by an Amazon Web Services service.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + }, + "documentation":"Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
For more information about these types of resources, see the Amazon Web Services Control Tower User Guide .
About control APIs
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
To call these APIs, you'll need to know:
the controlIdentifier for the control--or guardrail--you are targeting.
the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier for your Amazon Web Services Control Tower control:
The controlIdentifier is an ARN that is specified for each control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.
About identifiers for Amazon Web Services Control Tower
The Amazon Web Services Control Tower controlIdentifier is unique in each Amazon Web Services Region for each control. You can find the controlIdentifier for each Region and control in the Tables of control metadata or the Control availability by Region tables in the Amazon Web Services Control Tower Controls Reference Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Amazon Web Services Control Tower Controls Reference Guide . Remember that Mandatory controls cannot be added or removed.
Some controls have two identifiers
ARN format for Amazon Web Services Control Tower: arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
ARN format for Amazon Web Services Control Catalog: arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}
You can find the {CONTROL_CATALOG_OPAQUE_ID} in the Amazon Web Services Control Tower Controls Reference Guide , or in the Amazon Web Services Control Tower console, on the Control details page.
The Amazon Web Services Control Tower APIs for enabled controls, such as GetEnabledControl and ListEnabledControls always return an ARN of the same type given when the control was enabled.
To get the targetIdentifier:
The targetIdentifier is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
OU ARN format:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
About landing zone APIs
You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs.
For an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs. The individual API operations for landing zones are detailed in this document, the API reference manual, in the \"Actions\" section.
About baseline APIs
You can apply the AWSControlTowerBaseline baseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines.
You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.
The individual API operations for baselines are detailed in this document, the API reference manual, in the \"Actions\" section. For usage examples, see Baseline API input and output examples with CLI.
About Amazon Web Services Control Catalog identifiers
The EnableControl and DisableControl API operations can be called by specifying either the Amazon Web Services Control Tower identifer or the Amazon Web Services Control Catalog identifier. The API response returns the same type of identifier that you specified when calling the API.
If you use an Amazon Web Services Control Tower identifier to call the EnableControl API, and then call EnableControl again with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control Tower returns an error message stating that the control is already enabled. Similar behavior applies to the DisableControl API operation.
Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
" +} diff --git a/testbed/boto__botocore/botocore/data/deadline/2023-10-12/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/deadline/2023-10-12/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..6150299bedffe58e397b31dd9c87318052937e93 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/deadline/2023-10-12/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://deadline-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://deadline-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://deadline.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://deadline.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/docdb-elastic/2022-11-28/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/docdb-elastic/2022-11-28/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..086aaa0cea00d70ec92bfecc683817e014f80156 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/docdb-elastic/2022-11-28/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://docdb-elastic-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://docdb-elastic-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://docdb-elastic.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://docdb-elastic.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/docdb-elastic/2022-11-28/paginators-1.json b/testbed/boto__botocore/botocore/data/docdb-elastic/2022-11-28/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..db11a76bfb973eef0aba4e6ffdd8ddd7910edc11 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/docdb-elastic/2022-11-28/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListClusterSnapshots": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "snapshots" + }, + "ListClusters": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "clusters" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/docdb-elastic/2022-11-28/service-2.json b/testbed/boto__botocore/botocore/data/docdb-elastic/2022-11-28/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..ef72cb5b367447b792aa3a516449db7aec9541e8 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/docdb-elastic/2022-11-28/service-2.json @@ -0,0 +1,1387 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-11-28", + "endpointPrefix":"docdb-elastic", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"DocDB Elastic", + "serviceFullName":"Amazon DocumentDB Elastic Clusters", + "serviceId":"DocDB Elastic", + "signatureVersion":"v4", + "signingName":"docdb-elastic", + "uid":"docdb-elastic-2022-11-28" + }, + "operations":{ + "CopyClusterSnapshot":{ + "name":"CopyClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/cluster-snapshot/{snapshotArn}/copy", + "responseCode":200 + }, + "input":{"shape":"CopyClusterSnapshotInput"}, + "output":{"shape":"CopyClusterSnapshotOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Copies a snapshot of an elastic cluster.
", + "idempotent":true + }, + "CreateCluster":{ + "name":"CreateCluster", + "http":{ + "method":"POST", + "requestUri":"/cluster", + "responseCode":200 + }, + "input":{"shape":"CreateClusterInput"}, + "output":{"shape":"CreateClusterOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
", + "idempotent":true + }, + "CreateClusterSnapshot":{ + "name":"CreateClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/cluster-snapshot", + "responseCode":200 + }, + "input":{"shape":"CreateClusterSnapshotInput"}, + "output":{"shape":"CreateClusterSnapshotOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a snapshot of an elastic cluster.
", + "idempotent":true + }, + "DeleteCluster":{ + "name":"DeleteCluster", + "http":{ + "method":"DELETE", + "requestUri":"/cluster/{clusterArn}", + "responseCode":200 + }, + "input":{"shape":"DeleteClusterInput"}, + "output":{"shape":"DeleteClusterOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Delete an elastic cluster.
", + "idempotent":true + }, + "DeleteClusterSnapshot":{ + "name":"DeleteClusterSnapshot", + "http":{ + "method":"DELETE", + "requestUri":"/cluster-snapshot/{snapshotArn}", + "responseCode":200 + }, + "input":{"shape":"DeleteClusterSnapshotInput"}, + "output":{"shape":"DeleteClusterSnapshotOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Delete an elastic cluster snapshot.
", + "idempotent":true + }, + "GetCluster":{ + "name":"GetCluster", + "http":{ + "method":"GET", + "requestUri":"/cluster/{clusterArn}", + "responseCode":200 + }, + "input":{"shape":"GetClusterInput"}, + "output":{"shape":"GetClusterOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about a specific elastic cluster.
" + }, + "GetClusterSnapshot":{ + "name":"GetClusterSnapshot", + "http":{ + "method":"GET", + "requestUri":"/cluster-snapshot/{snapshotArn}", + "responseCode":200 + }, + "input":{"shape":"GetClusterSnapshotInput"}, + "output":{"shape":"GetClusterSnapshotOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about a specific elastic cluster snapshot
" + }, + "ListClusterSnapshots":{ + "name":"ListClusterSnapshots", + "http":{ + "method":"GET", + "requestUri":"/cluster-snapshots", + "responseCode":200 + }, + "input":{"shape":"ListClusterSnapshotsInput"}, + "output":{"shape":"ListClusterSnapshotsOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about snapshots for a specified elastic cluster.
" + }, + "ListClusters":{ + "name":"ListClusters", + "http":{ + "method":"GET", + "requestUri":"/clusters", + "responseCode":200 + }, + "input":{"shape":"ListClustersInput"}, + "output":{"shape":"ListClustersOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns information about provisioned Amazon DocumentDB elastic clusters.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Lists all tags on a elastic cluster resource
" + }, + "RestoreClusterFromSnapshot":{ + "name":"RestoreClusterFromSnapshot", + "http":{ + "method":"POST", + "requestUri":"/cluster-snapshot/{snapshotArn}/restore", + "responseCode":200 + }, + "input":{"shape":"RestoreClusterFromSnapshotInput"}, + "output":{"shape":"RestoreClusterFromSnapshotOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Restores an elastic cluster from a snapshot.
", + "idempotent":true + }, + "StartCluster":{ + "name":"StartCluster", + "http":{ + "method":"POST", + "requestUri":"/cluster/{clusterArn}/start", + "responseCode":200 + }, + "input":{"shape":"StartClusterInput"}, + "output":{"shape":"StartClusterOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Restarts the stopped elastic cluster that is specified by clusterARN.
Stops the running elastic cluster that is specified by clusterArn. The elastic cluster must be in the available state.
Adds metadata tags to an elastic cluster resource
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Removes metadata tags from an elastic cluster resource
", + "idempotent":true + }, + "UpdateCluster":{ + "name":"UpdateCluster", + "http":{ + "method":"PUT", + "requestUri":"/cluster/{clusterArn}", + "responseCode":200 + }, + "input":{"shape":"UpdateClusterInput"}, + "output":{"shape":"UpdateClusterOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window
", + "idempotent":true + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"String", + "documentation":"An error message explaining why access was denied.
" + } + }, + "documentation":"An exception that occurs when there are not sufficient permissions to perform an action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "Arn":{ + "type":"string", + "max":1011, + "min":1 + }, + "Auth":{ + "type":"string", + "enum":[ + "PLAIN_TEXT", + "SECRET_ARN" + ] + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "Cluster":{ + "type":"structure", + "required":[ + "adminUserName", + "authType", + "clusterArn", + "clusterEndpoint", + "clusterName", + "createTime", + "kmsKeyId", + "preferredMaintenanceWindow", + "shardCapacity", + "shardCount", + "status", + "subnetIds", + "vpcSecurityGroupIds" + ], + "members":{ + "adminUserName":{ + "shape":"String", + "documentation":"The name of the elastic cluster administrator.
" + }, + "authType":{ + "shape":"Auth", + "documentation":"The authentication type for the elastic cluster.
" + }, + "backupRetentionPeriod":{ + "shape":"Integer", + "documentation":"The number of days for which automatic snapshots are retained.
" + }, + "clusterArn":{ + "shape":"String", + "documentation":"The ARN identifier of the elastic cluster.
" + }, + "clusterEndpoint":{ + "shape":"String", + "documentation":"The URL used to connect to the elastic cluster.
" + }, + "clusterName":{ + "shape":"String", + "documentation":"The name of the elastic cluster.
" + }, + "createTime":{ + "shape":"String", + "documentation":"The time when the elastic cluster was created in Universal Coordinated Time (UTC).
" + }, + "kmsKeyId":{ + "shape":"String", + "documentation":"The KMS key identifier to use to encrypt the elastic cluster.
" + }, + "preferredBackupWindow":{ + "shape":"String", + "documentation":"The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
" + }, + "shardCount":{ + "shape":"Integer", + "documentation":"The number of shards assigned to the elastic cluster. Maximum is 32.
" + }, + "shardInstanceCount":{ + "shape":"Integer", + "documentation":"The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
The total number of shards in the cluster.
" + }, + "status":{ + "shape":"Status", + "documentation":"The status of the elastic cluster.
" + }, + "subnetIds":{ + "shape":"StringList", + "documentation":"The Amazon EC2 subnet IDs for the elastic cluster.
" + }, + "vpcSecurityGroupIds":{ + "shape":"StringList", + "documentation":"A list of EC2 VPC security groups associated with thie elastic cluster.
" + } + }, + "documentation":"Returns information about a specific elastic cluster.
" + }, + "ClusterInList":{ + "type":"structure", + "required":[ + "clusterArn", + "clusterName", + "status" + ], + "members":{ + "clusterArn":{ + "shape":"String", + "documentation":"The ARN identifier of the elastic cluster.
" + }, + "clusterName":{ + "shape":"String", + "documentation":"The name of the elastic cluster.
" + }, + "status":{ + "shape":"Status", + "documentation":"The status of the elastic cluster.
" + } + }, + "documentation":"A list of Amazon DocumentDB elastic clusters.
" + }, + "ClusterList":{ + "type":"list", + "member":{"shape":"ClusterInList"} + }, + "ClusterSnapshot":{ + "type":"structure", + "required":[ + "adminUserName", + "clusterArn", + "clusterCreationTime", + "kmsKeyId", + "snapshotArn", + "snapshotCreationTime", + "snapshotName", + "status", + "subnetIds", + "vpcSecurityGroupIds" + ], + "members":{ + "adminUserName":{ + "shape":"String", + "documentation":"The name of the elastic cluster administrator.
" + }, + "clusterArn":{ + "shape":"String", + "documentation":"The ARN identifier of the elastic cluster.
" + }, + "clusterCreationTime":{ + "shape":"String", + "documentation":"The time when the elastic cluster was created in Universal Coordinated Time (UTC).
" + }, + "kmsKeyId":{ + "shape":"String", + "documentation":"The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
" + }, + "snapshotArn":{ + "shape":"String", + "documentation":"The ARN identifier of the elastic cluster snapshot.
" + }, + "snapshotCreationTime":{ + "shape":"String", + "documentation":"The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
" + }, + "snapshotName":{ + "shape":"String", + "documentation":"The name of the elastic cluster snapshot.
" + }, + "snapshotType":{ + "shape":"SnapshotType", + "documentation":"The type of cluster snapshots to be returned. You can specify one of the following values:
automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
The status of the elastic cluster snapshot.
" + }, + "subnetIds":{ + "shape":"StringList", + "documentation":"The Amazon EC2 subnet IDs for the elastic cluster.
" + }, + "vpcSecurityGroupIds":{ + "shape":"StringList", + "documentation":"A list of EC2 VPC security groups to associate with the elastic cluster.
" + } + }, + "documentation":"Returns information about a specific elastic cluster snapshot.
" + }, + "ClusterSnapshotInList":{ + "type":"structure", + "required":[ + "clusterArn", + "snapshotArn", + "snapshotCreationTime", + "snapshotName", + "status" + ], + "members":{ + "clusterArn":{ + "shape":"String", + "documentation":"The ARN identifier of the elastic cluster.
" + }, + "snapshotArn":{ + "shape":"String", + "documentation":"The ARN identifier of the elastic cluster snapshot.
" + }, + "snapshotCreationTime":{ + "shape":"String", + "documentation":"The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
" + }, + "snapshotName":{ + "shape":"String", + "documentation":"The name of the elastic cluster snapshot.
" + }, + "status":{ + "shape":"Status", + "documentation":"The status of the elastic cluster snapshot.
" + } + }, + "documentation":"A list of elastic cluster snapshots.
" + }, + "ClusterSnapshotList":{ + "type":"list", + "member":{"shape":"ClusterSnapshotInList"} + }, + "ConflictException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{"shape":"String"}, + "resourceId":{ + "shape":"String", + "documentation":"The ID of the resource where there was an access conflict.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The type of the resource where there was an access conflict.
" + } + }, + "documentation":"There was an access conflict.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CopyClusterSnapshotInput":{ + "type":"structure", + "required":[ + "snapshotArn", + "targetSnapshotName" + ], + "members":{ + "copyTags":{ + "shape":"Boolean", + "documentation":"Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is false.
The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.
If you copy an encrypted elastic cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new Amazon Web ServicesS KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the elastic cluster snapshot is encrypted with the same AWS KMS key as the source elastic cluster snapshot.
To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set KmsKeyId to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.
If you copy an unencrypted elastic cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.
", + "location":"uri", + "locationName":"snapshotArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags to be assigned to the elastic cluster snapshot.
" + }, + "targetSnapshotName":{ + "shape":"CopyClusterSnapshotInputTargetSnapshotNameString", + "documentation":"The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: elastic-cluster-snapshot-5
The name of the Amazon DocumentDB elastic clusters administrator.
Constraints:
Must be from 1 to 63 letters or numbers.
The first character must be a letter.
Cannot be a reserved word.
The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.
Constraints:
Must contain from 8 to 100 characters.
Cannot contain a forward slash (/), double quote (\"), or the \"at\" symbol (@).
The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.
The number of days for which automatic snapshots are retained.
" + }, + "clientToken":{ + "shape":"String", + "documentation":"The client token for the elastic cluster.
", + "idempotencyToken":true + }, + "clusterName":{ + "shape":"String", + "documentation":"The name of the new elastic cluster. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster
The KMS key identifier to use to encrypt the new elastic cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
" + }, + "preferredBackupWindow":{ + "shape":"String", + "documentation":"The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
" + }, + "shardCapacity":{ + "shape":"Integer", + "documentation":"The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
" + }, + "shardCount":{ + "shape":"Integer", + "documentation":"The number of shards assigned to the elastic cluster. Maximum is 32.
" + }, + "shardInstanceCount":{ + "shape":"Integer", + "documentation":"The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
The Amazon EC2 subnet IDs for the new elastic cluster.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags to be assigned to the new elastic cluster.
" + }, + "vpcSecurityGroupIds":{ + "shape":"StringList", + "documentation":"A list of EC2 VPC security groups to associate with the new elastic cluster.
" + } + } + }, + "CreateClusterOutput":{ + "type":"structure", + "required":["cluster"], + "members":{ + "cluster":{ + "shape":"Cluster", + "documentation":"The new elastic cluster that has been created.
" + } + } + }, + "CreateClusterSnapshotInput":{ + "type":"structure", + "required":[ + "clusterArn", + "snapshotName" + ], + "members":{ + "clusterArn":{ + "shape":"String", + "documentation":"The ARN identifier of the elastic cluster of which you want to create a snapshot.
" + }, + "snapshotName":{ + "shape":"CreateClusterSnapshotInputSnapshotNameString", + "documentation":"The name of the new elastic cluster snapshot.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags to be assigned to the new elastic cluster snapshot.
" + } + } + }, + "CreateClusterSnapshotInputSnapshotNameString":{ + "type":"string", + "max":63, + "min":1 + }, + "CreateClusterSnapshotOutput":{ + "type":"structure", + "required":["snapshot"], + "members":{ + "snapshot":{ + "shape":"ClusterSnapshot", + "documentation":"Returns information about the new elastic cluster snapshot.
" + } + } + }, + "DeleteClusterInput":{ + "type":"structure", + "required":["clusterArn"], + "members":{ + "clusterArn":{ + "shape":"String", + "documentation":"The ARN identifier of the elastic cluster that is to be deleted.
", + "location":"uri", + "locationName":"clusterArn" + } + } + }, + "DeleteClusterOutput":{ + "type":"structure", + "required":["cluster"], + "members":{ + "cluster":{ + "shape":"Cluster", + "documentation":"Returns information about the newly deleted elastic cluster.
" + } + } + }, + "DeleteClusterSnapshotInput":{ + "type":"structure", + "required":["snapshotArn"], + "members":{ + "snapshotArn":{ + "shape":"String", + "documentation":"The ARN identifier of the elastic cluster snapshot that is to be deleted.
", + "location":"uri", + "locationName":"snapshotArn" + } + } + }, + "DeleteClusterSnapshotOutput":{ + "type":"structure", + "required":["snapshot"], + "members":{ + "snapshot":{ + "shape":"ClusterSnapshot", + "documentation":"Returns information about the newly deleted elastic cluster snapshot.
" + } + } + }, + "GetClusterInput":{ + "type":"structure", + "required":["clusterArn"], + "members":{ + "clusterArn":{ + "shape":"String", + "documentation":"The ARN identifier of the elastic cluster.
", + "location":"uri", + "locationName":"clusterArn" + } + } + }, + "GetClusterOutput":{ + "type":"structure", + "required":["cluster"], + "members":{ + "cluster":{ + "shape":"Cluster", + "documentation":"Returns information about a specific elastic cluster.
" + } + } + }, + "GetClusterSnapshotInput":{ + "type":"structure", + "required":["snapshotArn"], + "members":{ + "snapshotArn":{ + "shape":"String", + "documentation":"The ARN identifier of the elastic cluster snapshot.
", + "location":"uri", + "locationName":"snapshotArn" + } + } + }, + "GetClusterSnapshotOutput":{ + "type":"structure", + "required":["snapshot"], + "members":{ + "snapshot":{ + "shape":"ClusterSnapshot", + "documentation":"Returns information about a specific elastic cluster snapshot.
" + } + } + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"There was an internal server error.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "ListClusterSnapshotsInput":{ + "type":"structure", + "members":{ + "clusterArn":{ + "shape":"String", + "documentation":"The ARN identifier of the elastic cluster.
", + "location":"querystring", + "locationName":"clusterArn" + }, + "maxResults":{ + "shape":"ListClusterSnapshotsInputMaxResultsInteger", + "documentation":"The maximum number of elastic cluster snapshot results to receive in the response.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.
If there is no more data in the responce, the nextToken will not be returned.
The type of cluster snapshots to be returned. You can specify one of the following values:
automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.
If there is no more data in the responce, the nextToken will not be returned.
A list of snapshots for a specified elastic cluster.
" + } + } + }, + "ListClustersInput":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListClustersInputMaxResultsInteger", + "documentation":"The maximum number of elastic cluster snapshot results to receive in the response.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.
If there is no more data in the responce, the nextToken will not be returned.
A list of Amazon DocumentDB elastic clusters.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.
If there is no more data in the responce, the nextToken will not be returned.
The ARN identifier of the elastic cluster resource.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"The list of tags for the specified elastic cluster resource.
" + } + } + }, + "PaginationToken":{ + "type":"string", + "documentation":"Token or cursor used in paginated operations.
When this value is provided as operation input, the service returns results from where the previous response left off. When this value is present in operation output, it indicates that there are more results to retrieve.
This should be opaque to not expose implementation details and potentially versioned to allow evolution of pagination strategy.
" + }, + "Password":{ + "type":"string", + "sensitive":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{ + "shape":"String", + "documentation":"An error message describing the failure.
" + }, + "resourceId":{ + "shape":"String", + "documentation":"The ID of the resource that could not be located.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The type of the resource that could not be found.
" + } + }, + "documentation":"The specified resource could not be located.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "RestoreClusterFromSnapshotInput":{ + "type":"structure", + "required":[ + "clusterName", + "snapshotArn" + ], + "members":{ + "clusterName":{ + "shape":"String", + "documentation":"The name of the elastic cluster.
" + }, + "kmsKeyId":{ + "shape":"String", + "documentation":"The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
" + }, + "shardCapacity":{ + "shape":"Integer", + "documentation":"The capacity of each shard in the new restored elastic cluster.
" + }, + "shardInstanceCount":{ + "shape":"Integer", + "documentation":"The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
The ARN identifier of the elastic cluster snapshot.
", + "location":"uri", + "locationName":"snapshotArn" + }, + "subnetIds":{ + "shape":"StringList", + "documentation":"The Amazon EC2 subnet IDs for the elastic cluster.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.
" + }, + "vpcSecurityGroupIds":{ + "shape":"StringList", + "documentation":"A list of EC2 VPC security groups to associate with the elastic cluster.
" + } + } + }, + "RestoreClusterFromSnapshotOutput":{ + "type":"structure", + "required":["cluster"], + "members":{ + "cluster":{ + "shape":"Cluster", + "documentation":"Returns information about a the restored elastic cluster.
" + } + } + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The service quota for the action was exceeded.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "Shard":{ + "type":"structure", + "required":[ + "createTime", + "shardId", + "status" + ], + "members":{ + "createTime":{ + "shape":"String", + "documentation":"The time when the shard was created in Universal Coordinated Time (UTC).
" + }, + "shardId":{ + "shape":"String", + "documentation":"The ID of the shard.
" + }, + "status":{ + "shape":"Status", + "documentation":"The current status of the shard.
" + } + }, + "documentation":"The name of the shard.
" + }, + "ShardList":{ + "type":"list", + "member":{"shape":"Shard"} + }, + "SnapshotType":{ + "type":"string", + "enum":[ + "MANUAL", + "AUTOMATED" + ] + }, + "StartClusterInput":{ + "type":"structure", + "required":["clusterArn"], + "members":{ + "clusterArn":{ + "shape":"String", + "documentation":"The ARN identifier of the elastic cluster.
", + "location":"uri", + "locationName":"clusterArn" + } + } + }, + "StartClusterOutput":{ + "type":"structure", + "required":["cluster"], + "members":{ + "cluster":{"shape":"Cluster"} + } + }, + "Status":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING", + "UPDATING", + "VPC_ENDPOINT_LIMIT_EXCEEDED", + "IP_ADDRESS_LIMIT_EXCEEDED", + "INVALID_SECURITY_GROUP_ID", + "INVALID_SUBNET_ID", + "INACCESSIBLE_ENCRYPTION_CREDS", + "INACCESSIBLE_SECRET_ARN", + "INACCESSIBLE_VPC_ENDPOINT", + "INCOMPATIBLE_NETWORK", + "MERGING", + "MODIFYING", + "SPLITTING", + "COPYING", + "STARTING", + "STOPPING", + "STOPPED" + ] + }, + "StopClusterInput":{ + "type":"structure", + "required":["clusterArn"], + "members":{ + "clusterArn":{ + "shape":"String", + "documentation":"The ARN identifier of the elastic cluster.
", + "location":"uri", + "locationName":"clusterArn" + } + } + }, + "StopClusterOutput":{ + "type":"structure", + "required":["cluster"], + "members":{ + "cluster":{"shape":"Cluster"} + } + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The ARN identifier of the elastic cluster resource.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags that are assigned to the elastic cluster resource.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "retryAfterSeconds":{ + "shape":"Integer", + "documentation":"The number of seconds to wait before retrying the operation.
", + "location":"header", + "locationName":"Retry-After" + } + }, + "documentation":"ThrottlingException will be thrown when request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":false} + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The ARN identifier of the elastic cluster resource.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"The tag keys to be removed from the elastic cluster resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateClusterInput":{ + "type":"structure", + "required":["clusterArn"], + "members":{ + "adminUserPassword":{ + "shape":"Password", + "documentation":"The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol (@).
Constraints: Must contain from 8 to 100 characters.
" + }, + "authType":{ + "shape":"Auth", + "documentation":"The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.
The number of days for which automatic snapshots are retained.
" + }, + "clientToken":{ + "shape":"String", + "documentation":"The client token for the elastic cluster.
", + "idempotencyToken":true + }, + "clusterArn":{ + "shape":"String", + "documentation":"The ARN identifier of the elastic cluster.
", + "location":"uri", + "locationName":"clusterArn" + }, + "preferredBackupWindow":{ + "shape":"String", + "documentation":"The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
" + }, + "shardCapacity":{ + "shape":"Integer", + "documentation":"The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
" + }, + "shardCount":{ + "shape":"Integer", + "documentation":"The number of shards assigned to the elastic cluster. Maximum is 32.
" + }, + "shardInstanceCount":{ + "shape":"Integer", + "documentation":"The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
The Amazon EC2 subnet IDs for the elastic cluster.
" + }, + "vpcSecurityGroupIds":{ + "shape":"StringList", + "documentation":"A list of EC2 VPC security groups to associate with the elastic cluster.
" + } + } + }, + "UpdateClusterOutput":{ + "type":"structure", + "required":["cluster"], + "members":{ + "cluster":{ + "shape":"Cluster", + "documentation":"Returns information about the updated elastic cluster.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "required":[ + "message", + "reason" + ], + "members":{ + "fieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"A list of the fields in which the validation exception occurred.
" + }, + "message":{ + "shape":"String", + "documentation":"An error message describing the validation exception.
" + }, + "reason":{ + "shape":"ValidationExceptionReason", + "documentation":"The reason why the validation exception occurred (one of unknownOperation, cannotParse, fieldValidationFailed, or other).
A structure defining a validation exception.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "message", + "name" + ], + "members":{ + "message":{ + "shape":"String", + "documentation":"An error message describing the validation exception in this field.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the field where the validation exception occurred.
" + } + }, + "documentation":"A specific field in which a given validation exception occurred.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "unknownOperation", + "cannotParse", + "fieldValidationFailed", + "other" + ] + } + }, + "documentation":"Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage capacity. Amazon DocumentDB elastic clusters also simplify how developers interact with Amazon DocumentDB elastic-clusters by eliminating the need to choose, manage or upgrade instances.
Amazon DocumentDB elastic-clusters were created to:
provide a solution for customers looking for a database that provides virtually limitless scale with rich query capabilities and MongoDB API compatibility.
give customers higher connection limits, and to reduce downtime from patching.
continue investing in a cloud-native, elastic, and class leading architecture for JSON workloads.
Cancels a job run.
", + "idempotent":true + }, + "CreateApplication":{ + "name":"CreateApplication", + "http":{ + "method":"POST", + "requestUri":"/applications", + "responseCode":200 + }, + "input":{"shape":"CreateApplicationRequest"}, + "output":{"shape":"CreateApplicationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Creates an application.
", + "idempotent":true + }, + "DeleteApplication":{ + "name":"DeleteApplication", + "http":{ + "method":"DELETE", + "requestUri":"/applications/{applicationId}", + "responseCode":200 + }, + "input":{"shape":"DeleteApplicationRequest"}, + "output":{"shape":"DeleteApplicationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes an application. An application has to be in a stopped or created state in order to be deleted.
", + "idempotent":true + }, + "GetApplication":{ + "name":"GetApplication", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}", + "responseCode":200 + }, + "input":{"shape":"GetApplicationRequest"}, + "output":{"shape":"GetApplicationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Displays detailed information about a specified application.
" + }, + "GetDashboardForJobRun":{ + "name":"GetDashboardForJobRun", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/jobruns/{jobRunId}/dashboard", + "responseCode":200 + }, + "input":{"shape":"GetDashboardForJobRunRequest"}, + "output":{"shape":"GetDashboardForJobRunResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates and returns a URL that you can use to access the application UIs for a job run.
For jobs in a running state, the application UI is a live user interface such as the Spark or Tez web UI. For completed jobs, the application UI is a persistent application user interface such as the Spark History Server or persistent Tez UI.
The URL is valid for one hour after you generate it. To access the application UI after that hour elapses, you must invoke the API again to generate a new URL.
Displays detailed information about a job run.
" + }, + "ListApplications":{ + "name":"ListApplications", + "http":{ + "method":"GET", + "requestUri":"/applications", + "responseCode":200 + }, + "input":{"shape":"ListApplicationsRequest"}, + "output":{"shape":"ListApplicationsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists applications based on a set of parameters.
" + }, + "ListJobRunAttempts":{ + "name":"ListJobRunAttempts", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/jobruns/{jobRunId}/attempts", + "responseCode":200 + }, + "input":{"shape":"ListJobRunAttemptsRequest"}, + "output":{"shape":"ListJobRunAttemptsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists all attempt of a job run.
" + }, + "ListJobRuns":{ + "name":"ListJobRuns", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/jobruns", + "responseCode":200 + }, + "input":{"shape":"ListJobRunsRequest"}, + "output":{"shape":"ListJobRunsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists job runs based on a set of parameters.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists the tags assigned to the resources.
" + }, + "StartApplication":{ + "name":"StartApplication", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/start", + "responseCode":200 + }, + "input":{"shape":"StartApplicationRequest"}, + "output":{"shape":"StartApplicationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Starts a specified application and initializes initial capacity if configured.
", + "idempotent":true + }, + "StartJobRun":{ + "name":"StartJobRun", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/jobruns", + "responseCode":200 + }, + "input":{"shape":"StartJobRunRequest"}, + "output":{"shape":"StartJobRunResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Starts a job run.
", + "idempotent":true + }, + "StopApplication":{ + "name":"StopApplication", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/stop", + "responseCode":200 + }, + "input":{"shape":"StopApplicationRequest"}, + "output":{"shape":"StopApplicationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Stops a specified application and releases initial capacity if configured. All scheduled and running jobs must be completed or cancelled before stopping an application.
", + "idempotent":true + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your Amazon Web Services resources by attributes such as purpose, owner, or environment. When you have many resources of the same type, you can quickly identify a specific resource based on the tags you've assigned to it.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Removes tags from resources.
", + "idempotent":true + }, + "UpdateApplication":{ + "name":"UpdateApplication", + "http":{ + "method":"PATCH", + "requestUri":"/applications/{applicationId}", + "responseCode":200 + }, + "input":{"shape":"UpdateApplicationRequest"}, + "output":{"shape":"UpdateApplicationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates a specified application. An application has to be in a stopped or created state in order to be updated.
" + } + }, + "shapes":{ + "Application":{ + "type":"structure", + "required":[ + "applicationId", + "arn", + "releaseLabel", + "type", + "state", + "createdAt", + "updatedAt" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The ID of the application.
" + }, + "name":{ + "shape":"ApplicationName", + "documentation":"The name of the application.
" + }, + "arn":{ + "shape":"ApplicationArn", + "documentation":"The ARN of the application.
" + }, + "releaseLabel":{ + "shape":"ReleaseLabel", + "documentation":"The Amazon EMR release associated with the application.
" + }, + "type":{ + "shape":"EngineType", + "documentation":"The type of application, such as Spark or Hive.
" + }, + "state":{ + "shape":"ApplicationState", + "documentation":"The state of the application.
" + }, + "stateDetails":{ + "shape":"String256", + "documentation":"The state details of the application.
" + }, + "initialCapacity":{ + "shape":"InitialCapacityConfigMap", + "documentation":"The initial capacity of the application.
" + }, + "maximumCapacity":{ + "shape":"MaximumAllowedResources", + "documentation":"The maximum capacity of the application. This is cumulative across all workers at any given point in time during the lifespan of the application is created. No new resources will be created once any one of the defined limits is hit.
" + }, + "createdAt":{ + "shape":"Date", + "documentation":"The date and time when the application run was created.
" + }, + "updatedAt":{ + "shape":"Date", + "documentation":"The date and time when the application run was last updated.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags assigned to the application.
" + }, + "autoStartConfiguration":{ + "shape":"AutoStartConfig", + "documentation":"The configuration for an application to automatically start on job submission.
" + }, + "autoStopConfiguration":{ + "shape":"AutoStopConfig", + "documentation":"The configuration for an application to automatically stop after a certain amount of time being idle.
" + }, + "networkConfiguration":{ + "shape":"NetworkConfiguration", + "documentation":"The network configuration for customer VPC connectivity for the application.
" + }, + "architecture":{ + "shape":"Architecture", + "documentation":"The CPU architecture of an application.
" + }, + "imageConfiguration":{ + "shape":"ImageConfiguration", + "documentation":"The image configuration applied to all worker types.
" + }, + "workerTypeSpecifications":{ + "shape":"WorkerTypeSpecificationMap", + "documentation":"The specification applied to each worker type.
" + }, + "runtimeConfiguration":{ + "shape":"ConfigurationList", + "documentation":"The Configuration specifications of an application. Each configuration consists of a classification and properties. You use this parameter when creating or updating an application. To see the runtimeConfiguration object of an application, run the GetApplication API operation.
" + }, + "monitoringConfiguration":{"shape":"MonitoringConfiguration"}, + "interactiveConfiguration":{ + "shape":"InteractiveConfiguration", + "documentation":"The interactive configuration object that enables the interactive use cases for an application.
" + }, + "schedulerConfiguration":{ + "shape":"SchedulerConfiguration", + "documentation":"The scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above.
" + } + }, + "documentation":"Information about an application. Amazon EMR Serverless uses applications to run jobs.
" + }, + "ApplicationArn":{ + "type":"string", + "max":1024, + "min":60, + "pattern":"arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+" + }, + "ApplicationId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[0-9a-z]+" + }, + "ApplicationList":{ + "type":"list", + "member":{"shape":"ApplicationSummary"} + }, + "ApplicationName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z0-9._/#-]+" + }, + "ApplicationState":{ + "type":"string", + "enum":[ + "CREATING", + "CREATED", + "STARTING", + "STARTED", + "STOPPING", + "STOPPED", + "TERMINATED" + ] + }, + "ApplicationStateSet":{ + "type":"list", + "member":{"shape":"ApplicationState"}, + "max":7, + "min":1 + }, + "ApplicationSummary":{ + "type":"structure", + "required":[ + "id", + "arn", + "releaseLabel", + "type", + "state", + "createdAt", + "updatedAt" + ], + "members":{ + "id":{ + "shape":"ApplicationId", + "documentation":"The ID of the application.
" + }, + "name":{ + "shape":"ApplicationName", + "documentation":"The name of the application.
" + }, + "arn":{ + "shape":"ApplicationArn", + "documentation":"The ARN of the application.
" + }, + "releaseLabel":{ + "shape":"ReleaseLabel", + "documentation":"The Amazon EMR release associated with the application.
" + }, + "type":{ + "shape":"EngineType", + "documentation":"The type of application, such as Spark or Hive.
" + }, + "state":{ + "shape":"ApplicationState", + "documentation":"The state of the application.
" + }, + "stateDetails":{ + "shape":"String256", + "documentation":"The state details of the application.
" + }, + "createdAt":{ + "shape":"Date", + "documentation":"The date and time when the application was created.
" + }, + "updatedAt":{ + "shape":"Date", + "documentation":"The date and time when the application was last updated.
" + }, + "architecture":{ + "shape":"Architecture", + "documentation":"The CPU architecture of an application.
" + } + }, + "documentation":"The summary of attributes associated with an application.
" + }, + "Architecture":{ + "type":"string", + "enum":[ + "ARM64", + "X86_64" + ] + }, + "AttemptNumber":{ + "type":"integer", + "box":true, + "min":1 + }, + "AutoStartConfig":{ + "type":"structure", + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"Enables the application to automatically start on job submission. Defaults to true.
" + } + }, + "documentation":"The configuration for an application to automatically start on job submission.
" + }, + "AutoStopConfig":{ + "type":"structure", + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"Enables the application to automatically stop after a certain amount of time being idle. Defaults to true.
" + }, + "idleTimeoutMinutes":{ + "shape":"AutoStopConfigIdleTimeoutMinutesInteger", + "documentation":"The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.
" + } + }, + "documentation":"The configuration for an application to automatically stop after a certain amount of time being idle.
" + }, + "AutoStopConfigIdleTimeoutMinutesInteger":{ + "type":"integer", + "box":true, + "max":10080, + "min":1 + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "CancelJobRunRequest":{ + "type":"structure", + "required":[ + "applicationId", + "jobRunId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The ID of the application on which the job run will be canceled.
", + "location":"uri", + "locationName":"applicationId" + }, + "jobRunId":{ + "shape":"JobRunId", + "documentation":"The ID of the job run to cancel.
", + "location":"uri", + "locationName":"jobRunId" + } + } + }, + "CancelJobRunResponse":{ + "type":"structure", + "required":[ + "applicationId", + "jobRunId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The output contains the application ID on which the job run is cancelled.
" + }, + "jobRunId":{ + "shape":"JobRunId", + "documentation":"The output contains the ID of the cancelled job run.
" + } + } + }, + "ClientToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z0-9._-]+" + }, + "CloudWatchLoggingConfiguration":{ + "type":"structure", + "required":["enabled"], + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"Enables CloudWatch logging.
" + }, + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.
" + }, + "logStreamNamePrefix":{ + "shape":"LogStreamNamePrefix", + "documentation":"Prefix for the CloudWatch log stream name.
" + }, + "encryptionKeyArn":{ + "shape":"EncryptionKeyArn", + "documentation":"The Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.
" + }, + "logTypes":{ + "shape":"LogTypeMap", + "documentation":"The types of logs that you want to publish to CloudWatch. If you don't specify any log types, driver STDOUT and STDERR logs will be published to CloudWatch Logs by default. For more information including the supported worker types for Hive and Spark, see Logging for EMR Serverless with CloudWatch.
Key Valid Values: SPARK_DRIVER, SPARK_EXECUTOR, HIVE_DRIVER, TEZ_TASK
Array Members Valid Values: STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS
The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs to send log information to CloudWatch.
" + }, + "Configuration":{ + "type":"structure", + "required":["classification"], + "members":{ + "classification":{ + "shape":"String1024", + "documentation":"The classification within a configuration.
" + }, + "properties":{ + "shape":"SensitivePropertiesMap", + "documentation":"A set of properties specified within a configuration classification.
" + }, + "configurations":{ + "shape":"ConfigurationList", + "documentation":"A list of additional configurations to apply within a configuration object.
" + } + }, + "documentation":"A configuration specification to be used when provisioning an application. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.
" + }, + "ConfigurationList":{ + "type":"list", + "member":{"shape":"Configuration"}, + "max":100, + "min":0 + }, + "ConfigurationOverrides":{ + "type":"structure", + "members":{ + "applicationConfiguration":{ + "shape":"ConfigurationList", + "documentation":"The override configurations for the application.
" + }, + "monitoringConfiguration":{ + "shape":"MonitoringConfiguration", + "documentation":"The override configurations for monitoring.
" + } + }, + "documentation":"A configuration specification to be used to override existing configurations.
" + }, + "ConfigurationPropertyKey":{ + "type":"string", + "max":1024, + "min":1, + "pattern":".*\\S.*" + }, + "ConfigurationPropertyValue":{ + "type":"string", + "max":1024, + "min":0, + "pattern":".*\\S.*" + }, + "ConflictException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String1024"} + }, + "documentation":"The request could not be processed because of conflict in the current state of the resource.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CpuSize":{ + "type":"string", + "max":15, + "min":1, + "pattern":"[1-9][0-9]*(\\s)?(vCPU|vcpu|VCPU)?" + }, + "CreateApplicationRequest":{ + "type":"structure", + "required":[ + "releaseLabel", + "type", + "clientToken" + ], + "members":{ + "name":{ + "shape":"ApplicationName", + "documentation":"The name of the application.
" + }, + "releaseLabel":{ + "shape":"ReleaseLabel", + "documentation":"The Amazon EMR release associated with the application.
" + }, + "type":{ + "shape":"EngineType", + "documentation":"The type of application you want to start, such as Spark or Hive.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"The client idempotency token of the application to create. Its value must be unique for each request.
", + "idempotencyToken":true + }, + "initialCapacity":{ + "shape":"InitialCapacityConfigMap", + "documentation":"The capacity to initialize when the application is created.
" + }, + "maximumCapacity":{ + "shape":"MaximumAllowedResources", + "documentation":"The maximum capacity to allocate when the application is created. This is cumulative across all workers at any given point in time, not just when an application is created. No new resources will be created once any one of the defined limits is hit.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags assigned to the application.
" + }, + "autoStartConfiguration":{ + "shape":"AutoStartConfig", + "documentation":"The configuration for an application to automatically start on job submission.
" + }, + "autoStopConfiguration":{ + "shape":"AutoStopConfig", + "documentation":"The configuration for an application to automatically stop after a certain amount of time being idle.
" + }, + "networkConfiguration":{ + "shape":"NetworkConfiguration", + "documentation":"The network configuration for customer VPC connectivity.
" + }, + "architecture":{ + "shape":"Architecture", + "documentation":"The CPU architecture of an application.
" + }, + "imageConfiguration":{ + "shape":"ImageConfigurationInput", + "documentation":"The image configuration for all worker types. You can either set this parameter or imageConfiguration for each worker type in workerTypeSpecifications.
The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.
The Configuration specifications to use when creating an application. Each configuration consists of a classification and properties. This configuration is applied to all the job runs submitted under the application.
" + }, + "monitoringConfiguration":{ + "shape":"MonitoringConfiguration", + "documentation":"The configuration setting for monitoring.
" + }, + "interactiveConfiguration":{ + "shape":"InteractiveConfiguration", + "documentation":"The interactive configuration object that enables the interactive use cases to use when running an application.
" + }, + "schedulerConfiguration":{ + "shape":"SchedulerConfiguration", + "documentation":"The scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above.
" + } + } + }, + "CreateApplicationResponse":{ + "type":"structure", + "required":[ + "applicationId", + "arn" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The output contains the application ID.
" + }, + "name":{ + "shape":"ApplicationName", + "documentation":"The output contains the name of the application.
" + }, + "arn":{ + "shape":"ApplicationArn", + "documentation":"The output contains the ARN of the application.
" + } + } + }, + "Date":{"type":"timestamp"}, + "DeleteApplicationRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The ID of the application that will be deleted.
", + "location":"uri", + "locationName":"applicationId" + } + } + }, + "DeleteApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "DiskSize":{ + "type":"string", + "max":15, + "min":1, + "pattern":"[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)" + }, + "DiskType":{ + "type":"string", + "pattern":"(SHUFFLE_OPTIMIZED|[Ss]huffle_[Oo]ptimized|STANDARD|[Ss]tandard)" + }, + "Double":{ + "type":"double", + "box":true + }, + "Duration":{ + "type":"long", + "max":1000000, + "min":0 + }, + "EncryptionKeyArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:(aws[a-zA-Z0-9-]*):kms:[a-zA-Z0-9\\-]*:([0-9]{12}):key\\/[a-zA-Z0-9-]+" + }, + "EngineType":{ + "type":"string", + "max":64, + "min":1 + }, + "EntryPointArgument":{ + "type":"string", + "max":10280, + "min":1, + "pattern":".*\\S.*", + "sensitive":true + }, + "EntryPointArguments":{ + "type":"list", + "member":{"shape":"EntryPointArgument"} + }, + "EntryPointPath":{ + "type":"string", + "max":256, + "min":1, + "pattern":".*\\S.*", + "sensitive":true + }, + "GetApplicationRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The ID of the application that will be described.
", + "location":"uri", + "locationName":"applicationId" + } + } + }, + "GetApplicationResponse":{ + "type":"structure", + "required":["application"], + "members":{ + "application":{ + "shape":"Application", + "documentation":"The output displays information about the specified application.
" + } + } + }, + "GetDashboardForJobRunRequest":{ + "type":"structure", + "required":[ + "applicationId", + "jobRunId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The ID of the application.
", + "location":"uri", + "locationName":"applicationId" + }, + "jobRunId":{ + "shape":"JobRunId", + "documentation":"The ID of the job run.
", + "location":"uri", + "locationName":"jobRunId" + }, + "attempt":{ + "shape":"AttemptNumber", + "documentation":"An optimal parameter that indicates the amount of attempts for the job. If not specified, this value defaults to the attempt of the latest job.
", + "location":"querystring", + "locationName":"attempt" + } + } + }, + "GetDashboardForJobRunResponse":{ + "type":"structure", + "members":{ + "url":{ + "shape":"Url", + "documentation":"The URL to view job run's dashboard.
" + } + } + }, + "GetJobRunRequest":{ + "type":"structure", + "required":[ + "applicationId", + "jobRunId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The ID of the application on which the job run is submitted.
", + "location":"uri", + "locationName":"applicationId" + }, + "jobRunId":{ + "shape":"JobRunId", + "documentation":"The ID of the job run.
", + "location":"uri", + "locationName":"jobRunId" + }, + "attempt":{ + "shape":"AttemptNumber", + "documentation":"An optimal parameter that indicates the amount of attempts for the job. If not specified, this value defaults to the attempt of the latest job.
", + "location":"querystring", + "locationName":"attempt" + } + } + }, + "GetJobRunResponse":{ + "type":"structure", + "required":["jobRun"], + "members":{ + "jobRun":{ + "shape":"JobRun", + "documentation":"The output displays information about the job run.
" + } + } + }, + "Hive":{ + "type":"structure", + "required":["query"], + "members":{ + "query":{ + "shape":"Query", + "documentation":"The query for the Hive job run.
" + }, + "initQueryFile":{ + "shape":"InitScriptPath", + "documentation":"The query file for the Hive job run.
" + }, + "parameters":{ + "shape":"HiveCliParameters", + "documentation":"The parameters for the Hive job run.
" + } + }, + "documentation":"The configurations for the Hive job driver.
" + }, + "HiveCliParameters":{ + "type":"string", + "max":102400, + "min":1, + "pattern":".*\\S.*", + "sensitive":true + }, + "IAMRoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:(aws[a-zA-Z0-9-]*):iam::([0-9]{12}):(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)" + }, + "ImageConfiguration":{ + "type":"structure", + "required":["imageUri"], + "members":{ + "imageUri":{ + "shape":"ImageUri", + "documentation":"The image URI.
" + }, + "resolvedImageDigest":{ + "shape":"ImageDigest", + "documentation":"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.
" + } + }, + "documentation":"The applied image configuration.
" + }, + "ImageConfigurationInput":{ + "type":"structure", + "members":{ + "imageUri":{ + "shape":"ImageUri", + "documentation":"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.
" + } + }, + "documentation":"The image configuration.
" + }, + "ImageDigest":{ + "type":"string", + "pattern":"sha256:[0-9a-f]{64}" + }, + "ImageUri":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"([a-z0-9]+[a-z0-9-.]*)\\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(?:\\:([a-zA-Z0-9_][a-zA-Z0-9-._]{0,299})|@(sha256:[0-9a-f]{64}))" + }, + "InitScriptPath":{ + "type":"string", + "max":256, + "min":1, + "pattern":".*\\S.*", + "sensitive":true + }, + "InitialCapacityConfig":{ + "type":"structure", + "required":["workerCount"], + "members":{ + "workerCount":{ + "shape":"WorkerCounts", + "documentation":"The number of workers in the initial capacity configuration.
" + }, + "workerConfiguration":{ + "shape":"WorkerResourceConfig", + "documentation":"The resource configuration of the initial capacity configuration.
" + } + }, + "documentation":"The initial capacity configuration per worker.
" + }, + "InitialCapacityConfigMap":{ + "type":"map", + "key":{"shape":"WorkerTypeString"}, + "value":{"shape":"InitialCapacityConfig"}, + "max":10, + "min":0 + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InteractiveConfiguration":{ + "type":"structure", + "members":{ + "studioEnabled":{ + "shape":"Boolean", + "documentation":"Enables you to connect an application to Amazon EMR Studio to run interactive workloads in a notebook.
" + }, + "livyEndpointEnabled":{ + "shape":"Boolean", + "documentation":"Enables an Apache Livy endpoint that you can connect to and run interactive jobs.
" + } + }, + "documentation":"The configuration to use to enable the different types of interactive use cases in an application.
" + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String1024"} + }, + "documentation":"Request processing failed because of an error or failure with the service.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "JobArn":{ + "type":"string", + "max":1024, + "min":60, + "pattern":"arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+\\/jobruns\\/[0-9a-zA-Z]+" + }, + "JobDriver":{ + "type":"structure", + "members":{ + "sparkSubmit":{ + "shape":"SparkSubmit", + "documentation":"The job driver parameters specified for Spark.
" + }, + "hive":{ + "shape":"Hive", + "documentation":"The job driver parameters specified for Hive.
" + } + }, + "documentation":"The driver that the job runs on.
", + "union":true + }, + "JobRun":{ + "type":"structure", + "required":[ + "applicationId", + "jobRunId", + "arn", + "createdBy", + "createdAt", + "updatedAt", + "executionRole", + "state", + "stateDetails", + "releaseLabel", + "jobDriver" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The ID of the application the job is running on.
" + }, + "jobRunId":{ + "shape":"JobRunId", + "documentation":"The ID of the job run.
" + }, + "name":{ + "shape":"String256", + "documentation":"The optional job run name. This doesn't have to be unique.
" + }, + "arn":{ + "shape":"JobArn", + "documentation":"The execution role ARN of the job run.
" + }, + "createdBy":{ + "shape":"RequestIdentityUserArn", + "documentation":"The user who created the job run.
" + }, + "createdAt":{ + "shape":"Date", + "documentation":"The date and time when the job run was created.
" + }, + "updatedAt":{ + "shape":"Date", + "documentation":"The date and time when the job run was updated.
" + }, + "executionRole":{ + "shape":"IAMRoleArn", + "documentation":"The execution role ARN of the job run.
" + }, + "state":{ + "shape":"JobRunState", + "documentation":"The state of the job run.
" + }, + "stateDetails":{ + "shape":"String256", + "documentation":"The state details of the job run.
" + }, + "releaseLabel":{ + "shape":"ReleaseLabel", + "documentation":"The Amazon EMR release associated with the application your job is running on.
" + }, + "configurationOverrides":{ + "shape":"ConfigurationOverrides", + "documentation":"The configuration settings that are used to override default configuration.
" + }, + "jobDriver":{ + "shape":"JobDriver", + "documentation":"The job driver for the job run.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags assigned to the job run.
" + }, + "totalResourceUtilization":{ + "shape":"TotalResourceUtilization", + "documentation":"The aggregate vCPU, memory, and storage resources used from the time the job starts to execute, until the time the job terminates, rounded up to the nearest second.
" + }, + "networkConfiguration":{"shape":"NetworkConfiguration"}, + "totalExecutionDurationSeconds":{ + "shape":"Integer", + "documentation":"The job run total execution duration in seconds. This field is only available for job runs in a COMPLETED, FAILED, or CANCELLED state.
Returns the job run timeout value from the StartJobRun call. If no timeout was specified, then it returns the default timeout of 720 minutes.
The aggregate vCPU, memory, and storage that Amazon Web Services has billed for the job run. The billed resources include a 1-minute minimum usage for workers, plus additional storage over 20 GB per worker. Note that billed resources do not include usage for idle pre-initialized workers.
" + }, + "mode":{ + "shape":"JobRunMode", + "documentation":"The mode of the job run.
" + }, + "retryPolicy":{ + "shape":"RetryPolicy", + "documentation":"The retry policy of the job run.
" + }, + "attempt":{ + "shape":"AttemptNumber", + "documentation":"The attempt of the job run.
" + }, + "attemptCreatedAt":{ + "shape":"Date", + "documentation":"The date and time of when the job run attempt was created.
" + }, + "attemptUpdatedAt":{ + "shape":"Date", + "documentation":"The date and time of when the job run attempt was last updated.
" + }, + "startedAt":{ + "shape":"Date", + "documentation":"The date and time when the job moved to the RUNNING state.
" + }, + "endedAt":{ + "shape":"Date", + "documentation":"The date and time when the job was terminated.
" + }, + "queuedDurationMilliseconds":{ + "shape":"Long", + "documentation":"The total time for a job in the QUEUED state in milliseconds.
" + } + }, + "documentation":"Information about a job run. A job run is a unit of work, such as a Spark JAR, Hive query, or SparkSQL query, that you submit to an Amazon EMR Serverless application.
" + }, + "JobRunAttemptSummary":{ + "type":"structure", + "required":[ + "applicationId", + "id", + "arn", + "createdBy", + "jobCreatedAt", + "createdAt", + "updatedAt", + "executionRole", + "state", + "stateDetails", + "releaseLabel" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The ID of the application the job is running on.
" + }, + "id":{ + "shape":"JobRunId", + "documentation":"The ID of the job run attempt.
" + }, + "name":{ + "shape":"String256", + "documentation":"The name of the job run attempt.
" + }, + "mode":{ + "shape":"JobRunMode", + "documentation":"The mode of the job run attempt.
" + }, + "arn":{ + "shape":"JobArn", + "documentation":"The Amazon Resource Name (ARN) of the job run.
" + }, + "createdBy":{ + "shape":"RequestIdentityUserArn", + "documentation":"The user who created the job run.
" + }, + "jobCreatedAt":{ + "shape":"Date", + "documentation":"The date and time of when the job run was created.
" + }, + "createdAt":{ + "shape":"Date", + "documentation":"The date and time when the job run attempt was created.
" + }, + "updatedAt":{ + "shape":"Date", + "documentation":"The date and time of when the job run attempt was last updated.
" + }, + "executionRole":{ + "shape":"IAMRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the execution role of the job run..
" + }, + "state":{ + "shape":"JobRunState", + "documentation":"The state of the job run attempt.
" + }, + "stateDetails":{ + "shape":"String256", + "documentation":"The state details of the job run attempt.
" + }, + "releaseLabel":{ + "shape":"ReleaseLabel", + "documentation":"The Amazon EMR release label of the job run attempt.
" + }, + "type":{ + "shape":"JobRunType", + "documentation":"The type of the job run, such as Spark or Hive.
" + }, + "attempt":{ + "shape":"AttemptNumber", + "documentation":"The attempt number of the job run execution.
" + } + }, + "documentation":"The summary of attributes associated with a job run attempt.
" + }, + "JobRunAttempts":{ + "type":"list", + "member":{"shape":"JobRunAttemptSummary"} + }, + "JobRunId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[0-9a-z]+" + }, + "JobRunMode":{ + "type":"string", + "enum":[ + "BATCH", + "STREAMING" + ] + }, + "JobRunState":{ + "type":"string", + "enum":[ + "SUBMITTED", + "PENDING", + "SCHEDULED", + "RUNNING", + "SUCCESS", + "FAILED", + "CANCELLING", + "CANCELLED", + "QUEUED" + ] + }, + "JobRunStateSet":{ + "type":"list", + "member":{"shape":"JobRunState"}, + "max":8, + "min":0 + }, + "JobRunSummary":{ + "type":"structure", + "required":[ + "applicationId", + "id", + "arn", + "createdBy", + "createdAt", + "updatedAt", + "executionRole", + "state", + "stateDetails", + "releaseLabel" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The ID of the application the job is running on.
" + }, + "id":{ + "shape":"JobRunId", + "documentation":"The ID of the job run.
" + }, + "name":{ + "shape":"String256", + "documentation":"The optional job run name. This doesn't have to be unique.
" + }, + "mode":{ + "shape":"JobRunMode", + "documentation":"The mode of the job run.
" + }, + "arn":{ + "shape":"JobArn", + "documentation":"The ARN of the job run.
" + }, + "createdBy":{ + "shape":"RequestIdentityUserArn", + "documentation":"The user who created the job run.
" + }, + "createdAt":{ + "shape":"Date", + "documentation":"The date and time when the job run was created.
" + }, + "updatedAt":{ + "shape":"Date", + "documentation":"The date and time when the job run was last updated.
" + }, + "executionRole":{ + "shape":"IAMRoleArn", + "documentation":"The execution role ARN of the job run.
" + }, + "state":{ + "shape":"JobRunState", + "documentation":"The state of the job run.
" + }, + "stateDetails":{ + "shape":"String256", + "documentation":"The state details of the job run.
" + }, + "releaseLabel":{ + "shape":"ReleaseLabel", + "documentation":"The Amazon EMR release associated with the application your job is running on.
" + }, + "type":{ + "shape":"JobRunType", + "documentation":"The type of job run, such as Spark or Hive.
" + }, + "attempt":{ + "shape":"AttemptNumber", + "documentation":"The attempt number of the job run execution.
" + }, + "attemptCreatedAt":{ + "shape":"Date", + "documentation":"The date and time of when the job run attempt was created.
" + }, + "attemptUpdatedAt":{ + "shape":"Date", + "documentation":"The date and time of when the job run attempt was last updated.
" + } + }, + "documentation":"The summary of attributes associated with a job run.
" + }, + "JobRunType":{"type":"string"}, + "JobRuns":{ + "type":"list", + "member":{"shape":"JobRunSummary"} + }, + "ListApplicationsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of application results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"ListApplicationsRequestMaxResultsInteger", + "documentation":"The maximum number of applications that can be listed.
", + "location":"querystring", + "locationName":"maxResults" + }, + "states":{ + "shape":"ApplicationStateSet", + "documentation":"An optional filter for application states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.
", + "location":"querystring", + "locationName":"states" + } + } + }, + "ListApplicationsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "ListApplicationsResponse":{ + "type":"structure", + "required":["applications"], + "members":{ + "applications":{ + "shape":"ApplicationList", + "documentation":"The output lists the specified applications.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The output displays the token for the next set of application results. This is required for pagination and is available as a response of the previous request.
" + } + } + }, + "ListJobRunAttemptsRequest":{ + "type":"structure", + "required":[ + "applicationId", + "jobRunId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The ID of the application for which to list job runs.
", + "location":"uri", + "locationName":"applicationId" + }, + "jobRunId":{ + "shape":"JobRunId", + "documentation":"The ID of the job run to list.
", + "location":"uri", + "locationName":"jobRunId" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of job run attempt results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"ListJobRunAttemptsRequestMaxResultsInteger", + "documentation":"The maximum number of job run attempts to list.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListJobRunAttemptsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "ListJobRunAttemptsResponse":{ + "type":"structure", + "required":["jobRunAttempts"], + "members":{ + "jobRunAttempts":{ + "shape":"JobRunAttempts", + "documentation":"The array of the listed job run attempt objects.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The output displays the token for the next set of application results. This is required for pagination and is available as a response of the previous request.
" + } + } + }, + "ListJobRunsRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The ID of the application for which to list the job run.
", + "location":"uri", + "locationName":"applicationId" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of job run results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"ListJobRunsRequestMaxResultsInteger", + "documentation":"The maximum number of job runs that can be listed.
", + "location":"querystring", + "locationName":"maxResults" + }, + "createdAtAfter":{ + "shape":"Date", + "documentation":"The lower bound of the option to filter by creation date and time.
", + "location":"querystring", + "locationName":"createdAtAfter" + }, + "createdAtBefore":{ + "shape":"Date", + "documentation":"The upper bound of the option to filter by creation date and time.
", + "location":"querystring", + "locationName":"createdAtBefore" + }, + "states":{ + "shape":"JobRunStateSet", + "documentation":"An optional filter for job run states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.
", + "location":"querystring", + "locationName":"states" + }, + "mode":{ + "shape":"JobRunMode", + "documentation":"The mode of the job runs to list.
", + "location":"querystring", + "locationName":"mode" + } + } + }, + "ListJobRunsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "ListJobRunsResponse":{ + "type":"structure", + "required":["jobRuns"], + "members":{ + "jobRuns":{ + "shape":"JobRuns", + "documentation":"The output lists information about the specified job runs.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The output displays the token for the next set of job run results. This is required for pagination and is available as a response of the previous request.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"The tags for the resource.
" + } + } + }, + "LogGroupName":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[\\.\\-_/#A-Za-z0-9]+" + }, + "LogStreamNamePrefix":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[^:*]*" + }, + "LogTypeList":{ + "type":"list", + "member":{"shape":"LogTypeString"}, + "max":5, + "min":1 + }, + "LogTypeMap":{ + "type":"map", + "key":{"shape":"WorkerTypeString"}, + "value":{"shape":"LogTypeList"}, + "max":4, + "min":1 + }, + "LogTypeString":{ + "type":"string", + "documentation":"Log type for a Spark/Hive job-run.
", + "max":50, + "min":1, + "pattern":"[a-zA-Z]+[-_]*[a-zA-Z]+" + }, + "Long":{ + "type":"long", + "box":true + }, + "ManagedPersistenceMonitoringConfiguration":{ + "type":"structure", + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"Enables managed logging and defaults to true. If set to false, managed logging will be turned off.
" + }, + "encryptionKeyArn":{ + "shape":"EncryptionKeyArn", + "documentation":"The KMS key ARN to encrypt the logs stored in managed log persistence.
" + } + }, + "documentation":"The managed log persistence configuration for a job run.
" + }, + "MaximumAllowedResources":{ + "type":"structure", + "required":[ + "cpu", + "memory" + ], + "members":{ + "cpu":{ + "shape":"CpuSize", + "documentation":"The maximum allowed CPU for an application.
" + }, + "memory":{ + "shape":"MemorySize", + "documentation":"The maximum allowed resources for an application.
" + }, + "disk":{ + "shape":"DiskSize", + "documentation":"The maximum allowed disk for an application.
" + } + }, + "documentation":"The maximum allowed cumulative resources for an application. No new resources will be created once the limit is hit.
" + }, + "MemorySize":{ + "type":"string", + "max":15, + "min":1, + "pattern":"[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)?" + }, + "MonitoringConfiguration":{ + "type":"structure", + "members":{ + "s3MonitoringConfiguration":{ + "shape":"S3MonitoringConfiguration", + "documentation":"The Amazon S3 configuration for monitoring log publishing.
" + }, + "managedPersistenceMonitoringConfiguration":{ + "shape":"ManagedPersistenceMonitoringConfiguration", + "documentation":"The managed log persistence configuration for a job run.
" + }, + "cloudWatchLoggingConfiguration":{ + "shape":"CloudWatchLoggingConfiguration", + "documentation":"The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs to send log information to CloudWatch.
" + }, + "prometheusMonitoringConfiguration":{ + "shape":"PrometheusMonitoringConfiguration", + "documentation":"The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.
" + } + }, + "documentation":"The configuration setting for monitoring.
" + }, + "NetworkConfiguration":{ + "type":"structure", + "members":{ + "subnetIds":{ + "shape":"SubnetIds", + "documentation":"The array of subnet Ids for customer VPC connectivity.
" + }, + "securityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"The array of security group Ids for customer VPC connectivity.
" + } + }, + "documentation":"The network configuration for customer VPC connectivity.
" + }, + "NextToken":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[A-Za-z0-9_=-]+" + }, + "PrometheusMonitoringConfiguration":{ + "type":"structure", + "members":{ + "remoteWriteUrl":{ + "shape":"PrometheusUrlString", + "documentation":"The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.
" + } + }, + "documentation":"The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.
" + }, + "PrometheusUrlString":{ + "type":"string", + "max":10280, + "min":1, + "pattern":"https://aps-workspaces.([a-z]{2}-[a-z-]{1,20}-[1-9]).amazonaws(.[0-9A-Za-z]{2,4})+/workspaces/[-_.0-9A-Za-z]{1,100}/api/v1/remote_write" + }, + "Query":{ + "type":"string", + "max":10280, + "min":1, + "pattern":".*\\S.*", + "sensitive":true + }, + "ReleaseLabel":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z0-9._/-]+" + }, + "RequestIdentityUserArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\\d{12})?:[\\w/+=,.@-]+" + }, + "ResourceArn":{ + "type":"string", + "max":1024, + "min":60, + "pattern":"arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+(\\/jobruns\\/[0-9a-zA-Z]+)?" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String1024"} + }, + "documentation":"The specified resource was not found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceUtilization":{ + "type":"structure", + "members":{ + "vCPUHour":{ + "shape":"Double", + "documentation":"The aggregated vCPU used per hour from the time the job starts executing until the job is terminated.
" + }, + "memoryGBHour":{ + "shape":"Double", + "documentation":"The aggregated memory used per hour from the time the job starts executing until the job is terminated.
" + }, + "storageGBHour":{ + "shape":"Double", + "documentation":"The aggregated storage used per hour from the time the job starts executing until the job is terminated.
" + } + }, + "documentation":"The resource utilization for memory, storage, and vCPU for jobs.
" + }, + "RetryPolicy":{ + "type":"structure", + "members":{ + "maxAttempts":{ + "shape":"AttemptNumber", + "documentation":"Maximum number of attempts for the job run. This parameter is only applicable for BATCH mode.
Maximum number of failed attempts per hour. This [arameter is only applicable for STREAMING mode.
The retry policy to use for a job run.
" + }, + "RetryPolicyMaxFailedAttemptsPerHourInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "S3MonitoringConfiguration":{ + "type":"structure", + "members":{ + "logUri":{ + "shape":"UriString", + "documentation":"The Amazon S3 destination URI for log publishing.
" + }, + "encryptionKeyArn":{ + "shape":"EncryptionKeyArn", + "documentation":"The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.
" + } + }, + "documentation":"The Amazon S3 configuration for monitoring log publishing. You can configure your jobs to send log information to Amazon S3.
" + }, + "SchedulerConfiguration":{ + "type":"structure", + "members":{ + "queueTimeoutMinutes":{ + "shape":"Integer", + "documentation":"The maximum duration in minutes for the job in QUEUED state. If scheduler configuration is enabled on your application, the default value is 360 minutes (6 hours). The valid range is from 15 to 720.
" + }, + "maxConcurrentRuns":{ + "shape":"Integer", + "documentation":"The maximum concurrent job runs on this application. If scheduler configuration is enabled on your application, the default value is 15. The valid range is 1 to 1000.
" + } + }, + "documentation":"The scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above.
" + }, + "SecurityGroupIds":{ + "type":"list", + "member":{"shape":"SecurityGroupString"}, + "max":5, + "min":0 + }, + "SecurityGroupString":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[-0-9a-zA-Z]+.*" + }, + "SensitivePropertiesMap":{ + "type":"map", + "key":{"shape":"ConfigurationPropertyKey"}, + "value":{"shape":"ConfigurationPropertyValue"}, + "max":100, + "min":0, + "sensitive":true + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String1024"} + }, + "documentation":"The maximum number of resources per account has been reached.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SparkSubmit":{ + "type":"structure", + "required":["entryPoint"], + "members":{ + "entryPoint":{ + "shape":"EntryPointPath", + "documentation":"The entry point for the Spark submit job run.
" + }, + "entryPointArguments":{ + "shape":"EntryPointArguments", + "documentation":"The arguments for the Spark submit job run.
" + }, + "sparkSubmitParameters":{ + "shape":"SparkSubmitParameters", + "documentation":"The parameters for the Spark submit job run.
" + } + }, + "documentation":"The configurations for the Spark submit job driver.
" + }, + "SparkSubmitParameters":{ + "type":"string", + "max":102400, + "min":1, + "pattern":".*\\S.*", + "sensitive":true + }, + "StartApplicationRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The ID of the application to start.
", + "location":"uri", + "locationName":"applicationId" + } + } + }, + "StartApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "StartJobRunRequest":{ + "type":"structure", + "required":[ + "applicationId", + "clientToken", + "executionRoleArn" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The ID of the application on which to run the job.
", + "location":"uri", + "locationName":"applicationId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"The client idempotency token of the job run to start. Its value must be unique for each request.
", + "idempotencyToken":true + }, + "executionRoleArn":{ + "shape":"IAMRoleArn", + "documentation":"The execution role ARN for the job run.
" + }, + "jobDriver":{ + "shape":"JobDriver", + "documentation":"The job driver for the job run.
" + }, + "configurationOverrides":{ + "shape":"ConfigurationOverrides", + "documentation":"The configuration overrides for the job run.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags assigned to the job run.
" + }, + "executionTimeoutMinutes":{ + "shape":"Duration", + "documentation":"The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.
", + "box":true + }, + "name":{ + "shape":"String256", + "documentation":"The optional job run name. This doesn't have to be unique.
" + }, + "mode":{ + "shape":"JobRunMode", + "documentation":"The mode of the job run when it starts.
" + }, + "retryPolicy":{ + "shape":"RetryPolicy", + "documentation":"The retry policy when job run starts.
" + } + } + }, + "StartJobRunResponse":{ + "type":"structure", + "required":[ + "applicationId", + "jobRunId", + "arn" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"This output displays the application ID on which the job run was submitted.
" + }, + "jobRunId":{ + "shape":"JobRunId", + "documentation":"The output contains the ID of the started job run.
" + }, + "arn":{ + "shape":"JobArn", + "documentation":"This output displays the ARN of the job run..
" + } + } + }, + "StopApplicationRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The ID of the application to stop.
", + "location":"uri", + "locationName":"applicationId" + } + } + }, + "StopApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "String1024":{ + "type":"string", + "max":1024, + "min":1, + "pattern":".*\\S.*" + }, + "String256":{ + "type":"string", + "max":256, + "min":1, + "pattern":".*\\S.*" + }, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetString"}, + "max":16, + "min":0 + }, + "SubnetString":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[-0-9a-zA-Z]+.*" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[A-Za-z0-9 /_.:=+@-]+" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":1 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags to add to the resource. A tag is an array of key-value pairs.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"[A-Za-z0-9 /_.:=+@-]*" + }, + "TotalResourceUtilization":{ + "type":"structure", + "members":{ + "vCPUHour":{ + "shape":"Double", + "documentation":"The aggregated vCPU used per hour from the time job start executing till the time job is terminated.
" + }, + "memoryGBHour":{ + "shape":"Double", + "documentation":"The aggregated memory used per hour from the time job start executing till the time job is terminated.
" + }, + "storageGBHour":{ + "shape":"Double", + "documentation":"The aggregated storage used per hour from the time job start executing till the time job is terminated.
" + } + }, + "documentation":"The aggregate vCPU, memory, and storage resources used from the time job start executing till the time job is terminated, rounded up to the nearest second.
" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"The keys of the tags to be removed.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateApplicationRequest":{ + "type":"structure", + "required":[ + "applicationId", + "clientToken" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The ID of the application to update.
", + "location":"uri", + "locationName":"applicationId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"The client idempotency token of the application to update. Its value must be unique for each request.
", + "idempotencyToken":true + }, + "initialCapacity":{ + "shape":"InitialCapacityConfigMap", + "documentation":"The capacity to initialize when the application is updated.
" + }, + "maximumCapacity":{ + "shape":"MaximumAllowedResources", + "documentation":"The maximum capacity to allocate when the application is updated. This is cumulative across all workers at any given point in time during the lifespan of the application. No new resources will be created once any one of the defined limits is hit.
" + }, + "autoStartConfiguration":{ + "shape":"AutoStartConfig", + "documentation":"The configuration for an application to automatically start on job submission.
" + }, + "autoStopConfiguration":{ + "shape":"AutoStopConfig", + "documentation":"The configuration for an application to automatically stop after a certain amount of time being idle.
" + }, + "networkConfiguration":{"shape":"NetworkConfiguration"}, + "architecture":{ + "shape":"Architecture", + "documentation":"The CPU architecture of an application.
" + }, + "imageConfiguration":{ + "shape":"ImageConfigurationInput", + "documentation":"The image configuration to be used for all worker types. You can either set this parameter or imageConfiguration for each worker type in WorkerTypeSpecificationInput.
The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.
The interactive configuration object that contains new interactive use cases when the application is updated.
" + }, + "releaseLabel":{ + "shape":"ReleaseLabel", + "documentation":"The Amazon EMR release label for the application. You can change the release label to use a different release of Amazon EMR.
" + }, + "runtimeConfiguration":{ + "shape":"ConfigurationList", + "documentation":"The Configuration specifications to use when updating an application. Each configuration consists of a classification and properties. This configuration is applied across all the job runs submitted under the application.
" + }, + "monitoringConfiguration":{ + "shape":"MonitoringConfiguration", + "documentation":"The configuration setting for monitoring.
" + }, + "schedulerConfiguration":{ + "shape":"SchedulerConfiguration", + "documentation":"The scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above.
" + } + } + }, + "UpdateApplicationResponse":{ + "type":"structure", + "required":["application"], + "members":{ + "application":{ + "shape":"Application", + "documentation":"Information about the updated application.
" + } + } + }, + "UriString":{ + "type":"string", + "max":10280, + "min":1, + "pattern":".*[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*.*" + }, + "Url":{ + "type":"string", + "max":2048, + "min":1 + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String1024"} + }, + "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "WorkerCounts":{ + "type":"long", + "max":1000000, + "min":1 + }, + "WorkerResourceConfig":{ + "type":"structure", + "required":[ + "cpu", + "memory" + ], + "members":{ + "cpu":{ + "shape":"CpuSize", + "documentation":"The CPU requirements for every worker instance of the worker type.
" + }, + "memory":{ + "shape":"MemorySize", + "documentation":"The memory requirements for every worker instance of the worker type.
" + }, + "disk":{ + "shape":"DiskSize", + "documentation":"The disk requirements for every worker instance of the worker type.
" + }, + "diskType":{ + "shape":"DiskType", + "documentation":"The disk type for every worker instance of the work type. Shuffle optimized disks have higher performance characteristics and are better for shuffle heavy workloads. Default is STANDARD.
The cumulative configuration requirements for every worker instance of the worker type.
" + }, + "WorkerTypeSpecification":{ + "type":"structure", + "members":{ + "imageConfiguration":{ + "shape":"ImageConfiguration", + "documentation":"The image configuration for a worker type.
" + } + }, + "documentation":"The specifications for a worker type.
" + }, + "WorkerTypeSpecificationInput":{ + "type":"structure", + "members":{ + "imageConfiguration":{ + "shape":"ImageConfigurationInput", + "documentation":"The image configuration for a worker type.
" + } + }, + "documentation":"The specifications for a worker type.
" + }, + "WorkerTypeSpecificationInputMap":{ + "type":"map", + "key":{"shape":"WorkerTypeString"}, + "value":{"shape":"WorkerTypeSpecificationInput"} + }, + "WorkerTypeSpecificationMap":{ + "type":"map", + "key":{"shape":"WorkerTypeString"}, + "value":{"shape":"WorkerTypeSpecification"} + }, + "WorkerTypeString":{ + "type":"string", + "documentation":"Worker type for an analytics framework.
", + "max":50, + "min":1, + "pattern":"[a-zA-Z]+[-_]*[a-zA-Z]+" + } + }, + "documentation":"Amazon EMR Serverless is a new deployment option for Amazon EMR. Amazon EMR Serverless provides a serverless runtime environment that simplifies running analytics applications using the latest open source frameworks such as Apache Spark and Apache Hive. With Amazon EMR Serverless, you don’t have to configure, optimize, secure, or operate clusters to run applications with these frameworks.
The API reference to Amazon EMR Serverless is emr-serverless. The emr-serverless prefix is used in the following scenarios:
It is the prefix in the CLI commands for Amazon EMR Serverless. For example, aws emr-serverless start-job-run.
It is the prefix before IAM policy actions for Amazon EMR Serverless. For example, \"Action\": [\"emr-serverless:StartJobRun\"]. For more information, see Policy actions for Amazon EMR Serverless.
It is the prefix used in Amazon EMR Serverless service endpoints. For example, emr-serverless.us-east-2.amazonaws.com.
Adds a policy statement object. To retrieve a list of existing policy statements, use the GetPolicy API.
Deletes multiple unique IDs in a matching workflow.
" + }, + "CreateIdMappingWorkflow":{ + "name":"CreateIdMappingWorkflow", + "http":{ + "method":"POST", + "requestUri":"/idmappingworkflows", + "responseCode":200 + }, + "input":{"shape":"CreateIdMappingWorkflowInput"}, + "output":{"shape":"CreateIdMappingWorkflowOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ExceedsLimitException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.
Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it. Each ID namespace must have a unique name. To modify an existing ID namespace, use the UpdateIdNamespace API.
Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run. It is important to note that there should not be a pre-existing MatchingWorkflow with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.
Creates a schema mapping, which defines the schema of the input customer records table. The SchemaMapping also provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.
Deletes the IdMappingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.
Deletes the IdNamespace with a given name.
Deletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.
Deletes the policy statement.
", + "idempotent":true + }, + "DeleteSchemaMapping":{ + "name":"DeleteSchemaMapping", + "http":{ + "method":"DELETE", + "requestUri":"/schemas/{schemaName}", + "responseCode":200 + }, + "input":{"shape":"DeleteSchemaMappingInput"}, + "output":{"shape":"DeleteSchemaMappingOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"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.
Gets the status, metrics, and errors (if there are any) that are associated with a job.
" + }, + "GetIdMappingWorkflow":{ + "name":"GetIdMappingWorkflow", + "http":{ + "method":"GET", + "requestUri":"/idmappingworkflows/{workflowName}", + "responseCode":200 + }, + "input":{"shape":"GetIdMappingWorkflowInput"}, + "output":{"shape":"GetIdMappingWorkflowOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns the IdMappingWorkflow with a given name, if it exists.
Returns the IdNamespace with a given name, if it exists.
Returns the corresponding Match ID of a customer record if the record has been processed.
" + }, + "GetMatchingJob":{ + "name":"GetMatchingJob", + "http":{ + "method":"GET", + "requestUri":"/matchingworkflows/{workflowName}/jobs/{jobId}", + "responseCode":200 + }, + "input":{"shape":"GetMatchingJobInput"}, + "output":{"shape":"GetMatchingJobOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets the status, metrics, and errors (if there are any) that are associated with a job.
" + }, + "GetMatchingWorkflow":{ + "name":"GetMatchingWorkflow", + "http":{ + "method":"GET", + "requestUri":"/matchingworkflows/{workflowName}", + "responseCode":200 + }, + "input":{"shape":"GetMatchingWorkflowInput"}, + "output":{"shape":"GetMatchingWorkflowOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns the MatchingWorkflow with a given name, if it exists.
Returns the resource-based policy.
" + }, + "GetProviderService":{ + "name":"GetProviderService", + "http":{ + "method":"GET", + "requestUri":"/providerservices/{providerName}/{providerServiceName}", + "responseCode":200 + }, + "input":{"shape":"GetProviderServiceInput"}, + "output":{"shape":"GetProviderServiceOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns the ProviderService of a given name.
Returns the SchemaMapping of a given name.
" + }, + "ListIdMappingJobs":{ + "name":"ListIdMappingJobs", + "http":{ + "method":"GET", + "requestUri":"/idmappingworkflows/{workflowName}/jobs", + "responseCode":200 + }, + "input":{"shape":"ListIdMappingJobsInput"}, + "output":{"shape":"ListIdMappingJobsOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Lists all ID mapping jobs for a given workflow.
" + }, + "ListIdMappingWorkflows":{ + "name":"ListIdMappingWorkflows", + "http":{ + "method":"GET", + "requestUri":"/idmappingworkflows", + "responseCode":200 + }, + "input":{"shape":"ListIdMappingWorkflowsInput"}, + "output":{"shape":"ListIdMappingWorkflowsOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account.
Returns a list of all ID namespaces.
" + }, + "ListMatchingJobs":{ + "name":"ListMatchingJobs", + "http":{ + "method":"GET", + "requestUri":"/matchingworkflows/{workflowName}/jobs", + "responseCode":200 + }, + "input":{"shape":"ListMatchingJobsInput"}, + "output":{"shape":"ListMatchingJobsOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Lists all jobs for a given workflow.
" + }, + "ListMatchingWorkflows":{ + "name":"ListMatchingWorkflows", + "http":{ + "method":"GET", + "requestUri":"/matchingworkflows", + "responseCode":200 + }, + "input":{"shape":"ListMatchingWorkflowsInput"}, + "output":{"shape":"ListMatchingWorkflowsOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.
Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.
Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.
Displays the tags associated with an Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.
Updates the resource-based policy.
", + "idempotent":true + }, + "StartIdMappingJob":{ + "name":"StartIdMappingJob", + "http":{ + "method":"POST", + "requestUri":"/idmappingworkflows/{workflowName}/jobs", + "responseCode":200 + }, + "input":{"shape":"StartIdMappingJobInput"}, + "output":{"shape":"StartIdMappingJobOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ExceedsLimitException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Starts the IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.
Starts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.
Assigns one or more tags (key-value pairs) to the specified Entity Resolution resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Entity Resolution, SchemaMapping and MatchingWorkflow can be tagged. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.
Updates an existing IdMappingWorkflow. This method is identical to CreateIdMappingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the IdMappingWorkflow must already exist for the method to succeed.
Updates an existing ID namespace.
", + "idempotent":true + }, + "UpdateMatchingWorkflow":{ + "name":"UpdateMatchingWorkflow", + "http":{ + "method":"PUT", + "requestUri":"/matchingworkflows/{workflowName}", + "responseCode":200 + }, + "input":{"shape":"UpdateMatchingWorkflowInput"}, + "output":{"shape":"UpdateMatchingWorkflowOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates an existing MatchingWorkflow. This method is identical to CreateMatchingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the MatchingWorkflow must already exist for the method to succeed.
Updates a schema mapping.
A schema is immutable if it is being used by a workflow. Therefore, you can't update a schema mapping if it's associated with a workflow.
You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AddPolicyStatementInput":{ + "type":"structure", + "required":[ + "action", + "arn", + "effect", + "principal", + "statementId" + ], + "members":{ + "action":{ + "shape":"StatementActionList", + "documentation":"The action that the principal can use on the resource.
For example, entityresolution:GetIdMappingJob, entityresolution:GetMatchingJob.
The Amazon Resource Name (ARN) of the resource that will be accessed by the principal.
", + "location":"uri", + "locationName":"arn" + }, + "condition":{ + "shape":"StatementCondition", + "documentation":"A set of condition keys that you can use in key policies.
" + }, + "effect":{ + "shape":"StatementEffect", + "documentation":"Determines whether the permissions specified in the policy are to be allowed (Allow) or denied (Deny).
If you set the value of the effect parameter to Deny for the AddPolicyStatement operation, you must also set the value of the effect parameter in the policy to Deny for the PutPolicy operation.
The Amazon Web Services service or Amazon Web Services account that can access the resource defined as ARN.
" + }, + "statementId":{ + "shape":"StatementId", + "documentation":"A statement identifier that differentiates the statement from others in the same policy.
", + "location":"uri", + "locationName":"statementId" + } + } + }, + "AddPolicyStatementOutput":{ + "type":"structure", + "required":[ + "arn", + "token" + ], + "members":{ + "arn":{ + "shape":"VeniceGlobalArn", + "documentation":"The Amazon Resource Name (ARN) of the resource that will be accessed by the principal.
" + }, + "policy":{ + "shape":"PolicyDocument", + "documentation":"The resource-based policy.
" + }, + "token":{ + "shape":"PolicyToken", + "documentation":"A unique identifier for the current revision of the policy.
" + } + } + }, + "AttributeMatchingModel":{ + "type":"string", + "enum":[ + "ONE_TO_ONE", + "MANY_TO_MANY" + ] + }, + "AttributeName":{ + "type":"string", + "max":255, + "min":0, + "pattern":"^[a-zA-Z_0-9- \\t]*$" + }, + "AwsAccountId":{ + "type":"string", + "pattern":"^\\d{12}$" + }, + "AwsAccountIdList":{ + "type":"list", + "member":{"shape":"AwsAccountId"} + }, + "BatchDeleteUniqueIdInput":{ + "type":"structure", + "required":[ + "uniqueIds", + "workflowName" + ], + "members":{ + "inputSource":{ + "shape":"BatchDeleteUniqueIdInputInputSourceString", + "documentation":"The input source for the batch delete unique ID operation.
", + "location":"header", + "locationName":"inputSource" + }, + "uniqueIds":{ + "shape":"UniqueIdList", + "documentation":"The unique IDs to delete.
", + "location":"header", + "locationName":"uniqueIds" + }, + "workflowName":{ + "shape":"EntityName", + "documentation":"The name of the workflow.
", + "location":"uri", + "locationName":"workflowName" + } + } + }, + "BatchDeleteUniqueIdInputInputSourceString":{ + "type":"string", + "pattern":"^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$" + }, + "BatchDeleteUniqueIdOutput":{ + "type":"structure", + "required":[ + "deleted", + "disconnectedUniqueIds", + "errors", + "status" + ], + "members":{ + "deleted":{ + "shape":"DeletedUniqueIdList", + "documentation":"The unique IDs that were deleted.
" + }, + "disconnectedUniqueIds":{ + "shape":"DisconnectedUniqueIdsList", + "documentation":"The unique IDs that were disconnected.
" + }, + "errors":{ + "shape":"DeleteUniqueIdErrorsList", + "documentation":"The errors from deleting multiple unique IDs.
" + }, + "status":{ + "shape":"DeleteUniqueIdStatus", + "documentation":"The status of the batch delete unique ID operation.
" + } + } + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CreateIdMappingWorkflowInput":{ + "type":"structure", + "required":[ + "idMappingTechniques", + "inputSourceConfig", + "workflowName" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"A description of the workflow.
" + }, + "idMappingTechniques":{ + "shape":"IdMappingTechniques", + "documentation":"An object which defines the ID mapping technique and any additional configurations.
" + }, + "inputSourceConfig":{ + "shape":"IdMappingWorkflowInputSourceConfig", + "documentation":"A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "workflowName":{ + "shape":"EntityName", + "documentation":"The name of the workflow. There can't be multiple IdMappingWorkflows with the same name.
A description of the workflow.
" + }, + "idMappingTechniques":{ + "shape":"IdMappingTechniques", + "documentation":"An object which defines the ID mapping technique and any additional configurations.
" + }, + "inputSourceConfig":{ + "shape":"IdMappingWorkflowInputSourceConfig", + "documentation":"A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
" + }, + "workflowArn":{ + "shape":"IdMappingWorkflowArn", + "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the IDMappingWorkflow.
The name of the workflow.
" + } + } + }, + "CreateIdNamespaceInput":{ + "type":"structure", + "required":[ + "idNamespaceName", + "type" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"The description of the ID namespace.
" + }, + "idMappingWorkflowProperties":{ + "shape":"IdNamespaceIdMappingWorkflowPropertiesList", + "documentation":"Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target.
The name of the ID namespace.
" + }, + "inputSourceConfig":{ + "shape":"IdNamespaceInputSourceConfig", + "documentation":"A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.
The tags used to organize, track, or control access for this resource.
" + }, + "type":{ + "shape":"IdNamespaceType", + "documentation":"The type of ID namespace. There are two types: SOURCE and TARGET.
The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.
The TARGET contains a configuration of targetId to which all sourceIds will resolve to.
The timestamp of when the ID namespace was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the ID namespace.
" + }, + "idMappingWorkflowProperties":{ + "shape":"IdNamespaceIdMappingWorkflowPropertiesList", + "documentation":"Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.
The Amazon Resource Name (ARN) of the ID namespace.
" + }, + "idNamespaceName":{ + "shape":"EntityName", + "documentation":"The name of the ID namespace.
" + }, + "inputSourceConfig":{ + "shape":"IdNamespaceInputSourceConfig", + "documentation":"A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in inputSourceConfig on your behalf as part of the workflow run.
The tags used to organize, track, or control access for this resource.
" + }, + "type":{ + "shape":"IdNamespaceType", + "documentation":"The type of ID namespace. There are two types: SOURCE and TARGET.
The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.
The TARGET contains a configuration of targetId to which all sourceIds will resolve to.
The timestamp of when the ID namespace was last updated.
" + } + } + }, + "CreateMatchingWorkflowInput":{ + "type":"structure", + "required":[ + "inputSourceConfig", + "outputSourceConfig", + "resolutionTechniques", + "roleArn", + "workflowName" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"A description of the workflow.
" + }, + "incrementalRunConfig":{ + "shape":"IncrementalRunConfig", + "documentation":"An object which defines an incremental run type and has only incrementalRunType as a field.
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "workflowName":{ + "shape":"EntityName", + "documentation":"The name of the workflow. There can't be multiple MatchingWorkflows with the same name.
A description of the workflow.
" + }, + "incrementalRunConfig":{ + "shape":"IncrementalRunConfig", + "documentation":"An object which defines an incremental run type and has only incrementalRunType as a field.
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
" + }, + "workflowArn":{ + "shape":"MatchingWorkflowArn", + "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
The name of the workflow.
" + } + } + }, + "CreateSchemaMappingInput":{ + "type":"structure", + "required":[ + "mappedInputFields", + "schemaName" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"A description of the schema.
" + }, + "mappedInputFields":{ + "shape":"SchemaInputAttributes", + "documentation":"A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.
The name of the schema. There can't be multiple SchemaMappings with the same name.
The tags used to organize, track, or control access for this resource.
" + } + } + }, + "CreateSchemaMappingOutput":{ + "type":"structure", + "required":[ + "description", + "mappedInputFields", + "schemaArn", + "schemaName" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"A description of the schema.
" + }, + "mappedInputFields":{ + "shape":"SchemaInputAttributes", + "documentation":"A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.
The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
The name of the schema.
" + } + } + }, + "DeleteIdMappingWorkflowInput":{ + "type":"structure", + "required":["workflowName"], + "members":{ + "workflowName":{ + "shape":"EntityName", + "documentation":"The name of the workflow to be deleted.
", + "location":"uri", + "locationName":"workflowName" + } + } + }, + "DeleteIdMappingWorkflowOutput":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"String", + "documentation":"A successful operation message.
" + } + } + }, + "DeleteIdNamespaceInput":{ + "type":"structure", + "required":["idNamespaceName"], + "members":{ + "idNamespaceName":{ + "shape":"EntityName", + "documentation":"The name of the ID namespace.
", + "location":"uri", + "locationName":"idNamespaceName" + } + } + }, + "DeleteIdNamespaceOutput":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"String", + "documentation":"A successful operation message.
" + } + } + }, + "DeleteMatchingWorkflowInput":{ + "type":"structure", + "required":["workflowName"], + "members":{ + "workflowName":{ + "shape":"EntityName", + "documentation":"The name of the workflow to be retrieved.
", + "location":"uri", + "locationName":"workflowName" + } + } + }, + "DeleteMatchingWorkflowOutput":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"String", + "documentation":"A successful operation message.
" + } + } + }, + "DeletePolicyStatementInput":{ + "type":"structure", + "required":[ + "arn", + "statementId" + ], + "members":{ + "arn":{ + "shape":"VeniceGlobalArn", + "documentation":"The ARN of the resource for which the policy need to be deleted.
", + "location":"uri", + "locationName":"arn" + }, + "statementId":{ + "shape":"StatementId", + "documentation":"A statement identifier that differentiates the statement from others in the same policy.
", + "location":"uri", + "locationName":"statementId" + } + } + }, + "DeletePolicyStatementOutput":{ + "type":"structure", + "required":[ + "arn", + "token" + ], + "members":{ + "arn":{ + "shape":"VeniceGlobalArn", + "documentation":"The ARN of the resource for which the policy need to be deleted.
" + }, + "policy":{ + "shape":"PolicyDocument", + "documentation":"The resource-based policy.
" + }, + "token":{ + "shape":"PolicyToken", + "documentation":"A unique identifier for the deleted policy.
" + } + } + }, + "DeleteSchemaMappingInput":{ + "type":"structure", + "required":["schemaName"], + "members":{ + "schemaName":{ + "shape":"EntityName", + "documentation":"The name of the schema to delete.
", + "location":"uri", + "locationName":"schemaName" + } + } + }, + "DeleteSchemaMappingOutput":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"String", + "documentation":"A successful operation message.
" + } + } + }, + "DeleteUniqueIdError":{ + "type":"structure", + "required":[ + "errorType", + "uniqueId" + ], + "members":{ + "errorType":{ + "shape":"DeleteUniqueIdErrorType", + "documentation":"The error type for the batch delete unique ID operation.
" + }, + "uniqueId":{ + "shape":"UniqueId", + "documentation":"The unique ID that could not be deleted.
" + } + }, + "documentation":"The Delete Unique Id error.
" + }, + "DeleteUniqueIdErrorType":{ + "type":"string", + "enum":[ + "SERVICE_ERROR", + "VALIDATION_ERROR" + ] + }, + "DeleteUniqueIdErrorsList":{ + "type":"list", + "member":{"shape":"DeleteUniqueIdError"} + }, + "DeleteUniqueIdStatus":{ + "type":"string", + "enum":[ + "COMPLETED", + "ACCEPTED" + ] + }, + "DeletedUniqueId":{ + "type":"structure", + "required":["uniqueId"], + "members":{ + "uniqueId":{ + "shape":"UniqueId", + "documentation":"The unique ID of the deleted item.
" + } + }, + "documentation":"The deleted unique ID.
" + }, + "DeletedUniqueIdList":{ + "type":"list", + "member":{"shape":"DeletedUniqueId"} + }, + "Description":{ + "type":"string", + "max":255, + "min":0 + }, + "DisconnectedUniqueIdsList":{ + "type":"list", + "member":{"shape":"UniqueId"} + }, + "Document":{ + "type":"structure", + "members":{ + }, + "document":true + }, + "EntityName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z_0-9-]*$" + }, + "EntityNameOrIdMappingWorkflowArn":{ + "type":"string", + "pattern":"^[a-zA-Z_0-9-=+/]*$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idmappingworkflow/[a-zA-Z_0-9-]{1,255})$" + }, + "EntityNameOrIdNamespaceArn":{ + "type":"string", + "pattern":"^[a-zA-Z_0-9-=+/]*$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$" + }, + "ErrorDetails":{ + "type":"structure", + "members":{ + "errorMessage":{ + "shape":"ErrorMessage", + "documentation":"The error message from the job, if there is one.
" + } + }, + "documentation":"An object containing an error message, if there was an error.
" + }, + "ErrorMessage":{ + "type":"string", + "max":2048, + "min":1 + }, + "ExceedsLimitException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "quotaName":{ + "shape":"String", + "documentation":"The name of the quota that has been breached.
" + }, + "quotaValue":{ + "shape":"Integer", + "documentation":"The current quota value for the customers.
" + } + }, + "documentation":"The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "GetIdMappingJobInput":{ + "type":"structure", + "required":[ + "jobId", + "workflowName" + ], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"The ID of the job.
", + "location":"uri", + "locationName":"jobId" + }, + "workflowName":{ + "shape":"EntityNameOrIdMappingWorkflowArn", + "documentation":"The name of the workflow.
", + "location":"uri", + "locationName":"workflowName" + } + } + }, + "GetIdMappingJobOutput":{ + "type":"structure", + "required":[ + "jobId", + "startTime", + "status" + ], + "members":{ + "endTime":{ + "shape":"Timestamp", + "documentation":"The time at which the job has finished.
" + }, + "errorDetails":{"shape":"ErrorDetails"}, + "jobId":{ + "shape":"JobId", + "documentation":"The ID of the job.
" + }, + "metrics":{ + "shape":"IdMappingJobMetrics", + "documentation":"Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.
" + }, + "outputSourceConfig":{ + "shape":"IdMappingJobOutputSourceConfig", + "documentation":"A list of OutputSource objects.
The time at which the job was started.
" + }, + "status":{ + "shape":"JobStatus", + "documentation":"The current status of the job.
" + } + } + }, + "GetIdMappingWorkflowInput":{ + "type":"structure", + "required":["workflowName"], + "members":{ + "workflowName":{ + "shape":"EntityName", + "documentation":"The name of the workflow.
", + "location":"uri", + "locationName":"workflowName" + } + } + }, + "GetIdMappingWorkflowOutput":{ + "type":"structure", + "required":[ + "createdAt", + "idMappingTechniques", + "inputSourceConfig", + "updatedAt", + "workflowArn", + "workflowName" + ], + "members":{ + "createdAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the workflow was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"A description of the workflow.
" + }, + "idMappingTechniques":{ + "shape":"IdMappingTechniques", + "documentation":"An object which defines the ID mapping technique and any additional configurations.
" + }, + "inputSourceConfig":{ + "shape":"IdMappingWorkflowInputSourceConfig", + "documentation":"A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the workflow was last updated.
" + }, + "workflowArn":{ + "shape":"IdMappingWorkflowArn", + "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the IdMappingWorkflow .
The name of the workflow.
" + } + } + }, + "GetIdNamespaceInput":{ + "type":"structure", + "required":["idNamespaceName"], + "members":{ + "idNamespaceName":{ + "shape":"EntityNameOrIdNamespaceArn", + "documentation":"The name of the ID namespace.
", + "location":"uri", + "locationName":"idNamespaceName" + } + } + }, + "GetIdNamespaceOutput":{ + "type":"structure", + "required":[ + "createdAt", + "idNamespaceArn", + "idNamespaceName", + "type", + "updatedAt" + ], + "members":{ + "createdAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the ID namespace was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the ID namespace.
" + }, + "idMappingWorkflowProperties":{ + "shape":"IdNamespaceIdMappingWorkflowPropertiesList", + "documentation":"Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.
The Amazon Resource Name (ARN) of the ID namespace.
" + }, + "idNamespaceName":{ + "shape":"EntityName", + "documentation":"The name of the ID namespace.
" + }, + "inputSourceConfig":{ + "shape":"IdNamespaceInputSourceConfig", + "documentation":"A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of a workflow run.
The tags used to organize, track, or control access for this resource.
" + }, + "type":{ + "shape":"IdNamespaceType", + "documentation":"The type of ID namespace. There are two types: SOURCE and TARGET.
The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.
The TARGET contains a configuration of targetId to which all sourceIds will resolve to.
The timestamp of when the ID namespace was last updated.
" + } + } + }, + "GetMatchIdInput":{ + "type":"structure", + "required":[ + "record", + "workflowName" + ], + "members":{ + "applyNormalization":{ + "shape":"Boolean", + "documentation":"Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.
The record to fetch the Match ID for.
" + }, + "workflowName":{ + "shape":"EntityName", + "documentation":"The name of the workflow.
", + "location":"uri", + "locationName":"workflowName" + } + } + }, + "GetMatchIdOutput":{ + "type":"structure", + "members":{ + "matchId":{ + "shape":"String", + "documentation":"The unique identifiers for this group of match records.
" + }, + "matchRule":{ + "shape":"String", + "documentation":"The rule the record matched on.
" + } + } + }, + "GetMatchingJobInput":{ + "type":"structure", + "required":[ + "jobId", + "workflowName" + ], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"The ID of the job.
", + "location":"uri", + "locationName":"jobId" + }, + "workflowName":{ + "shape":"EntityName", + "documentation":"The name of the workflow.
", + "location":"uri", + "locationName":"workflowName" + } + } + }, + "GetMatchingJobOutput":{ + "type":"structure", + "required":[ + "jobId", + "startTime", + "status" + ], + "members":{ + "endTime":{ + "shape":"Timestamp", + "documentation":"The time at which the job has finished.
" + }, + "errorDetails":{ + "shape":"ErrorDetails", + "documentation":"An object containing an error message, if there was an error.
" + }, + "jobId":{ + "shape":"JobId", + "documentation":"The ID of the job.
" + }, + "metrics":{ + "shape":"JobMetrics", + "documentation":"Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.
" + }, + "outputSourceConfig":{ + "shape":"JobOutputSourceConfig", + "documentation":"A list of OutputSource objects.
The time at which the job was started.
" + }, + "status":{ + "shape":"JobStatus", + "documentation":"The current status of the job.
" + } + } + }, + "GetMatchingWorkflowInput":{ + "type":"structure", + "required":["workflowName"], + "members":{ + "workflowName":{ + "shape":"EntityName", + "documentation":"The name of the workflow.
", + "location":"uri", + "locationName":"workflowName" + } + } + }, + "GetMatchingWorkflowOutput":{ + "type":"structure", + "required":[ + "createdAt", + "inputSourceConfig", + "outputSourceConfig", + "resolutionTechniques", + "roleArn", + "updatedAt", + "workflowArn", + "workflowName" + ], + "members":{ + "createdAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the workflow was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"A description of the workflow.
" + }, + "incrementalRunConfig":{ + "shape":"IncrementalRunConfig", + "documentation":"An object which defines an incremental run type and has only incrementalRunType as a field.
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the workflow was last updated.
" + }, + "workflowArn":{ + "shape":"MatchingWorkflowArn", + "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
The name of the workflow.
" + } + } + }, + "GetPolicyInput":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"VeniceGlobalArn", + "documentation":"The Amazon Resource Name (ARN) of the resource for which the policy need to be returned.
", + "location":"uri", + "locationName":"arn" + } + } + }, + "GetPolicyOutput":{ + "type":"structure", + "required":[ + "arn", + "token" + ], + "members":{ + "arn":{ + "shape":"VeniceGlobalArn", + "documentation":"The Entity Resolution resource ARN.
" + }, + "policy":{ + "shape":"PolicyDocument", + "documentation":"The resource-based policy.
" + }, + "token":{ + "shape":"PolicyToken", + "documentation":"A unique identifier for the current revision of the policy.
" + } + } + }, + "GetProviderServiceInput":{ + "type":"structure", + "required":[ + "providerName", + "providerServiceName" + ], + "members":{ + "providerName":{ + "shape":"EntityName", + "documentation":"The name of the provider. This name is typically the company name.
", + "location":"uri", + "locationName":"providerName" + }, + "providerServiceName":{ + "shape":"ProviderServiceArn", + "documentation":"The ARN (Amazon Resource Name) of the product that the provider service provides.
", + "location":"uri", + "locationName":"providerServiceName" + } + } + }, + "GetProviderServiceOutput":{ + "type":"structure", + "required":[ + "anonymizedOutput", + "providerEndpointConfiguration", + "providerEntityOutputDefinition", + "providerName", + "providerServiceArn", + "providerServiceDisplayName", + "providerServiceName", + "providerServiceType" + ], + "members":{ + "anonymizedOutput":{ + "shape":"Boolean", + "documentation":"Specifies whether output data from the provider is anonymized. A value of TRUE means the output will be anonymized and you can't relate the data that comes back from the provider to the identifying input. A value of FALSE means the output won't be anonymized and you can relate the data that comes back from the provider to your source data.
Input schema for the provider service.
" + }, + "providerConfigurationDefinition":{ + "shape":"Document", + "documentation":"The definition of the provider configuration.
" + }, + "providerEndpointConfiguration":{ + "shape":"ProviderEndpointConfiguration", + "documentation":"The required configuration fields to use with the provider service.
" + }, + "providerEntityOutputDefinition":{ + "shape":"Document", + "documentation":"The definition of the provider entity output.
" + }, + "providerIdNameSpaceConfiguration":{ + "shape":"ProviderIdNameSpaceConfiguration", + "documentation":"The provider configuration required for different ID namespace types.
" + }, + "providerIntermediateDataAccessConfiguration":{ + "shape":"ProviderIntermediateDataAccessConfiguration", + "documentation":"The Amazon Web Services accounts and the S3 permissions that are required by some providers to create an S3 bucket for intermediate data storage.
" + }, + "providerJobConfiguration":{ + "shape":"Document", + "documentation":"Provider service job configurations.
" + }, + "providerName":{ + "shape":"EntityName", + "documentation":"The name of the provider. This name is typically the company name.
" + }, + "providerServiceArn":{ + "shape":"ProviderServiceArn", + "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the provider service.
" + }, + "providerServiceDisplayName":{ + "shape":"ProviderServiceDisplayName", + "documentation":"The display name of the provider service.
" + }, + "providerServiceName":{ + "shape":"EntityName", + "documentation":"The name of the product that the provider service provides.
" + }, + "providerServiceType":{ + "shape":"ServiceType", + "documentation":"The type of provider service.
" + } + } + }, + "GetSchemaMappingInput":{ + "type":"structure", + "required":["schemaName"], + "members":{ + "schemaName":{ + "shape":"EntityName", + "documentation":"The name of the schema to be retrieved.
", + "location":"uri", + "locationName":"schemaName" + } + } + }, + "GetSchemaMappingOutput":{ + "type":"structure", + "required":[ + "createdAt", + "hasWorkflows", + "mappedInputFields", + "schemaArn", + "schemaName", + "updatedAt" + ], + "members":{ + "createdAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the SchemaMapping was created.
A description of the schema.
" + }, + "hasWorkflows":{ + "shape":"Boolean", + "documentation":"Specifies whether the schema mapping has been applied to a workflow.
" + }, + "mappedInputFields":{ + "shape":"SchemaInputAttributes", + "documentation":"A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information Venice uses for matching.
The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
" + }, + "schemaName":{ + "shape":"EntityName", + "documentation":"The name of the schema.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the SchemaMapping was last updated.
The total number of records that were input for processing.
" + }, + "recordsNotProcessed":{ + "shape":"Integer", + "documentation":"The total number of records that did not get processed.
" + }, + "totalMappedRecords":{ + "shape":"Integer", + "documentation":"The total number of records that were mapped.
" + }, + "totalMappedSourceRecords":{ + "shape":"Integer", + "documentation":"The total number of mapped source records.
" + }, + "totalMappedTargetRecords":{ + "shape":"Integer", + "documentation":"The total number of distinct mapped target records.
" + }, + "totalRecordsProcessed":{ + "shape":"Integer", + "documentation":"The total number of records that were processed.
" + } + }, + "documentation":"An object containing InputRecords, RecordsNotProcessed, TotalRecordsProcessed, TotalMappedRecords, TotalMappedSourceRecords, and TotalMappedTargetRecords.
Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
" + }, + "outputS3Path":{ + "shape":"S3Path", + "documentation":"The S3 path to which Entity Resolution will write the output table.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf as part of workflow execution.
" + } + }, + "documentation":"An object containing KMSArn, OutputS3Path, and RoleARN.
The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.
If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of the BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.
If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.
The type of matching record that is allowed to be used in an ID mapping workflow.
If the value is set to ONE_SOURCE_TO_ONE_TARGET, only one record in the source can be matched to the same record in the target.
If the value is set to MANY_SOURCE_TO_ONE_TARGET, multiple records in the source can be matched to one record in the target.
The set of rules you can use in an ID mapping workflow. The limitations specified for the source or target to define the match rules must be compatible.
" + }, + "rules":{ + "shape":"IdMappingRuleBasedPropertiesRulesList", + "documentation":"The rules that can be used for ID mapping.
" + } + }, + "documentation":"An object that defines the list of matching rules to run in an ID mapping workflow.
" + }, + "IdMappingRuleBasedPropertiesRulesList":{ + "type":"list", + "member":{"shape":"Rule"}, + "max":25, + "min":1 + }, + "IdMappingTechniques":{ + "type":"structure", + "required":["idMappingType"], + "members":{ + "idMappingType":{ + "shape":"IdMappingType", + "documentation":"The type of ID mapping.
" + }, + "providerProperties":{ + "shape":"ProviderProperties", + "documentation":"An object which defines any additional configurations required by the provider service.
" + }, + "ruleBasedProperties":{ + "shape":"IdMappingRuleBasedProperties", + "documentation":"An object which defines any additional configurations required by rule-based matching.
" + } + }, + "documentation":"An object which defines the ID mapping technique and any additional configurations.
" + }, + "IdMappingType":{ + "type":"string", + "enum":[ + "PROVIDER", + "RULE_BASED" + ] + }, + "IdMappingWorkflowArn":{ + "type":"string", + "pattern":"^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idmappingworkflow/[a-zA-Z_0-9-]{1,255})$" + }, + "IdMappingWorkflowInputSource":{ + "type":"structure", + "required":["inputSourceARN"], + "members":{ + "inputSourceARN":{ + "shape":"IdMappingWorkflowInputSourceInputSourceARNString", + "documentation":"An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.
" + }, + "schemaName":{ + "shape":"EntityName", + "documentation":"The name of the schema to be retrieved.
" + }, + "type":{ + "shape":"IdNamespaceType", + "documentation":"The type of ID namespace. There are two types: SOURCE and TARGET.
The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.
The TARGET contains a configuration of targetId which all sourceIds will resolve to.
An object containing InputSourceARN, SchemaName, and Type.
Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
" + }, + "outputS3Path":{ + "shape":"S3Path", + "documentation":"The S3 path to which Entity Resolution will write the output table.
" + } + }, + "documentation":"The output source for the ID mapping workflow.
" + }, + "IdMappingWorkflowOutputSourceConfig":{ + "type":"list", + "member":{"shape":"IdMappingWorkflowOutputSource"}, + "max":1, + "min":1 + }, + "IdMappingWorkflowRuleDefinitionType":{ + "type":"string", + "enum":[ + "SOURCE", + "TARGET" + ] + }, + "IdMappingWorkflowRuleDefinitionTypeList":{ + "type":"list", + "member":{"shape":"IdMappingWorkflowRuleDefinitionType"} + }, + "IdMappingWorkflowSummary":{ + "type":"structure", + "required":[ + "createdAt", + "updatedAt", + "workflowArn", + "workflowName" + ], + "members":{ + "createdAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the workflow was created.
" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the workflow was last updated.
" + }, + "workflowArn":{ + "shape":"IdMappingWorkflowArn", + "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the IdMappingWorkflow.
The name of the workflow.
" + } + }, + "documentation":"A list of IdMappingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.
The type of ID mapping.
" + } + }, + "documentation":"The settings for the ID namespace for the ID mapping workflow job.
" + }, + "IdNamespaceIdMappingWorkflowMetadataList":{ + "type":"list", + "member":{"shape":"IdNamespaceIdMappingWorkflowMetadata"}, + "max":1, + "min":1 + }, + "IdNamespaceIdMappingWorkflowProperties":{ + "type":"structure", + "required":["idMappingType"], + "members":{ + "idMappingType":{ + "shape":"IdMappingType", + "documentation":"The type of ID mapping.
" + }, + "providerProperties":{ + "shape":"NamespaceProviderProperties", + "documentation":"An object which defines any additional configurations required by the provider service.
" + }, + "ruleBasedProperties":{ + "shape":"NamespaceRuleBasedProperties", + "documentation":"An object which defines any additional configurations required by rule-based matching.
" + } + }, + "documentation":"An object containing IdMappingType, ProviderProperties, and RuleBasedProperties.
An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.
" + }, + "schemaName":{ + "shape":"EntityName", + "documentation":"The name of the schema.
" + } + }, + "documentation":"An object containing InputSourceARN and SchemaName.
The timestamp of when the ID namespace was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the ID namespace.
" + }, + "idMappingWorkflowProperties":{ + "shape":"IdNamespaceIdMappingWorkflowMetadataList", + "documentation":"An object which defines any additional configurations required by the ID mapping workflow.
" + }, + "idNamespaceArn":{ + "shape":"IdNamespaceArn", + "documentation":"The Amazon Resource Name (ARN) of the ID namespace.
" + }, + "idNamespaceName":{ + "shape":"EntityName", + "documentation":"The name of the ID namespace.
" + }, + "type":{ + "shape":"IdNamespaceType", + "documentation":"The type of ID namespace. There are two types: SOURCE and TARGET.
The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.
The TARGET contains a configuration of targetId which all sourceIds will resolve to.
The timestamp of when the ID namespace was last updated.
" + } + }, + "documentation":"A summary of ID namespaces.
" + }, + "IdNamespaceType":{ + "type":"string", + "enum":[ + "SOURCE", + "TARGET" + ] + }, + "IncrementalRunConfig":{ + "type":"structure", + "members":{ + "incrementalRunType":{ + "shape":"IncrementalRunType", + "documentation":"The type of incremental run. It takes only one value: IMMEDIATE.
An object which defines an incremental run type and has only incrementalRunType as a field.
Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.
An Glue table Amazon Resource Name (ARN) for the input source table.
" + }, + "schemaName":{ + "shape":"EntityName", + "documentation":"The name of the schema to be retrieved.
" + } + }, + "documentation":"An object containing InputSourceARN, SchemaName, and ApplyNormalization.
The Amazon S3 location (bucket and prefix). For example: s3://provider_bucket/DOC-EXAMPLE-BUCKET
The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
" + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"This exception occurs when there is an internal failure in the Entity Resolution service.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "JobId":{ + "type":"string", + "pattern":"^[a-f0-9]{32}$" + }, + "JobList":{ + "type":"list", + "member":{"shape":"JobSummary"} + }, + "JobMetrics":{ + "type":"structure", + "members":{ + "inputRecords":{ + "shape":"Integer", + "documentation":"The total number of input records.
" + }, + "matchIDs":{ + "shape":"Integer", + "documentation":"The total number of matchIDs generated.
The total number of records that did not get processed.
" + }, + "totalRecordsProcessed":{ + "shape":"Integer", + "documentation":"The total number of records processed.
" + } + }, + "documentation":"An object containing InputRecords, TotalRecordsProcessed, MatchIDs, and RecordsNotProcessed.
Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
" + }, + "outputS3Path":{ + "shape":"S3Path", + "documentation":"The S3 path to which Entity Resolution will write the output table.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf as part of workflow execution.
" + } + }, + "documentation":"An object containing KMSArn, OutputS3Path, and RoleArn.
The time at which the job has finished.
" + }, + "jobId":{ + "shape":"JobId", + "documentation":"The ID of the job.
" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"The time at which the job was started.
" + }, + "status":{ + "shape":"JobStatus", + "documentation":"The current status of the job.
" + } + }, + "documentation":"An object containing the JobId, Status, StartTime, and EndTime of a job.
The maximum number of objects returned per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token from the previous API call.
", + "location":"querystring", + "locationName":"nextToken" + }, + "workflowName":{ + "shape":"EntityNameOrIdMappingWorkflowArn", + "documentation":"The name of the workflow to be retrieved.
", + "location":"uri", + "locationName":"workflowName" + } + } + }, + "ListIdMappingJobsInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":25, + "min":1 + }, + "ListIdMappingJobsOutput":{ + "type":"structure", + "members":{ + "jobs":{ + "shape":"JobList", + "documentation":"A list of JobSummary objects.
The pagination token from the previous API call.
" + } + } + }, + "ListIdMappingWorkflowsInput":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListIdMappingWorkflowsInputMaxResultsInteger", + "documentation":"The maximum number of objects returned per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token from the previous API call.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListIdMappingWorkflowsInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":25 + }, + "ListIdMappingWorkflowsOutput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token from the previous API call.
" + }, + "workflowSummaries":{ + "shape":"IdMappingWorkflowList", + "documentation":"A list of IdMappingWorkflowSummary objects.
The maximum number of IdNamespace objects returned per page.
The pagination token from the previous API call.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListIdNamespacesInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":25 + }, + "ListIdNamespacesOutput":{ + "type":"structure", + "members":{ + "idNamespaceSummaries":{ + "shape":"IdNamespaceList", + "documentation":"A list of IdNamespaceSummaries objects.
The pagination token from the previous API call.
" + } + } + }, + "ListMatchingJobsInput":{ + "type":"structure", + "required":["workflowName"], + "members":{ + "maxResults":{ + "shape":"ListMatchingJobsInputMaxResultsInteger", + "documentation":"The maximum number of objects returned per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token from the previous API call.
", + "location":"querystring", + "locationName":"nextToken" + }, + "workflowName":{ + "shape":"EntityName", + "documentation":"The name of the workflow to be retrieved.
", + "location":"uri", + "locationName":"workflowName" + } + } + }, + "ListMatchingJobsInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":25, + "min":1 + }, + "ListMatchingJobsOutput":{ + "type":"structure", + "members":{ + "jobs":{ + "shape":"JobList", + "documentation":"A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.
The pagination token from the previous API call.
" + } + } + }, + "ListMatchingWorkflowsInput":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListMatchingWorkflowsInputMaxResultsInteger", + "documentation":"The maximum number of objects returned per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token from the previous API call.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListMatchingWorkflowsInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":25 + }, + "ListMatchingWorkflowsOutput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token from the previous API call.
" + }, + "workflowSummaries":{ + "shape":"MatchingWorkflowList", + "documentation":"A list of MatchingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.
The maximum number of objects returned per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token from the previous API call.
", + "location":"querystring", + "locationName":"nextToken" + }, + "providerName":{ + "shape":"EntityName", + "documentation":"The name of the provider. This name is typically the company name.
", + "location":"querystring", + "locationName":"providerName" + } + } + }, + "ListProviderServicesInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":25, + "min":15 + }, + "ListProviderServicesOutput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token from the previous API call.
" + }, + "providerServiceSummaries":{ + "shape":"ProviderServiceList", + "documentation":"A list of ProviderServices objects.
The maximum number of objects returned per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token from the previous API call.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListSchemaMappingsInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":25 + }, + "ListSchemaMappingsOutput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token from the previous API call.
" + }, + "schemaList":{ + "shape":"SchemaMappingList", + "documentation":"A list of SchemaMappingSummary objects, each of which contain the fields SchemaName, SchemaArn, CreatedAt, UpdatedAt.
The ARN of the resource for which you want to view tags.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + } + }, + "MatchPurpose":{ + "type":"string", + "enum":[ + "IDENTIFIER_GENERATION", + "INDEXING" + ] + }, + "MatchingWorkflowArn":{ + "type":"string", + "pattern":"^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$" + }, + "MatchingWorkflowList":{ + "type":"list", + "member":{"shape":"MatchingWorkflowSummary"} + }, + "MatchingWorkflowSummary":{ + "type":"structure", + "required":[ + "createdAt", + "resolutionType", + "updatedAt", + "workflowArn", + "workflowName" + ], + "members":{ + "createdAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the workflow was created.
" + }, + "resolutionType":{ + "shape":"ResolutionType", + "documentation":"The method that has been specified for data matching, either using matching provided by Entity Resolution or through a provider service.
" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the workflow was last updated.
" + }, + "workflowArn":{ + "shape":"MatchingWorkflowArn", + "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
The name of the workflow.
" + } + }, + "documentation":"A list of MatchingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, UpdatedAt.
An object which defines any additional configurations required by the provider service.
" + }, + "providerServiceArn":{ + "shape":"ProviderServiceArn", + "documentation":"The Amazon Resource Name (ARN) of the provider service.
" + } + }, + "documentation":"An object containing ProviderConfiguration and ProviderServiceArn.
The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.
If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.
If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.
The type of matching record that is allowed to be used in an ID mapping workflow.
If the value is set to ONE_SOURCE_TO_ONE_TARGET, only one record in the source is matched to one record in the target.
If the value is set to MANY_SOURCE_TO_ONE_TARGET, all matching records in the source are matched to one record in the target.
The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.
" + }, + "rules":{ + "shape":"NamespaceRuleBasedPropertiesRulesList", + "documentation":"The rules for the ID namespace.
" + } + }, + "documentation":"The rule-based properties of an ID namespace. These properties define how the ID namespace can be used in an ID mapping workflow.
" + }, + "NamespaceRuleBasedPropertiesRulesList":{ + "type":"list", + "member":{"shape":"Rule"}, + "max":25, + "min":1 + }, + "NextToken":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^[a-zA-Z_0-9-=+/]*$" + }, + "OutputAttribute":{ + "type":"structure", + "required":["name"], + "members":{ + "hashed":{ + "shape":"Boolean", + "documentation":"Enables the ability to hash the column values in the output.
" + }, + "name":{ + "shape":"AttributeName", + "documentation":"A name of a column to be written to the output. This must be an InputField name in the schema mapping.
A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.
Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
" + }, + "applyNormalization":{ + "shape":"Boolean", + "documentation":"Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.
A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.
The S3 path to which Entity Resolution will write the output table.
" + } + }, + "documentation":"A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.
The provider schema attributes.
" + }, + "schemas":{ + "shape":"Schemas", + "documentation":"Input schema for the provider service.
" + } + }, + "documentation":"The input schema supported by provider service.
" + }, + "ProviderEndpointConfiguration":{ + "type":"structure", + "members":{ + "marketplaceConfiguration":{ + "shape":"ProviderMarketplaceConfiguration", + "documentation":"The identifiers of the provider service, from Data Exchange.
" + } + }, + "documentation":"The required configuration fields to use with the provider service.
", + "union":true + }, + "ProviderIdNameSpaceConfiguration":{ + "type":"structure", + "members":{ + "description":{ + "shape":"String", + "documentation":"The description of the ID namespace.
" + }, + "providerSourceConfigurationDefinition":{ + "shape":"Document", + "documentation":"Configurations required for the source ID namespace.
" + }, + "providerTargetConfigurationDefinition":{ + "shape":"Document", + "documentation":"Configurations required for the target ID namespace.
" + } + }, + "documentation":"The provider configuration required for different ID namespace types.
" + }, + "ProviderIntermediateDataAccessConfiguration":{ + "type":"structure", + "members":{ + "awsAccountIds":{ + "shape":"AwsAccountIdList", + "documentation":"The Amazon Web Services account that provider can use to read or write data into the customer's intermediate S3 bucket.
" + }, + "requiredBucketActions":{ + "shape":"RequiredBucketActionsList", + "documentation":"The S3 bucket actions that the provider requires permission for.
" + } + }, + "documentation":"The required configuration fields to give intermediate access to a provider service.
" + }, + "ProviderMarketplaceConfiguration":{ + "type":"structure", + "required":[ + "assetId", + "dataSetId", + "listingId", + "revisionId" + ], + "members":{ + "assetId":{ + "shape":"String", + "documentation":"The asset ID on Data Exchange.
" + }, + "dataSetId":{ + "shape":"String", + "documentation":"The dataset ID on Data Exchange.
" + }, + "listingId":{ + "shape":"String", + "documentation":"The listing ID on Data Exchange.
" + }, + "revisionId":{ + "shape":"String", + "documentation":"The revision ID on Data Exchange.
" + } + }, + "documentation":"The identifiers of the provider service, from Data Exchange.
" + }, + "ProviderProperties":{ + "type":"structure", + "required":["providerServiceArn"], + "members":{ + "intermediateSourceConfiguration":{ + "shape":"IntermediateSourceConfiguration", + "documentation":"The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
" + }, + "providerConfiguration":{ + "shape":"Document", + "documentation":"The required configuration fields to use with the provider service.
" + }, + "providerServiceArn":{ + "shape":"ProviderServiceArn", + "documentation":"The ARN of the provider service.
" + } + }, + "documentation":"An object containing the providerServiceARN, intermediateSourceConfiguration, and providerConfiguration.
The field name.
" + }, + "hashing":{ + "shape":"Boolean", + "documentation":"The hashing attribute of the provider schema.
" + }, + "subType":{ + "shape":"AttributeName", + "documentation":"The sub type of the provider schema attribute.
" + }, + "type":{ + "shape":"SchemaAttributeType", + "documentation":"The type of the provider schema attribute.
" + } + }, + "documentation":"The provider schema attribute.
" + }, + "ProviderSchemaAttributes":{ + "type":"list", + "member":{"shape":"ProviderSchemaAttribute"} + }, + "ProviderServiceArn":{ + "type":"string", + "max":255, + "min":20, + "pattern":"^arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z]{1,10}-[0-9])::providerservice/([a-zA-Z0-9_-]{1,255})/([a-zA-Z0-9_-]{1,255})$" + }, + "ProviderServiceDisplayName":{ + "type":"string", + "max":255, + "min":0 + }, + "ProviderServiceList":{ + "type":"list", + "member":{"shape":"ProviderServiceSummary"} + }, + "ProviderServiceSummary":{ + "type":"structure", + "required":[ + "providerName", + "providerServiceArn", + "providerServiceDisplayName", + "providerServiceName", + "providerServiceType" + ], + "members":{ + "providerName":{ + "shape":"EntityName", + "documentation":"The name of the provider. This name is typically the company name.
" + }, + "providerServiceArn":{ + "shape":"ProviderServiceArn", + "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the providerService.
The display name of the provider service.
" + }, + "providerServiceName":{ + "shape":"EntityName", + "documentation":"The name of the product that the provider service provides.
" + }, + "providerServiceType":{ + "shape":"ServiceType", + "documentation":"The type of provider service.
" + } + }, + "documentation":"A list of ProviderService objects, each of which contain the fields providerName, providerServiceArn, providerServiceName, and providerServiceType.
The Amazon Resource Name (ARN) of the resource for which the policy needs to be updated.
", + "location":"uri", + "locationName":"arn" + }, + "policy":{ + "shape":"PolicyDocument", + "documentation":"The resource-based policy.
If you set the value of the effect parameter in the policy to Deny for the PutPolicy operation, you must also set the value of the effect parameter to Deny for the AddPolicyStatement operation.
A unique identifier for the current revision of the policy.
" + } + } + }, + "PutPolicyOutput":{ + "type":"structure", + "required":[ + "arn", + "token" + ], + "members":{ + "arn":{ + "shape":"VeniceGlobalArn", + "documentation":"The Entity Resolution resource ARN.
" + }, + "policy":{ + "shape":"PolicyDocument", + "documentation":"The resource-based policy.
" + }, + "token":{ + "shape":"PolicyToken", + "documentation":"A unique identifier for the current revision of the policy.
" + } + } + }, + "RecordAttributeMap":{ + "type":"map", + "key":{"shape":"RecordAttributeMapKeyString"}, + "value":{"shape":"RecordAttributeMapValueString"}, + "sensitive":true + }, + "RecordAttributeMapKeyString":{ + "type":"string", + "max":255, + "min":0, + "pattern":"^[a-zA-Z_0-9- \\t]*$" + }, + "RecordAttributeMapValueString":{ + "type":"string", + "max":255, + "min":0, + "pattern":"^[a-zA-Z_0-9-./@ ()+\\t]*$" + }, + "RecordMatchingModel":{ + "type":"string", + "enum":[ + "ONE_SOURCE_TO_ONE_TARGET", + "MANY_SOURCE_TO_ONE_TARGET" + ] + }, + "RecordMatchingModelList":{ + "type":"list", + "member":{"shape":"RecordMatchingModel"} + }, + "RequiredBucketActionsList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ResolutionTechniques":{ + "type":"structure", + "required":["resolutionType"], + "members":{ + "providerProperties":{ + "shape":"ProviderProperties", + "documentation":"The properties of the provider service.
" + }, + "resolutionType":{ + "shape":"ResolutionType", + "documentation":"The type of matching. There are three types of matching: RULE_MATCHING, ML_MATCHING, and PROVIDER.
An object which defines the list of matching rules to run and has a field Rules, which is a list of rule objects.
An object which defines the resolutionType and the ruleBasedProperties.
The resource could not be found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "RoleArn":{ + "type":"string", + "max":512, + "min":32, + "pattern":"^arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" + }, + "Rule":{ + "type":"structure", + "required":[ + "matchingKeys", + "ruleName" + ], + "members":{ + "matchingKeys":{ + "shape":"RuleMatchingKeysList", + "documentation":"A list of MatchingKeys. The MatchingKeys must have been defined in the SchemaMapping. Two records are considered to match according to this rule if all of the MatchingKeys match.
A name for the matching rule.
" + } + }, + "documentation":"An object containing RuleName, and MatchingKeys.
The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.
If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, the two profiles are matched on the Email attribute type.
If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.
An indicator of whether to generate IDs and index the data or not.
If you choose IDENTIFIER_GENERATION, the process generates IDs and indexes the data.
If you choose INDEXING, the process indexes the data without generating IDs.
A list of Rule objects, each of which have fields RuleName and MatchingKeys.
An object which defines the list of matching rules to run in a matching workflow. RuleBasedProperties contain a Rules field, which is a list of rule objects.
A string containing the field name.
" + }, + "groupName":{ + "shape":"AttributeName", + "documentation":"A string that instructs Entity Resolution to combine several columns into a unified column with the identical attribute type.
For example, when working with columns such as first_name, middle_name, and last_name, assigning them a common groupName will prompt Entity Resolution to concatenate them into a single value.
Indicates if the column values are hashed in the schema input. If the value is set to TRUE, the column values are hashed. If the value is set to FALSE, the column values are cleartext.
A key that allows grouping of multiple input attributes into a unified matching group.
For example, consider a scenario where the source table contains various addresses, such as business_address and shipping_address. By assigning a matchKey called address to both attributes, Entity Resolution will match records across these fields to create a consolidated matching group.
If no matchKey is specified for a column, it won't be utilized for matching purposes but will still be included in the output table.
The subtype of the attribute, selected from a list of values.
" + }, + "type":{ + "shape":"SchemaAttributeType", + "documentation":"The type of the attribute, selected from a list of values.
" + } + }, + "documentation":"An object containing FieldName, Type, GroupName, MatchKey, Hashing, and SubType.
The timestamp of when the SchemaMapping was created.
Specifies whether the schema mapping has been applied to a workflow.
" + }, + "schemaArn":{ + "shape":"SchemaMappingArn", + "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
The name of the schema.
" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the SchemaMapping was last updated.
An object containing SchemaName, SchemaArn, CreatedAt, andUpdatedAt.
A list of OutputSource objects.
The name of the ID mapping job to be retrieved.
", + "location":"uri", + "locationName":"workflowName" + } + } + }, + "StartIdMappingJobOutput":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"The ID of the job.
" + }, + "outputSourceConfig":{ + "shape":"IdMappingJobOutputSourceConfig", + "documentation":"A list of OutputSource objects.
The name of the matching job to be retrieved.
", + "location":"uri", + "locationName":"workflowName" + } + } + }, + "StartMatchingJobOutput":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"The ID of the job.
" + } + } + }, + "StatementAction":{ + "type":"string", + "max":64, + "min":3, + "pattern":"^(entityresolution:[a-zA-Z0-9]+)$" + }, + "StatementActionList":{ + "type":"list", + "member":{"shape":"StatementAction"}, + "min":1 + }, + "StatementCondition":{ + "type":"string", + "max":40960, + "min":1 + }, + "StatementEffect":{ + "type":"string", + "enum":[ + "Allow", + "Deny" + ] + }, + "StatementId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[0-9A-Za-z]+$" + }, + "StatementPrincipal":{ + "type":"string", + "max":64, + "min":12, + "pattern":"^(\\d{12})|([a-z0-9\\.]+)$" + }, + "StatementPrincipalList":{ + "type":"list", + "member":{"shape":"StatementPrincipal"}, + "min":1 + }, + "String":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":0 + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"VeniceGlobalArn", + "documentation":"The ARN of the resource for which you want to view tags.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":true} + }, + "Timestamp":{"type":"timestamp"}, + "UniqueId":{ + "type":"string", + "max":760, + "min":1, + "pattern":"^[a-zA-Z_0-9-+=/,]*$" + }, + "UniqueIdList":{ + "type":"list", + "member":{"shape":"UniqueId"} + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"VeniceGlobalArn", + "documentation":"The ARN of the resource for which you want to untag.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"The list of tag keys to remove from the resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateIdMappingWorkflowInput":{ + "type":"structure", + "required":[ + "idMappingTechniques", + "inputSourceConfig", + "workflowName" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"A description of the workflow.
" + }, + "idMappingTechniques":{ + "shape":"IdMappingTechniques", + "documentation":"An object which defines the ID mapping technique and any additional configurations.
" + }, + "inputSourceConfig":{ + "shape":"IdMappingWorkflowInputSourceConfig", + "documentation":"A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.
" + }, + "workflowName":{ + "shape":"EntityName", + "documentation":"The name of the workflow.
", + "location":"uri", + "locationName":"workflowName" + } + } + }, + "UpdateIdMappingWorkflowOutput":{ + "type":"structure", + "required":[ + "idMappingTechniques", + "inputSourceConfig", + "workflowArn", + "workflowName" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"A description of the workflow.
" + }, + "idMappingTechniques":{ + "shape":"IdMappingTechniques", + "documentation":"An object which defines the ID mapping technique and any additional configurations.
" + }, + "inputSourceConfig":{ + "shape":"IdMappingWorkflowInputSourceConfig", + "documentation":"A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.
" + }, + "workflowArn":{ + "shape":"IdMappingWorkflowArn", + "documentation":"The Amazon Resource Name (ARN) of the workflow role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.
" + }, + "workflowName":{ + "shape":"EntityName", + "documentation":"The name of the workflow.
" + } + } + }, + "UpdateIdNamespaceInput":{ + "type":"structure", + "required":["idNamespaceName"], + "members":{ + "description":{ + "shape":"Description", + "documentation":"The description of the ID namespace.
" + }, + "idMappingWorkflowProperties":{ + "shape":"IdNamespaceIdMappingWorkflowPropertiesList", + "documentation":"Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.
The name of the ID namespace.
", + "location":"uri", + "locationName":"idNamespaceName" + }, + "inputSourceConfig":{ + "shape":"IdNamespaceInputSourceConfig", + "documentation":"A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of a workflow run.
The timestamp of when the ID namespace was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the ID namespace.
" + }, + "idMappingWorkflowProperties":{ + "shape":"IdNamespaceIdMappingWorkflowPropertiesList", + "documentation":"Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.
The Amazon Resource Name (ARN) of the ID namespace.
" + }, + "idNamespaceName":{ + "shape":"EntityName", + "documentation":"The name of the ID namespace.
" + }, + "inputSourceConfig":{ + "shape":"IdNamespaceInputSourceConfig", + "documentation":"A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of a workflow run.
The type of ID namespace. There are two types: SOURCE and TARGET.
The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.
The TARGET contains a configuration of targetId to which all sourceIds will resolve to.
The timestamp of when the ID namespace was last updated.
" + } + } + }, + "UpdateMatchingWorkflowInput":{ + "type":"structure", + "required":[ + "inputSourceConfig", + "outputSourceConfig", + "resolutionTechniques", + "roleArn", + "workflowName" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"A description of the workflow.
" + }, + "incrementalRunConfig":{ + "shape":"IncrementalRunConfig", + "documentation":"An object which defines an incremental run type and has only incrementalRunType as a field.
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
" + }, + "workflowName":{ + "shape":"EntityName", + "documentation":"The name of the workflow to be retrieved.
", + "location":"uri", + "locationName":"workflowName" + } + } + }, + "UpdateMatchingWorkflowOutput":{ + "type":"structure", + "required":[ + "inputSourceConfig", + "outputSourceConfig", + "resolutionTechniques", + "roleArn", + "workflowName" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"A description of the workflow.
" + }, + "incrementalRunConfig":{ + "shape":"IncrementalRunConfig", + "documentation":"An object which defines an incremental run type and has only incrementalRunType as a field.
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
" + }, + "workflowName":{ + "shape":"EntityName", + "documentation":"The name of the workflow.
" + } + } + }, + "UpdateSchemaMappingInput":{ + "type":"structure", + "required":[ + "mappedInputFields", + "schemaName" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"A description of the schema.
" + }, + "mappedInputFields":{ + "shape":"SchemaInputAttributes", + "documentation":"A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.
The name of the schema. There can't be multiple SchemaMappings with the same name.
A description of the schema.
" + }, + "mappedInputFields":{ + "shape":"SchemaInputAttributes", + "documentation":"A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.
The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
The name of the schema.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"The input fails to satisfy the constraints specified by Entity Resolution.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "VeniceGlobalArn":{ + "type":"string", + "pattern":"^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:((schemamapping|matchingworkflow|idmappingworkflow|idnamespace)/[a-zA-Z_0-9-]{1,255})$" + } + }, + "documentation":"Welcome to the Entity Resolution API Reference.
Entity Resolution is an Amazon Web Services service that provides pre-configured entity resolution capabilities that enable developers and analysts at advertising and marketing companies to build an accurate and complete view of their consumers.
With Entity Resolution, you can match source records containing consumer identifiers, such as name, email address, and phone number. This is true even when these records have incomplete or conflicting identifiers. For example, Entity Resolution can effectively match a source record from a customer relationship management (CRM) system with a source record from a marketing system containing campaign information.
To learn more about Entity Resolution concepts, procedures, and best practices, see the Entity Resolution User Guide.
" +} diff --git a/testbed/boto__botocore/botocore/data/internetmonitor/2021-06-03/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/internetmonitor/2021-06-03/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..58429604e346ef0bdabb1153ac643d3ff8cc08f9 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/internetmonitor/2021-06-03/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://internetmonitor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://internetmonitor-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://internetmonitor.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://internetmonitor.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/internetmonitor/2021-06-03/paginators-1.json b/testbed/boto__botocore/botocore/data/internetmonitor/2021-06-03/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..c08ea4f0d8bc65ced8756c1669ffdf633ba72847 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/internetmonitor/2021-06-03/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListHealthEvents": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "HealthEvents" + }, + "ListMonitors": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Monitors" + }, + "ListInternetEvents": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InternetEvents" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/internetmonitor/2021-06-03/service-2.json b/testbed/boto__botocore/botocore/data/internetmonitor/2021-06-03/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..1730acc4104214f5c752e7cb0bfe92b9e11b7ea8 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/internetmonitor/2021-06-03/service-2.json @@ -0,0 +1,1904 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-06-03", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"internetmonitor", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"Amazon CloudWatch Internet Monitor", + "serviceId":"InternetMonitor", + "signatureVersion":"v4", + "signingName":"internetmonitor", + "uid":"internetmonitor-2021-06-03" + }, + "operations":{ + "CreateMonitor":{ + "name":"CreateMonitor", + "http":{ + "method":"POST", + "requestUri":"/v20210603/Monitors", + "responseCode":200 + }, + "input":{"shape":"CreateMonitorInput"}, + "output":{"shape":"CreateMonitorOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"} + ], + "documentation":"Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: VPCs, Network Load Balancers (NLBs), Amazon CloudFront distributions, and Amazon WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services that are specific to the city-networks. That is, the locations and ASNs (typically internet service providers or ISPs), where clients access your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.
When you create a monitor, you choose the percentage of traffic that you want to monitor. You can also set a maximum limit for the number of city-networks where client traffic is monitored, that caps the total traffic that Internet Monitor monitors. A city-network maximum is the limit of city-networks, but you only pay for the number of city-networks that are actually monitored. You can update your monitor at any time to change the percentage of traffic to monitor or the city-networks maximum. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.
", + "idempotent":true + }, + "DeleteMonitor":{ + "name":"DeleteMonitor", + "http":{ + "method":"DELETE", + "requestUri":"/v20210603/Monitors/{MonitorName}", + "responseCode":200 + }, + "input":{"shape":"DeleteMonitorInput"}, + "output":{"shape":"DeleteMonitorOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes a monitor in Amazon CloudWatch Internet Monitor.
", + "idempotent":true + }, + "GetHealthEvent":{ + "name":"GetHealthEvent", + "http":{ + "method":"GET", + "requestUri":"/v20210603/Monitors/{MonitorName}/HealthEvents/{EventId}", + "responseCode":200 + }, + "input":{"shape":"GetHealthEventInput"}, + "output":{"shape":"GetHealthEventOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, and all the information related to the event, by location.
The information returned includes the impact on performance, availability, and round-trip time, information about the network providers (ASNs), the event type, and so on.
Information rolled up at the global traffic level is also returned, including the impact type and total traffic impact.
" + }, + "GetInternetEvent":{ + "name":"GetInternetEvent", + "http":{ + "method":"GET", + "requestUri":"/v20210603/InternetEvents/{EventId}", + "responseCode":200 + }, + "input":{"shape":"GetInternetEventInput"}, + "output":{"shape":"GetInternetEventOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event. Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers.
The information returned here includes the impacted location, when the event started and (if the event is over) ended, the type of event (PERFORMANCE or AVAILABILITY), and the status (ACTIVE or RESOLVED).
Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.
" + }, + "GetQueryResults":{ + "name":"GetQueryResults", + "http":{ + "method":"GET", + "requestUri":"/v20210603/Monitors/{MonitorName}/Queries/{QueryId}/Results", + "responseCode":200 + }, + "input":{"shape":"GetQueryResultsInput"}, + "output":{"shape":"GetQueryResultsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"} + ], + "documentation":"Return the data for a query with the Amazon CloudWatch Internet Monitor query interface. Specify the query that you want to return results for by providing a QueryId and a monitor name.
For more information about using the query interface, including examples, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
" + }, + "GetQueryStatus":{ + "name":"GetQueryStatus", + "http":{ + "method":"GET", + "requestUri":"/v20210603/Monitors/{MonitorName}/Queries/{QueryId}/Status", + "responseCode":200 + }, + "input":{"shape":"GetQueryStatusInput"}, + "output":{"shape":"GetQueryStatusOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor. When you run a query, check the status to make sure that the query has SUCCEEDED before you review the results.
QUEUED: The query is scheduled to run.
RUNNING: The query is in progress but not complete.
SUCCEEDED: The query completed sucessfully.
FAILED: The query failed due to an error.
CANCELED: The query was canceled.
Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns information for health events including the event start and end times, and the status.
Health events that have start times during the time frame that is requested are not included in the list of health events.
Lists internet events that cause performance or availability issues for client locations. Amazon CloudWatch Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers.
You can constrain the list of internet events returned by providing a start time and end time to define a total time frame for events you want to list. Both start time and end time specify the time when an event started. End time is optional. If you don't include it, the default end time is the current time.
You can also limit the events returned to a specific status (ACTIVE or RESOLVED) or type (PERFORMANCE or AVAILABILITY).
Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{ResourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.
" + }, + "StartQuery":{ + "name":"StartQuery", + "http":{ + "method":"POST", + "requestUri":"/v20210603/Monitors/{MonitorName}/Queries", + "responseCode":200 + }, + "input":{"shape":"StartQueryInput"}, + "output":{"shape":"StartQueryOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"} + ], + "documentation":"Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface. Specify a time period for the data that you want returned by using StartTime and EndTime. You filter the query results to return by providing parameters that you specify with FilterParameters.
For more information about using the query interface, including examples, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
" + }, + "StopQuery":{ + "name":"StopQuery", + "http":{ + "method":"DELETE", + "requestUri":"/v20210603/Monitors/{MonitorName}/Queries/{QueryId}", + "responseCode":200 + }, + "input":{"shape":"StopQueryInput"}, + "output":{"shape":"StopQueryOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"} + ], + "documentation":"Stop a query that is progress for a specific monitor.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{ResourceArn}", + "responseCode":204 + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"Adds a tag to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor. You can add a maximum of 50 tags in Internet Monitor.
A minimum of one tag is required for this call. It returns an error if you use the TagResource request with 0 tags.
Removes a tag from a resource.
", + "idempotent":true + }, + "UpdateMonitor":{ + "name":"UpdateMonitor", + "http":{ + "method":"PATCH", + "requestUri":"/v20210603/Monitors/{MonitorName}", + "responseCode":200 + }, + "input":{"shape":"UpdateMonitorInput"}, + "output":{"shape":"UpdateMonitorOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates a monitor. You can update a monitor to change the percentage of traffic to monitor or the maximum number of city-networks (locations and ASNs), to add or remove resources, or to change the status of the monitor. Note that you can't change the name of a monitor.
The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.
", + "idempotent":true + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"You don't have sufficient permission to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccountId":{ + "type":"string", + "max":12, + "min":12 + }, + "Arn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:.*" + }, + "AvailabilityMeasurement":{ + "type":"structure", + "members":{ + "ExperienceScore":{ + "shape":"Double", + "documentation":"Experience scores, or health scores are calculated for different geographic and network provider combinations (that is, different granularities) and also summed into global scores. If you view performance or availability scores without filtering for any specific geography or service provider, Amazon CloudWatch Internet Monitor provides global health scores.
The Amazon CloudWatch Internet Monitor chapter in the CloudWatch User Guide includes detailed information about how Internet Monitor calculates health scores, including performance and availability scores, and when it creates and resolves health events. For more information, see How Amazon Web Services calculates performance and availability scores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + }, + "PercentOfTotalTrafficImpacted":{ + "shape":"Double", + "documentation":"The impact on total traffic that a health event has, in increased latency or reduced availability. This is the percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this client location to the Amazon Web Services location using this client network.
For information about how Internet Monitor calculates impact, see How Internet Monitor works in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.
" + }, + "PercentOfClientLocationImpacted":{ + "shape":"Double", + "documentation":"The percentage of impact caused by a health event for client location traffic globally.
For information about how Internet Monitor calculates impact, see Inside Internet Monitor in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.
" + } + }, + "documentation":"Amazon CloudWatch Internet Monitor calculates measurements about the availability for your application's internet traffic between client locations and Amazon Web Services. Amazon Web Services has substantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it easier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.
Availability in Internet Monitor represents the estimated percentage of traffic that is not seeing an availability drop. For example, an availability score of 99% for an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.
For more information, see How Internet Monitor calculates performance and availability scores in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.
" + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"A bad request was received.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ClientLocation":{ + "type":"structure", + "required":[ + "ASName", + "ASNumber", + "Country", + "City", + "Latitude", + "Longitude" + ], + "members":{ + "ASName":{ + "shape":"String", + "documentation":"The name of the internet service provider (ISP) or network (ASN).
" + }, + "ASNumber":{ + "shape":"Long", + "documentation":"The Autonomous System Number (ASN) of the network at an impacted location.
" + }, + "Country":{ + "shape":"String", + "documentation":"The name of the country where the internet event is located.
" + }, + "Subdivision":{ + "shape":"String", + "documentation":"The subdivision location where the health event is located. The subdivision usually maps to states in most countries (including the United States). For United Kingdom, it maps to a country (England, Scotland, Wales) or province (Northern Ireland).
" + }, + "Metro":{ + "shape":"String", + "documentation":"The metro area where the health event is located.
Metro indicates a metropolitan region in the United States, such as the region around New York City. In non-US countries, this is a second-level subdivision. For example, in the United Kingdom, it could be a county, a London borough, a unitary authority, council area, and so on.
" + }, + "City":{ + "shape":"String", + "documentation":"The name of the city where the internet event is located.
" + }, + "Latitude":{ + "shape":"Double", + "documentation":"The latitude where the internet event is located.
" + }, + "Longitude":{ + "shape":"Double", + "documentation":"The longitude where the internet event is located.
" + } + }, + "documentation":"The impacted location, such as a city, that Amazon Web Services clients access application resources from.
" + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The requested resource is in use.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateMonitorInput":{ + "type":"structure", + "required":["MonitorName"], + "members":{ + "MonitorName":{ + "shape":"ResourceName", + "documentation":"The name of the monitor.
" + }, + "Resources":{ + "shape":"SetOfARNs", + "documentation":"The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories.
You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources.
If you add only Amazon VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.
A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.
", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.
" + }, + "MaxCityNetworksToMonitor":{ + "shape":"MaxCityNetworksToMonitor", + "documentation":"The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. Setting this limit can help control billing costs.
To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + }, + "InternetMeasurementsLogDelivery":{ + "shape":"InternetMeasurementsLogDelivery", + "documentation":"Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.
" + }, + "TrafficPercentageToMonitor":{ + "shape":"TrafficPercentageToMonitor", + "documentation":"The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.
To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + }, + "HealthEventsConfig":{ + "shape":"HealthEventsConfig", + "documentation":"Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a health event when an internet issue that affects your application end users has a health score percentage that is at or below a specific threshold, and, sometimes, when other criteria are met.
If you don't set a health event threshold, the default value is 95%.
For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.
" + } + } + }, + "CreateMonitorOutput":{ + "type":"structure", + "required":[ + "Arn", + "Status" + ], + "members":{ + "Arn":{ + "shape":"MonitorArn", + "documentation":"The Amazon Resource Name (ARN) of the monitor.
" + }, + "Status":{ + "shape":"MonitorConfigState", + "documentation":"The status of a monitor.
" + } + } + }, + "DeleteMonitorInput":{ + "type":"structure", + "required":["MonitorName"], + "members":{ + "MonitorName":{ + "shape":"ResourceName", + "documentation":"The name of the monitor to delete.
", + "location":"uri", + "locationName":"MonitorName" + } + } + }, + "DeleteMonitorOutput":{ + "type":"structure", + "members":{ + } + }, + "Double":{ + "type":"double", + "box":true + }, + "FilterList":{ + "type":"list", + "member":{"shape":"String"} + }, + "FilterParameter":{ + "type":"structure", + "members":{ + "Field":{ + "shape":"String", + "documentation":"A data field that you want to filter, to further scope your application's Internet Monitor data in a repository that you created by running a query. A field might be city, for example. The field must be one of the fields that was returned by the specific query that you used to create the repository.
The operator to use with the filter field and a value, such as not_equals.
One or more values to be used, together with the specified operator, to filter data for a query. For example, you could specify an array of values such as [\"Seattle\", \"Redmond\"]. Values in the array are separated by commas.
A filter that you use with the results of a Amazon CloudWatch Internet Monitor query that you created and ran. The query sets up a repository of data that is a subset of your application's Internet Monitor data. FilterParameter is a string that defines how you want to filter the repository of data to return a set of results, based on your criteria.
The filter parameters that you can specify depend on the query type that you used to create the repository, since each query type returns a different set of Internet Monitor data.
For each filter, you specify a field (such as city), an operator (such as not_equals, and a value or array of values (such as [\"Seattle\", \"Redmond\"]). Separate values in the array with commas.
For more information about specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
" + }, + "FilterParameters":{ + "type":"list", + "member":{"shape":"FilterParameter"} + }, + "GetHealthEventInput":{ + "type":"structure", + "required":[ + "MonitorName", + "EventId" + ], + "members":{ + "MonitorName":{ + "shape":"ResourceName", + "documentation":"The name of the monitor.
", + "location":"uri", + "locationName":"MonitorName" + }, + "EventId":{ + "shape":"HealthEventName", + "documentation":"The internally-generated identifier of a health event. Because EventID contains the forward slash (“/”) character, you must URL-encode the EventID field in the request URL.
The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.
", + "location":"querystring", + "locationName":"LinkedAccountId" + } + } + }, + "GetHealthEventOutput":{ + "type":"structure", + "required":[ + "EventArn", + "EventId", + "StartedAt", + "LastUpdatedAt", + "ImpactedLocations", + "Status", + "ImpactType" + ], + "members":{ + "EventArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the event.
" + }, + "EventId":{ + "shape":"HealthEventName", + "documentation":"The internally-generated identifier of a health event.
" + }, + "StartedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time when a health event started.
" + }, + "EndedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time when a health event was resolved. If the health event is still active, the end time is not set.
" + }, + "CreatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time when a health event was created.
" + }, + "LastUpdatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time when a health event was last updated or recalculated.
" + }, + "ImpactedLocations":{ + "shape":"ImpactedLocationsList", + "documentation":"The locations affected by a health event.
" + }, + "Status":{ + "shape":"HealthEventStatus", + "documentation":"The status of a health event.
" + }, + "PercentOfTotalTrafficImpacted":{ + "shape":"Double", + "documentation":"The impact on total traffic that a health event has, in increased latency or reduced availability. This is the percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this client location to the Amazon Web Services location using this client network.
" + }, + "ImpactType":{ + "shape":"HealthEventImpactType", + "documentation":"The type of impairment of a specific health event.
" + }, + "HealthScoreThreshold":{ + "shape":"Percentage", + "documentation":"The threshold percentage for a health score that determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.
" + } + } + }, + "GetInternetEventInput":{ + "type":"structure", + "required":["EventId"], + "members":{ + "EventId":{ + "shape":"InternetEventId", + "documentation":"The EventId of the internet event to return information for.
The internally-generated identifier of an internet event.
" + }, + "EventArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the internet event.
" + }, + "StartedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time when the internet event started.
" + }, + "EndedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time when the internet event ended. If the event hasn't ended yet, this value is empty.
" + }, + "ClientLocation":{ + "shape":"ClientLocation", + "documentation":"The impacted location, such as a city, where clients access Amazon Web Services application resources.
" + }, + "EventType":{ + "shape":"InternetEventType", + "documentation":"The type of network impairment.
" + }, + "EventStatus":{ + "shape":"InternetEventStatus", + "documentation":"The status of the internet event.
" + } + } + }, + "GetMonitorInput":{ + "type":"structure", + "required":["MonitorName"], + "members":{ + "MonitorName":{ + "shape":"ResourceName", + "documentation":"The name of the monitor.
", + "location":"uri", + "locationName":"MonitorName" + }, + "LinkedAccountId":{ + "shape":"AccountId", + "documentation":"The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.
", + "location":"querystring", + "locationName":"LinkedAccountId" + } + } + }, + "GetMonitorOutput":{ + "type":"structure", + "required":[ + "MonitorName", + "MonitorArn", + "Resources", + "Status", + "CreatedAt", + "ModifiedAt" + ], + "members":{ + "MonitorName":{ + "shape":"ResourceName", + "documentation":"The name of the monitor.
" + }, + "MonitorArn":{ + "shape":"MonitorArn", + "documentation":"The Amazon Resource Name (ARN) of the monitor.
" + }, + "Resources":{ + "shape":"SetOfARNs", + "documentation":"The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).
" + }, + "Status":{ + "shape":"MonitorConfigState", + "documentation":"The status of the monitor.
" + }, + "CreatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time when the monitor was created.
" + }, + "ModifiedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The last time that the monitor was modified.
" + }, + "ProcessingStatus":{ + "shape":"MonitorProcessingStatusCode", + "documentation":"The health of the data processing for the monitor.
" + }, + "ProcessingStatusInfo":{ + "shape":"String", + "documentation":"Additional information about the health of the data processing for the monitor.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The tags that have been added to monitor.
" + }, + "MaxCityNetworksToMonitor":{ + "shape":"MaxCityNetworksToMonitor", + "documentation":"The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. This limit can help control billing costs.
To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + }, + "InternetMeasurementsLogDelivery":{ + "shape":"InternetMeasurementsLogDelivery", + "documentation":"Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.
" + }, + "TrafficPercentageToMonitor":{ + "shape":"TrafficPercentageToMonitor", + "documentation":"The percentage of the internet-facing traffic for your application to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.
To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + }, + "HealthEventsConfig":{ + "shape":"HealthEventsConfig", + "documentation":"The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.
For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.
" + } + } + }, + "GetQueryResultsInput":{ + "type":"structure", + "required":[ + "MonitorName", + "QueryId" + ], + "members":{ + "MonitorName":{ + "shape":"ResourceName", + "documentation":"The name of the monitor to return data for.
", + "location":"uri", + "locationName":"MonitorName" + }, + "QueryId":{ + "shape":"String", + "documentation":"The ID of the query that you want to return data results for. A QueryId is an internally-generated identifier for a specific query.
The token for the next set of results. You receive this token from a previous call.
", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"QueryMaxResults", + "documentation":"The number of query results that you want to return with this call.
", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "GetQueryResultsOutput":{ + "type":"structure", + "required":[ + "Fields", + "Data" + ], + "members":{ + "Fields":{ + "shape":"QueryFields", + "documentation":"The fields that the query returns data for. Fields are name-data type pairs, such as availability_score-float.
The data results that the query returns. Data is returned in arrays, aligned with the Fields for the query, which creates a repository of Amazon CloudWatch Internet Monitor information for your application. Then, you can filter the information in the repository by using FilterParameters that you define.
The token for the next set of results. You receive this token from a previous call.
" + } + } + }, + "GetQueryStatusInput":{ + "type":"structure", + "required":[ + "MonitorName", + "QueryId" + ], + "members":{ + "MonitorName":{ + "shape":"ResourceName", + "documentation":"The name of the monitor.
", + "location":"uri", + "locationName":"MonitorName" + }, + "QueryId":{ + "shape":"String", + "documentation":"The ID of the query that you want to return the status for. A QueryId is an internally-generated dentifier for a specific query.
The current status for a query.
" + } + } + }, + "HealthEvent":{ + "type":"structure", + "required":[ + "EventArn", + "EventId", + "StartedAt", + "LastUpdatedAt", + "ImpactedLocations", + "Status", + "ImpactType" + ], + "members":{ + "EventArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the event.
" + }, + "EventId":{ + "shape":"HealthEventName", + "documentation":"The internally-generated identifier of a specific network traffic impairment health event.
" + }, + "StartedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When a health event started.
" + }, + "EndedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time when a health event ended. If the health event is still active, then the end time is not set.
" + }, + "CreatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the health event was created.
" + }, + "LastUpdatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the health event was last updated.
" + }, + "ImpactedLocations":{ + "shape":"ImpactedLocationsList", + "documentation":"The locations impacted by the health event.
" + }, + "Status":{ + "shape":"HealthEventStatus", + "documentation":"The status of a health event.
" + }, + "PercentOfTotalTrafficImpacted":{ + "shape":"Double", + "documentation":"The impact on total traffic that a health event has, in increased latency or reduced availability. This is the percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this client location to the Amazon Web Services location using this client network.
" + }, + "ImpactType":{ + "shape":"HealthEventImpactType", + "documentation":"The type of impairment for a health event.
" + }, + "HealthScoreThreshold":{ + "shape":"Percentage", + "documentation":"The value of the threshold percentage for performance or availability that was configured when Amazon CloudWatch Internet Monitor created the health event.
" + } + }, + "documentation":"Information about a health event created in a monitor in Amazon CloudWatch Internet Monitor.
" + }, + "HealthEventImpactType":{ + "type":"string", + "enum":[ + "AVAILABILITY", + "PERFORMANCE", + "LOCAL_AVAILABILITY", + "LOCAL_PERFORMANCE" + ] + }, + "HealthEventList":{ + "type":"list", + "member":{"shape":"HealthEvent"} + }, + "HealthEventName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[a-zA-Z0-9/_.-]+" + }, + "HealthEventStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "RESOLVED" + ] + }, + "HealthEventsConfig":{ + "type":"structure", + "members":{ + "AvailabilityScoreThreshold":{ + "shape":"Percentage", + "documentation":"The health event threshold percentage set for availability scores.
" + }, + "PerformanceScoreThreshold":{ + "shape":"Percentage", + "documentation":"The health event threshold percentage set for performance scores.
" + }, + "AvailabilityLocalHealthEventsConfig":{ + "shape":"LocalHealthEventsConfig", + "documentation":"The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.
" + }, + "PerformanceLocalHealthEventsConfig":{ + "shape":"LocalHealthEventsConfig", + "documentation":"The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.
" + } + }, + "documentation":"A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.
Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.
You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.
If you don't set a health event threshold, the default value is 95%.
For local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.
For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.
" + }, + "ImpactedLocation":{ + "type":"structure", + "required":[ + "ASName", + "ASNumber", + "Country", + "Status" + ], + "members":{ + "ASName":{ + "shape":"String", + "documentation":"The name of the internet service provider (ISP) or network (ASN).
" + }, + "ASNumber":{ + "shape":"Long", + "documentation":"The Autonomous System Number (ASN) of the network at an impacted location.
" + }, + "Country":{ + "shape":"String", + "documentation":"The name of the country where the health event is located.
" + }, + "Subdivision":{ + "shape":"String", + "documentation":"The subdivision location where the health event is located. The subdivision usually maps to states in most countries (including the United States). For United Kingdom, it maps to a country (England, Scotland, Wales) or province (Northern Ireland).
" + }, + "Metro":{ + "shape":"String", + "documentation":"The metro area where the health event is located.
Metro indicates a metropolitan region in the United States, such as the region around New York City. In non-US countries, this is a second-level subdivision. For example, in the United Kingdom, it could be a county, a London borough, a unitary authority, council area, and so on.
" + }, + "City":{ + "shape":"String", + "documentation":"The name of the city where the health event is located.
" + }, + "Latitude":{ + "shape":"Double", + "documentation":"The latitude where the health event is located.
" + }, + "Longitude":{ + "shape":"Double", + "documentation":"The longitude where the health event is located.
" + }, + "CountryCode":{ + "shape":"String", + "documentation":"The country code where the health event is located. The ISO 3166-2 codes for the country is provided, when available.
" + }, + "SubdivisionCode":{ + "shape":"String", + "documentation":"The subdivision code where the health event is located. The ISO 3166-2 codes for country subdivisions is provided, when available.
" + }, + "ServiceLocation":{ + "shape":"String", + "documentation":"The service location where the health event is located.
" + }, + "Status":{ + "shape":"HealthEventStatus", + "documentation":"The status of the health event at an impacted location.
" + }, + "CausedBy":{ + "shape":"NetworkImpairment", + "documentation":"The cause of the impairment. There are two types of network impairments: Amazon Web Services network issues or internet issues. Internet issues are typically a problem with a network provider, like an internet service provider (ISP).
" + }, + "InternetHealth":{ + "shape":"InternetHealth", + "documentation":"The calculated health at a specific location.
" + }, + "Ipv4Prefixes":{ + "shape":"Ipv4PrefixList", + "documentation":"The IPv4 prefixes at the client location that was impacted by the health event.
" + } + }, + "documentation":"Information about a location impacted by a health event in Amazon CloudWatch Internet Monitor.
Geographic regions are hierarchically categorized into country, subdivision, metro and city geographic granularities. The geographic region is identified based on the IP address used at the client locations.
" + }, + "ImpactedLocationsList":{ + "type":"list", + "member":{"shape":"ImpactedLocation"} + }, + "InternalServerErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"There was an internal server error.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"An internal error occurred.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "InternetEventId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[a-zA-Z0-9-]+" + }, + "InternetEventMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "InternetEventStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "RESOLVED" + ] + }, + "InternetEventSummary":{ + "type":"structure", + "required":[ + "EventId", + "EventArn", + "StartedAt", + "ClientLocation", + "EventType", + "EventStatus" + ], + "members":{ + "EventId":{ + "shape":"InternetEventId", + "documentation":"The internally-generated identifier of an internet event.
" + }, + "EventArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the internet event.
" + }, + "StartedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time when an internet event started.
" + }, + "EndedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time when an internet event ended. If the event hasn't ended yet, this value is empty.
" + }, + "ClientLocation":{ + "shape":"ClientLocation", + "documentation":"The impacted location, such as a city, that Amazon Web Services clients access application resources from.
" + }, + "EventType":{ + "shape":"InternetEventType", + "documentation":"The type of network impairment.
" + }, + "EventStatus":{ + "shape":"InternetEventStatus", + "documentation":"The status of an internet event.
" + } + }, + "documentation":"A summary of information about an internet event in Amazon CloudWatch Internet Monitor. Internet events are issues that cause performance degradation or availability problems for impacted Amazon Web Services client locations. Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers.
" + }, + "InternetEventType":{ + "type":"string", + "enum":[ + "AVAILABILITY", + "PERFORMANCE" + ] + }, + "InternetEventsList":{ + "type":"list", + "member":{"shape":"InternetEventSummary"} + }, + "InternetHealth":{ + "type":"structure", + "members":{ + "Availability":{ + "shape":"AvailabilityMeasurement", + "documentation":"Availability in Internet Monitor represents the estimated percentage of traffic that is not seeing an availability drop. For example, an availability score of 99% for an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.
For more information, see How Internet Monitor calculates performance and availability scores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + }, + "Performance":{ + "shape":"PerformanceMeasurement", + "documentation":"Performance in Internet Monitor represents the estimated percentage of traffic that is not seeing a performance drop. For example, a performance score of 99% for an end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.
For more information, see How Internet Monitor calculates performance and availability scores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + } + }, + "documentation":"Internet health includes measurements calculated by Amazon CloudWatch Internet Monitor about the performance and availability for your application on the internet. Amazon Web Services has substantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it easier to see those drops, Internet Monitor reports the information to you in the form of health scores: a performance score and an availability score.
" + }, + "InternetMeasurementsLogDelivery":{ + "type":"structure", + "members":{ + "S3Config":{ + "shape":"S3Config", + "documentation":"The configuration information for publishing Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is ENABLED or DISABLED, depending on whether you choose to deliver internet measurements to S3 logs.
Publish internet measurements to an Amazon S3 bucket in addition to CloudWatch Logs.
" + }, + "Ipv4PrefixList":{ + "type":"list", + "member":{"shape":"String"} + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request exceeded a service quota.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "ListHealthEventsInput":{ + "type":"structure", + "required":["MonitorName"], + "members":{ + "MonitorName":{ + "shape":"ResourceName", + "documentation":"The name of the monitor.
", + "location":"uri", + "locationName":"MonitorName" + }, + "StartTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time when a health event started.
", + "location":"querystring", + "locationName":"StartTime" + }, + "EndTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time when a health event ended. If the health event is still ongoing, then the end time is not set.
", + "location":"querystring", + "locationName":"EndTime" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token for the next set of results. You receive this token from a previous call.
", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The number of health event objects that you want to return with this call.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "EventStatus":{ + "shape":"HealthEventStatus", + "documentation":"The status of a health event.
", + "location":"querystring", + "locationName":"EventStatus" + }, + "LinkedAccountId":{ + "shape":"AccountId", + "documentation":"The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.
", + "location":"querystring", + "locationName":"LinkedAccountId" + } + } + }, + "ListHealthEventsOutput":{ + "type":"structure", + "required":["HealthEvents"], + "members":{ + "HealthEvents":{ + "shape":"HealthEventList", + "documentation":"A list of health events.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token for the next set of results. You receive this token from a previous call.
" + } + } + }, + "ListInternetEventsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"The token for the next set of results. You receive this token from a previous call.
", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"InternetEventMaxResults", + "documentation":"The number of query results that you want to return with this call.
", + "location":"querystring", + "locationName":"InternetEventMaxResults" + }, + "StartTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The start time of the time window that you want to get a list of internet events for.
", + "location":"querystring", + "locationName":"StartTime" + }, + "EndTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The end time of the time window that you want to get a list of internet events for.
", + "location":"querystring", + "locationName":"EndTime" + }, + "EventStatus":{ + "shape":"String", + "documentation":"The status of an internet event.
", + "location":"querystring", + "locationName":"EventStatus" + }, + "EventType":{ + "shape":"String", + "documentation":"The type of network impairment.
", + "location":"querystring", + "locationName":"EventType" + } + } + }, + "ListInternetEventsOutput":{ + "type":"structure", + "required":["InternetEvents"], + "members":{ + "InternetEvents":{ + "shape":"InternetEventsList", + "documentation":"A set of internet events returned for the list operation.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token for the next set of results. You receive this token from a previous call.
" + } + } + }, + "ListMonitorsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"The token for the next set of results. You receive this token from a previous call.
", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The number of monitor objects that you want to return with this call.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "MonitorStatus":{ + "shape":"String", + "documentation":"The status of a monitor. This includes the status of the data processing for the monitor and the status of the monitor itself.
For information about the statuses for a monitor, see Monitor.
", + "location":"querystring", + "locationName":"MonitorStatus" + }, + "IncludeLinkedAccounts":{ + "shape":"Boolean", + "documentation":"A boolean option that you can set to TRUE to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.
A list of monitors.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token for the next set of results. You receive this token from a previous call.
" + } + } + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"MonitorArn", + "documentation":"The Amazon Resource Name (ARN) for a resource.
", + "location":"uri", + "locationName":"ResourceArn" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"Tags for a resource.
" + } + } + }, + "LocalHealthEventsConfig":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"LocalHealthEventsConfigStatus", + "documentation":"The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED.
The health event threshold percentage set for a local health score.
" + }, + "MinTrafficImpact":{ + "shape":"Percentage", + "documentation":"The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.
If you don't set a minimum traffic impact threshold, the default value is 0.1%.
" + } + }, + "documentation":"A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance or availability issue, when scores cross a threshold for one or more city-networks.
Defines the percentages, for performance scores or availability scores, that are the local thresholds for when Amazon CloudWatch Internet Monitor creates a health event. Also defines whether a local threshold is enabled or disabled, and the minimum percentage of overall traffic that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.
If you don't set a local health event threshold, the default value is 60%.
For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.
" + }, + "LocalHealthEventsConfigStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "LogDeliveryStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "Long":{ + "type":"long", + "box":true + }, + "MaxCityNetworksToMonitor":{ + "type":"integer", + "box":true, + "max":500000, + "min":1 + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":25, + "min":1 + }, + "Monitor":{ + "type":"structure", + "required":[ + "MonitorName", + "MonitorArn", + "Status" + ], + "members":{ + "MonitorName":{ + "shape":"ResourceName", + "documentation":"The name of the monitor.
" + }, + "MonitorArn":{ + "shape":"MonitorArn", + "documentation":"The Amazon Resource Name (ARN) of the monitor.
" + }, + "Status":{ + "shape":"MonitorConfigState", + "documentation":"The status of a monitor.
" + }, + "ProcessingStatus":{ + "shape":"MonitorProcessingStatusCode", + "documentation":"The health of data processing for the monitor.
" + } + }, + "documentation":"The description of and information about a monitor in Amazon CloudWatch Internet Monitor.
" + }, + "MonitorArn":{ + "type":"string", + "max":512, + "min":20, + "pattern":"arn:.*" + }, + "MonitorConfigState":{ + "type":"string", + "enum":[ + "PENDING", + "ACTIVE", + "INACTIVE", + "ERROR" + ] + }, + "MonitorList":{ + "type":"list", + "member":{"shape":"Monitor"} + }, + "MonitorProcessingStatusCode":{ + "type":"string", + "enum":[ + "OK", + "INACTIVE", + "COLLECTING_DATA", + "INSUFFICIENT_DATA", + "FAULT_SERVICE", + "FAULT_ACCESS_CLOUDWATCH" + ] + }, + "Network":{ + "type":"structure", + "required":[ + "ASName", + "ASNumber" + ], + "members":{ + "ASName":{ + "shape":"String", + "documentation":"The name of the internet service provider (ISP) or network (ASN).
" + }, + "ASNumber":{ + "shape":"Long", + "documentation":"The Autonomous System Number (ASN) of the internet provider or network.
" + } + }, + "documentation":"An internet service provider (ISP) or network (ASN) in Amazon CloudWatch Internet Monitor.
" + }, + "NetworkImpairment":{ + "type":"structure", + "required":[ + "Networks", + "AsPath", + "NetworkEventType" + ], + "members":{ + "Networks":{ + "shape":"NetworkList", + "documentation":"The networks that could be impacted by a network impairment event.
" + }, + "AsPath":{ + "shape":"NetworkList", + "documentation":"The combination of the Autonomous System Number (ASN) of the network and the name of the network.
" + }, + "NetworkEventType":{ + "shape":"TriangulationEventType", + "documentation":"The type of network impairment.
" + } + }, + "documentation":"Information about the network impairment for a specific network measured by Amazon CloudWatch Internet Monitor.
" + }, + "NetworkList":{ + "type":"list", + "member":{"shape":"Network"} + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request specifies something that doesn't exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "Operator":{ + "type":"string", + "enum":[ + "EQUALS", + "NOT_EQUALS" + ] + }, + "Percentage":{ + "type":"double", + "max":100, + "min":0 + }, + "PerformanceMeasurement":{ + "type":"structure", + "members":{ + "ExperienceScore":{ + "shape":"Double", + "documentation":"Experience scores, or health scores, are calculated for different geographic and network provider combinations (that is, different granularities) and also totaled into global scores. If you view performance or availability scores without filtering for any specific geography or service provider, Amazon CloudWatch Internet Monitor provides global health scores.
The Amazon CloudWatch Internet Monitor chapter in the CloudWatch User Guide includes detailed information about how Internet Monitor calculates health scores, including performance and availability scores, and when it creates and resolves health events. For more information, see How Amazon Web Services calculates performance and availability scores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + }, + "PercentOfTotalTrafficImpacted":{ + "shape":"Double", + "documentation":"The impact on total traffic that a health event has, in increased latency or reduced availability. This is the percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this client location to the Amazon Web Services location using this client network.
For more information, see When Amazon Web Services creates and resolves health events in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + }, + "PercentOfClientLocationImpacted":{ + "shape":"Double", + "documentation":"How much performance impact was caused by a health event at a client location. For performance, this is the percentage of how much latency increased during the event compared to typical performance for traffic, from this client location to an Amazon Web Services location, using a specific client network.
For more information, see When Amazon Web Services creates and resolves health events in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + }, + "RoundTripTime":{ + "shape":"RoundTripTime", + "documentation":"This is the percentage of how much round-trip time increased during the event compared to typical round-trip time for your application for traffic.
For more information, see When Amazon Web Services creates and resolves health events in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + } + }, + "documentation":"Amazon CloudWatch Internet Monitor calculates measurements about the performance for your application's internet traffic between client locations and Amazon Web Services. Amazon Web Services has substantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it easier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.
Performance in Internet Monitor represents the estimated percentage of traffic that is not seeing a performance drop. For example, a performance score of 99% for an end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.
For more information, see How Internet Monitor calculates performance and availability scores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + }, + "QueryData":{ + "type":"list", + "member":{"shape":"QueryRow"} + }, + "QueryField":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of a field to query your application's Amazon CloudWatch Internet Monitor data for, such as availability_score.
The data type for a query field, which must correspond to the field you're defining for QueryField. For example, if the query field name is availability_score, the data type is float.
Defines a field to query for your application's Amazon CloudWatch Internet Monitor data. You create a data repository by running a query of a specific type. Each QueryType includes a specific set of fields and datatypes to retrieve data for.
The request specifies a resource that doesn't exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "RoundTripTime":{ + "type":"structure", + "members":{ + "P50":{ + "shape":"Double", + "documentation":"RTT at the 50th percentile (p50).
" + }, + "P90":{ + "shape":"Double", + "documentation":"RTT at the 90th percentile (p90).
" + }, + "P95":{ + "shape":"Double", + "documentation":"RTT at the 95th percentile (p95).
" + } + }, + "documentation":"Round-trip time (RTT) is how long it takes for a request from the user to return a response to the user. Amazon CloudWatch Internet Monitor calculates RTT at different percentiles: p50, p90, and p95.
" + }, + "S3Config":{ + "type":"structure", + "members":{ + "BucketName":{ + "shape":"S3ConfigBucketNameString", + "documentation":"The Amazon S3 bucket name.
" + }, + "BucketPrefix":{ + "shape":"String", + "documentation":"The Amazon S3 bucket prefix.
" + }, + "LogDeliveryStatus":{ + "shape":"LogDeliveryStatus", + "documentation":"The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.
" + } + }, + "documentation":"The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is ENABLED or DISABLED, depending on whether you choose to deliver internet measurements to S3 logs.
The name of the monitor to query.
", + "location":"uri", + "locationName":"MonitorName" + }, + "StartTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The timestamp that is the beginning of the period that you want to retrieve data for with your query.
" + }, + "EndTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The timestamp that is the end of the period that you want to retrieve data for with your query.
" + }, + "QueryType":{ + "shape":"QueryType", + "documentation":"The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:
MEASUREMENTS: Provides availability score, performance score, total traffic, and round-trip times, at 5 minute intervals.
TOP_LOCATIONS: Provides availability score, performance score, total traffic, and time to first byte (TTFB) information, for the top location and ASN combinations that you're monitoring, by traffic volume.
TOP_LOCATION_DETAILS: Provides TTFB for Amazon CloudFront, your current configuration, and the best performing EC2 configuration, at 1 hour intervals.
OVERALL_TRAFFIC_SUGGESTIONS: Provides TTFB, using a 30-day weighted average, for all traffic in each Amazon Web Services location that is monitored.
OVERALL_TRAFFIC_SUGGESTIONS_DETAILS: Provides TTFB, using a 30-day weighted average, for each top location, for a proposed Amazon Web Services location. Must provide a Amazon Web Services location to search.
For lists of the fields returned with each query type and more information about how each type of query is performed, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
" + }, + "FilterParameters":{ + "shape":"FilterParameters", + "documentation":"The FilterParameters field that you use with Amazon CloudWatch Internet Monitor queries is a string the defines how you want a query to be filtered. The filter parameters that you can specify depend on the query type, since each query type returns a different set of Internet Monitor data.
For more information about specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
" + }, + "LinkedAccountId":{ + "shape":"AccountId", + "documentation":"The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.
" + } + } + }, + "StartQueryOutput":{ + "type":"structure", + "required":["QueryId"], + "members":{ + "QueryId":{ + "shape":"String", + "documentation":"The internally-generated identifier of a specific query.
" + } + } + }, + "StopQueryInput":{ + "type":"structure", + "required":[ + "MonitorName", + "QueryId" + ], + "members":{ + "MonitorName":{ + "shape":"ResourceName", + "documentation":"The name of the monitor.
", + "location":"uri", + "locationName":"MonitorName" + }, + "QueryId":{ + "shape":"String", + "documentation":"The ID of the query that you want to stop. A QueryId is an internally-generated identifier for a specific query.
The Amazon Resource Name (ARN) for a tag that you add to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.
", + "location":"uri", + "locationName":"ResourceArn" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"Tags that you add to a resource. You can add a maximum of 50 tags in Internet Monitor.
" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":true} + }, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"There were too many requests.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":true} + }, + "TrafficPercentageToMonitor":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "TriangulationEventType":{ + "type":"string", + "enum":[ + "AWS", + "Internet" + ] + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"MonitorArn", + "documentation":"The Amazon Resource Name (ARN) for a tag you remove a resource from.
", + "location":"uri", + "locationName":"ResourceArn" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"Tag keys that you remove from a resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateMonitorInput":{ + "type":"structure", + "required":["MonitorName"], + "members":{ + "MonitorName":{ + "shape":"ResourceName", + "documentation":"The name of the monitor.
", + "location":"uri", + "locationName":"MonitorName" + }, + "ResourcesToAdd":{ + "shape":"SetOfARNs", + "documentation":"The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories.
You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources.
If you add only Amazon Virtual Private Clouds resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.
The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
" + }, + "Status":{ + "shape":"MonitorConfigState", + "documentation":"The status for a monitor. The accepted values for Status with the UpdateMonitor API call are the following: ACTIVE and INACTIVE. The following values are not accepted: PENDING, and ERROR.
A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. You should not reuse the same client token for other API requests.
", + "idempotencyToken":true + }, + "MaxCityNetworksToMonitor":{ + "shape":"MaxCityNetworksToMonitor", + "documentation":"The maximum number of city-networks to monitor for your application. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. Setting this limit can help control billing costs.
" + }, + "InternetMeasurementsLogDelivery":{ + "shape":"InternetMeasurementsLogDelivery", + "documentation":"Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.
" + }, + "TrafficPercentageToMonitor":{ + "shape":"TrafficPercentageToMonitor", + "documentation":"The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.
To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + }, + "HealthEventsConfig":{ + "shape":"HealthEventsConfig", + "documentation":"The list of health score thresholds. A threshold percentage for health scores, along with other configuration information, determines when Internet Monitor creates a health event when there's an internet issue that affects your application end users.
For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.
" + } + } + }, + "UpdateMonitorOutput":{ + "type":"structure", + "required":[ + "MonitorArn", + "Status" + ], + "members":{ + "MonitorArn":{ + "shape":"MonitorArn", + "documentation":"The Amazon Resource Name (ARN) of the monitor.
" + }, + "Status":{ + "shape":"MonitorConfigState", + "documentation":"The status of a monitor.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Invalid request.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + }, + "documentation":"Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability between your applications hosted on Amazon Web Services and your end users. It can reduce the time it takes for you to diagnose internet issues from days to minutes. Internet Monitor uses the connectivity data that Amazon Web Services captures from its global networking footprint to calculate a baseline of performance and availability for internet traffic. This is the same data that Amazon Web Services uses to monitor internet uptime and availability. With those measurements as a baseline, Internet Monitor raises awareness for you when there are significant problems for your end users in the different geographic locations where your application runs.
Internet Monitor publishes internet measurements to CloudWatch Logs and CloudWatch Metrics, to easily support using CloudWatch tools with health information for geographies and networks specific to your application. Internet Monitor sends health events to Amazon EventBridge so that you can set up notifications. If an issue is caused by the Amazon Web Services network, you also automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem.
To use Internet Monitor, you create a monitor and associate your application's resources with it - VPCs, NLBs, CloudFront distributions, or WorkSpaces directories - so Internet Monitor can determine where your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to the locations and ASNs (typically, internet service providers or ISPs) that communicate with your application.
For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.
" +} diff --git a/testbed/boto__botocore/botocore/data/internetmonitor/2021-06-03/waiters-2.json b/testbed/boto__botocore/botocore/data/internetmonitor/2021-06-03/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..13f60ee66be6a3d75208653e2bd7b563561adacc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/internetmonitor/2021-06-03/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/testbed/boto__botocore/botocore/data/iotfleetwise/2021-06-17/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/iotfleetwise/2021-06-17/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..c3642aa04450440cf42d516a5adb0a8a8dd75029 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/iotfleetwise/2021-06-17/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://iotfleetwise-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://iotfleetwise-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://iotfleetwise.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://iotfleetwise.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/iotfleetwise/2021-06-17/paginators-1.json b/testbed/boto__botocore/botocore/data/iotfleetwise/2021-06-17/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..ff157ff1753a09a1c15d5ab40ad700ead529e825 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/iotfleetwise/2021-06-17/paginators-1.json @@ -0,0 +1,82 @@ +{ + "pagination": { + "GetVehicleStatus": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "campaigns" + }, + "ListCampaigns": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "campaignSummaries" + }, + "ListDecoderManifestNetworkInterfaces": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "networkInterfaces" + }, + "ListDecoderManifestSignals": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "signalDecoders" + }, + "ListDecoderManifests": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "summaries" + }, + "ListFleets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "fleetSummaries" + }, + "ListFleetsForVehicle": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "fleets" + }, + "ListModelManifestNodes": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "nodes" + }, + "ListModelManifests": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "summaries" + }, + "ListSignalCatalogNodes": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "nodes" + }, + "ListSignalCatalogs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "summaries" + }, + "ListVehicles": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "vehicleSummaries" + }, + "ListVehiclesInFleet": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "vehicles" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/iotfleetwise/2021-06-17/service-2.json b/testbed/boto__botocore/botocore/data/iotfleetwise/2021-06-17/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..655b9f2727037c84680d2927a5918575bbbac6c2 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/iotfleetwise/2021-06-17/service-2.json @@ -0,0 +1,5088 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-06-17", + "endpointPrefix":"iotfleetwise", + "jsonVersion":"1.0", + "protocol":"json", + "serviceFullName":"AWS IoT FleetWise", + "serviceId":"IoTFleetWise", + "signatureVersion":"v4", + "signingName":"iotfleetwise", + "targetPrefix":"IoTAutobahnControlPlane", + "uid":"iotfleetwise-2021-06-17" + }, + "operations":{ + "AssociateVehicleFleet":{ + "name":"AssociateVehicleFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateVehicleFleetRequest"}, + "output":{"shape":"AssociateVehicleFleetResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Adds, or associates, a vehicle with a fleet.
" + }, + "BatchCreateVehicle":{ + "name":"BatchCreateVehicle", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchCreateVehicleRequest"}, + "output":{"shape":"BatchCreateVehicleResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a group, or batch, of vehicles.
You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle.
For more information, see Create multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
" + }, + "BatchUpdateVehicle":{ + "name":"BatchUpdateVehicle", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchUpdateVehicleRequest"}, + "output":{"shape":"BatchUpdateVehicleResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates a group, or batch, of vehicles.
You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle.
For more information, see Update multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
" + }, + "CreateCampaign":{ + "name":"CreateCampaign", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCampaignRequest"}, + "output":{"shape":"CreateCampaignResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, Amazon Web Services IoT FleetWise automatically deploys them to vehicles.
For more information, see Collect and transfer data with campaigns in the Amazon Web Services IoT FleetWise Developer Guide.
", + "idempotent":true + }, + "CreateDecoderManifest":{ + "name":"CreateDecoderManifest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDecoderManifestRequest"}, + "output":{"shape":"CreateDecoderManifestResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"DecoderManifestValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true:
Every signal decoder has a unique name.
Each signal decoder is associated with a network interface.
Each network interface has a unique ID.
The signal decoders are specified in the model manifest.
Creates a fleet that represents a group of vehicles.
You must create both a signal catalog and vehicles before you can create a fleet.
For more information, see Fleets in the Amazon Web Services IoT FleetWise Developer Guide.
", + "idempotent":true + }, + "CreateModelManifest":{ + "name":"CreateModelManifest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateModelManifestRequest"}, + "output":{"shape":"CreateModelManifestResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"InvalidSignalsException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators).
For more information, see Vehicle models in the Amazon Web Services IoT FleetWise Developer Guide.
", + "idempotent":true + }, + "CreateSignalCatalog":{ + "name":"CreateSignalCatalog", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSignalCatalogRequest"}, + "output":{"shape":"CreateSignalCatalogResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidNodeException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"InvalidSignalsException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a collection of standardized signals that can be reused to create vehicle models.
", + "idempotent":true + }, + "CreateVehicle":{ + "name":"CreateVehicle", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVehicleRequest"}, + "output":{"shape":"CreateVehicleResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.
If you have an existing Amazon Web Services IoT thing, you can use Amazon Web Services IoT FleetWise to create a vehicle and collect data from your thing.
For more information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
", + "idempotent":true + }, + "DeleteCampaign":{ + "name":"DeleteCampaign", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCampaignRequest"}, + "output":{"shape":"DeleteCampaignResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.
", + "idempotent":true + }, + "DeleteDecoderManifest":{ + "name":"DeleteDecoderManifest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDecoderManifestRequest"}, + "output":{"shape":"DeleteDecoderManifestResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it.
If the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
Deletes a fleet. Before you delete a fleet, all vehicles must be dissociated from the fleet. For more information, see Delete a fleet (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
If the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
Deletes a vehicle model (model manifest).
If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
Deletes a signal catalog.
If the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
Deletes a vehicle and removes it from any campaigns.
If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle.
If the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
Retrieves information about a campaign.
" + }, + "GetDecoderManifest":{ + "name":"GetDecoderManifest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDecoderManifestRequest"}, + "output":{"shape":"GetDecoderManifestResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves information about a created decoder manifest.
" + }, + "GetEncryptionConfiguration":{ + "name":"GetEncryptionConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetEncryptionConfigurationRequest"}, + "output":{"shape":"GetEncryptionConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.
" + }, + "GetFleet":{ + "name":"GetFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetFleetRequest"}, + "output":{"shape":"GetFleetResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves information about a fleet.
" + }, + "GetLoggingOptions":{ + "name":"GetLoggingOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLoggingOptionsRequest"}, + "output":{"shape":"GetLoggingOptionsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves the logging options.
" + }, + "GetModelManifest":{ + "name":"GetModelManifest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetModelManifestRequest"}, + "output":{"shape":"GetModelManifestResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves information about a vehicle model (model manifest).
" + }, + "GetRegisterAccountStatus":{ + "name":"GetRegisterAccountStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRegisterAccountStatusRequest"}, + "output":{"shape":"GetRegisterAccountStatusResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves information about the status of registering your Amazon Web Services account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud.
For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise.
This API operation doesn't require input parameters.
Retrieves information about a signal catalog.
" + }, + "GetVehicle":{ + "name":"GetVehicle", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetVehicleRequest"}, + "output":{"shape":"GetVehicleResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves information about a vehicle.
" + }, + "GetVehicleStatus":{ + "name":"GetVehicleStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetVehicleStatusRequest"}, + "output":{"shape":"GetVehicleStatusResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves information about the status of a vehicle with any associated campaigns.
" + }, + "ImportDecoderManifest":{ + "name":"ImportDecoderManifest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportDecoderManifestRequest"}, + "output":{"shape":"ImportDecoderManifestResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"DecoderManifestValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"InvalidSignalsException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a decoder manifest using your existing CAN DBC file from your local device.
" + }, + "ImportSignalCatalog":{ + "name":"ImportSignalCatalog", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportSignalCatalogRequest"}, + "output":{"shape":"ImportSignalCatalogResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"InvalidSignalsException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a signal catalog using your existing VSS formatted content from your local device.
", + "idempotent":true + }, + "ListCampaigns":{ + "name":"ListCampaigns", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCampaignsRequest"}, + "output":{"shape":"ListCampaignsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists information about created campaigns.
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
Lists the network interfaces specified in a decoder manifest.
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
A list of information about signal decoders specified in a decoder manifest.
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
Lists decoder manifests.
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
Retrieves information for each created fleet in an Amazon Web Services account.
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
Retrieves a list of IDs for all fleets that the vehicle is associated with.
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
Lists information about nodes specified in a vehicle model (model manifest).
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
Retrieves a list of vehicle models (model manifests).
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
Lists of information about the signals (nodes) specified in a signal catalog.
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
Lists all the created signal catalogs in an Amazon Web Services account.
You can use to list information about each signal (node) specified in a signal catalog.
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
Lists the tags (metadata) you have assigned to the resource.
" + }, + "ListVehicles":{ + "name":"ListVehicles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListVehiclesRequest"}, + "output":{"shape":"ListVehiclesResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of summaries of created vehicles.
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
Retrieves a list of summaries of all vehicles associated with a fleet.
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and manage. For more information, see Data encryption in the Amazon Web Services IoT FleetWise Developer Guide.
" + }, + "PutLoggingOptions":{ + "name":"PutLoggingOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutLoggingOptionsRequest"}, + "output":{"shape":"PutLoggingOptionsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates or updates the logging option.
", + "idempotent":true + }, + "RegisterAccount":{ + "name":"RegisterAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterAccountRequest"}, + "output":{"shape":"RegisterAccountResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"This API operation contains deprecated parameters. Register your account again without the Timestream resources parameter so that Amazon Web Services IoT FleetWise can remove the Timestream metadata stored. You should then pass the data destination into the CreateCampaign API operation.
You must delete any existing campaigns that include an empty data destination before you register your account again. For more information, see the DeleteCampaign API operation.
If you want to delete the Timestream inline policy from the service-linked role, such as to mitigate an overly permissive policy, you must first delete any existing campaigns. Then delete the service-linked role and register your account again to enable CloudWatch metrics. For more information, see DeleteServiceLinkedRole in the Identity and Access Management API Reference.
Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise.
An Amazon Web Services account is not the same thing as a \"user.\" An Amazon Web Services user is an identity that you create using Identity and Access Management (IAM) and takes the form of either an IAM user or an IAM role, both with credentials. A single Amazon Web Services account can, and typically does, contain many users and roles.
Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Removes the given tags (metadata) from the resource.
", + "idempotent":true + }, + "UpdateCampaign":{ + "name":"UpdateCampaign", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateCampaignRequest"}, + "output":{"shape":"UpdateCampaignResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates a campaign.
" + }, + "UpdateDecoderManifest":{ + "name":"UpdateDecoderManifest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDecoderManifestRequest"}, + "output":{"shape":"UpdateDecoderManifestResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"DecoderManifestValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates a decoder manifest.
A decoder manifest can only be updated when the status is DRAFT. Only ACTIVE decoder manifests can be associated with vehicles.
Updates the description of an existing fleet.
If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty HTTP body.
Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated.
", + "idempotent":true + }, + "UpdateSignalCatalog":{ + "name":"UpdateSignalCatalog", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSignalCatalogRequest"}, + "output":{"shape":"UpdateSignalCatalogResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidNodeException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"InvalidSignalsException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates a signal catalog.
", + "idempotent":true + }, + "UpdateVehicle":{ + "name":"UpdateVehicle", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateVehicleRequest"}, + "output":{"shape":"UpdateVehicleResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates a vehicle.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"string"} + }, + "documentation":"You don't have sufficient permission to perform this action.
", + "exception":true + }, + "Actuator":{ + "type":"structure", + "required":[ + "fullyQualifiedName", + "dataType" + ], + "members":{ + "fullyQualifiedName":{ + "shape":"string", + "documentation":"The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.
The specified data type of the actuator.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the actuator.
" + }, + "unit":{ + "shape":"string", + "documentation":"The scientific unit for the actuator.
" + }, + "allowedValues":{ + "shape":"listOfStrings", + "documentation":"A list of possible values an actuator can take.
" + }, + "min":{ + "shape":"double", + "documentation":"The specified possible minimum value of an actuator.
" + }, + "max":{ + "shape":"double", + "documentation":"The specified possible maximum value of an actuator.
" + }, + "assignedValue":{ + "shape":"string", + "documentation":"A specified value for the actuator.
", + "deprecated":true, + "deprecatedMessage":"assignedValue is no longer in use" + }, + "deprecationMessage":{ + "shape":"message", + "documentation":"The deprecation message for the node or the branch that was moved or deleted.
" + }, + "comment":{ + "shape":"message", + "documentation":"A comment in addition to the description.
" + }, + "structFullyQualifiedName":{ + "shape":"NodePath", + "documentation":"The fully qualified name of the struct node for the actuator if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of an actuator might be Vehicle.Door.LockStruct.
A signal that represents a vehicle device such as the engine, heater, and door locks. Data from an actuator reports the state of a certain vehicle device.
Updating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data.
The unique ID of the vehicle to associate with the fleet.
" + }, + "fleetId":{ + "shape":"fleetId", + "documentation":"The ID of a fleet.
" + } + } + }, + "AssociateVehicleFleetResponse":{ + "type":"structure", + "members":{ + } + }, + "Attribute":{ + "type":"structure", + "required":[ + "fullyQualifiedName", + "dataType" + ], + "members":{ + "fullyQualifiedName":{ + "shape":"string", + "documentation":"The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type.
The specified data type of the attribute.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the attribute.
" + }, + "unit":{ + "shape":"string", + "documentation":"The scientific unit for the attribute.
" + }, + "allowedValues":{ + "shape":"listOfStrings", + "documentation":"A list of possible values an attribute can be assigned.
" + }, + "min":{ + "shape":"double", + "documentation":"The specified possible minimum value of the attribute.
" + }, + "max":{ + "shape":"double", + "documentation":"The specified possible maximum value of the attribute.
" + }, + "assignedValue":{ + "shape":"string", + "documentation":"A specified value for the attribute.
", + "deprecated":true, + "deprecatedMessage":"assignedValue is no longer in use" + }, + "defaultValue":{ + "shape":"string", + "documentation":"The default value of the attribute.
" + }, + "deprecationMessage":{ + "shape":"message", + "documentation":"The deprecation message for the node or the branch that was moved or deleted.
" + }, + "comment":{ + "shape":"message", + "documentation":"A comment in addition to the description.
" + } + }, + "documentation":"A signal that represents static information about the vehicle, such as engine type or manufacturing date.
" + }, + "BatchCreateVehicleRequest":{ + "type":"structure", + "required":["vehicles"], + "members":{ + "vehicles":{ + "shape":"createVehicleRequestItems", + "documentation":"A list of information about each vehicle to create. For more information, see the API data type.
" + } + } + }, + "BatchCreateVehicleResponse":{ + "type":"structure", + "members":{ + "vehicles":{ + "shape":"createVehicleResponses", + "documentation":"A list of information about a batch of created vehicles. For more information, see the API data type.
" + }, + "errors":{ + "shape":"createVehicleErrors", + "documentation":"A list of information about creation errors, or an empty list if there aren't any errors.
" + } + } + }, + "BatchUpdateVehicleRequest":{ + "type":"structure", + "required":["vehicles"], + "members":{ + "vehicles":{ + "shape":"updateVehicleRequestItems", + "documentation":"A list of information about the vehicles to update. For more information, see the API data type.
" + } + } + }, + "BatchUpdateVehicleResponse":{ + "type":"structure", + "members":{ + "vehicles":{ + "shape":"updateVehicleResponseItems", + "documentation":"A list of information about the batch of updated vehicles.
This list contains only unique IDs for the vehicles that were updated.
A list of information about errors returned while updating a batch of vehicles, or, if there aren't any errors, an empty list.
" + } + } + }, + "Branch":{ + "type":"structure", + "required":["fullyQualifiedName"], + "members":{ + "fullyQualifiedName":{ + "shape":"string", + "documentation":"The fully qualified name of the branch. For example, the fully qualified name of a branch might be Vehicle.Body.Engine.
A brief description of the branch.
" + }, + "deprecationMessage":{ + "shape":"message", + "documentation":"The deprecation message for the node or the branch that was moved or deleted.
" + }, + "comment":{ + "shape":"message", + "documentation":"A comment in addition to the description.
" + } + }, + "documentation":"A group of signals that are defined in a hierarchical structure.
" + }, + "CampaignStatus":{ + "type":"string", + "enum":[ + "CREATING", + "WAITING_FOR_APPROVAL", + "RUNNING", + "SUSPENDED" + ] + }, + "CampaignSummary":{ + "type":"structure", + "required":[ + "creationTime", + "lastModificationTime" + ], + "members":{ + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of a campaign.
" + }, + "name":{ + "shape":"campaignName", + "documentation":"The name of a campaign.
" + }, + "description":{ + "shape":"description", + "documentation":"The description of the campaign.
" + }, + "signalCatalogArn":{ + "shape":"arn", + "documentation":"The ARN of the signal catalog associated with the campaign.
" + }, + "targetArn":{ + "shape":"arn", + "documentation":"The ARN of a vehicle or fleet to which the campaign is deployed.
" + }, + "status":{ + "shape":"CampaignStatus", + "documentation":"The state of a campaign. The status can be one of the following:
CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.
WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.
RUNNING - The campaign is active.
SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.
The time the campaign was created.
" + }, + "lastModificationTime":{ + "shape":"timestamp", + "documentation":"The last time the campaign was modified.
" + } + }, + "documentation":"Information about a campaign.
You can use the API operation to return this information about multiple created campaigns.
" + }, + "CanDbcDefinition":{ + "type":"structure", + "required":[ + "networkInterface", + "canDbcFiles" + ], + "members":{ + "networkInterface":{ + "shape":"InterfaceId", + "documentation":"Contains information about a network interface.
" + }, + "canDbcFiles":{ + "shape":"NetworkFilesList", + "documentation":"A list of DBC files. You can upload only one DBC file for each network interface and specify up to five (inclusive) files in the list. The DBC file can be a maximum size of 200 MB.
" + }, + "signalsMap":{ + "shape":"ModelSignalsMap", + "documentation":"Pairs every signal specified in your vehicle model with a signal decoder.
" + } + }, + "documentation":"Configurations used to create a decoder manifest.
" + }, + "CanInterface":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"CanInterfaceName", + "documentation":"The unique name of the interface.
" + }, + "protocolName":{ + "shape":"ProtocolName", + "documentation":"The name of the communication protocol for the interface.
" + }, + "protocolVersion":{ + "shape":"ProtocolVersion", + "documentation":"The version of the communication protocol for the interface.
" + } + }, + "documentation":"A single controller area network (CAN) device interface.
" + }, + "CanInterfaceName":{ + "type":"string", + "max":100, + "min":1 + }, + "CanSignal":{ + "type":"structure", + "required":[ + "messageId", + "isBigEndian", + "isSigned", + "startBit", + "offset", + "factor", + "length" + ], + "members":{ + "messageId":{ + "shape":"nonNegativeInteger", + "documentation":"The ID of the message.
" + }, + "isBigEndian":{ + "shape":"PrimitiveBoolean", + "documentation":"Whether the byte ordering of a CAN message is big-endian.
" + }, + "isSigned":{ + "shape":"PrimitiveBoolean", + "documentation":"Whether the message data is specified as a signed value.
" + }, + "startBit":{ + "shape":"nonNegativeInteger", + "documentation":"Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).
This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.
The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset.
A multiplier used to decode the CAN message.
" + }, + "length":{ + "shape":"nonNegativeInteger", + "documentation":"How many bytes of data are in the message.
" + }, + "name":{ + "shape":"CanSignalName", + "documentation":"The name of the signal.
" + } + }, + "documentation":"Information about a single controller area network (CAN) signal and the messages it receives and transmits.
" + }, + "CanSignalName":{ + "type":"string", + "max":100, + "min":1 + }, + "CloudWatchLogDeliveryOptions":{ + "type":"structure", + "required":["logType"], + "members":{ + "logType":{ + "shape":"LogType", + "documentation":"The type of log to send data to Amazon CloudWatch Logs.
" + }, + "logGroupName":{ + "shape":"CloudWatchLogGroupName", + "documentation":"The Amazon CloudWatch Logs group the operation sends data to.
" + } + }, + "documentation":"The log delivery option to send data to Amazon CloudWatch Logs.
" + }, + "CloudWatchLogGroupName":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[\\.\\-_\\/#A-Za-z0-9]+" + }, + "CollectionScheme":{ + "type":"structure", + "members":{ + "timeBasedCollectionScheme":{ + "shape":"TimeBasedCollectionScheme", + "documentation":"Information about a collection scheme that uses a time period to decide how often to collect data.
" + }, + "conditionBasedCollectionScheme":{ + "shape":"ConditionBasedCollectionScheme", + "documentation":"Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
" + } + }, + "documentation":"Specifies what data to collect and how often or when to collect it.
", + "union":true + }, + "Compression":{ + "type":"string", + "enum":[ + "OFF", + "SNAPPY" + ] + }, + "ConditionBasedCollectionScheme":{ + "type":"structure", + "required":["expression"], + "members":{ + "expression":{ + "shape":"eventExpression", + "documentation":"The logical expression used to recognize what data to collect. For example, $variable.`Vehicle.OutsideAirTemperature` >= 105.0.
The minimum duration of time between two triggering events to collect data, in milliseconds.
If a signal changes often, you might want to collect data at a slower rate.
Whether to collect data for all triggering events (ALWAYS). Specify (RISING_EDGE), or specify only when the condition first evaluates to false. For example, triggering on \"AirbagDeployed\"; Users aren't interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.
Specifies the version of the conditional expression language.
" + } + }, + "documentation":"Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
" + }, + "ConflictException":{ + "type":"structure", + "required":[ + "message", + "resource", + "resourceType" + ], + "members":{ + "message":{"shape":"string"}, + "resource":{ + "shape":"string", + "documentation":"The resource on which there are conflicting operations.
" + }, + "resourceType":{ + "shape":"string", + "documentation":"The type of resource on which there are conflicting operations..
" + } + }, + "documentation":"The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
", + "exception":true + }, + "CreateCampaignRequest":{ + "type":"structure", + "required":[ + "name", + "signalCatalogArn", + "targetArn", + "collectionScheme" + ], + "members":{ + "name":{ + "shape":"campaignName", + "documentation":"The name of the campaign to create.
" + }, + "description":{ + "shape":"description", + "documentation":"An optional description of the campaign to help identify its purpose.
" + }, + "signalCatalogArn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
" + }, + "targetArn":{ + "shape":"arn", + "documentation":"The ARN of the vehicle or fleet to deploy a campaign to.
" + }, + "startTime":{ + "shape":"timestamp", + "documentation":"(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.
Default: 0
(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires.
Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
" + }, + "postTriggerCollectionDuration":{ + "shape":"uint32", + "documentation":" (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0 is used.
Default: 0
(Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS. If it's not specified, OFF is used.
Default: OFF
(Optional) Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK. If it's not specified, OFF is used.
Default: OFF
(Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF. If it's not specified, SNAPPY is used.
Default: SNAPPY
(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0 is used.
Default: 0
(Optional) A list of information about signals to collect.
" + }, + "collectionScheme":{ + "shape":"CollectionScheme", + "documentation":"The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.
" + }, + "dataExtraDimensions":{ + "shape":"DataExtraDimensionNodePathList", + "documentation":"(Optional) A list of vehicle attributes to associate with a campaign.
Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make and model.
Default: An empty array
" + }, + "tags":{ + "shape":"TagList", + "documentation":"Metadata that can be used to manage the campaign.
" + }, + "dataDestinationConfigs":{ + "shape":"DataDestinationConfigs", + "documentation":"The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
" + } + } + }, + "CreateCampaignResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"campaignName", + "documentation":"The name of the created campaign.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The ARN of the created campaign.
" + } + } + }, + "CreateDecoderManifestRequest":{ + "type":"structure", + "required":[ + "name", + "modelManifestArn" + ], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The unique name of the decoder manifest to create.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the decoder manifest.
" + }, + "modelManifestArn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the vehicle model (model manifest).
" + }, + "signalDecoders":{ + "shape":"SignalDecoders", + "documentation":"A list of information about signal decoders.
" + }, + "networkInterfaces":{ + "shape":"NetworkInterfaces", + "documentation":"A list of information about available network interfaces.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"Metadata that can be used to manage the decoder manifest.
" + } + } + }, + "CreateDecoderManifestResponse":{ + "type":"structure", + "required":[ + "name", + "arn" + ], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the created decoder manifest.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The ARN of the created decoder manifest.
" + } + } + }, + "CreateFleetRequest":{ + "type":"structure", + "required":[ + "fleetId", + "signalCatalogArn" + ], + "members":{ + "fleetId":{ + "shape":"fleetId", + "documentation":"The unique ID of the fleet to create.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the fleet to create.
" + }, + "signalCatalogArn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of a signal catalog.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"Metadata that can be used to manage the fleet.
" + } + } + }, + "CreateFleetResponse":{ + "type":"structure", + "required":[ + "id", + "arn" + ], + "members":{ + "id":{ + "shape":"fleetId", + "documentation":"The ID of the created fleet.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The ARN of the created fleet.
" + } + } + }, + "CreateModelManifestRequest":{ + "type":"structure", + "required":[ + "name", + "nodes", + "signalCatalogArn" + ], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the vehicle model to create.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the vehicle model.
" + }, + "nodes":{ + "shape":"listOfStrings", + "documentation":"A list of nodes, which are a general abstraction of signals.
" + }, + "signalCatalogArn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of a signal catalog.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"Metadata that can be used to manage the vehicle model.
" + } + } + }, + "CreateModelManifestResponse":{ + "type":"structure", + "required":[ + "name", + "arn" + ], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the created vehicle model.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The ARN of the created vehicle model.
" + } + } + }, + "CreateSignalCatalogRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the signal catalog to create.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the signal catalog.
" + }, + "nodes":{ + "shape":"Nodes", + "documentation":"A list of information about nodes, which are a general abstraction of signals. For more information, see the API data type.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"Metadata that can be used to manage the signal catalog.
" + } + } + }, + "CreateSignalCatalogResponse":{ + "type":"structure", + "required":[ + "name", + "arn" + ], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the created signal catalog.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The ARN of the created signal catalog.
" + } + } + }, + "CreateVehicleError":{ + "type":"structure", + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The ID of the vehicle with the error.
" + }, + "code":{ + "shape":"string", + "documentation":"An HTTP error code.
" + }, + "message":{ + "shape":"string", + "documentation":"A description of the HTTP error.
" + } + }, + "documentation":"An HTTP error resulting from creating a vehicle.
" + }, + "CreateVehicleRequest":{ + "type":"structure", + "required":[ + "vehicleName", + "modelManifestArn", + "decoderManifestArn" + ], + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The unique ID of the vehicle to create.
" + }, + "modelManifestArn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name ARN of a vehicle model.
" + }, + "decoderManifestArn":{ + "shape":"arn", + "documentation":"The ARN of a decoder manifest.
" + }, + "attributes":{ + "shape":"attributesMap", + "documentation":"Static information about a vehicle in a key-value pair. For example: \"engineType\" : \"1.3 L R2\"
A campaign must include the keys (attribute names) in dataExtraDimensions for them to display in Amazon Timestream.
An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.
Default:
Metadata that can be used to manage the vehicle.
" + } + } + }, + "CreateVehicleRequestItem":{ + "type":"structure", + "required":[ + "vehicleName", + "modelManifestArn", + "decoderManifestArn" + ], + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The unique ID of the vehicle to create.
" + }, + "modelManifestArn":{ + "shape":"arn", + "documentation":"The ARN of the vehicle model (model manifest) to create the vehicle from.
" + }, + "decoderManifestArn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
" + }, + "attributes":{ + "shape":"attributesMap", + "documentation":"Static information about a vehicle in a key-value pair. For example: \"engine Type\" : \"v6\"
An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"Metadata which can be used to manage the vehicle.
" + } + }, + "documentation":"Information about the vehicle to create.
" + }, + "CreateVehicleResponse":{ + "type":"structure", + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The unique ID of the created vehicle.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The ARN of the created vehicle.
" + }, + "thingArn":{ + "shape":"arn", + "documentation":"The ARN of a created or validated Amazon Web Services IoT thing.
" + } + } + }, + "CreateVehicleResponseItem":{ + "type":"structure", + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The unique ID of the vehicle to create.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The ARN of the created vehicle.
" + }, + "thingArn":{ + "shape":"arn", + "documentation":"The ARN of a created or validated Amazon Web Services IoT thing.
" + } + }, + "documentation":"Information about a created vehicle.
" + }, + "CustomProperty":{ + "type":"structure", + "required":[ + "fullyQualifiedName", + "dataType" + ], + "members":{ + "fullyQualifiedName":{ + "shape":"string", + "documentation":"The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS.
The data type for the custom property.
" + }, + "dataEncoding":{ + "shape":"NodeDataEncoding", + "documentation":"Indicates whether the property is binary data.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the custom property.
" + }, + "deprecationMessage":{ + "shape":"message", + "documentation":"The deprecation message for the node or the branch that was moved or deleted.
" + }, + "comment":{ + "shape":"message", + "documentation":"A comment in addition to the description.
" + }, + "structFullyQualifiedName":{ + "shape":"NodePath", + "documentation":"The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray.
Represents a member of the complex data structure. The data type of the property can be either primitive or another struct.
The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be ComplexDataTypes.VehicleDataTypes.SVMCamera.
A brief description of the custom structure.
" + }, + "deprecationMessage":{ + "shape":"message", + "documentation":"The deprecation message for the node or the branch that was moved or deleted.
" + }, + "comment":{ + "shape":"message", + "documentation":"A comment in addition to the description.
" + } + }, + "documentation":"The custom structure represents a complex or higher-order data structure.
" + }, + "DataDestinationConfig":{ + "type":"structure", + "members":{ + "s3Config":{ + "shape":"S3Config", + "documentation":"The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data.
" + }, + "timestreamConfig":{ + "shape":"TimestreamConfig", + "documentation":"The Amazon Timestream table where the campaign sends data.
" + } + }, + "documentation":"The destination where the Amazon Web Services IoT FleetWise campaign sends data. You can send data to be stored in Amazon S3 or Amazon Timestream.
", + "union":true + }, + "DataDestinationConfigs":{ + "type":"list", + "member":{"shape":"DataDestinationConfig"}, + "max":1, + "min":1 + }, + "DataExtraDimensionNodePathList":{ + "type":"list", + "member":{"shape":"NodePath"}, + "max":5, + "min":0 + }, + "DataFormat":{ + "type":"string", + "enum":[ + "JSON", + "PARQUET" + ] + }, + "DecoderManifestSummary":{ + "type":"structure", + "required":[ + "creationTime", + "lastModificationTime" + ], + "members":{ + "name":{ + "shape":"string", + "documentation":"The name of the decoder manifest.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The ARN of a vehicle model (model manifest) associated with the decoder manifest.
" + }, + "modelManifestArn":{ + "shape":"arn", + "documentation":"The ARN of a vehicle model (model manifest) associated with the decoder manifest.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the decoder manifest.
" + }, + "status":{ + "shape":"ManifestStatus", + "documentation":"The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is marked DRAFT, you can edit the decoder manifest.
The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "lastModificationTime":{ + "shape":"timestamp", + "documentation":"The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "message":{ + "shape":"message", + "documentation":"The detailed message for the decoder manifest. When a decoder manifest is in an INVALID status, the message contains detailed reason and help information.
Information about a created decoder manifest. You can use the API operation to return this information about multiple decoder manifests.
" + }, + "DecoderManifestValidationException":{ + "type":"structure", + "members":{ + "invalidSignals":{ + "shape":"InvalidSignalDecoders", + "documentation":"The request couldn't be completed because of invalid signals in the request.
" + }, + "invalidNetworkInterfaces":{ + "shape":"InvalidNetworkInterfaces", + "documentation":"The request couldn't be completed because of invalid network interfaces in the request.
" + }, + "message":{"shape":"string"} + }, + "documentation":"The request couldn't be completed because it contains signal decoders with one or more validation errors.
", + "exception":true + }, + "DeleteCampaignRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"campaignName", + "documentation":"The name of the campaign to delete.
" + } + } + }, + "DeleteCampaignResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"campaignName", + "documentation":"The name of the deleted campaign.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the deleted campaign.
The ARN isn’t returned if a campaign doesn’t exist.
The name of the decoder manifest to delete.
" + } + } + }, + "DeleteDecoderManifestResponse":{ + "type":"structure", + "required":[ + "name", + "arn" + ], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the deleted decoder manifest.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the deleted decoder manifest.
" + } + } + }, + "DeleteFleetRequest":{ + "type":"structure", + "required":["fleetId"], + "members":{ + "fleetId":{ + "shape":"fleetId", + "documentation":"The ID of the fleet to delete.
" + } + } + }, + "DeleteFleetResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"fleetId", + "documentation":"The ID of the deleted fleet.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the deleted fleet.
" + } + } + }, + "DeleteModelManifestRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the model manifest to delete.
" + } + } + }, + "DeleteModelManifestResponse":{ + "type":"structure", + "required":[ + "name", + "arn" + ], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the deleted model manifest.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the deleted model manifest.
" + } + } + }, + "DeleteSignalCatalogRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the signal catalog to delete.
" + } + } + }, + "DeleteSignalCatalogResponse":{ + "type":"structure", + "required":[ + "name", + "arn" + ], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the deleted signal catalog.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the deleted signal catalog.
" + } + } + }, + "DeleteVehicleRequest":{ + "type":"structure", + "required":["vehicleName"], + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The ID of the vehicle to delete.
" + } + } + }, + "DeleteVehicleResponse":{ + "type":"structure", + "required":[ + "vehicleName", + "arn" + ], + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The ID of the deleted vehicle.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the deleted vehicle.
" + } + } + }, + "DiagnosticsMode":{ + "type":"string", + "enum":[ + "OFF", + "SEND_ACTIVE_DTCS" + ] + }, + "DisassociateVehicleFleetRequest":{ + "type":"structure", + "required":[ + "vehicleName", + "fleetId" + ], + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The unique ID of the vehicle to disassociate from the fleet.
" + }, + "fleetId":{ + "shape":"fleetId", + "documentation":"The unique ID of a fleet.
" + } + } + }, + "DisassociateVehicleFleetResponse":{ + "type":"structure", + "members":{ + } + }, + "EncryptionStatus":{ + "type":"string", + "enum":[ + "PENDING", + "SUCCESS", + "FAILURE" + ] + }, + "EncryptionType":{ + "type":"string", + "enum":[ + "KMS_BASED_ENCRYPTION", + "FLEETWISE_DEFAULT_ENCRYPTION" + ] + }, + "FleetSummary":{ + "type":"structure", + "required":[ + "id", + "arn", + "signalCatalogArn", + "creationTime" + ], + "members":{ + "id":{ + "shape":"fleetId", + "documentation":"The unique ID of the fleet.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the fleet.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the fleet.
" + }, + "signalCatalogArn":{ + "shape":"arn", + "documentation":"The ARN of the signal catalog associated with the fleet.
" + }, + "creationTime":{ + "shape":"timestamp", + "documentation":"The time the fleet was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "lastModificationTime":{ + "shape":"timestamp", + "documentation":"The time the fleet was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
" + } + }, + "documentation":"Information about a fleet.
You can use the API operation to return this information about multiple fleets.
" + }, + "FormattedVss":{ + "type":"structure", + "members":{ + "vssJson":{ + "shape":"String", + "documentation":"Provides the VSS in JSON format.
" + } + }, + "documentation":"Vehicle Signal Specification (VSS) is a precise language used to describe and model signals in vehicle networks. The JSON file collects signal specificiations in a VSS format.
", + "union":true + }, + "Fqns":{ + "type":"list", + "member":{"shape":"FullyQualifiedName"}, + "max":500, + "min":1 + }, + "FullyQualifiedName":{ + "type":"string", + "max":150, + "min":1 + }, + "GetCampaignRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"campaignName", + "documentation":"The name of the campaign to retrieve information about.
" + } + } + }, + "GetCampaignResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"campaignName", + "documentation":"The name of the campaign.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the campaign.
" + }, + "description":{ + "shape":"description", + "documentation":"The description of the campaign.
" + }, + "signalCatalogArn":{ + "shape":"arn", + "documentation":"The ARN of a signal catalog.
" + }, + "targetArn":{ + "shape":"arn", + "documentation":"The ARN of the vehicle or the fleet targeted by the campaign.
" + }, + "status":{ + "shape":"CampaignStatus", + "documentation":"The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.
The time, in milliseconds, to deliver a campaign after it was approved.
" + }, + "expiryTime":{ + "shape":"timestamp", + "documentation":"The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.
" + }, + "postTriggerCollectionDuration":{ + "shape":"uint32", + "documentation":"How long (in seconds) to collect raw data after a triggering event initiates the collection.
" + }, + "diagnosticsMode":{ + "shape":"DiagnosticsMode", + "documentation":"Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
" + }, + "spoolingMode":{ + "shape":"SpoolingMode", + "documentation":"Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.
" + }, + "compression":{ + "shape":"Compression", + "documentation":" Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.
A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.
" + }, + "signalsToCollect":{ + "shape":"SignalInformationList", + "documentation":"Information about a list of signals to collect data on.
" + }, + "collectionScheme":{ + "shape":"CollectionScheme", + "documentation":"Information about the data collection scheme associated with the campaign.
" + }, + "dataExtraDimensions":{ + "shape":"DataExtraDimensionNodePathList", + "documentation":"A list of vehicle attributes associated with the campaign.
" + }, + "creationTime":{ + "shape":"timestamp", + "documentation":"The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "lastModificationTime":{ + "shape":"timestamp", + "documentation":"The last time the campaign was modified.
" + }, + "dataDestinationConfigs":{ + "shape":"DataDestinationConfigs", + "documentation":"The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
" + } + } + }, + "GetDecoderManifestRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the decoder manifest to retrieve information about.
" + } + } + }, + "GetDecoderManifestResponse":{ + "type":"structure", + "required":[ + "name", + "arn", + "creationTime", + "lastModificationTime" + ], + "members":{ + "name":{ + "shape":"string", + "documentation":"The name of the decoder manifest.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the decoder manifest.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the decoder manifest.
" + }, + "modelManifestArn":{ + "shape":"arn", + "documentation":"The ARN of a vehicle model (model manifest) associated with the decoder manifest.
" + }, + "status":{ + "shape":"ManifestStatus", + "documentation":" The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is marked DRAFT, you can edit the decoder manifest.
The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "lastModificationTime":{ + "shape":"timestamp", + "documentation":"The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "message":{ + "shape":"message", + "documentation":"The detailed message for the decoder manifest. When a decoder manifest is in an INVALID status, the message contains detailed reason and help information.
The ID of the KMS key that is used for encryption.
" + }, + "encryptionStatus":{ + "shape":"EncryptionStatus", + "documentation":"The encryption status.
" + }, + "encryptionType":{ + "shape":"EncryptionType", + "documentation":"The type of encryption. Set to KMS_BASED_ENCRYPTION to use a KMS key that you own and manage. Set to FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account.
The error message that describes why encryption settings couldn't be configured, if applicable.
" + }, + "creationTime":{ + "shape":"timestamp", + "documentation":"The time when encryption was configured in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "lastModificationTime":{ + "shape":"timestamp", + "documentation":"The time when encryption was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
" + } + } + }, + "GetFleetRequest":{ + "type":"structure", + "required":["fleetId"], + "members":{ + "fleetId":{ + "shape":"fleetId", + "documentation":"The ID of the fleet to retrieve information about.
" + } + } + }, + "GetFleetResponse":{ + "type":"structure", + "required":[ + "id", + "arn", + "signalCatalogArn", + "creationTime", + "lastModificationTime" + ], + "members":{ + "id":{ + "shape":"fleetId", + "documentation":"The ID of the fleet.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the fleet.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the fleet.
" + }, + "signalCatalogArn":{ + "shape":"arn", + "documentation":"The ARN of a signal catalog associated with the fleet.
" + }, + "creationTime":{ + "shape":"timestamp", + "documentation":"The time the fleet was created in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "lastModificationTime":{ + "shape":"timestamp", + "documentation":"The time the fleet was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
" + } + } + }, + "GetLoggingOptionsRequest":{ + "type":"structure", + "members":{ + } + }, + "GetLoggingOptionsResponse":{ + "type":"structure", + "required":["cloudWatchLogDelivery"], + "members":{ + "cloudWatchLogDelivery":{ + "shape":"CloudWatchLogDeliveryOptions", + "documentation":"Returns information about log delivery to Amazon CloudWatch Logs.
" + } + } + }, + "GetModelManifestRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the vehicle model to retrieve information about.
" + } + } + }, + "GetModelManifestResponse":{ + "type":"structure", + "required":[ + "name", + "arn", + "creationTime", + "lastModificationTime" + ], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the vehicle model.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the vehicle model.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the vehicle model.
" + }, + "signalCatalogArn":{ + "shape":"arn", + "documentation":"The ARN of the signal catalog associated with the vehicle model.
" + }, + "status":{ + "shape":"ManifestStatus", + "documentation":" The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. You can edit the vehicle model if the status is marked DRAFT.
The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "lastModificationTime":{ + "shape":"timestamp", + "documentation":"The last time the vehicle model was modified.
" + } + } + }, + "GetRegisterAccountStatusRequest":{ + "type":"structure", + "members":{ + } + }, + "GetRegisterAccountStatusResponse":{ + "type":"structure", + "required":[ + "customerAccountId", + "accountStatus", + "iamRegistrationResponse", + "creationTime", + "lastModificationTime" + ], + "members":{ + "customerAccountId":{ + "shape":"customerAccountId", + "documentation":"The unique ID of the Amazon Web Services account, provided at account creation.
" + }, + "accountStatus":{ + "shape":"RegistrationStatus", + "documentation":"The status of registering your account and resources. The status can be one of:
REGISTRATION_SUCCESS - The Amazon Web Services resource is successfully registered.
REGISTRATION_PENDING - Amazon Web Services IoT FleetWise is processing the registration request. This process takes approximately five minutes to complete.
REGISTRATION_FAILURE - Amazon Web Services IoT FleetWise can't register the AWS resource. Try again later.
Information about the registered Amazon Timestream resources or errors, if any.
" + }, + "iamRegistrationResponse":{ + "shape":"IamRegistrationResponse", + "documentation":"Information about the registered IAM resources or errors, if any.
" + }, + "creationTime":{ + "shape":"timestamp", + "documentation":"The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "lastModificationTime":{ + "shape":"timestamp", + "documentation":"The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
" + } + } + }, + "GetSignalCatalogRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the signal catalog to retrieve information about.
" + } + } + }, + "GetSignalCatalogResponse":{ + "type":"structure", + "required":[ + "name", + "arn", + "creationTime", + "lastModificationTime" + ], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the signal catalog.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the signal catalog.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the signal catalog.
" + }, + "nodeCounts":{ + "shape":"NodeCounts", + "documentation":"The total number of network nodes specified in a signal catalog.
" + }, + "creationTime":{ + "shape":"timestamp", + "documentation":"The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "lastModificationTime":{ + "shape":"timestamp", + "documentation":"The last time the signal catalog was modified.
" + } + } + }, + "GetVehicleRequest":{ + "type":"structure", + "required":["vehicleName"], + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The ID of the vehicle to retrieve information about.
" + } + } + }, + "GetVehicleResponse":{ + "type":"structure", + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The ID of the vehicle.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the vehicle to retrieve information about.
" + }, + "modelManifestArn":{ + "shape":"arn", + "documentation":"The ARN of a vehicle model (model manifest) associated with the vehicle.
" + }, + "decoderManifestArn":{ + "shape":"arn", + "documentation":"The ARN of a decoder manifest associated with the vehicle.
" + }, + "attributes":{ + "shape":"attributesMap", + "documentation":"Static information about a vehicle in a key-value pair. For example:
\"engineType\" : \"1.3 L R2\"
The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "lastModificationTime":{ + "shape":"timestamp", + "documentation":"The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
" + } + } + }, + "GetVehicleStatusRequest":{ + "type":"structure", + "required":["vehicleName"], + "members":{ + "nextToken":{ + "shape":"nextToken", + "documentation":"A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
" + }, + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The ID of the vehicle to retrieve information about.
" + } + } + }, + "GetVehicleStatusResponse":{ + "type":"structure", + "members":{ + "campaigns":{ + "shape":"VehicleStatusList", + "documentation":"Lists information about the state of the vehicle with deployed campaigns.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":" The token to retrieve the next set of results, or null if there are no more results.
The Amazon Resource Name (ARN) of the IAM role to register.
" + }, + "registrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"The status of registering your IAM resource. The status can be one of REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.
A message associated with a registration error.
" + } + }, + "documentation":"Information about registering an Identity and Access Management (IAM) resource so Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to Amazon Timestream.
" + }, + "IamResources":{ + "type":"structure", + "required":["roleArn"], + "members":{ + "roleArn":{ + "shape":"IAMRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream. For example, arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN.
The IAM resource that enables Amazon Web Services IoT FleetWise edge agent software to send data to Amazon Timestream.
For more information, see IAM roles in the Identity and Access Management User Guide.
" + }, + "ImportDecoderManifestRequest":{ + "type":"structure", + "required":[ + "name", + "networkFileDefinitions" + ], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the decoder manifest to import.
" + }, + "networkFileDefinitions":{ + "shape":"NetworkFileDefinitions", + "documentation":"The file to load into an Amazon Web Services account.
" + } + } + }, + "ImportDecoderManifestResponse":{ + "type":"structure", + "required":[ + "name", + "arn" + ], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the imported decoder manifest.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the decoder manifest that was imported.
" + } + } + }, + "ImportSignalCatalogRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the signal catalog to import.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the signal catalog.
" + }, + "vss":{ + "shape":"FormattedVss", + "documentation":"The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a precise language used to describe and model signals in vehicle networks.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"Metadata that can be used to manage the signal catalog.
" + } + } + }, + "ImportSignalCatalogResponse":{ + "type":"structure", + "required":[ + "name", + "arn" + ], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the imported signal catalog.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the imported signal catalog.
" + } + } + }, + "InterfaceId":{ + "type":"string", + "max":50, + "min":1 + }, + "InterfaceIds":{ + "type":"list", + "member":{"shape":"InterfaceId"}, + "max":500, + "min":1 + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"string"}, + "retryAfterSeconds":{ + "shape":"RetryAfterSeconds", + "documentation":"The number of seconds to wait before retrying the command.
" + } + }, + "documentation":"The request couldn't be completed because the server temporarily failed.
", + "exception":true, + "fault":true + }, + "InvalidNetworkInterface":{ + "type":"structure", + "members":{ + "interfaceId":{ + "shape":"InterfaceId", + "documentation":"The ID of the interface that isn't valid.
" + }, + "reason":{ + "shape":"NetworkInterfaceFailureReason", + "documentation":"A message about why the interface isn't valid.
" + } + }, + "documentation":"A reason a vehicle network interface isn't valid.
" + }, + "InvalidNetworkInterfaces":{ + "type":"list", + "member":{"shape":"InvalidNetworkInterface"} + }, + "InvalidNodeException":{ + "type":"structure", + "members":{ + "invalidNodes":{ + "shape":"Nodes", + "documentation":"The specified node type isn't valid.
" + }, + "reason":{ + "shape":"string", + "documentation":"The reason the node validation failed.
" + }, + "message":{"shape":"string"} + }, + "documentation":"The specified node type doesn't match the expected node type for a node. You can specify the node type as branch, sensor, actuator, or attribute.
", + "exception":true + }, + "InvalidSignal":{ + "type":"structure", + "members":{ + "name":{ + "shape":"FullyQualifiedName", + "documentation":"The name of the signal that isn't valid.
" + }, + "reason":{ + "shape":"string", + "documentation":"A message about why the signal isn't valid.
" + } + }, + "documentation":"A reason that a signal isn't valid.
" + }, + "InvalidSignalDecoder":{ + "type":"structure", + "members":{ + "name":{ + "shape":"FullyQualifiedName", + "documentation":"The name of a signal decoder that isn't valid.
" + }, + "reason":{ + "shape":"SignalDecoderFailureReason", + "documentation":"A message about why the signal decoder isn't valid.
" + }, + "hint":{ + "shape":"message", + "documentation":"The possible cause for the invalid signal decoder.
" + } + }, + "documentation":"A reason that a signal decoder isn't valid.
" + }, + "InvalidSignalDecoders":{ + "type":"list", + "member":{"shape":"InvalidSignalDecoder"} + }, + "InvalidSignals":{ + "type":"list", + "member":{"shape":"InvalidSignal"} + }, + "InvalidSignalsException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"}, + "invalidSignals":{ + "shape":"InvalidSignals", + "documentation":"The signals which caused the exception.
" + } + }, + "documentation":"The request couldn't be completed because it contains signals that aren't valid.
", + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{"shape":"string"}, + "resourceId":{ + "shape":"string", + "documentation":"The identifier of the resource that was exceeded.
" + }, + "resourceType":{ + "shape":"string", + "documentation":"The type of resource that was exceeded.
" + } + }, + "documentation":"A service quota was exceeded.
", + "exception":true + }, + "ListCampaignsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"nextToken", + "documentation":"A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
" + }, + "status":{ + "shape":"status", + "documentation":"Optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, or SUSPENDED.
A summary of information about each campaign.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":" The token to retrieve the next set of results, or null if there are no more results.
The name of the decoder manifest to list information about.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
" + } + } + }, + "ListDecoderManifestNetworkInterfacesResponse":{ + "type":"structure", + "members":{ + "networkInterfaces":{ + "shape":"NetworkInterfaces", + "documentation":"A list of information about network interfaces.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":" The token to retrieve the next set of results, or null if there are no more results.
The name of the decoder manifest to list information about.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
" + } + } + }, + "ListDecoderManifestSignalsResponse":{ + "type":"structure", + "members":{ + "signalDecoders":{ + "shape":"SignalDecoders", + "documentation":"Information about a list of signals to decode.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":" The token to retrieve the next set of results, or null if there are no more results.
The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
" + } + } + }, + "ListDecoderManifestsResponse":{ + "type":"structure", + "members":{ + "summaries":{ + "shape":"decoderManifestSummaries", + "documentation":"A list of information about each decoder manifest.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":" The token to retrieve the next set of results, or null if there are no more results.
The ID of the vehicle to retrieve information about.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
" + } + } + }, + "ListFleetsForVehicleResponse":{ + "type":"structure", + "members":{ + "fleets":{ + "shape":"fleets", + "documentation":"A list of fleet IDs that the vehicle is associated with.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":" The token to retrieve the next set of results, or null if there are no more results.
A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
" + } + } + }, + "ListFleetsResponse":{ + "type":"structure", + "members":{ + "fleetSummaries":{ + "shape":"fleetSummaries", + "documentation":"A list of information for each fleet.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":" The token to retrieve the next set of results, or null if there are no more results.
The name of the vehicle model to list information about.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
" + } + } + }, + "ListModelManifestNodesResponse":{ + "type":"structure", + "members":{ + "nodes":{ + "shape":"Nodes", + "documentation":"A list of information about nodes.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":" The token to retrieve the next set of results, or null if there are no more results.
The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models associated with it are returned.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
" + } + } + }, + "ListModelManifestsResponse":{ + "type":"structure", + "members":{ + "summaries":{ + "shape":"modelManifestSummaries", + "documentation":"A list of information about vehicle models.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":" The token to retrieve the next set of results, or null if there are no more results.
The name of the signal catalog to list information about.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
" + }, + "signalNodeType":{ + "shape":"SignalNodeType", + "documentation":"The type of node in the signal catalog.
" + } + } + }, + "ListSignalCatalogNodesResponse":{ + "type":"structure", + "members":{ + "nodes":{ + "shape":"Nodes", + "documentation":"A list of information about nodes.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":" The token to retrieve the next set of results, or null if there are no more results.
A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
" + } + } + }, + "ListSignalCatalogsResponse":{ + "type":"structure", + "members":{ + "summaries":{ + "shape":"signalCatalogSummaries", + "documentation":"A list of information about each signal catalog.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":" The token to retrieve the next set of results, or null if there are no more results.
The ARN of the resource.
" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"The list of tags assigned to the resource.
" + } + } + }, + "ListVehiclesInFleetRequest":{ + "type":"structure", + "required":["fleetId"], + "members":{ + "fleetId":{ + "shape":"fleetId", + "documentation":"The ID of a fleet.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
" + } + } + }, + "ListVehiclesInFleetResponse":{ + "type":"structure", + "members":{ + "vehicles":{ + "shape":"vehicles", + "documentation":"A list of vehicles associated with the fleet.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":" The token to retrieve the next set of results, or null if there are no more results.
The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional parameter to list only the vehicles created from a certain vehicle model.
" + }, + "attributeNames":{ + "shape":"attributeNamesList", + "documentation":"The fully qualified names of the attributes. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type.
Static information about a vehicle attribute value in string format. For example:
\"1.3 L R2\"
A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
The maximum number of items to return, between 1 and 100, inclusive.
" + } + } + }, + "ListVehiclesResponse":{ + "type":"structure", + "members":{ + "vehicleSummaries":{ + "shape":"vehicleSummaries", + "documentation":"A list of vehicles and information about them.
" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":" The token to retrieve the next set of results, or null if there are no more results.
The topic name for the message signal. It corresponds to topics in ROS 2.
" + }, + "structuredMessage":{ + "shape":"StructuredMessage", + "documentation":"The structured message for the message signal. It can be defined with either a primitiveMessageDefinition, structuredMessageListDefinition, or structuredMessageDefinition recursively.
The decoding information for a specific message which support higher order data types.
" + }, + "ModelManifestSummary":{ + "type":"structure", + "required":[ + "creationTime", + "lastModificationTime" + ], + "members":{ + "name":{ + "shape":"string", + "documentation":"The name of the vehicle model.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the vehicle model.
" + }, + "signalCatalogArn":{ + "shape":"arn", + "documentation":"The ARN of the signal catalog associated with the vehicle model.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the vehicle model.
" + }, + "status":{ + "shape":"ManifestStatus", + "documentation":"The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. If the status is DRAFT, you can edit the vehicle model.
The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "lastModificationTime":{ + "shape":"timestamp", + "documentation":"The time the vehicle model was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
" + } + }, + "documentation":"Information about a vehicle model (model manifest). You can use the API operation to return this information about multiple vehicle models.
" + }, + "ModelSignalsMap":{ + "type":"map", + "key":{"shape":"string"}, + "value":{"shape":"string"} + }, + "NetworkFileBlob":{ + "type":"blob", + "max":200000000, + "min":0 + }, + "NetworkFileDefinition":{ + "type":"structure", + "members":{ + "canDbc":{ + "shape":"CanDbcDefinition", + "documentation":"Information, including CAN DBC files, about the configurations used to create a decoder manifest.
" + } + }, + "documentation":"Specifications for defining a vehicle network.
", + "union":true + }, + "NetworkFileDefinitions":{ + "type":"list", + "member":{"shape":"NetworkFileDefinition"} + }, + "NetworkFilesList":{ + "type":"list", + "member":{"shape":"NetworkFileBlob"}, + "max":5, + "min":1 + }, + "NetworkInterface":{ + "type":"structure", + "required":[ + "interfaceId", + "type" + ], + "members":{ + "interfaceId":{ + "shape":"InterfaceId", + "documentation":"The ID of the network interface.
" + }, + "type":{ + "shape":"NetworkInterfaceType", + "documentation":"The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
Information about a network interface specified by the Controller Area Network (CAN) protocol.
" + }, + "obdInterface":{ + "shape":"ObdInterface", + "documentation":"Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
" + }, + "vehicleMiddleware":{ + "shape":"VehicleMiddleware", + "documentation":"The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP.
Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node.
To return this information about all the network interfaces specified in a decoder manifest, use the API operation.
" + }, + "NetworkInterfaceFailureReason":{ + "type":"string", + "enum":[ + "DUPLICATE_NETWORK_INTERFACE", + "CONFLICTING_NETWORK_INTERFACE", + "NETWORK_INTERFACE_TO_ADD_ALREADY_EXISTS", + "CAN_NETWORK_INTERFACE_INFO_IS_NULL", + "OBD_NETWORK_INTERFACE_INFO_IS_NULL", + "NETWORK_INTERFACE_TO_REMOVE_ASSOCIATED_WITH_SIGNALS", + "VEHICLE_MIDDLEWARE_NETWORK_INTERFACE_INFO_IS_NULL" + ] + }, + "NetworkInterfaceType":{ + "type":"string", + "enum":[ + "CAN_INTERFACE", + "OBD_INTERFACE", + "VEHICLE_MIDDLEWARE" + ] + }, + "NetworkInterfaces":{ + "type":"list", + "member":{"shape":"NetworkInterface"}, + "max":500, + "min":1 + }, + "Node":{ + "type":"structure", + "members":{ + "branch":{ + "shape":"Branch", + "documentation":"Information about a node specified as a branch.
A group of signals that are defined in a hierarchical structure.
Information about a node specified as an actuator.
An actuator is a digital representation of a vehicle device.
Information about a node specified as an attribute.
An attribute represents static information about a vehicle.
Represents a complex or higher-order data structure.
" + }, + "property":{ + "shape":"CustomProperty", + "documentation":"Represents a member of the complex data structure. The datatype of the property can be either primitive or another struct.
A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor.
", + "union":true + }, + "NodeCounts":{ + "type":"structure", + "members":{ + "totalNodes":{ + "shape":"number", + "documentation":"The total number of nodes in a vehicle network.
" + }, + "totalBranches":{ + "shape":"number", + "documentation":"The total number of nodes in a vehicle network that represent branches.
" + }, + "totalSensors":{ + "shape":"number", + "documentation":"The total number of nodes in a vehicle network that represent sensors.
" + }, + "totalAttributes":{ + "shape":"number", + "documentation":"The total number of nodes in a vehicle network that represent attributes.
" + }, + "totalActuators":{ + "shape":"number", + "documentation":"The total number of nodes in a vehicle network that represent actuators.
" + }, + "totalStructs":{ + "shape":"number", + "documentation":"The total structure for the node.
" + }, + "totalProperties":{ + "shape":"number", + "documentation":"The total properties for the node.
" + } + }, + "documentation":"Information about the number of nodes and node types in a vehicle network.
" + }, + "NodeDataEncoding":{ + "type":"string", + "enum":[ + "BINARY", + "TYPED" + ] + }, + "NodeDataType":{ + "type":"string", + "enum":[ + "INT8", + "UINT8", + "INT16", + "UINT16", + "INT32", + "UINT32", + "INT64", + "UINT64", + "BOOLEAN", + "FLOAT", + "DOUBLE", + "STRING", + "UNIX_TIMESTAMP", + "INT8_ARRAY", + "UINT8_ARRAY", + "INT16_ARRAY", + "UINT16_ARRAY", + "INT32_ARRAY", + "UINT32_ARRAY", + "INT64_ARRAY", + "UINT64_ARRAY", + "BOOLEAN_ARRAY", + "FLOAT_ARRAY", + "DOUBLE_ARRAY", + "STRING_ARRAY", + "UNIX_TIMESTAMP_ARRAY", + "UNKNOWN", + "STRUCT", + "STRUCT_ARRAY" + ] + }, + "NodePath":{ + "type":"string", + "max":150, + "min":1, + "pattern":"[a-zA-Z0-9_.]+" + }, + "NodePaths":{ + "type":"list", + "member":{"shape":"NodePath"}, + "max":500, + "min":1 + }, + "Nodes":{ + "type":"list", + "member":{"shape":"Node"}, + "max":500, + "min":0 + }, + "ObdBitmaskLength":{ + "type":"integer", + "box":true, + "max":8, + "min":1 + }, + "ObdByteLength":{ + "type":"integer", + "box":true, + "max":8, + "min":1 + }, + "ObdInterface":{ + "type":"structure", + "required":[ + "name", + "requestMessageId" + ], + "members":{ + "name":{ + "shape":"ObdInterfaceName", + "documentation":"The name of the interface.
" + }, + "requestMessageId":{ + "shape":"nonNegativeInteger", + "documentation":"The ID of the message requesting vehicle data.
" + }, + "obdStandard":{ + "shape":"ObdStandard", + "documentation":"The standard OBD II PID.
" + }, + "pidRequestIntervalSeconds":{ + "shape":"nonNegativeInteger", + "documentation":"The maximum number message requests per second.
" + }, + "dtcRequestIntervalSeconds":{ + "shape":"nonNegativeInteger", + "documentation":"The maximum number message requests per diagnostic trouble code per second.
" + }, + "useExtendedIds":{ + "shape":"PrimitiveBoolean", + "documentation":"Whether to use extended IDs in the message.
" + }, + "hasTransmissionEcu":{ + "shape":"PrimitiveBoolean", + "documentation":"Whether the vehicle has a transmission control module (TCM).
" + } + }, + "documentation":"A network interface that specifies the On-board diagnostic (OBD) II network protocol.
" + }, + "ObdInterfaceName":{ + "type":"string", + "max":100, + "min":1 + }, + "ObdSignal":{ + "type":"structure", + "required":[ + "pidResponseLength", + "serviceMode", + "pid", + "scaling", + "offset", + "startByte", + "byteLength" + ], + "members":{ + "pidResponseLength":{ + "shape":"positiveInteger", + "documentation":"The length of the requested data.
" + }, + "serviceMode":{ + "shape":"nonNegativeInteger", + "documentation":"The mode of operation (diagnostic service) in a message.
" + }, + "pid":{ + "shape":"nonNegativeInteger", + "documentation":"The diagnostic code used to request data from a vehicle for this signal.
" + }, + "scaling":{ + "shape":"double", + "documentation":"A multiplier used to decode the message.
" + }, + "offset":{ + "shape":"double", + "documentation":"The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.
Indicates the beginning of the message.
" + }, + "byteLength":{ + "shape":"ObdByteLength", + "documentation":"The length of a message.
" + }, + "bitRightShift":{ + "shape":"nonNegativeInteger", + "documentation":"The number of positions to shift bits in the message.
" + }, + "bitMaskLength":{ + "shape":"ObdBitmaskLength", + "documentation":"The number of bits to mask in a message.
" + } + }, + "documentation":"Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
" + }, + "ObdStandard":{ + "type":"string", + "max":50, + "min":1 + }, + "Prefix":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[a-zA-Z0-9-_:./!*'()]+" + }, + "PrimitiveBoolean":{"type":"boolean"}, + "PrimitiveMessageDefinition":{ + "type":"structure", + "members":{ + "ros2PrimitiveMessageDefinition":{ + "shape":"ROS2PrimitiveMessageDefinition", + "documentation":"Information about a PrimitiveMessage using a ROS 2 compliant primitive type message of the complex data structure.
Represents a primitive type node of the complex data structure.
", + "union":true + }, + "ProtocolName":{ + "type":"string", + "max":50, + "min":1 + }, + "ProtocolVersion":{ + "type":"string", + "max":50, + "min":1 + }, + "PutEncryptionConfigurationRequest":{ + "type":"structure", + "required":["encryptionType"], + "members":{ + "kmsKeyId":{ + "shape":"PutEncryptionConfigurationRequestKmsKeyIdString", + "documentation":"The ID of the KMS key that is used for encryption.
" + }, + "encryptionType":{ + "shape":"EncryptionType", + "documentation":"The type of encryption. Choose KMS_BASED_ENCRYPTION to use a KMS key or FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key.
The ID of the KMS key that is used for encryption.
" + }, + "encryptionStatus":{ + "shape":"EncryptionStatus", + "documentation":"The encryption status.
" + }, + "encryptionType":{ + "shape":"EncryptionType", + "documentation":"The type of encryption. Set to KMS_BASED_ENCRYPTION to use an KMS key that you own and manage. Set to FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account.
Creates or updates the log delivery option to Amazon CloudWatch Logs.
" + } + } + }, + "PutLoggingOptionsResponse":{ + "type":"structure", + "members":{ + } + }, + "ROS2PrimitiveMessageDefinition":{ + "type":"structure", + "required":["primitiveType"], + "members":{ + "primitiveType":{ + "shape":"ROS2PrimitiveType", + "documentation":"The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.
" + }, + "offset":{ + "shape":"double", + "documentation":"The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.
A multiplier used to decode the message.
" + }, + "upperBound":{ + "shape":"ROS2PrimitiveMessageDefinitionUpperBoundLong", + "documentation":"An optional attribute specifying the upper bound for STRING and WSTRING.
Represents a ROS 2 compliant primitive type message of the complex data structure.
" + }, + "ROS2PrimitiveMessageDefinitionUpperBoundLong":{ + "type":"long", + "box":true, + "max":2048, + "min":0 + }, + "ROS2PrimitiveType":{ + "type":"string", + "enum":[ + "BOOL", + "BYTE", + "CHAR", + "FLOAT32", + "FLOAT64", + "INT8", + "UINT8", + "INT16", + "UINT16", + "INT32", + "UINT32", + "INT64", + "UINT64", + "STRING", + "WSTRING" + ] + }, + "RegisterAccountRequest":{ + "type":"structure", + "members":{ + "timestreamResources":{ + "shape":"TimestreamResources", + "deprecated":true, + "deprecatedMessage":"Amazon Timestream metadata is now passed in the CreateCampaign API." + }, + "iamResources":{ + "shape":"IamResources", + "documentation":"The IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.
", + "deprecated":true, + "deprecatedMessage":"iamResources is no longer used or needed as input" + } + } + }, + "RegisterAccountResponse":{ + "type":"structure", + "required":[ + "registerAccountStatus", + "iamResources", + "creationTime", + "lastModificationTime" + ], + "members":{ + "registerAccountStatus":{ + "shape":"RegistrationStatus", + "documentation":"The status of registering your Amazon Web Services account, IAM role, and Timestream resources.
" + }, + "timestreamResources":{"shape":"TimestreamResources"}, + "iamResources":{ + "shape":"IamResources", + "documentation":"The registered IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.
" + }, + "creationTime":{ + "shape":"timestamp", + "documentation":"The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "lastModificationTime":{ + "shape":"timestamp", + "documentation":"The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
" + } + } + }, + "RegistrationStatus":{ + "type":"string", + "enum":[ + "REGISTRATION_PENDING", + "REGISTRATION_SUCCESS", + "REGISTRATION_FAILURE" + ] + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{"shape":"string"}, + "resourceId":{ + "shape":"string", + "documentation":"The identifier of the resource that wasn't found.
" + }, + "resourceType":{ + "shape":"string", + "documentation":"The type of resource that wasn't found.
" + } + }, + "documentation":"The resource wasn't found.
", + "exception":true + }, + "RetryAfterSeconds":{"type":"integer"}, + "S3BucketArn":{ + "type":"string", + "max":100, + "min":16, + "pattern":"arn:(aws[a-zA-Z0-9-]*):s3:::.+" + }, + "S3Config":{ + "type":"structure", + "required":["bucketArn"], + "members":{ + "bucketArn":{ + "shape":"S3BucketArn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon S3 bucket.
" + }, + "dataFormat":{ + "shape":"DataFormat", + "documentation":"Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.
Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.
JSON - Store data in a standard text-based JSON file format.
By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.
" + }, + "prefix":{ + "shape":"Prefix", + "documentation":"(Optional) Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
By default, Amazon Web Services IoT FleetWise sets the prefix processed-data/year=YY/month=MM/date=DD/hour=HH/ (in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefix vehicles, the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/.
The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data. Amazon S3 is an object storage service that stores data as objects within buckets. For more information, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide.
" + }, + "Sensor":{ + "type":"structure", + "required":[ + "fullyQualifiedName", + "dataType" + ], + "members":{ + "fullyQualifiedName":{ + "shape":"string", + "documentation":"The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery.
The specified data type of the sensor.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of a sensor.
" + }, + "unit":{ + "shape":"string", + "documentation":"The scientific unit of measurement for data collected by the sensor.
" + }, + "allowedValues":{ + "shape":"listOfStrings", + "documentation":"A list of possible values a sensor can take.
" + }, + "min":{ + "shape":"double", + "documentation":"The specified possible minimum value of the sensor.
" + }, + "max":{ + "shape":"double", + "documentation":"The specified possible maximum value of the sensor.
" + }, + "deprecationMessage":{ + "shape":"message", + "documentation":"The deprecation message for the node or the branch that was moved or deleted.
" + }, + "comment":{ + "shape":"message", + "documentation":"A comment in addition to the description.
" + }, + "structFullyQualifiedName":{ + "shape":"NodePath", + "documentation":"The fully qualified name of the struct node for a sensor if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of a sensor might be Vehicle.ADAS.CameraStruct.
An input component that reports the environmental condition of a vehicle.
You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
The name of the signal catalog.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the signal catalog.
" + }, + "creationTime":{ + "shape":"timestamp", + "documentation":"The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "lastModificationTime":{ + "shape":"timestamp", + "documentation":"The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
" + } + }, + "documentation":"Information about a collection of standardized signals, which can be attributes, branches, sensors, or actuators.
" + }, + "SignalDecoder":{ + "type":"structure", + "required":[ + "fullyQualifiedName", + "type", + "interfaceId" + ], + "members":{ + "fullyQualifiedName":{ + "shape":"FullyQualifiedName", + "documentation":"The fully qualified name of a signal decoder as defined in a vehicle model.
" + }, + "type":{ + "shape":"SignalDecoderType", + "documentation":"The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
The ID of a network interface that specifies what network protocol a vehicle follows.
" + }, + "canSignal":{ + "shape":"CanSignal", + "documentation":"Information about signal decoder using the Controller Area Network (CAN) protocol.
" + }, + "obdSignal":{ + "shape":"ObdSignal", + "documentation":"Information about signal decoder using the On-board diagnostic (OBD) II protocol.
" + }, + "messageSignal":{ + "shape":"MessageSignal", + "documentation":"The decoding information for a specific message which supports higher order data types.
" + } + }, + "documentation":"Information about a signal decoder.
" + }, + "SignalDecoderFailureReason":{ + "type":"string", + "enum":[ + "DUPLICATE_SIGNAL", + "CONFLICTING_SIGNAL", + "SIGNAL_TO_ADD_ALREADY_EXISTS", + "SIGNAL_NOT_ASSOCIATED_WITH_NETWORK_INTERFACE", + "NETWORK_INTERFACE_TYPE_INCOMPATIBLE_WITH_SIGNAL_DECODER_TYPE", + "SIGNAL_NOT_IN_MODEL", + "CAN_SIGNAL_INFO_IS_NULL", + "OBD_SIGNAL_INFO_IS_NULL", + "NO_DECODER_INFO_FOR_SIGNAL_IN_MODEL", + "MESSAGE_SIGNAL_INFO_IS_NULL", + "SIGNAL_DECODER_TYPE_INCOMPATIBLE_WITH_MESSAGE_SIGNAL_TYPE", + "STRUCT_SIZE_MISMATCH", + "NO_SIGNAL_IN_CATALOG_FOR_DECODER_SIGNAL", + "SIGNAL_DECODER_INCOMPATIBLE_WITH_SIGNAL_CATALOG", + "EMPTY_MESSAGE_SIGNAL" + ] + }, + "SignalDecoderType":{ + "type":"string", + "enum":[ + "CAN_SIGNAL", + "OBD_SIGNAL", + "MESSAGE_SIGNAL" + ] + }, + "SignalDecoders":{ + "type":"list", + "member":{"shape":"SignalDecoder"}, + "max":500, + "min":1 + }, + "SignalInformation":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"wildcardSignalName", + "documentation":"The name of the signal.
" + }, + "maxSampleCount":{ + "shape":"maxSampleCount", + "documentation":"The maximum number of samples to collect.
" + }, + "minimumSamplingIntervalMs":{ + "shape":"uint32", + "documentation":"The minimum duration of time (in milliseconds) between two triggering events to collect data.
If a signal changes often, you might want to collect data at a slower rate.
Information about a signal.
" + }, + "SignalInformationList":{ + "type":"list", + "member":{"shape":"SignalInformation"}, + "max":1000, + "min":0 + }, + "SignalNodeType":{ + "type":"string", + "enum":[ + "SENSOR", + "ACTUATOR", + "ATTRIBUTE", + "BRANCH", + "CUSTOM_STRUCT", + "CUSTOM_PROPERTY" + ] + }, + "SpoolingMode":{ + "type":"string", + "enum":[ + "OFF", + "TO_DISK" + ] + }, + "StorageCompressionFormat":{ + "type":"string", + "enum":[ + "NONE", + "GZIP" + ] + }, + "String":{"type":"string"}, + "StructureMessageName":{ + "type":"string", + "max":150, + "min":1 + }, + "StructuredMessage":{ + "type":"structure", + "members":{ + "primitiveMessageDefinition":{ + "shape":"PrimitiveMessageDefinition", + "documentation":"Represents a primitive type node of the complex data structure.
" + }, + "structuredMessageListDefinition":{ + "shape":"StructuredMessageListDefinition", + "documentation":"Represents a list type node of the complex data structure.
" + }, + "structuredMessageDefinition":{ + "shape":"StructuredMessageDefinition", + "documentation":"Represents a struct type node of the complex data structure.
" + } + }, + "documentation":"The structured message for the message signal. It can be defined with either a primitiveMessageDefinition, structuredMessageListDefinition, or structuredMessageDefinition recursively.
The field name of the structured message. It determines how a data value is referenced in the target language.
" + }, + "dataType":{ + "shape":"StructuredMessage", + "documentation":"The data type.
" + } + }, + "documentation":"Represents a StructureMessageName to DataType map element.
The name of the structured message list definition.
" + }, + "memberType":{ + "shape":"StructuredMessage", + "documentation":"The member type of the structured message list definition.
" + }, + "listType":{ + "shape":"StructuredMessageListType", + "documentation":"The type of list of the structured message list definition.
" + }, + "capacity":{ + "shape":"nonNegativeInteger", + "documentation":"The capacity of the structured message list definition when the list type is FIXED_CAPACITY or DYNAMIC_BOUNDED_CAPACITY.
Represents a list type node of the complex data structure.
" + }, + "StructuredMessageListType":{ + "type":"string", + "enum":[ + "FIXED_CAPACITY", + "DYNAMIC_UNBOUNDED_CAPACITY", + "DYNAMIC_BOUNDED_CAPACITY" + ] + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"The tag's key.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The tag's value.
" + } + }, + "documentation":"A set of key/value pairs that are used to manage the resource.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the resource.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The new or modified tags for the resource.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"string"}, + "quotaCode":{ + "shape":"string", + "documentation":"The quota identifier of the applied throttling rules for this request.
" + }, + "serviceCode":{ + "shape":"string", + "documentation":"The code for the service that couldn't be completed due to throttling.
" + }, + "retryAfterSeconds":{ + "shape":"RetryAfterSeconds", + "documentation":"The number of seconds to wait before retrying the command.
" + } + }, + "documentation":"The request couldn't be completed due to throttling.
", + "exception":true + }, + "TimeBasedCollectionScheme":{ + "type":"structure", + "required":["periodMs"], + "members":{ + "periodMs":{ + "shape":"collectionPeriodMs", + "documentation":"The time period (in milliseconds) to decide how often to collect data. For example, if the time period is 60000, the Edge Agent software collects data once every minute.
Information about a collection scheme that uses a time period to decide how often to collect data.
" + }, + "TimestreamConfig":{ + "type":"structure", + "required":[ + "timestreamTableArn", + "executionRoleArn" + ], + "members":{ + "timestreamTableArn":{ + "shape":"TimestreamTableArn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Timestream table.
" + }, + "executionRoleArn":{ + "shape":"IAMRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the task execution role that grants Amazon Web Services IoT FleetWise permission to deliver data to the Amazon Timestream table.
" + } + }, + "documentation":"The Amazon Timestream table where the Amazon Web Services IoT FleetWise campaign sends data. Timestream stores and organizes data to optimize query processing time and to reduce storage costs. For more information, see Data modeling in the Amazon Timestream Developer Guide.
" + }, + "TimestreamDatabaseName":{ + "type":"string", + "max":255, + "min":3, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "TimestreamRegistrationResponse":{ + "type":"structure", + "required":[ + "timestreamDatabaseName", + "timestreamTableName", + "registrationStatus" + ], + "members":{ + "timestreamDatabaseName":{ + "shape":"TimestreamDatabaseName", + "documentation":"The name of the Timestream database.
" + }, + "timestreamTableName":{ + "shape":"TimestreamTableName", + "documentation":"The name of the Timestream database table.
" + }, + "timestreamDatabaseArn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the Timestream database.
" + }, + "timestreamTableArn":{ + "shape":"arn", + "documentation":"The ARN of the Timestream database table.
" + }, + "registrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"The status of registering your Amazon Timestream resources. The status can be one of REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.
A message associated with a registration error.
" + } + }, + "documentation":"Information about the registered Amazon Timestream resources or errors, if any.
" + }, + "TimestreamResources":{ + "type":"structure", + "required":[ + "timestreamDatabaseName", + "timestreamTableName" + ], + "members":{ + "timestreamDatabaseName":{ + "shape":"TimestreamDatabaseName", + "documentation":"The name of the registered Amazon Timestream database.
" + }, + "timestreamTableName":{ + "shape":"TimestreamTableName", + "documentation":"The name of the registered Amazon Timestream database table.
" + } + }, + "documentation":"The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.
" + }, + "TimestreamTableArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:(aws[a-zA-Z0-9-]*):timestream:[a-zA-Z0-9-]+:[0-9]{12}:database/[a-zA-Z0-9_.-]+/table/[a-zA-Z0-9_.-]+" + }, + "TimestreamTableName":{ + "type":"string", + "max":255, + "min":3, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "TopicName":{ + "type":"string", + "max":150, + "min":1, + "pattern":"[a-zA-Z0-9_\\-#:./]+" + }, + "TriggerMode":{ + "type":"string", + "enum":[ + "ALWAYS", + "RISING_EDGE" + ] + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the resource.
" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"A list of the keys of the tags to be removed from the resource.
" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateCampaignAction":{ + "type":"string", + "enum":[ + "APPROVE", + "SUSPEND", + "RESUME", + "UPDATE" + ] + }, + "UpdateCampaignRequest":{ + "type":"structure", + "required":[ + "name", + "action" + ], + "members":{ + "name":{ + "shape":"campaignName", + "documentation":"The name of the campaign to update.
" + }, + "description":{ + "shape":"description", + "documentation":"The description of the campaign.
" + }, + "dataExtraDimensions":{ + "shape":"DataExtraDimensionNodePathList", + "documentation":"A list of vehicle attributes to associate with a signal.
Default: An empty array
" + }, + "action":{ + "shape":"UpdateCampaignAction", + "documentation":"Specifies how to update a campaign. The action can be one of the following:
APPROVE - To approve delivering a data collection scheme to vehicles.
SUSPEND - To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.
RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.
UPDATE - To update a campaign.
The Amazon Resource Name (ARN) of the campaign.
" + }, + "name":{ + "shape":"campaignName", + "documentation":"The name of the updated campaign.
" + }, + "status":{ + "shape":"CampaignStatus", + "documentation":"The state of a campaign. The status can be one of:
CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.
WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.
RUNNING - The campaign is active.
SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.
The name of the decoder manifest to update.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the decoder manifest to update.
" + }, + "signalDecodersToAdd":{ + "shape":"SignalDecoders", + "documentation":"A list of information about decoding additional signals to add to the decoder manifest.
" + }, + "signalDecodersToUpdate":{ + "shape":"SignalDecoders", + "documentation":"A list of updated information about decoding signals to update in the decoder manifest.
" + }, + "signalDecodersToRemove":{ + "shape":"Fqns", + "documentation":"A list of signal decoders to remove from the decoder manifest.
" + }, + "networkInterfacesToAdd":{ + "shape":"NetworkInterfaces", + "documentation":"A list of information about the network interfaces to add to the decoder manifest.
" + }, + "networkInterfacesToUpdate":{ + "shape":"NetworkInterfaces", + "documentation":"A list of information about the network interfaces to update in the decoder manifest.
" + }, + "networkInterfacesToRemove":{ + "shape":"InterfaceIds", + "documentation":"A list of network interfaces to remove from the decoder manifest.
" + }, + "status":{ + "shape":"ManifestStatus", + "documentation":" The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.
The name of the updated decoder manifest.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the updated decoder manifest.
" + } + } + }, + "UpdateFleetRequest":{ + "type":"structure", + "required":["fleetId"], + "members":{ + "fleetId":{ + "shape":"fleetId", + "documentation":"The ID of the fleet to update.
" + }, + "description":{ + "shape":"description", + "documentation":"An updated description of the fleet.
" + } + } + }, + "UpdateFleetResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"fleetId", + "documentation":"The ID of the updated fleet.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the updated fleet.
" + } + } + }, + "UpdateMode":{ + "type":"string", + "enum":[ + "Overwrite", + "Merge" + ] + }, + "UpdateModelManifestRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the vehicle model to update.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the vehicle model.
" + }, + "nodesToAdd":{ + "shape":"NodePaths", + "documentation":" A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to add to the vehicle model.
A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to remove from the vehicle model.
The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. If the status is DRAFT, you can edit the vehicle model.
The name of the updated vehicle model.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the updated vehicle model.
" + } + } + }, + "UpdateSignalCatalogRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"resourceName", + "documentation":"The name of the signal catalog to update.
" + }, + "description":{ + "shape":"description", + "documentation":"A brief description of the signal catalog to update.
" + }, + "nodesToAdd":{ + "shape":"Nodes", + "documentation":"A list of information about nodes to add to the signal catalog.
" + }, + "nodesToUpdate":{ + "shape":"Nodes", + "documentation":"A list of information about nodes to update in the signal catalog.
" + }, + "nodesToRemove":{ + "shape":"NodePaths", + "documentation":" A list of fullyQualifiedName of nodes to remove from the signal catalog.
The name of the updated signal catalog.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The ARN of the updated signal catalog.
" + } + } + }, + "UpdateVehicleError":{ + "type":"structure", + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The ID of the vehicle with the error.
" + }, + "code":{ + "shape":"number", + "documentation":"The relevant HTTP error code (400+).
" + }, + "message":{ + "shape":"string", + "documentation":"A message associated with the error.
" + } + }, + "documentation":"An HTTP error resulting from updating the description for a vehicle.
" + }, + "UpdateVehicleRequest":{ + "type":"structure", + "required":["vehicleName"], + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The unique ID of the vehicle to update.
" + }, + "modelManifestArn":{ + "shape":"arn", + "documentation":"The ARN of a vehicle model (model manifest) associated with the vehicle.
" + }, + "decoderManifestArn":{ + "shape":"arn", + "documentation":"The ARN of the decoder manifest associated with this vehicle.
" + }, + "attributes":{ + "shape":"attributesMap", + "documentation":"Static information about a vehicle in a key-value pair. For example:
\"engineType\" : \"1.3 L R2\"
The method the specified attributes will update the existing attributes on the vehicle. UseOverwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.
This is required if attributes are present in the input.
" + } + } + }, + "UpdateVehicleRequestItem":{ + "type":"structure", + "required":["vehicleName"], + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The unique ID of the vehicle to update.
" + }, + "modelManifestArn":{ + "shape":"arn", + "documentation":"The ARN of the vehicle model (model manifest) associated with the vehicle to update.
" + }, + "decoderManifestArn":{ + "shape":"arn", + "documentation":"The ARN of the signal decoder manifest associated with the vehicle to update.
" + }, + "attributes":{ + "shape":"attributesMap", + "documentation":"Static information about a vehicle in a key-value pair. For example:
\"engineType\" : \"1.3 L R2\"
The method the specified attributes will update the existing attributes on the vehicle. UseOverwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.
This is required if attributes are present in the input.
" + } + }, + "documentation":"Information about the vehicle to update.
" + }, + "UpdateVehicleResponse":{ + "type":"structure", + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The ID of the updated vehicle.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The ARN of the updated vehicle.
" + } + } + }, + "UpdateVehicleResponseItem":{ + "type":"structure", + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The unique ID of the updated vehicle.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the updated vehicle.
" + } + }, + "documentation":"Information about the updated vehicle.
" + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"string"}, + "reason":{ + "shape":"ValidationExceptionReason", + "documentation":"The reason the input failed to satisfy the constraints specified by an Amazon Web Services service.
" + }, + "fieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"The list of fields that fail to satisfy the constraints specified by an Amazon Web Services service.
" + } + }, + "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
", + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "name", + "message" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of the parameter field with the validation error.
" + }, + "message":{ + "shape":"String", + "documentation":"A message about the validation error.
" + } + }, + "documentation":"A validation error due to mismatch between the expected data type, length, or pattern of the parameter and the input.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "unknownOperation", + "cannotParse", + "fieldValidationFailed", + "other" + ] + }, + "VehicleAssociationBehavior":{ + "type":"string", + "enum":[ + "CreateIotThing", + "ValidateIotThingExists" + ] + }, + "VehicleMiddleware":{ + "type":"structure", + "required":[ + "name", + "protocolName" + ], + "members":{ + "name":{ + "shape":"VehicleMiddlewareName", + "documentation":"The name of the vehicle middleware.
" + }, + "protocolName":{ + "shape":"VehicleMiddlewareProtocol", + "documentation":"The protocol name of the vehicle middleware.
" + } + }, + "documentation":"The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP.
The name of a campaign.
" + }, + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The unique ID of the vehicle.
" + }, + "status":{ + "shape":"VehicleState", + "documentation":"The state of a vehicle, which can be one of the following:
CREATED - Amazon Web Services IoT FleetWise sucessfully created the vehicle.
READY - The vehicle is ready to receive a campaign deployment.
HEALTHY - A campaign deployment was delivered to the vehicle.
SUSPENDED - A campaign associated with the vehicle was suspended and data collection was paused.
DELETING - Amazon Web Services IoT FleetWise is removing a campaign from the vehicle.
Information about the state of a vehicle and how it relates to the status of a campaign.
" + }, + "VehicleStatusList":{ + "type":"list", + "member":{"shape":"VehicleStatus"} + }, + "VehicleSummary":{ + "type":"structure", + "required":[ + "vehicleName", + "arn", + "modelManifestArn", + "decoderManifestArn", + "creationTime", + "lastModificationTime" + ], + "members":{ + "vehicleName":{ + "shape":"vehicleName", + "documentation":"The unique ID of the vehicle.
" + }, + "arn":{ + "shape":"arn", + "documentation":"The Amazon Resource Name (ARN) of the vehicle.
" + }, + "modelManifestArn":{ + "shape":"arn", + "documentation":"The ARN of a vehicle model (model manifest) associated with the vehicle.
" + }, + "decoderManifestArn":{ + "shape":"arn", + "documentation":"The ARN of a decoder manifest associated with the vehicle.
" + }, + "creationTime":{ + "shape":"timestamp", + "documentation":"The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "lastModificationTime":{ + "shape":"timestamp", + "documentation":"The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
" + }, + "attributes":{ + "shape":"attributesMap", + "documentation":"Static information about a vehicle in a key-value pair. For example:
\"engineType\" : \"1.3 L R2\"
Information about a vehicle.
To return this information about vehicles in your account, you can use the API operation.
" + }, + "arn":{"type":"string"}, + "attributeName":{ + "type":"string", + "max":150, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "attributeNamesList":{ + "type":"list", + "member":{"shape":"attributeName"}, + "max":5, + "min":1 + }, + "attributeValue":{"type":"string"}, + "attributeValuesList":{ + "type":"list", + "member":{"shape":"attributeValue"}, + "max":5, + "min":1 + }, + "attributesMap":{ + "type":"map", + "key":{"shape":"attributeName"}, + "value":{"shape":"attributeValue"} + }, + "campaignName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[a-zA-Z\\d\\-_:]+" + }, + "campaignSummaries":{ + "type":"list", + "member":{"shape":"CampaignSummary"} + }, + "collectionPeriodMs":{ + "type":"long", + "box":true, + "max":60000, + "min":10000 + }, + "createVehicleErrors":{ + "type":"list", + "member":{"shape":"CreateVehicleError"} + }, + "createVehicleRequestItems":{ + "type":"list", + "member":{"shape":"CreateVehicleRequestItem"}, + "min":1 + }, + "createVehicleResponses":{ + "type":"list", + "member":{"shape":"CreateVehicleResponseItem"} + }, + "customerAccountId":{"type":"string"}, + "decoderManifestSummaries":{ + "type":"list", + "member":{"shape":"DecoderManifestSummary"} + }, + "description":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[^\\u0000-\\u001F\\u007F]+" + }, + "double":{ + "type":"double", + "box":true + }, + "errorMessage":{"type":"string"}, + "eventExpression":{ + "type":"string", + "max":2048, + "min":1 + }, + "fleetId":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[a-zA-Z0-9:_-]+" + }, + "fleetSummaries":{ + "type":"list", + "member":{"shape":"FleetSummary"} + }, + "fleets":{ + "type":"list", + "member":{"shape":"fleetId"} + }, + "languageVersion":{ + "type":"integer", + "box":true, + "min":1 + }, + "listOfStrings":{ + "type":"list", + "member":{"shape":"string"} + }, + "listVehiclesMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "maxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "maxSampleCount":{ + "type":"long", + "box":true, + "max":4294967295, + "min":1 + }, + "message":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[^\\u0000-\\u001F\\u007F]+" + }, + "modelManifestSummaries":{ + "type":"list", + "member":{"shape":"ModelManifestSummary"} + }, + "nextToken":{ + "type":"string", + "max":4096, + "min":1 + }, + "nonNegativeInteger":{ + "type":"integer", + "min":0 + }, + "number":{"type":"integer"}, + "positiveInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "priority":{ + "type":"integer", + "box":true, + "min":0 + }, + "resourceName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[a-zA-Z\\d\\-_:]+" + }, + "signalCatalogSummaries":{ + "type":"list", + "member":{"shape":"SignalCatalogSummary"} + }, + "status":{"type":"string"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"}, + "uint32":{ + "type":"long", + "box":true, + "max":4294967295, + "min":0 + }, + "updateVehicleErrors":{ + "type":"list", + "member":{"shape":"UpdateVehicleError"} + }, + "updateVehicleRequestItems":{ + "type":"list", + "member":{"shape":"UpdateVehicleRequestItem"}, + "min":1 + }, + "updateVehicleResponseItems":{ + "type":"list", + "member":{"shape":"UpdateVehicleResponseItem"} + }, + "vehicleName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[a-zA-Z\\d\\-_:]+" + }, + "vehicleSummaries":{ + "type":"list", + "member":{"shape":"VehicleSummary"} + }, + "vehicles":{ + "type":"list", + "member":{"shape":"vehicleName"} + }, + "wildcardSignalName":{ + "type":"string", + "max":150, + "min":1, + "pattern":"[\\w|*|-]+(\\.[\\w|*|-]+)*" + } + }, + "documentation":"Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of your vehicle data models, independent of the in-vehicle communication architecture, and define data collection rules to transfer only high-value data to the cloud.
For more information, see What is Amazon Web Services IoT FleetWise? in the Amazon Web Services IoT FleetWise Developer Guide.
" +} diff --git a/testbed/boto__botocore/botocore/data/iotfleetwise/2021-06-17/waiters-2.json b/testbed/boto__botocore/botocore/data/iotfleetwise/2021-06-17/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..13f60ee66be6a3d75208653e2bd7b563561adacc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/iotfleetwise/2021-06-17/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/testbed/boto__botocore/botocore/data/ivs-realtime/2020-07-14/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/ivs-realtime/2020-07-14/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..9c4c0ef5cab0fa74dd8359231a8f9d710d64eb01 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/ivs-realtime/2020-07-14/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ivsrealtime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ivsrealtime-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ivsrealtime.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ivsrealtime.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/ivs-realtime/2020-07-14/paginators-1.json b/testbed/boto__botocore/botocore/data/ivs-realtime/2020-07-14/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..a7ae6129ac69aad0821be210d25c98ce55d6d15b --- /dev/null +++ b/testbed/boto__botocore/botocore/data/ivs-realtime/2020-07-14/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListPublicKeys": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "publicKeys" + }, + "ListIngestConfigurations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "ingestConfigurations" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/ivs-realtime/2020-07-14/service-2.json b/testbed/boto__botocore/botocore/data/ivs-realtime/2020-07-14/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..6d76fe7d40e3e51e49922e6f2842c1bcda95b2f3 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/ivs-realtime/2020-07-14/service-2.json @@ -0,0 +1,3158 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-07-14", + "endpointPrefix":"ivsrealtime", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"ivsrealtime", + "serviceFullName":"Amazon Interactive Video Service RealTime", + "serviceId":"IVS RealTime", + "signatureVersion":"v4", + "signingName":"ivs", + "uid":"ivs-realtime-2020-07-14" + }, + "operations":{ + "CreateEncoderConfiguration":{ + "name":"CreateEncoderConfiguration", + "http":{ + "method":"POST", + "requestUri":"/CreateEncoderConfiguration", + "responseCode":200 + }, + "input":{"shape":"CreateEncoderConfigurationRequest"}, + "output":{"shape":"CreateEncoderConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"PendingVerification"} + ], + "documentation":"Creates an EncoderConfiguration object.
" + }, + "CreateIngestConfiguration":{ + "name":"CreateIngestConfiguration", + "http":{ + "method":"POST", + "requestUri":"/CreateIngestConfiguration", + "responseCode":200 + }, + "input":{"shape":"CreateIngestConfigurationRequest"}, + "output":{"shape":"CreateIngestConfigurationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"PendingVerification"} + ], + "documentation":"Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.
" + }, + "CreateParticipantToken":{ + "name":"CreateParticipantToken", + "http":{ + "method":"POST", + "requestUri":"/CreateParticipantToken", + "responseCode":200 + }, + "input":{"shape":"CreateParticipantTokenRequest"}, + "output":{"shape":"CreateParticipantTokenResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"PendingVerification"} + ], + "documentation":"Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.
Encryption keys are owned by Amazon IVS and never used directly by your application.
" + }, + "CreateStage":{ + "name":"CreateStage", + "http":{ + "method":"POST", + "requestUri":"/CreateStage", + "responseCode":200 + }, + "input":{"shape":"CreateStageRequest"}, + "output":{"shape":"CreateStageResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"PendingVerification"} + ], + "documentation":"Creates a new stage (and optionally participant tokens).
" + }, + "CreateStorageConfiguration":{ + "name":"CreateStorageConfiguration", + "http":{ + "method":"POST", + "requestUri":"/CreateStorageConfiguration", + "responseCode":200 + }, + "input":{"shape":"CreateStorageConfigurationRequest"}, + "output":{"shape":"CreateStorageConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"PendingVerification"} + ], + "documentation":"Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.
" + }, + "DeleteEncoderConfiguration":{ + "name":"DeleteEncoderConfiguration", + "http":{ + "method":"POST", + "requestUri":"/DeleteEncoderConfiguration", + "responseCode":200 + }, + "input":{"shape":"DeleteEncoderConfigurationRequest"}, + "output":{"shape":"DeleteEncoderConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
" + }, + "DeleteIngestConfiguration":{ + "name":"DeleteIngestConfiguration", + "http":{ + "method":"POST", + "requestUri":"/DeleteIngestConfiguration", + "responseCode":200 + }, + "input":{"shape":"DeleteIngestConfigurationRequest"}, + "output":{"shape":"DeleteIngestConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"PendingVerification"} + ], + "documentation":"Deletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless force is set to true.
Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.
" + }, + "DeleteStage":{ + "name":"DeleteStage", + "http":{ + "method":"POST", + "requestUri":"/DeleteStage", + "responseCode":200 + }, + "input":{"shape":"DeleteStageRequest"}, + "output":{"shape":"DeleteStageResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"PendingVerification"} + ], + "documentation":"Shuts down and deletes the specified stage (disconnecting all participants). This operation also removes the stageArn from the associated IngestConfiguration, if there are participants using the IngestConfiguration to publish to the stage.
Deletes the storage configuration for the specified ARN.
If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, then use DeleteStorageConfiguration.
" + }, + "DisconnectParticipant":{ + "name":"DisconnectParticipant", + "http":{ + "method":"POST", + "requestUri":"/DisconnectParticipant", + "responseCode":200 + }, + "input":{"shape":"DisconnectParticipantRequest"}, + "output":{"shape":"DisconnectParticipantResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"PendingVerification"} + ], + "documentation":"Disconnects a specified participant from a specified stage. If the participant is publishing using an IngestConfiguration, DisconnectParticipant also updates the stageArn in the IngestConfiguration to be an empty string.
Get information about the specified Composition resource.
" + }, + "GetEncoderConfiguration":{ + "name":"GetEncoderConfiguration", + "http":{ + "method":"POST", + "requestUri":"/GetEncoderConfiguration", + "responseCode":200 + }, + "input":{"shape":"GetEncoderConfigurationRequest"}, + "output":{"shape":"GetEncoderConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"} + ], + "documentation":"Gets information about the specified EncoderConfiguration resource.
" + }, + "GetIngestConfiguration":{ + "name":"GetIngestConfiguration", + "http":{ + "method":"POST", + "requestUri":"/GetIngestConfiguration", + "responseCode":200 + }, + "input":{"shape":"GetIngestConfigurationRequest"}, + "output":{"shape":"GetIngestConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets information about the specified IngestConfiguration.
" + }, + "GetParticipant":{ + "name":"GetParticipant", + "http":{ + "method":"POST", + "requestUri":"/GetParticipant", + "responseCode":200 + }, + "input":{"shape":"GetParticipantRequest"}, + "output":{"shape":"GetParticipantResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets information about the specified participant token.
" + }, + "GetPublicKey":{ + "name":"GetPublicKey", + "http":{ + "method":"POST", + "requestUri":"/GetPublicKey", + "responseCode":200 + }, + "input":{"shape":"GetPublicKeyRequest"}, + "output":{"shape":"GetPublicKeyResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets information for the specified public key.
" + }, + "GetStage":{ + "name":"GetStage", + "http":{ + "method":"POST", + "requestUri":"/GetStage", + "responseCode":200 + }, + "input":{"shape":"GetStageRequest"}, + "output":{"shape":"GetStageResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets information for the specified stage.
" + }, + "GetStageSession":{ + "name":"GetStageSession", + "http":{ + "method":"POST", + "requestUri":"/GetStageSession", + "responseCode":200 + }, + "input":{"shape":"GetStageSessionRequest"}, + "output":{"shape":"GetStageSessionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets information for the specified stage session.
" + }, + "GetStorageConfiguration":{ + "name":"GetStorageConfiguration", + "http":{ + "method":"POST", + "requestUri":"/GetStorageConfiguration", + "responseCode":200 + }, + "input":{"shape":"GetStorageConfigurationRequest"}, + "output":{"shape":"GetStorageConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"} + ], + "documentation":"Gets the storage configuration for the specified ARN.
" + }, + "ImportPublicKey":{ + "name":"ImportPublicKey", + "http":{ + "method":"POST", + "requestUri":"/ImportPublicKey", + "responseCode":200 + }, + "input":{"shape":"ImportPublicKeyRequest"}, + "output":{"shape":"ImportPublicKeyResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"PendingVerification"} + ], + "documentation":"Import a public key to be used for signing stage participant tokens.
" + }, + "ListCompositions":{ + "name":"ListCompositions", + "http":{ + "method":"POST", + "requestUri":"/ListCompositions", + "responseCode":200 + }, + "input":{"shape":"ListCompositionsRequest"}, + "output":{"shape":"ListCompositionsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"} + ], + "documentation":"Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
" + }, + "ListEncoderConfigurations":{ + "name":"ListEncoderConfigurations", + "http":{ + "method":"POST", + "requestUri":"/ListEncoderConfigurations", + "responseCode":200 + }, + "input":{"shape":"ListEncoderConfigurationsRequest"}, + "output":{"shape":"ListEncoderConfigurationsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"} + ], + "documentation":"Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
" + }, + "ListIngestConfigurations":{ + "name":"ListIngestConfigurations", + "http":{ + "method":"POST", + "requestUri":"/ListIngestConfigurations", + "responseCode":200 + }, + "input":{"shape":"ListIngestConfigurationsRequest"}, + "output":{"shape":"ListIngestConfigurationsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.
" + }, + "ListParticipantEvents":{ + "name":"ListParticipantEvents", + "http":{ + "method":"POST", + "requestUri":"/ListParticipantEvents", + "responseCode":200 + }, + "input":{"shape":"ListParticipantEventsRequest"}, + "output":{"shape":"ListParticipantEventsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists events for a specified participant that occurred during a specified stage session.
" + }, + "ListParticipants":{ + "name":"ListParticipants", + "http":{ + "method":"POST", + "requestUri":"/ListParticipants", + "responseCode":200 + }, + "input":{"shape":"ListParticipantsRequest"}, + "output":{"shape":"ListParticipantsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists all participants in a specified stage session.
" + }, + "ListPublicKeys":{ + "name":"ListPublicKeys", + "http":{ + "method":"POST", + "requestUri":"/ListPublicKeys", + "responseCode":200 + }, + "input":{"shape":"ListPublicKeysRequest"}, + "output":{"shape":"ListPublicKeysResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets summary information about all public keys in your account, in the AWS region where the API request is processed.
" + }, + "ListStageSessions":{ + "name":"ListStageSessions", + "http":{ + "method":"POST", + "requestUri":"/ListStageSessions", + "responseCode":200 + }, + "input":{"shape":"ListStageSessionsRequest"}, + "output":{"shape":"ListStageSessionsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets all sessions for a specified stage.
" + }, + "ListStages":{ + "name":"ListStages", + "http":{ + "method":"POST", + "requestUri":"/ListStages", + "responseCode":200 + }, + "input":{"shape":"ListStagesRequest"}, + "output":{"shape":"ListStagesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ], + "documentation":"Gets summary information about all stages in your account, in the AWS region where the API request is processed.
" + }, + "ListStorageConfigurations":{ + "name":"ListStorageConfigurations", + "http":{ + "method":"POST", + "requestUri":"/ListStorageConfigurations", + "responseCode":200 + }, + "input":{"shape":"ListStorageConfigurationsRequest"}, + "output":{"shape":"ListStorageConfigurationsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"} + ], + "documentation":"Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets information about AWS tags for the specified ARN.
" + }, + "StartComposition":{ + "name":"StartComposition", + "http":{ + "method":"POST", + "requestUri":"/StartComposition", + "responseCode":200 + }, + "input":{"shape":"StartCompositionRequest"}, + "output":{"shape":"StartCompositionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"PendingVerification"} + ], + "documentation":"Starts a Composition from a stage based on the configuration provided in the request.
A Composition is an ephemeral resource that exists after this operation returns successfully. Composition stops and the resource is deleted:
When StopComposition is called.
After a 1-minute timeout, when all participants are disconnected from the stage.
After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.
When broadcasting to the IVS channel fails and all retries are exhausted.
When broadcasting is disconnected and all attempts to reconnect are exhausted.
Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Adds or updates tags for the AWS resource with the specified ARN.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Removes tags from the resource with the specified ARN.
", + "idempotent":true + }, + "UpdateIngestConfiguration":{ + "name":"UpdateIngestConfiguration", + "http":{ + "method":"POST", + "requestUri":"/UpdateIngestConfiguration", + "responseCode":200 + }, + "input":{"shape":"UpdateIngestConfigurationRequest"}, + "output":{"shape":"UpdateIngestConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"PendingVerification"} + ], + "documentation":"Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.
" + }, + "UpdateStage":{ + "name":"UpdateStage", + "http":{ + "method":"POST", + "requestUri":"/UpdateStage", + "responseCode":200 + }, + "input":{"shape":"UpdateStageRequest"}, + "output":{"shape":"UpdateStageResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"PendingVerification"} + ], + "documentation":"Updates a stage’s configuration.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"User does not have sufficient access to perform this action.
" + } + }, + "documentation":"", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AttributeKey":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[a-zA-Z0-9-_]*" + }, + "AutoParticipantRecordingConfiguration":{ + "type":"structure", + "required":["storageConfigurationArn"], + "members":{ + "storageConfigurationArn":{ + "shape":"AutoParticipantRecordingStorageConfigurationArn", + "documentation":"ARN of the StorageConfiguration resource to use for individual participant recording. Default: \"\" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.
Types of media to be recorded. Default: AUDIO_VIDEO.
Object specifying a configuration for individual participant recording.
" + }, + "AutoParticipantRecordingStorageConfigurationArn":{ + "type":"string", + "max":128, + "min":0, + "pattern":"^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:storage-configuration/[a-zA-Z0-9-]+$" + }, + "Bitrate":{ + "type":"integer", + "box":true, + "max":8500000, + "min":1 + }, + "Boolean":{"type":"boolean"}, + "ChannelArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+" + }, + "ChannelDestinationConfiguration":{ + "type":"structure", + "required":["channelArn"], + "members":{ + "channelArn":{ + "shape":"ChannelArn", + "documentation":"ARN of the channel to use for broadcasting. The channel and stage resources must be in the same AWS account and region. The channel must be offline (not broadcasting).
" + }, + "encoderConfigurationArn":{ + "shape":"EncoderConfigurationArn", + "documentation":"ARN of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.
" + } + }, + "documentation":"Object specifying a channel as a destination.
" + }, + "Composition":{ + "type":"structure", + "required":[ + "arn", + "stageArn", + "state", + "layout", + "destinations" + ], + "members":{ + "arn":{ + "shape":"CompositionArn", + "documentation":"ARN of the Composition resource.
" + }, + "stageArn":{ + "shape":"StageArn", + "documentation":"ARN of the stage used as input
" + }, + "state":{ + "shape":"CompositionState", + "documentation":"State of the Composition.
" + }, + "layout":{ + "shape":"LayoutConfiguration", + "documentation":"Layout object to configure composition parameters.
" + }, + "destinations":{ + "shape":"DestinationList", + "documentation":"Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "endTime":{ + "shape":"Time", + "documentation":"UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
" + } + }, + "documentation":"Object specifying a Composition resource.
" + }, + "CompositionArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:composition/[a-zA-Z0-9-]+" + }, + "CompositionClientToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9-_]*" + }, + "CompositionState":{ + "type":"string", + "enum":[ + "STARTING", + "ACTIVE", + "STOPPING", + "FAILED", + "STOPPED" + ] + }, + "CompositionSummary":{ + "type":"structure", + "required":[ + "arn", + "stageArn", + "destinations", + "state" + ], + "members":{ + "arn":{ + "shape":"CompositionArn", + "documentation":"ARN of the Composition resource.
" + }, + "stageArn":{ + "shape":"StageArn", + "documentation":"ARN of the attached stage.
" + }, + "destinations":{ + "shape":"DestinationSummaryList", + "documentation":"Array of Destination objects.
" + }, + "state":{ + "shape":"CompositionState", + "documentation":"State of the Composition resource.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "endTime":{ + "shape":"Time", + "documentation":"UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
" + } + }, + "documentation":"Summary information about a Composition.
" + }, + "CompositionSummaryList":{ + "type":"list", + "member":{"shape":"CompositionSummary"} + }, + "ConflictException":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"Updating or deleting a resource can cause an inconsistent state.
" + } + }, + "documentation":"", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateEncoderConfigurationRequest":{ + "type":"structure", + "members":{ + "name":{ + "shape":"EncoderConfigurationName", + "documentation":"Optional name to identify the resource.
" + }, + "video":{ + "shape":"Video", + "documentation":"Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
The EncoderConfiguration that was created.
" + } + } + }, + "CreateIngestConfigurationRequest":{ + "type":"structure", + "required":["ingestProtocol"], + "members":{ + "name":{ + "shape":"IngestConfigurationName", + "documentation":"Optional name that can be specified for the IngestConfiguration being created.
" + }, + "stageArn":{ + "shape":"IngestConfigurationStageArn", + "documentation":"ARN of the stage with which the IngestConfiguration is associated.
" + }, + "userId":{ + "shape":"UserId", + "documentation":"Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "attributes":{ + "shape":"ParticipantAttributes", + "documentation":"Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "ingestProtocol":{ + "shape":"IngestProtocol", + "documentation":"Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.
Whether the stage allows insecure RTMP ingest. This must be set to true, if ingestProtocol is set to RTMP. Default: false.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
The IngestConfiguration that was created.
" + } + } + }, + "CreateParticipantTokenRequest":{ + "type":"structure", + "required":["stageArn"], + "members":{ + "stageArn":{ + "shape":"StageArn", + "documentation":"ARN of the stage to which this token is scoped.
" + }, + "duration":{ + "shape":"ParticipantTokenDurationMinutes", + "documentation":"Duration (in minutes), after which the token expires. Default: 720 (12 hours).
" + }, + "userId":{ + "shape":"ParticipantTokenUserId", + "documentation":"Name that can be specified to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "attributes":{ + "shape":"ParticipantTokenAttributes", + "documentation":"Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "capabilities":{ + "shape":"ParticipantTokenCapabilities", + "documentation":"Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.
The participant token that was created.
" + } + } + }, + "CreateStageRequest":{ + "type":"structure", + "members":{ + "name":{ + "shape":"StageName", + "documentation":"Optional name that can be specified for the stage being created.
" + }, + "participantTokenConfigurations":{ + "shape":"ParticipantTokenConfigurations", + "documentation":"Array of participant token configuration objects to attach to the new stage.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Configuration object for individual participant recording, to attach to the new stage.
" + } + } + }, + "CreateStageResponse":{ + "type":"structure", + "members":{ + "stage":{ + "shape":"Stage", + "documentation":"The stage that was created.
" + }, + "participantTokens":{ + "shape":"ParticipantTokenList", + "documentation":"Participant tokens attached to the stage. These correspond to the participants in the request.
Storage configuration name. The value does not need to be unique.
" + }, + "s3":{ + "shape":"S3StorageConfiguration", + "documentation":"A complex type that contains a storage configuration for where recorded video will be stored.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
The StorageConfiguration that was created.
" + } + } + }, + "DeleteEncoderConfigurationRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"EncoderConfigurationArn", + "documentation":"ARN of the EncoderConfiguration.
" + } + } + }, + "DeleteEncoderConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteIngestConfigurationRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"IngestConfigurationArn", + "documentation":"ARN of the IngestConfiguration.
" + }, + "force":{ + "shape":"Boolean", + "documentation":"Optional field to force deletion of the IngestConfiguration. If this is set to true when a participant is actively publishing, the participant is disconnected from the stage, followed by deletion of the IngestConfiguration. Default: false.
ARN of the public key to be deleted.
" + } + } + }, + "DeletePublicKeyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteStageRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"StageArn", + "documentation":"ARN of the stage to be deleted.
" + } + } + }, + "DeleteStageResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteStorageConfigurationRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"StorageConfigurationArn", + "documentation":"ARN of the storage configuration to be deleted.
" + } + } + }, + "DeleteStorageConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "Destination":{ + "type":"structure", + "required":[ + "id", + "state", + "configuration" + ], + "members":{ + "id":{ + "shape":"String", + "documentation":"Unique identifier for this destination, assigned by IVS.
" + }, + "state":{ + "shape":"DestinationState", + "documentation":"State of the Composition Destination.
" + }, + "startTime":{ + "shape":"Time", + "documentation":"UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "endTime":{ + "shape":"Time", + "documentation":"UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "configuration":{ + "shape":"DestinationConfiguration", + "documentation":"Configuration used to create this destination.
" + }, + "detail":{ + "shape":"DestinationDetail", + "documentation":"Optional details regarding the status of the destination.
" + } + }, + "documentation":"Object specifying the status of a Destination.
" + }, + "DestinationConfiguration":{ + "type":"structure", + "members":{ + "name":{ + "shape":"DestinationConfigurationName", + "documentation":"Name that can be specified to help identify the destination.
" + }, + "channel":{ + "shape":"ChannelDestinationConfiguration", + "documentation":"An IVS channel to be used for broadcasting, for server-side composition. Either a channel or an s3 must be specified.
An S3 storage configuration to be used for recording video data. Either a channel or an s3 must be specified.
Complex data type that defines destination-configuration objects.
" + }, + "DestinationConfigurationList":{ + "type":"list", + "member":{"shape":"DestinationConfiguration"}, + "max":2, + "min":1 + }, + "DestinationConfigurationName":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[a-zA-Z0-9-_]*" + }, + "DestinationDetail":{ + "type":"structure", + "members":{ + "s3":{ + "shape":"S3Detail", + "documentation":"An S3 detail object to return information about the S3 destination.
" + } + }, + "documentation":"Complex data type that defines destination-detail objects.
" + }, + "DestinationList":{ + "type":"list", + "member":{"shape":"Destination"}, + "max":2, + "min":1 + }, + "DestinationState":{ + "type":"string", + "enum":[ + "STARTING", + "ACTIVE", + "STOPPING", + "RECONNECTING", + "FAILED", + "STOPPED" + ] + }, + "DestinationSummary":{ + "type":"structure", + "required":[ + "id", + "state" + ], + "members":{ + "id":{ + "shape":"String", + "documentation":"Unique identifier for this destination, assigned by IVS.
" + }, + "state":{ + "shape":"DestinationState", + "documentation":"State of the Composition Destination.
" + }, + "startTime":{ + "shape":"Time", + "documentation":"UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "endTime":{ + "shape":"Time", + "documentation":"UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.
" + } + }, + "documentation":"Summary information about a Destination.
" + }, + "DestinationSummaryList":{ + "type":"list", + "member":{"shape":"DestinationSummary"}, + "max":2, + "min":1 + }, + "DisconnectParticipantReason":{ + "type":"string", + "max":128, + "min":0 + }, + "DisconnectParticipantRequest":{ + "type":"structure", + "required":[ + "stageArn", + "participantId" + ], + "members":{ + "stageArn":{ + "shape":"StageArn", + "documentation":"ARN of the stage to which the participant is attached.
" + }, + "participantId":{ + "shape":"ParticipantTokenId", + "documentation":"Identifier of the participant to be disconnected. IVS assigns this; it is returned by CreateParticipantToken (for streams using WebRTC ingest) or CreateIngestConfiguration (for streams using RTMP ingest).
" + }, + "reason":{ + "shape":"DisconnectParticipantReason", + "documentation":"Description of why this participant is being disconnected.
" + } + } + }, + "DisconnectParticipantResponse":{ + "type":"structure", + "members":{ + } + }, + "EncoderConfiguration":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"EncoderConfigurationArn", + "documentation":"ARN of the EncoderConfiguration resource.
" + }, + "name":{ + "shape":"EncoderConfigurationName", + "documentation":"Optional name to identify the resource.
" + }, + "video":{ + "shape":"Video", + "documentation":"Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Settings for transcoding.
" + }, + "EncoderConfigurationArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:encoder-configuration/[a-zA-Z0-9-]+" + }, + "EncoderConfigurationArnList":{ + "type":"list", + "member":{"shape":"EncoderConfigurationArn"}, + "max":1, + "min":1 + }, + "EncoderConfigurationName":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[a-zA-Z0-9-_]*" + }, + "EncoderConfigurationSummary":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"EncoderConfigurationArn", + "documentation":"ARN of the EncoderConfiguration resource.
" + }, + "name":{ + "shape":"EncoderConfigurationName", + "documentation":"Optional name to identify the resource.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Summary information about an EncoderConfiguration.
" + }, + "EncoderConfigurationSummaryList":{ + "type":"list", + "member":{"shape":"EncoderConfigurationSummary"} + }, + "Event":{ + "type":"structure", + "members":{ + "name":{ + "shape":"EventName", + "documentation":"The name of the event.
" + }, + "participantId":{ + "shape":"ParticipantId", + "documentation":"Unique identifier for the participant who triggered the event. This is assigned by IVS.
" + }, + "eventTime":{ + "shape":"Time", + "documentation":"ISO 8601 timestamp (returned as a string) for when the event occurred.
" + }, + "remoteParticipantId":{ + "shape":"ParticipantId", + "documentation":"Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.
" + }, + "errorCode":{ + "shape":"EventErrorCode", + "documentation":"If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.
An occurrence during a stage session.
" + }, + "EventErrorCode":{ + "type":"string", + "enum":[ + "INSUFFICIENT_CAPABILITIES", + "QUOTA_EXCEEDED", + "PUBLISHER_NOT_FOUND", + "BITRATE_EXCEEDED", + "RESOLUTION_EXCEEDED", + "STREAM_DURATION_EXCEEDED", + "INVALID_AUDIO_CODEC", + "INVALID_VIDEO_CODEC", + "INVALID_PROTOCOL", + "INVALID_STREAM_KEY", + "REUSE_OF_STREAM_KEY" + ] + }, + "EventList":{ + "type":"list", + "member":{"shape":"Event"} + }, + "EventName":{ + "type":"string", + "enum":[ + "JOINED", + "LEFT", + "PUBLISH_STARTED", + "PUBLISH_STOPPED", + "SUBSCRIBE_STARTED", + "SUBSCRIBE_STOPPED", + "PUBLISH_ERROR", + "SUBSCRIBE_ERROR", + "JOIN_ERROR" + ] + }, + "Framerate":{ + "type":"float", + "box":true, + "max":60, + "min":1 + }, + "GetCompositionRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"CompositionArn", + "documentation":"ARN of the Composition resource.
" + } + } + }, + "GetCompositionResponse":{ + "type":"structure", + "members":{ + "composition":{ + "shape":"Composition", + "documentation":"The Composition that was returned.
" + } + } + }, + "GetEncoderConfigurationRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"EncoderConfigurationArn", + "documentation":"ARN of the EncoderConfiguration resource.
" + } + } + }, + "GetEncoderConfigurationResponse":{ + "type":"structure", + "members":{ + "encoderConfiguration":{ + "shape":"EncoderConfiguration", + "documentation":"The EncoderConfiguration that was returned.
" + } + } + }, + "GetIngestConfigurationRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"IngestConfigurationArn", + "documentation":"ARN of the ingest for which the information is to be retrieved.
" + } + } + }, + "GetIngestConfigurationResponse":{ + "type":"structure", + "members":{ + "ingestConfiguration":{ + "shape":"IngestConfiguration", + "documentation":"The IngestConfiguration that was returned.
" + } + } + }, + "GetParticipantRequest":{ + "type":"structure", + "required":[ + "stageArn", + "sessionId", + "participantId" + ], + "members":{ + "stageArn":{ + "shape":"StageArn", + "documentation":"Stage ARN.
" + }, + "sessionId":{ + "shape":"StageSessionId", + "documentation":"ID of a session within the stage.
" + }, + "participantId":{ + "shape":"ParticipantId", + "documentation":"Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken.
" + } + } + }, + "GetParticipantResponse":{ + "type":"structure", + "members":{ + "participant":{ + "shape":"Participant", + "documentation":"The participant that is returned.
" + } + } + }, + "GetPublicKeyRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"PublicKeyArn", + "documentation":"ARN of the public key for which the information is to be retrieved.
" + } + } + }, + "GetPublicKeyResponse":{ + "type":"structure", + "members":{ + "publicKey":{ + "shape":"PublicKey", + "documentation":"The public key that is returned.
" + } + } + }, + "GetStageRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"StageArn", + "documentation":"ARN of the stage for which the information is to be retrieved.
" + } + } + }, + "GetStageResponse":{ + "type":"structure", + "members":{ + "stage":{ + "shape":"Stage", + "documentation":"The stage that is returned.
" + } + } + }, + "GetStageSessionRequest":{ + "type":"structure", + "required":[ + "stageArn", + "sessionId" + ], + "members":{ + "stageArn":{ + "shape":"StageArn", + "documentation":"ARN of the stage for which the information is to be retrieved.
" + }, + "sessionId":{ + "shape":"StageSessionId", + "documentation":"ID of a session within the stage.
" + } + } + }, + "GetStageSessionResponse":{ + "type":"structure", + "members":{ + "stageSession":{ + "shape":"StageSession", + "documentation":"The stage session that is returned.
" + } + } + }, + "GetStorageConfigurationRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"StorageConfigurationArn", + "documentation":"ARN of the storage configuration to be retrieved.
" + } + } + }, + "GetStorageConfigurationResponse":{ + "type":"structure", + "members":{ + "storageConfiguration":{ + "shape":"StorageConfiguration", + "documentation":"The StorageConfiguration that was returned.
" + } + } + }, + "GridConfiguration":{ + "type":"structure", + "members":{ + "featuredParticipantAttribute":{ + "shape":"AttributeKey", + "documentation":"This attribute name identifies the featured slot. A participant with this attribute set to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: \"\" (no featured participant).
Determines whether to omit participants with stopped video in the composition. Default: false.
Sets the non-featured participant display mode, to control the aspect ratio of video tiles. VIDEO is 16:9, SQUARE is 1:1, and PORTRAIT is 3:4. Default: VIDEO.
Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.
Specifies the spacing between participant tiles in pixels. Default: 2.
Configuration information specific to Grid layout, for server-side composition. See \"Layouts\" in Server-Side Composition.
" + }, + "GridGap":{ + "type":"integer", + "min":0 + }, + "Height":{ + "type":"integer", + "box":true, + "max":1920, + "min":1 + }, + "ImportPublicKeyRequest":{ + "type":"structure", + "required":["publicKeyMaterial"], + "members":{ + "publicKeyMaterial":{ + "shape":"PublicKeyMaterial", + "documentation":"The content of the public key to be imported.
" + }, + "name":{ + "shape":"PublicKeyName", + "documentation":"Name of the public key to be imported.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
The public key that was imported.
" + } + } + }, + "IngestConfiguration":{ + "type":"structure", + "required":[ + "arn", + "ingestProtocol", + "streamKey", + "stageArn", + "participantId", + "state" + ], + "members":{ + "name":{ + "shape":"IngestConfigurationName", + "documentation":"Ingest name
" + }, + "arn":{ + "shape":"IngestConfigurationArn", + "documentation":"Ingest configuration ARN.
" + }, + "ingestProtocol":{ + "shape":"IngestProtocol", + "documentation":"Type of ingest protocol that the user employs for broadcasting.
" + }, + "streamKey":{ + "shape":"StreamKey", + "documentation":"Ingest-key value for the RTMP(S) protocol.
" + }, + "stageArn":{ + "shape":"IngestConfigurationStageArn", + "documentation":"ARN of the stage with which the IngestConfiguration is associated.
" + }, + "participantId":{ + "shape":"ParticipantId", + "documentation":"ID of the participant within the stage.
" + }, + "state":{ + "shape":"IngestConfigurationState", + "documentation":"State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.
Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "attributes":{ + "shape":"ParticipantAttributes", + "documentation":"Application-provided attributes to to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Object specifying an ingest configuration.
" + }, + "IngestConfigurationArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:ingest-configuration/[a-zA-Z0-9-]+" + }, + "IngestConfigurationList":{ + "type":"list", + "member":{"shape":"IngestConfigurationSummary"} + }, + "IngestConfigurationName":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[a-zA-Z0-9-_]*" + }, + "IngestConfigurationStageArn":{ + "type":"string", + "max":128, + "min":0, + "pattern":"^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$" + }, + "IngestConfigurationState":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE" + ] + }, + "IngestConfigurationSummary":{ + "type":"structure", + "required":[ + "arn", + "ingestProtocol", + "stageArn", + "participantId", + "state" + ], + "members":{ + "name":{ + "shape":"IngestConfigurationName", + "documentation":"Ingest name.
" + }, + "arn":{ + "shape":"IngestConfigurationArn", + "documentation":"Ingest configuration ARN.
" + }, + "ingestProtocol":{ + "shape":"IngestProtocol", + "documentation":"Type of ingest protocol that the user employs for broadcasting.
" + }, + "stageArn":{ + "shape":"IngestConfigurationStageArn", + "documentation":"ARN of the stage with which the IngestConfiguration is associated.
" + }, + "participantId":{ + "shape":"ParticipantId", + "documentation":"ID of the participant within the stage.
" + }, + "state":{ + "shape":"IngestConfigurationState", + "documentation":"State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.
Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + } + }, + "documentation":"Summary information about an IngestConfiguration.
" + }, + "IngestProtocol":{ + "type":"string", + "enum":[ + "RTMP", + "RTMPS" + ] + }, + "InsecureIngest":{"type":"boolean"}, + "InternalServerException":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"Unexpected error during processing of request.
" + } + }, + "documentation":"", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "LayoutConfiguration":{ + "type":"structure", + "members":{ + "grid":{ + "shape":"GridConfiguration", + "documentation":"Configuration related to grid layout. Default: Grid layout.
" + }, + "pip":{ + "shape":"PipConfiguration", + "documentation":"Configuration related to PiP layout.
" + } + }, + "documentation":"Configuration information of supported layouts for server-side composition.
" + }, + "ListCompositionsRequest":{ + "type":"structure", + "members":{ + "filterByStageArn":{ + "shape":"StageArn", + "documentation":"Filters the Composition list to match the specified Stage ARN.
" + }, + "filterByEncoderConfigurationArn":{ + "shape":"EncoderConfigurationArn", + "documentation":"Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first Composition to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of results to return. Default: 100.
" + } + } + }, + "ListCompositionsResponse":{ + "type":"structure", + "required":["compositions"], + "members":{ + "compositions":{ + "shape":"CompositionSummaryList", + "documentation":"List of the matching Compositions (summary information only).
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more compositions than maxResults, use nextToken in the request to get the next set.
The first encoder configuration to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of results to return. Default: 100.
" + } + } + }, + "ListEncoderConfigurationsResponse":{ + "type":"structure", + "required":["encoderConfigurations"], + "members":{ + "encoderConfigurations":{ + "shape":"EncoderConfigurationSummaryList", + "documentation":"List of the matching EncoderConfigurations (summary information only).
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more encoder configurations than maxResults, use nextToken in the request to get the next set.
Filters the response list to match the specified stage ARN. Only one filter (by stage ARN or by state) can be used at a time.
" + }, + "filterByState":{ + "shape":"IngestConfigurationState", + "documentation":"Filters the response list to match the specified state. Only one filter (by stage ARN or by state) can be used at a time.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first IngestConfiguration to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of results to return. Default: 50.
" + } + } + }, + "ListIngestConfigurationsResponse":{ + "type":"structure", + "required":["ingestConfigurations"], + "members":{ + "ingestConfigurations":{ + "shape":"IngestConfigurationList", + "documentation":"List of the matching ingest configurations (summary information only).
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more IngestConfigurations than maxResults, use nextToken in the request to get the next set.
Stage ARN.
" + }, + "sessionId":{ + "shape":"StageSessionId", + "documentation":"ID of a session within the stage.
" + }, + "participantId":{ + "shape":"ParticipantId", + "documentation":"Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first participant event to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of results to return. Default: 50.
" + } + } + }, + "ListParticipantEventsResponse":{ + "type":"structure", + "required":["events"], + "members":{ + "events":{ + "shape":"EventList", + "documentation":"List of the matching events.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more events than maxResults, use nextToken in the request to get the next set.
Stage ARN.
" + }, + "sessionId":{ + "shape":"StageSessionId", + "documentation":"ID of the session within the stage.
" + }, + "filterByUserId":{ + "shape":"UserId", + "documentation":"Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.
Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
The first participant to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of results to return. Default: 50.
" + }, + "filterByRecordingState":{ + "shape":"ParticipantRecordingFilterByRecordingState", + "documentation":"Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
List of the matching participants (summary information only).
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more participants than maxResults, use nextToken in the request to get the next set.
The first public key to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of results to return. Default: 50.
" + } + } + }, + "ListPublicKeysResponse":{ + "type":"structure", + "required":["publicKeys"], + "members":{ + "publicKeys":{ + "shape":"PublicKeyList", + "documentation":"List of the matching public keys (summary information only).
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more public keys than maxResults, use nextToken in the request to get the next set.
Stage ARN.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first stage session to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of results to return. Default: 50.
" + } + } + }, + "ListStageSessionsResponse":{ + "type":"structure", + "required":["stageSessions"], + "members":{ + "stageSessions":{ + "shape":"StageSessionList", + "documentation":"List of matching stage sessions.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more stage sessions than maxResults, use nextToken in the request to get the next set.
The first stage to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of results to return. Default: 50.
" + } + } + }, + "ListStagesResponse":{ + "type":"structure", + "required":["stages"], + "members":{ + "stages":{ + "shape":"StageSummaryList", + "documentation":"List of the matching stages (summary information only).
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more stages than maxResults, use nextToken in the request to get the next set.
The first storage configuration to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of storage configurations to return. Default: your service quota or 100, whichever is smaller.
" + } + } + }, + "ListStorageConfigurationsResponse":{ + "type":"structure", + "required":["storageConfigurations"], + "members":{ + "storageConfigurations":{ + "shape":"StorageConfigurationSummaryList", + "documentation":"List of the matching storage configurations.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more storage configurations than maxResults, use nextToken in the request to get the next set.
The ARN of the resource to be retrieved. The ARN must be URL-encoded.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Unique identifier for this participant, assigned by IVS.
" + }, + "userId":{ + "shape":"UserId", + "documentation":"Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "state":{ + "shape":"ParticipantState", + "documentation":"Whether the participant is connected to or disconnected from the stage.
" + }, + "firstJoinTime":{ + "shape":"Time", + "documentation":"ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
" + }, + "attributes":{ + "shape":"ParticipantAttributes", + "documentation":"Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "published":{ + "shape":"Published", + "documentation":"Whether the participant ever published to the stage session.
" + }, + "ispName":{ + "shape":"ParticipantClientAttribute", + "documentation":"The participant’s Internet Service Provider.
" + }, + "osName":{ + "shape":"ParticipantClientAttribute", + "documentation":"The participant’s operating system.
" + }, + "osVersion":{ + "shape":"ParticipantClientAttribute", + "documentation":"The participant’s operating system version.
" + }, + "browserName":{ + "shape":"ParticipantClientAttribute", + "documentation":"The participant’s browser.
" + }, + "browserVersion":{ + "shape":"ParticipantClientAttribute", + "documentation":"The participant’s browser version.
" + }, + "sdkVersion":{ + "shape":"ParticipantClientAttribute", + "documentation":"The participant’s SDK version.
" + }, + "recordingS3BucketName":{ + "shape":"ParticipantRecordingS3BucketName", + "documentation":"Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or \"\" (empty string), if recording is not enabled.
S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or \"\" (empty string), if recording is not enabled.
The participant’s recording state.
" + }, + "protocol":{ + "shape":"ParticipantProtocol", + "documentation":"Type of ingest protocol that the participant employs for broadcasting.
" + } + }, + "documentation":"Object describing a participant that has joined a stage.
" + }, + "ParticipantAttributes":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "ParticipantClientAttribute":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[a-zA-Z0-9-_.,:;\\s]*" + }, + "ParticipantId":{ + "type":"string", + "max":64, + "min":0, + "pattern":"[a-zA-Z0-9-]*" + }, + "ParticipantList":{ + "type":"list", + "member":{"shape":"ParticipantSummary"} + }, + "ParticipantProtocol":{ + "type":"string", + "enum":[ + "UNKNOWN", + "WHIP", + "RTMP", + "RTMPS" + ] + }, + "ParticipantRecordingFilterByRecordingState":{ + "type":"string", + "enum":[ + "STARTING", + "ACTIVE", + "STOPPING", + "STOPPED", + "FAILED" + ] + }, + "ParticipantRecordingMediaType":{ + "type":"string", + "enum":[ + "AUDIO_VIDEO", + "AUDIO_ONLY" + ] + }, + "ParticipantRecordingMediaTypeList":{ + "type":"list", + "member":{"shape":"ParticipantRecordingMediaType"}, + "max":1, + "min":0 + }, + "ParticipantRecordingS3BucketName":{ + "type":"string", + "max":63, + "min":0, + "pattern":"[a-z0-9-.]*" + }, + "ParticipantRecordingS3Prefix":{ + "type":"string", + "max":256, + "min":0, + "pattern":"[a-zA-Z0-9-]*" + }, + "ParticipantRecordingState":{ + "type":"string", + "enum":[ + "STARTING", + "ACTIVE", + "STOPPING", + "STOPPED", + "FAILED", + "DISABLED" + ] + }, + "ParticipantState":{ + "type":"string", + "enum":[ + "CONNECTED", + "DISCONNECTED" + ] + }, + "ParticipantSummary":{ + "type":"structure", + "members":{ + "participantId":{ + "shape":"ParticipantId", + "documentation":"Unique identifier for this participant, assigned by IVS.
" + }, + "userId":{ + "shape":"UserId", + "documentation":"Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "state":{ + "shape":"ParticipantState", + "documentation":"Whether the participant is connected to or disconnected from the stage.
" + }, + "firstJoinTime":{ + "shape":"Time", + "documentation":"ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
" + }, + "published":{ + "shape":"Published", + "documentation":"Whether the participant ever published to the stage session.
" + }, + "recordingState":{ + "shape":"ParticipantRecordingState", + "documentation":"The participant’s recording state.
" + } + }, + "documentation":"Summary object describing a participant that has joined a stage.
" + }, + "ParticipantToken":{ + "type":"structure", + "members":{ + "participantId":{ + "shape":"ParticipantTokenId", + "documentation":"Unique identifier for this participant token, assigned by IVS.
" + }, + "token":{ + "shape":"ParticipantTokenString", + "documentation":"The issued client token, encrypted.
" + }, + "userId":{ + "shape":"ParticipantTokenUserId", + "documentation":"Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "attributes":{ + "shape":"ParticipantTokenAttributes", + "documentation":"Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "duration":{ + "shape":"ParticipantTokenDurationMinutes", + "documentation":"Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).
" + }, + "capabilities":{ + "shape":"ParticipantTokenCapabilities", + "documentation":"Set of capabilities that the user is allowed to perform in the stage.
" + }, + "expirationTime":{ + "shape":"ParticipantTokenExpirationTime", + "documentation":"ISO 8601 timestamp (returned as a string) for when this token expires.
" + } + }, + "documentation":"Object specifying a participant token in a stage.
Important: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.
" + }, + "ParticipantTokenAttributes":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "ParticipantTokenCapabilities":{ + "type":"list", + "member":{"shape":"ParticipantTokenCapability"}, + "max":2, + "min":0 + }, + "ParticipantTokenCapability":{ + "type":"string", + "enum":[ + "PUBLISH", + "SUBSCRIBE" + ] + }, + "ParticipantTokenConfiguration":{ + "type":"structure", + "members":{ + "duration":{ + "shape":"ParticipantTokenDurationMinutes", + "documentation":"Duration (in minutes), after which the corresponding participant token expires. Default: 720 (12 hours).
" + }, + "userId":{ + "shape":"ParticipantTokenUserId", + "documentation":"Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "attributes":{ + "shape":"ParticipantTokenAttributes", + "documentation":"Application-provided attributes to encode into the corresponding participant token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "capabilities":{ + "shape":"ParticipantTokenCapabilities", + "documentation":"Set of capabilities that the user is allowed to perform in the stage.
" + } + }, + "documentation":"Object specifying a participant token configuration in a stage.
" + }, + "ParticipantTokenConfigurations":{ + "type":"list", + "member":{"shape":"ParticipantTokenConfiguration"}, + "max":12, + "min":0 + }, + "ParticipantTokenDurationMinutes":{ + "type":"integer", + "box":true, + "max":20160, + "min":1 + }, + "ParticipantTokenExpirationTime":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "ParticipantTokenId":{"type":"string"}, + "ParticipantTokenList":{ + "type":"list", + "member":{"shape":"ParticipantToken"} + }, + "ParticipantTokenString":{ + "type":"string", + "sensitive":true + }, + "ParticipantTokenUserId":{ + "type":"string", + "max":128, + "min":0 + }, + "PendingVerification":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"Your account is pending verification.
" + } + }, + "documentation":"", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "PipBehavior":{ + "type":"string", + "enum":[ + "STATIC", + "DYNAMIC" + ] + }, + "PipConfiguration":{ + "type":"structure", + "members":{ + "featuredParticipantAttribute":{ + "shape":"AttributeKey", + "documentation":"This attribute name identifies the featured slot. A participant with this attribute set to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: \"\" (no featured participant).
Determines whether to omit participants with stopped video in the composition. Default: false.
Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.
Specifies the spacing between participant tiles in pixels. Default: 0.
Specifies the participant for the PiP window. A participant with this attribute set to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot. Default: \"\" (no PiP participant).
Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.
Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.
Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.
Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.
Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.
Configuration information specific to Picture-in-Picture (PiP) layout, for server-side composition.
" + }, + "PipHeight":{ + "type":"integer", + "box":true, + "min":1 + }, + "PipOffset":{ + "type":"integer", + "min":0 + }, + "PipPosition":{ + "type":"string", + "enum":[ + "TOP_LEFT", + "TOP_RIGHT", + "BOTTOM_LEFT", + "BOTTOM_RIGHT" + ] + }, + "PipWidth":{ + "type":"integer", + "box":true, + "min":1 + }, + "PublicKey":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"PublicKeyArn", + "documentation":"Public key ARN.
" + }, + "name":{ + "shape":"PublicKeyName", + "documentation":"Public key name.
" + }, + "publicKeyMaterial":{ + "shape":"PublicKeyMaterial", + "documentation":"Public key material.
" + }, + "fingerprint":{ + "shape":"PublicKeyFingerprint", + "documentation":"The public key fingerprint, a short string used to identify or verify the full public key.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Object specifying a public key used to sign stage participant tokens.
" + }, + "PublicKeyArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:public-key/[a-zA-Z0-9-]+" + }, + "PublicKeyFingerprint":{"type":"string"}, + "PublicKeyList":{ + "type":"list", + "member":{"shape":"PublicKeySummary"} + }, + "PublicKeyMaterial":{ + "type":"string", + "pattern":".*-----BEGIN PUBLIC KEY-----\\r?\\n([a-zA-Z0-9+/=\\r\\n]+)\\r?\\n-----END PUBLIC KEY-----(\\r?\\n)?.*" + }, + "PublicKeyName":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[a-zA-Z0-9-_]*" + }, + "PublicKeySummary":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"PublicKeyArn", + "documentation":"Public key ARN.
" + }, + "name":{ + "shape":"PublicKeyName", + "documentation":"Public key name.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Summary information about a public key.
" + }, + "Published":{"type":"boolean"}, + "RecordingConfiguration":{ + "type":"structure", + "members":{ + "format":{ + "shape":"RecordingConfigurationFormat", + "documentation":"The recording format for storing a recording in Amazon S3.
" + } + }, + "documentation":"An object representing a configuration to record a stage stream.
" + }, + "RecordingConfigurationFormat":{ + "type":"string", + "enum":["HLS"] + }, + "ResourceArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"Request references a resource which does not exist.
" + } + }, + "documentation":"", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "S3BucketName":{ + "type":"string", + "max":63, + "min":3, + "pattern":"[a-z0-9-.]+" + }, + "S3DestinationConfiguration":{ + "type":"structure", + "required":[ + "storageConfigurationArn", + "encoderConfigurationArns" + ], + "members":{ + "storageConfigurationArn":{ + "shape":"StorageConfigurationArn", + "documentation":"ARN of the StorageConfiguration where recorded videos will be stored.
" + }, + "encoderConfigurationArns":{ + "shape":"EncoderConfigurationArnList", + "documentation":"ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.
" + }, + "recordingConfiguration":{ + "shape":"RecordingConfiguration", + "documentation":"Array of maps, each of the form string:string (key:value). This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.
A complex type that describes an S3 location where recorded videos will be stored.
" + }, + "S3Detail":{ + "type":"structure", + "required":["recordingPrefix"], + "members":{ + "recordingPrefix":{ + "shape":"String", + "documentation":"The S3 bucket prefix under which the recording is stored.
" + } + }, + "documentation":"Complex data type that defines S3Detail objects.
" + }, + "S3StorageConfiguration":{ + "type":"structure", + "required":["bucketName"], + "members":{ + "bucketName":{ + "shape":"S3BucketName", + "documentation":"Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.
" + } + }, + "documentation":"A complex type that describes an S3 location where recorded videos will be stored.
" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"Request would cause a service quota to be exceeded.
" + } + }, + "documentation":"", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "Stage":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"StageArn", + "documentation":"Stage ARN.
" + }, + "name":{ + "shape":"StageName", + "documentation":"Stage name.
" + }, + "activeSessionId":{ + "shape":"StageSessionId", + "documentation":"ID of the active session within the stage.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Configuration object for individual participant recording, attached to the stage.
" + }, + "endpoints":{ + "shape":"StageEndpoints", + "documentation":"Summary information about various endpoints for a stage.
" + } + }, + "documentation":"Object specifying a stage.
" + }, + "StageArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+" + }, + "StageEndpoint":{ + "type":"string", + "max":2048, + "min":0 + }, + "StageEndpoints":{ + "type":"structure", + "members":{ + "events":{ + "shape":"StageEndpoint", + "documentation":"Events endpoint.
" + }, + "whip":{ + "shape":"StageEndpoint", + "documentation":"The endpoint to be used for IVS real-time streaming using the WHIP protocol.
" + }, + "rtmp":{ + "shape":"StageEndpoint", + "documentation":"The endpoint to be used for IVS real-time streaming using the RTMP protocol.
" + }, + "rtmps":{ + "shape":"StageEndpoint", + "documentation":"The endpoint to be used for IVS real-time streaming using the RTMPS protocol.
" + } + }, + "documentation":"Summary information about various endpoints for a stage. We recommend that you cache these values at stage creation; the values can be cached for up to 14 days.
" + }, + "StageName":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[a-zA-Z0-9-_]*" + }, + "StageSession":{ + "type":"structure", + "members":{ + "sessionId":{ + "shape":"StageSessionId", + "documentation":"ID of the session within the stage.
" + }, + "startTime":{ + "shape":"Time", + "documentation":"ISO 8601 timestamp (returned as a string) when this stage session began.
" + }, + "endTime":{ + "shape":"Time", + "documentation":"ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.
" + } + }, + "documentation":"A stage session begins when the first participant joins a stage and ends after the last participant leaves the stage. A stage session helps with debugging stages by grouping events and participants into shorter periods of time (i.e., a session), which is helpful when stages are used over long periods of time.
" + }, + "StageSessionId":{ + "type":"string", + "max":16, + "min":16, + "pattern":"st-[a-zA-Z0-9]+" + }, + "StageSessionList":{ + "type":"list", + "member":{"shape":"StageSessionSummary"} + }, + "StageSessionSummary":{ + "type":"structure", + "members":{ + "sessionId":{ + "shape":"StageSessionId", + "documentation":"ID of the session within the stage.
" + }, + "startTime":{ + "shape":"Time", + "documentation":"ISO 8601 timestamp (returned as a string) when this stage session began.
" + }, + "endTime":{ + "shape":"Time", + "documentation":"ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.
" + } + }, + "documentation":"Summary information about a stage session.
" + }, + "StageSummary":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"StageArn", + "documentation":"Stage ARN.
" + }, + "name":{ + "shape":"StageName", + "documentation":"Stage name.
" + }, + "activeSessionId":{ + "shape":"StageSessionId", + "documentation":"ID of the active session within the stage.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Summary information about a stage.
" + }, + "StageSummaryList":{ + "type":"list", + "member":{"shape":"StageSummary"} + }, + "StartCompositionRequest":{ + "type":"structure", + "required":[ + "stageArn", + "destinations" + ], + "members":{ + "stageArn":{ + "shape":"StageArn", + "documentation":"ARN of the stage to be used for compositing.
" + }, + "idempotencyToken":{ + "shape":"CompositionClientToken", + "documentation":"Idempotency token.
", + "idempotencyToken":true + }, + "layout":{ + "shape":"LayoutConfiguration", + "documentation":"Layout object to configure composition parameters.
" + }, + "destinations":{ + "shape":"DestinationConfigurationList", + "documentation":"Array of destination configuration.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
The Composition that was created.
" + } + } + }, + "StopCompositionRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"CompositionArn", + "documentation":"ARN of the Composition.
" + } + } + }, + "StopCompositionResponse":{ + "type":"structure", + "members":{ + } + }, + "StorageConfiguration":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"StorageConfigurationArn", + "documentation":"ARN of the storage configuration.
" + }, + "name":{ + "shape":"StorageConfigurationName", + "documentation":"Name of the storage configuration.
" + }, + "s3":{ + "shape":"S3StorageConfiguration", + "documentation":"An S3 destination configuration where recorded videos will be stored.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
A complex type that describes a location where recorded videos will be stored.
" + }, + "StorageConfigurationArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:storage-configuration/[a-zA-Z0-9-]+" + }, + "StorageConfigurationName":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[a-zA-Z0-9-_]*" + }, + "StorageConfigurationSummary":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"StorageConfigurationArn", + "documentation":"ARN of the storage configuration.
" + }, + "name":{ + "shape":"StorageConfigurationName", + "documentation":"Name of the storage configuration.
" + }, + "s3":{ + "shape":"S3StorageConfiguration", + "documentation":"An S3 destination configuration where recorded videos will be stored.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Summary information about a storage configuration.
" + }, + "StorageConfigurationSummaryList":{ + "type":"list", + "member":{"shape":"StorageConfigurationSummary"} + }, + "StreamKey":{ + "type":"string", + "pattern":"rt_[0-9]+_[a-z0-9-]+_[a-zA-Z0-9-]+_.+", + "sensitive":true + }, + "String":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"The ARN of the resource to be tagged. The ARN must be URL-encoded.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"Tags", + "documentation":"Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
The ARN of the resource to be untagged. The ARN must be URL-encoded.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"Array of tags to be removed. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
ARN of the IngestConfiguration, for which the related stage ARN needs to be updated.
" + }, + "stageArn":{ + "shape":"IngestConfigurationStageArn", + "documentation":"Stage ARN that needs to be updated.
" + } + } + }, + "UpdateIngestConfigurationResponse":{ + "type":"structure", + "members":{ + "ingestConfiguration":{ + "shape":"IngestConfiguration", + "documentation":"The updated IngestConfiguration.
" + } + } + }, + "UpdateStageRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"StageArn", + "documentation":"ARN of the stage to be updated.
" + }, + "name":{ + "shape":"StageName", + "documentation":"Name of the stage to be updated.
" + }, + "autoParticipantRecordingConfiguration":{ + "shape":"AutoParticipantRecordingConfiguration", + "documentation":"Configuration object for individual participant recording, to attach to the stage. Note that this cannot be updated while recording is active.
" + } + } + }, + "UpdateStageResponse":{ + "type":"structure", + "members":{ + "stage":{ + "shape":"Stage", + "documentation":"The updated stage.
" + } + } + }, + "UserId":{ + "type":"string", + "max":128, + "min":0 + }, + "ValidationException":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
" + } + }, + "documentation":"", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Video":{ + "type":"structure", + "members":{ + "width":{ + "shape":"Width", + "documentation":"Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.
Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.
Video frame rate, in fps. Default: 30.
" + }, + "bitrate":{ + "shape":"Bitrate", + "documentation":"Bitrate for generated output, in bps. Default: 2500000.
" + } + }, + "documentation":"Settings for video.
" + }, + "VideoAspectRatio":{ + "type":"string", + "enum":[ + "AUTO", + "VIDEO", + "SQUARE", + "PORTRAIT" + ] + }, + "VideoFillMode":{ + "type":"string", + "enum":[ + "FILL", + "COVER", + "CONTAIN" + ] + }, + "Width":{ + "type":"integer", + "box":true, + "max":1920, + "min":1 + }, + "errorMessage":{"type":"string"} + }, + "documentation":"The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
Key Concepts
Stage — A virtual space where participants can exchange video in real time.
Participant token — A token that authenticates a participant when they join a stage.
Participant object — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.
For server-side composition:
Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process.
Composition — Controls the look of the outputs, including how participants are positioned in the video.
For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS real-time API has these tag-related operations: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
" +} diff --git a/testbed/boto__botocore/botocore/data/ivs-realtime/2020-07-14/waiters-2.json b/testbed/boto__botocore/botocore/data/ivs-realtime/2020-07-14/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..13f60ee66be6a3d75208653e2bd7b563561adacc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/ivs-realtime/2020-07-14/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/testbed/boto__botocore/botocore/data/ivschat/2020-07-14/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/ivschat/2020-07-14/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..d59a79dc4dff4b4cc25a197499441d5e35ce09cd --- /dev/null +++ b/testbed/boto__botocore/botocore/data/ivschat/2020-07-14/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ivschat-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ivschat-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ivschat.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://ivschat.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/ivschat/2020-07-14/examples-1.json b/testbed/boto__botocore/botocore/data/ivschat/2020-07-14/examples-1.json new file mode 100644 index 0000000000000000000000000000000000000000..0ea7e3b0bbe917eb027880396ac01509becd1fa0 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/ivschat/2020-07-14/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/testbed/boto__botocore/botocore/data/ivschat/2020-07-14/paginators-1.json b/testbed/boto__botocore/botocore/data/ivschat/2020-07-14/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..ea142457a6a77d6e6a54942329f1199bc2f2a60c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/ivschat/2020-07-14/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/testbed/boto__botocore/botocore/data/ivschat/2020-07-14/service-2.json b/testbed/boto__botocore/botocore/data/ivschat/2020-07-14/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..d7721c68452db156792ae1b826570e0e6979dee8 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/ivschat/2020-07-14/service-2.json @@ -0,0 +1,1552 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-07-14", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"ivschat", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceAbbreviation":"ivschat", + "serviceFullName":"Amazon Interactive Video Service Chat", + "serviceId":"ivschat", + "signatureVersion":"v4", + "signingName":"ivschat", + "uid":"ivschat-2020-07-14" + }, + "operations":{ + "CreateChatToken":{ + "name":"CreateChatToken", + "http":{ + "method":"POST", + "requestUri":"/CreateChatToken", + "responseCode":200 + }, + "input":{"shape":"CreateChatTokenRequest"}, + "output":{"shape":"CreateChatTokenResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"PendingVerification"}, + {"shape":"ValidationException"} + ], + "documentation":"Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.
Use the capabilities field to permit an end user to send messages or moderate a room.
The attributes field securely attaches structured data to the chat session; the data is included within each message sent by the end user and received by other participants in the room. Common use cases for attributes include passing end-user profile data like an icon, display name, colors, badges, and other display features.
Encryption keys are owned by Amazon IVS Chat and never used directly by your application.
" + }, + "CreateLoggingConfiguration":{ + "name":"CreateLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/CreateLoggingConfiguration", + "responseCode":200 + }, + "input":{"shape":"CreateLoggingConfigurationRequest"}, + "output":{"shape":"CreateLoggingConfigurationResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"PendingVerification"}, + {"shape":"ValidationException"} + ], + "documentation":"Creates a logging configuration that allows clients to store and record sent messages.
" + }, + "CreateRoom":{ + "name":"CreateRoom", + "http":{ + "method":"POST", + "requestUri":"/CreateRoom", + "responseCode":200 + }, + "input":{"shape":"CreateRoomRequest"}, + "output":{"shape":"CreateRoomResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"PendingVerification"}, + {"shape":"ValidationException"} + ], + "documentation":"Creates a room that allows clients to connect and pass messages.
" + }, + "DeleteLoggingConfiguration":{ + "name":"DeleteLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/DeleteLoggingConfiguration", + "responseCode":204 + }, + "input":{"shape":"DeleteLoggingConfigurationRequest"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"PendingVerification"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes the specified logging configuration.
" + }, + "DeleteMessage":{ + "name":"DeleteMessage", + "http":{ + "method":"POST", + "requestUri":"/DeleteMessage", + "responseCode":200 + }, + "input":{"shape":"DeleteMessageRequest"}, + "output":{"shape":"DeleteMessageResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"PendingVerification"}, + {"shape":"ValidationException"} + ], + "documentation":"Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.
Deletes the specified room.
" + }, + "DisconnectUser":{ + "name":"DisconnectUser", + "http":{ + "method":"POST", + "requestUri":"/DisconnectUser", + "responseCode":200 + }, + "input":{"shape":"DisconnectUserRequest"}, + "output":{"shape":"DisconnectUserResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"PendingVerification"}, + {"shape":"ValidationException"} + ], + "documentation":"Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
" + }, + "GetLoggingConfiguration":{ + "name":"GetLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/GetLoggingConfiguration", + "responseCode":200 + }, + "input":{"shape":"GetLoggingConfigurationRequest"}, + "output":{"shape":"GetLoggingConfigurationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets the specified logging configuration.
" + }, + "GetRoom":{ + "name":"GetRoom", + "http":{ + "method":"POST", + "requestUri":"/GetRoom", + "responseCode":200 + }, + "input":{"shape":"GetRoomRequest"}, + "output":{"shape":"GetRoomResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets the specified room.
" + }, + "ListLoggingConfigurations":{ + "name":"ListLoggingConfigurations", + "http":{ + "method":"POST", + "requestUri":"/ListLoggingConfigurations", + "responseCode":200 + }, + "input":{"shape":"ListLoggingConfigurationsRequest"}, + "output":{"shape":"ListLoggingConfigurationsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets summary information about all your logging configurations in the AWS region where the API request is processed.
" + }, + "ListRooms":{ + "name":"ListRooms", + "http":{ + "method":"POST", + "requestUri":"/ListRooms", + "responseCode":200 + }, + "input":{"shape":"ListRoomsRequest"}, + "output":{"shape":"ListRoomsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.
Gets information about AWS tags for the specified ARN.
" + }, + "SendEvent":{ + "name":"SendEvent", + "http":{ + "method":"POST", + "requestUri":"/SendEvent", + "responseCode":200 + }, + "input":{"shape":"SendEventRequest"}, + "output":{"shape":"SendEventResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"PendingVerification"}, + {"shape":"ValidationException"} + ], + "documentation":"Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Adds or updates tags for the AWS resource with the specified ARN.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Removes tags from the resource with the specified ARN.
", + "idempotent":true + }, + "UpdateLoggingConfiguration":{ + "name":"UpdateLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/UpdateLoggingConfiguration", + "responseCode":200 + }, + "input":{"shape":"UpdateLoggingConfigurationRequest"}, + "output":{"shape":"UpdateLoggingConfigurationResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"PendingVerification"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates a specified logging configuration.
" + }, + "UpdateRoom":{ + "name":"UpdateRoom", + "http":{ + "method":"POST", + "requestUri":"/UpdateRoom", + "responseCode":200 + }, + "input":{"shape":"UpdateRoomRequest"}, + "output":{"shape":"UpdateRoomResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"PendingVerification"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates a room’s configuration.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "BucketName":{ + "type":"string", + "max":63, + "min":3, + "pattern":"[a-z0-9-.]+" + }, + "ChatToken":{ + "type":"string", + "sensitive":true + }, + "ChatTokenAttributes":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"}, + "sensitive":true + }, + "ChatTokenCapabilities":{ + "type":"list", + "member":{"shape":"ChatTokenCapability"} + }, + "ChatTokenCapability":{ + "type":"string", + "enum":[ + "SEND_MESSAGE", + "DISCONNECT_USER", + "DELETE_MESSAGE" + ] + }, + "CloudWatchLogsDestinationConfiguration":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.
" + } + }, + "documentation":"Specifies a CloudWatch Logs location where chat logs will be stored.
" + }, + "ConflictException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "resourceId":{ + "shape":"ResourceId", + "documentation":"" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"" + } + }, + "documentation":"", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateChatTokenRequest":{ + "type":"structure", + "required":[ + "roomIdentifier", + "userId" + ], + "members":{ + "roomIdentifier":{ + "shape":"RoomIdentifier", + "documentation":"Identifier of the room that the client is trying to access. Currently this must be an ARN.
" + }, + "userId":{ + "shape":"UserID", + "documentation":"Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.
" + }, + "capabilities":{ + "shape":"ChatTokenCapabilities", + "documentation":"Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).
" + }, + "sessionDurationInMinutes":{ + "shape":"SessionDurationInMinutes", + "documentation":"Session duration (in minutes), after which the session expires. Default: 60 (1 hour).
" + }, + "attributes":{ + "shape":"ChatTokenAttributes", + "documentation":"Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
" + } + } + }, + "CreateChatTokenResponse":{ + "type":"structure", + "members":{ + "token":{ + "shape":"ChatToken", + "documentation":"The issued client token, encrypted.
" + }, + "tokenExpirationTime":{ + "shape":"Time", + "documentation":"Time after which the token is no longer valid and cannot be used to connect to a room. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "sessionExpirationTime":{ + "shape":"Time", + "documentation":"Time after which an end user's session is no longer valid. This is an ISO 8601 timestamp; note that this is returned as a string.
" + } + } + }, + "CreateLoggingConfigurationRequest":{ + "type":"structure", + "required":["destinationConfiguration"], + "members":{ + "name":{ + "shape":"LoggingConfigurationName", + "documentation":"Logging-configuration name. The value does not need to be unique.
" + }, + "destinationConfiguration":{ + "shape":"DestinationConfiguration", + "documentation":"A complex type that contains a destination configuration for where chat content will be logged. There can be only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints on tags beyond what is documented there.
Logging-configuration ARN, assigned by the system.
" + }, + "id":{ + "shape":"LoggingConfigurationID", + "documentation":"Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the logging configuration.
" + }, + "createTime":{ + "shape":"Time", + "documentation":"Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "updateTime":{ + "shape":"Time", + "documentation":"Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "name":{ + "shape":"LoggingConfigurationName", + "documentation":"Logging-configuration name, from the request (if specified).
" + }, + "destinationConfiguration":{ + "shape":"DestinationConfiguration", + "documentation":"A complex type that contains a destination configuration for where chat content will be logged, from the request. There is only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.
Tags attached to the resource, from the request (if specified). Array of maps, each of the form string:string (key:value).
Room name. The value does not need to be unique.
" + }, + "maximumMessageRatePerSecond":{ + "shape":"RoomMaxMessageRatePerSecond", + "documentation":"Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
" + }, + "maximumMessageLength":{ + "shape":"RoomMaxMessageLength", + "documentation":"Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
" + }, + "messageReviewHandler":{ + "shape":"MessageReviewHandler", + "documentation":"Configuration information for optional review of messages.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented there.
Array of logging-configuration identifiers attached to the room.
" + } + } + }, + "CreateRoomResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"RoomArn", + "documentation":"Room ARN, assigned by the system.
" + }, + "id":{ + "shape":"RoomID", + "documentation":"Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
" + }, + "name":{ + "shape":"RoomName", + "documentation":"Room name, from the request (if specified).
" + }, + "createTime":{ + "shape":"Time", + "documentation":"Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "updateTime":{ + "shape":"Time", + "documentation":"Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "maximumMessageRatePerSecond":{ + "shape":"RoomMaxMessageRatePerSecond", + "documentation":"Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).
" + }, + "maximumMessageLength":{ + "shape":"RoomMaxMessageLength", + "documentation":"Maximum number of characters in a single message, from the request (if specified).
" + }, + "messageReviewHandler":{ + "shape":"MessageReviewHandler", + "documentation":"Configuration information for optional review of messages.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource, from the request (if specified).
" + }, + "loggingConfigurationIdentifiers":{ + "shape":"LoggingConfigurationIdentifierList", + "documentation":"Array of logging configurations attached to the room, from the request (if specified).
" + } + } + }, + "DeleteLoggingConfigurationRequest":{ + "type":"structure", + "required":["identifier"], + "members":{ + "identifier":{ + "shape":"LoggingConfigurationIdentifier", + "documentation":"Identifier of the logging configuration to be deleted.
" + } + } + }, + "DeleteMessageRequest":{ + "type":"structure", + "required":[ + "roomIdentifier", + "id" + ], + "members":{ + "roomIdentifier":{ + "shape":"RoomIdentifier", + "documentation":"Identifier of the room where the message should be deleted. Currently this must be an ARN.
" + }, + "id":{ + "shape":"MessageID", + "documentation":"ID of the message to be deleted. This is the Id field in the received message (see Message (Subscribe) in the Chat Messaging API).
Reason for deleting the message.
" + } + } + }, + "DeleteMessageResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"ID", + "documentation":"Operation identifier, generated by Amazon IVS Chat.
" + } + } + }, + "DeleteRoomRequest":{ + "type":"structure", + "required":["identifier"], + "members":{ + "identifier":{ + "shape":"RoomIdentifier", + "documentation":"Identifier of the room to be deleted. Currently this must be an ARN.
" + } + } + }, + "DeliveryStreamName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "DestinationConfiguration":{ + "type":"structure", + "members":{ + "s3":{ + "shape":"S3DestinationConfiguration", + "documentation":"An Amazon S3 destination configuration where chat activity will be logged.
" + }, + "cloudWatchLogs":{ + "shape":"CloudWatchLogsDestinationConfiguration", + "documentation":"An Amazon CloudWatch Logs destination configuration where chat activity will be logged.
" + }, + "firehose":{ + "shape":"FirehoseDestinationConfiguration", + "documentation":"An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.
" + } + }, + "documentation":"A complex type that describes a location where chat logs will be stored. Each member represents the configuration of one log destination. For logging, you define only one type of destination (for CloudWatch Logs, Kinesis Firehose, or S3).
", + "union":true + }, + "DisconnectUserRequest":{ + "type":"structure", + "required":[ + "roomIdentifier", + "userId" + ], + "members":{ + "roomIdentifier":{ + "shape":"RoomIdentifier", + "documentation":"Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.
" + }, + "userId":{ + "shape":"UserID", + "documentation":"ID of the user (connection) to disconnect from the room.
" + }, + "reason":{ + "shape":"Reason", + "documentation":"Reason for disconnecting the user.
" + } + } + }, + "DisconnectUserResponse":{ + "type":"structure", + "members":{ + } + }, + "ErrorMessage":{"type":"string"}, + "EventAttributes":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "EventName":{ + "type":"string", + "max":100, + "min":1 + }, + "FallbackResult":{ + "type":"string", + "enum":[ + "ALLOW", + "DENY" + ] + }, + "FieldName":{"type":"string"}, + "FirehoseDestinationConfiguration":{ + "type":"structure", + "required":["deliveryStreamName"], + "members":{ + "deliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.
" + } + }, + "documentation":"Specifies a Kinesis Firehose location where chat logs will be stored.
" + }, + "GetLoggingConfigurationRequest":{ + "type":"structure", + "required":["identifier"], + "members":{ + "identifier":{ + "shape":"LoggingConfigurationIdentifier", + "documentation":"Identifier of the logging configuration to be retrieved.
" + } + } + }, + "GetLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"LoggingConfigurationArn", + "documentation":"Logging-configuration ARN, from the request (if identifier was an ARN).
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the logging configuration.
" + }, + "createTime":{ + "shape":"Time", + "documentation":"Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "updateTime":{ + "shape":"Time", + "documentation":"Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "name":{ + "shape":"LoggingConfigurationName", + "documentation":"Logging-configuration name. This value does not need to be unique.
" + }, + "destinationConfiguration":{ + "shape":"DestinationConfiguration", + "documentation":"A complex type that contains a destination configuration for where chat content will be logged. There is only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.
Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.
" + } + } + }, + "GetRoomResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"RoomArn", + "documentation":"Room ARN, from the request (if identifier was an ARN).
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
" + }, + "name":{ + "shape":"RoomName", + "documentation":"Room name. The value does not need to be unique.
" + }, + "createTime":{ + "shape":"Time", + "documentation":"Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "updateTime":{ + "shape":"Time", + "documentation":"Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "maximumMessageRatePerSecond":{ + "shape":"RoomMaxMessageRatePerSecond", + "documentation":"Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
" + }, + "maximumMessageLength":{ + "shape":"RoomMaxMessageLength", + "documentation":"Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
" + }, + "messageReviewHandler":{ + "shape":"MessageReviewHandler", + "documentation":"Configuration information for optional review of messages.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Array of logging configurations attached to the room.
" + } + } + }, + "ID":{ + "type":"string", + "max":12, + "min":12, + "pattern":"[a-zA-Z0-9]+" + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "LambdaArn":{ + "type":"string", + "max":170, + "min":0, + "pattern":"$|^arn:aws:lambda:[a-z0-9-]+:[0-9]{12}:function:.+.*" + }, + "Limit":{"type":"integer"}, + "ListLoggingConfigurationsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first logging configurations to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of logging configurations to return. Default: 50.
" + } + } + }, + "ListLoggingConfigurationsResponse":{ + "type":"structure", + "required":["loggingConfigurations"], + "members":{ + "loggingConfigurations":{ + "shape":"LoggingConfigurationList", + "documentation":"List of the matching logging configurations (summary information only). There is only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
If there are more logging configurations than maxResults, use nextToken in the request to get the next set.
Filters the list to match the specified room name.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first room to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of rooms to return. Default: 50.
" + }, + "messageReviewHandlerUri":{ + "shape":"LambdaArn", + "documentation":"Filters the list to match the specified message review handler URI.
" + }, + "loggingConfigurationIdentifier":{ + "shape":"LoggingConfigurationIdentifier", + "documentation":"Logging-configuration identifier.
" + } + } + }, + "ListRoomsResponse":{ + "type":"structure", + "required":["rooms"], + "members":{ + "rooms":{ + "shape":"RoomList", + "documentation":"List of the matching rooms (summary information only).
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are more rooms than maxResults, use nextToken in the request to get the next set.
The ARN of the resource to be retrieved. The ARN must be URL-encoded.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Logging-configuration ARN.
" + }, + "id":{ + "shape":"LoggingConfigurationID", + "documentation":"Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
" + }, + "createTime":{ + "shape":"Time", + "documentation":"Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "updateTime":{ + "shape":"Time", + "documentation":"Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "name":{ + "shape":"LoggingConfigurationName", + "documentation":"Logging-configuration name. The value does not need to be unique.
" + }, + "destinationConfiguration":{ + "shape":"DestinationConfiguration", + "documentation":"A complex type that contains a destination configuration for where chat content will be logged.
" + }, + "state":{ + "shape":"LoggingConfigurationState", + "documentation":"The state of the logging configuration. When this is ACTIVE, the configuration is ready for logging chat content.
Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints on tags beyond what is documented there.
Summary information about a logging configuration.
" + }, + "MaxLoggingConfigurationResults":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "MaxRoomResults":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "MessageID":{ + "type":"string", + "max":12, + "min":12, + "pattern":"[a-zA-Z0-9]+" + }, + "MessageReviewHandler":{ + "type":"structure", + "members":{ + "uri":{ + "shape":"LambdaArn", + "documentation":"Identifier of the message review handler. Currently this must be an ARN of a lambda function.
" + }, + "fallbackResult":{ + "shape":"FallbackResult", + "documentation":"Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. (For the timeout period, see Service Quotas.) If allowed, the message is delivered with returned content to all users connected to the room. If denied, the message is not delivered to any user. Default: ALLOW.
Configuration information for optional message review.
" + }, + "PaginationToken":{ + "type":"string", + "max":1024, + "min":0 + }, + "PendingVerification":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "Reason":{ + "type":"string", + "max":256, + "min":1 + }, + "ResourceArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:aws:ivschat:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+" + }, + "ResourceId":{ + "type":"string", + "pattern":"[a-zA-Z0-9]+" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "resourceId":{ + "shape":"ResourceId", + "documentation":"" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"" + } + }, + "documentation":"", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceType":{ + "type":"string", + "enum":["ROOM"] + }, + "RoomArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+" + }, + "RoomID":{ + "type":"string", + "max":12, + "min":12, + "pattern":"[a-zA-Z0-9]+" + }, + "RoomIdentifier":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+" + }, + "RoomList":{ + "type":"list", + "member":{"shape":"RoomSummary"} + }, + "RoomMaxMessageLength":{ + "type":"integer", + "box":true, + "max":500, + "min":1 + }, + "RoomMaxMessageRatePerSecond":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "RoomName":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[a-zA-Z0-9-_]*" + }, + "RoomSummary":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"RoomArn", + "documentation":"Room ARN.
" + }, + "id":{ + "shape":"RoomID", + "documentation":"Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
" + }, + "name":{ + "shape":"RoomName", + "documentation":"Room name. The value does not need to be unique.
" + }, + "messageReviewHandler":{ + "shape":"MessageReviewHandler", + "documentation":"Configuration information for optional review of messages.
" + }, + "createTime":{ + "shape":"Time", + "documentation":"Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "updateTime":{ + "shape":"Time", + "documentation":"Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented there.
List of logging-configuration identifiers attached to the room.
" + } + }, + "documentation":"Summary information about a room.
" + }, + "S3DestinationConfiguration":{ + "type":"structure", + "required":["bucketName"], + "members":{ + "bucketName":{ + "shape":"BucketName", + "documentation":"Name of the Amazon S3 bucket where chat activity will be logged.
" + } + }, + "documentation":"Specifies an S3 location where chat logs will be stored.
" + }, + "SendEventRequest":{ + "type":"structure", + "required":[ + "roomIdentifier", + "eventName" + ], + "members":{ + "roomIdentifier":{ + "shape":"RoomIdentifier", + "documentation":"Identifier of the room to which the event will be sent. Currently this must be an ARN.
" + }, + "eventName":{ + "shape":"EventName", + "documentation":"Application-defined name of the event to send to clients.
" + }, + "attributes":{ + "shape":"EventAttributes", + "documentation":"Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.
" + } + } + }, + "SendEventResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"ID", + "documentation":"An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent operations for this message, such as DeleteMessage.
" + } + } + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType", + "limit" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "resourceId":{ + "shape":"ResourceId", + "documentation":"" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"" + }, + "limit":{ + "shape":"Limit", + "documentation":"" + } + }, + "documentation":"", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SessionDurationInMinutes":{ + "type":"integer", + "box":true, + "max":180, + "min":1 + }, + "String":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"The ARN of the resource to be tagged. The ARN must be URL-encoded.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"Tags", + "documentation":"Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented there.
The ARN of the resource to be untagged. The ARN must be URL-encoded.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"Array of tags to be removed. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented there.
Identifier of the logging configuration to be updated.
" + }, + "name":{ + "shape":"LoggingConfigurationName", + "documentation":"Logging-configuration name. The value does not need to be unique.
" + }, + "destinationConfiguration":{ + "shape":"DestinationConfiguration", + "documentation":"A complex type that contains a destination configuration for where chat content will be logged. There can be only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
Logging-configuration ARN, from the request (if identifier was an ARN).
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
" + }, + "createTime":{ + "shape":"Time", + "documentation":"Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "updateTime":{ + "shape":"Time", + "documentation":"Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "name":{ + "shape":"LoggingConfigurationName", + "documentation":"Logging-configuration name, from the request (if specified).
" + }, + "destinationConfiguration":{ + "shape":"DestinationConfiguration", + "documentation":"A complex type that contains a destination configuration for where chat content will be logged, from the request. There is only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.
Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Identifier of the room to be updated. Currently this must be an ARN.
" + }, + "name":{ + "shape":"RoomName", + "documentation":"Room name. The value does not need to be unique.
" + }, + "maximumMessageRatePerSecond":{ + "shape":"RoomMaxMessageRatePerSecond", + "documentation":"Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
" + }, + "maximumMessageLength":{ + "shape":"RoomMaxMessageLength", + "documentation":"The maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
" + }, + "messageReviewHandler":{ + "shape":"MessageReviewHandler", + "documentation":"Configuration information for optional review of messages. Specify an empty uri string to disassociate a message review handler from the specified room.
Array of logging-configuration identifiers attached to the room.
" + } + } + }, + "UpdateRoomResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"RoomArn", + "documentation":"Room ARN, from the request (if identifier was an ARN).
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
" + }, + "name":{ + "shape":"RoomName", + "documentation":"Room name, from the request (if specified).
" + }, + "createTime":{ + "shape":"Time", + "documentation":"Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "updateTime":{ + "shape":"Time", + "documentation":"Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "maximumMessageRatePerSecond":{ + "shape":"RoomMaxMessageRatePerSecond", + "documentation":"Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).
" + }, + "maximumMessageLength":{ + "shape":"RoomMaxMessageLength", + "documentation":"Maximum number of characters in a single message, from the request (if specified).
" + }, + "messageReviewHandler":{ + "shape":"MessageReviewHandler", + "documentation":"Configuration information for optional review of messages.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Array of logging configurations attached to the room, from the request (if specified).
" + } + } + }, + "UserID":{ + "type":"string", + "max":128, + "min":1, + "sensitive":true + }, + "ValidationException":{ + "type":"structure", + "required":[ + "message", + "reason" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "reason":{ + "shape":"ValidationExceptionReason", + "documentation":"" + }, + "fieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"" + } + }, + "documentation":"", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "name", + "message" + ], + "members":{ + "name":{ + "shape":"FieldName", + "documentation":"Name of the field which failed validation.
" + }, + "message":{ + "shape":"ErrorMessage", + "documentation":"Explanation of the reason for the validation error.
" + } + }, + "documentation":"This object is used in the ValidationException error.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "UNKNOWN_OPERATION", + "FIELD_VALIDATION_FAILED", + "OTHER" + ] + } + }, + "documentation":"Introduction
The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat resources. You also need to integrate with the Amazon IVS Chat Messaging API, to enable users to interact with chat rooms in real time.
The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the AWS General Reference.
This document describes HTTP operations. There is a separate messaging API for managing Chat resources; see the Amazon IVS Chat Messaging API Reference.
Notes on terminology:
You create service applications using the Amazon IVS Chat API. We refer to these as applications.
You create front-end client applications (browser and Android/iOS apps) using the Amazon IVS Chat Messaging API. We refer to these as clients.
Resources
The following resources are part of Amazon IVS Chat:
LoggingConfiguration — A configuration that allows customers to store and record sent messages in a chat room. See the Logging Configuration endpoints for more information.
Room — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages. See the Room endpoints for more information.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS Chat API has these tag-related operations: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Room.
At most 50 tags can be applied to a resource.
API Access Security
Your Amazon IVS Chat applications (service applications and clients) must be authenticated and authorized to access Amazon IVS Chat resources. Note the differences between these concepts:
Authentication is about verifying identity. Requests to the Amazon IVS Chat API must be signed to verify your identity.
Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS Chat API requests.
Users (viewers) connect to a room using secure access tokens that you create using the CreateChatToken operation through the AWS SDK. You call CreateChatToken for every user’s chat session, passing identity and authorization information about the user.
Signing API Requests
HTTP API requests must be signed with an AWS SigV4 signature using your AWS security credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API directly, it’s your responsibility to sign the requests.
You generate a signature using valid AWS credentials for an IAM role that has permission to perform the requested action. For example, DeleteMessage requests must be made using an IAM role that has the ivschat:DeleteMessage permission.
For more information:
Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Amazon Resource Names (ARNs)
ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.
" +} diff --git a/testbed/boto__botocore/botocore/data/ivschat/2020-07-14/waiters-2.json b/testbed/boto__botocore/botocore/data/ivschat/2020-07-14/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..13f60ee66be6a3d75208653e2bd7b563561adacc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/ivschat/2020-07-14/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/testbed/boto__botocore/botocore/data/kendra-ranking/2022-10-19/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/kendra-ranking/2022-10-19/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..18515f8ee5467de25be0dba792db06416cd3e19e --- /dev/null +++ b/testbed/boto__botocore/botocore/data/kendra-ranking/2022-10-19/endpoint-rule-set-1.json @@ -0,0 +1,247 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kendra-ranking-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://kendra-ranking.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kendra-ranking-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://kendra-ranking.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/kendra-ranking/2022-10-19/paginators-1.json b/testbed/boto__botocore/botocore/data/kendra-ranking/2022-10-19/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..ea142457a6a77d6e6a54942329f1199bc2f2a60c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/kendra-ranking/2022-10-19/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/testbed/boto__botocore/botocore/data/kendra-ranking/2022-10-19/service-2.json b/testbed/boto__botocore/botocore/data/kendra-ranking/2022-10-19/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..e2e6bbeed0ab4f9213b30200b61073e4f5577a63 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/kendra-ranking/2022-10-19/service-2.json @@ -0,0 +1,760 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-10-19", + "endpointPrefix":"kendra-ranking", + "jsonVersion":"1.0", + "protocol":"json", + "serviceAbbreviation":"Kendra Ranking", + "serviceFullName":"Amazon Kendra Intelligent Ranking", + "serviceId":"Kendra Ranking", + "signatureVersion":"v4", + "signingName":"kendra-ranking", + "targetPrefix":"AWSKendraRerankingFrontendService", + "uid":"kendra-ranking-2022-10-19" + }, + "operations":{ + "CreateRescoreExecutionPlan":{ + "name":"CreateRescoreExecutionPlan", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRescoreExecutionPlanRequest"}, + "output":{"shape":"CreateRescoreExecutionPlanResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You set the number of capacity units that you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results.
For an example of using the CreateRescoreExecutionPlan API, including using the Python and Java SDKs, see Semantically ranking a search service's results.
Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
Gets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
Gets a list of tags associated with a specified resource. A rescore execution plan is an example of a resource that can have tags associated with it.
" + }, + "Rescore":{ + "name":"Rescore", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RescoreRequest"}, + "output":{"shape":"RescoreResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Rescores or re-ranks search results from a search service such as OpenSearch (self managed). You use the semantic search capabilities of Amazon Kendra Intelligent Ranking to improve the search service's results.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Adds a specified tag to a specified rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. If the tag already exists, the existing value is replaced with the new value.
Removes a tag from a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore operation.
Updates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can update the number of capacity units you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results.
You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
", + "exception":true + }, + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1 + }, + "BodyTokensList":{ + "type":"list", + "member":{"shape":"Tokens"}, + "min":1 + }, + "CapacityUnitsConfiguration":{ + "type":"structure", + "required":["RescoreCapacityUnits"], + "members":{ + "RescoreCapacityUnits":{ + "shape":"RescoreCapacityUnit", + "documentation":"The amount of extra capacity for your rescore execution plan.
A single extra capacity unit for a rescore execution plan provides 0.01 rescore requests per second. You can add up to 1000 extra capacity units.
" + } + }, + "documentation":"Sets additional capacity units configured for your rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can add and remove capacity units to fit your usage requirements.
A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.
", + "exception":true + }, + "CreateRescoreExecutionPlanRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"RescoreExecutionPlanName", + "documentation":"A name for the rescore execution plan.
" + }, + "Description":{ + "shape":"Description", + "documentation":"A description for the rescore execution plan.
" + }, + "CapacityUnits":{ + "shape":"CapacityUnitsConfiguration", + "documentation":"You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For more information on the default capacity and additional capacity units, see Adjusting capacity.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A list of key-value pairs that identify or categorize your rescore execution plan. You can also use tags to help control access to the rescore execution plan. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
" + }, + "ClientToken":{ + "shape":"ClientTokenName", + "documentation":"A token that you provide to identify the request to create a rescore execution plan. Multiple calls to the CreateRescoreExecutionPlanRequest API with the same client token will create only one rescore execution plan.
The identifier of the rescore execution plan.
" + }, + "Arn":{ + "shape":"RescoreExecutionPlanArn", + "documentation":"The Amazon Resource Name (ARN) of the rescore execution plan.
" + } + } + }, + "DeleteRescoreExecutionPlanRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"RescoreExecutionPlanId", + "documentation":"The identifier of the rescore execution plan that you want to delete.
" + } + } + }, + "DescribeRescoreExecutionPlanRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"RescoreExecutionPlanId", + "documentation":"The identifier of the rescore execution plan that you want to get information on.
" + } + } + }, + "DescribeRescoreExecutionPlanResponse":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"RescoreExecutionPlanId", + "documentation":"The identifier of the rescore execution plan.
" + }, + "Arn":{ + "shape":"RescoreExecutionPlanArn", + "documentation":"The Amazon Resource Name (ARN) of the rescore execution plan.
" + }, + "Name":{ + "shape":"RescoreExecutionPlanName", + "documentation":"The name for the rescore execution plan.
" + }, + "Description":{ + "shape":"Description", + "documentation":"The description for the rescore execution plan.
" + }, + "CapacityUnits":{ + "shape":"CapacityUnitsConfiguration", + "documentation":"The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore execution plan is using the default capacity. For more information on the default capacity and additional capacity units, see Adjusting capacity.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The Unix timestamp of when the rescore execution plan was created.
" + }, + "UpdatedAt":{ + "shape":"Timestamp", + "documentation":"The Unix timestamp of when the rescore execution plan was last updated.
" + }, + "Status":{ + "shape":"RescoreExecutionPlanStatus", + "documentation":"The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution plan is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
The identifier of the document from the search service.
" + }, + "GroupId":{ + "shape":"GroupId", + "documentation":"The optional group identifier of the document from the search service. Documents with the same group identifier are grouped together and processed as one document within the service.
" + }, + "Title":{ + "shape":"DocumentTitle", + "documentation":"The title of the search service's document.
" + }, + "Body":{ + "shape":"DocumentBody", + "documentation":"The body text of the search service's document.
" + }, + "TokenizedTitle":{ + "shape":"TitleTokensList", + "documentation":"The title of the search service's document represented as a list of tokens or words. You must choose to provide Title or TokenizedTitle. You cannot provide both.
The body text of the search service's document represented as a list of tokens or words. You must choose to provide Body or TokenizedBody. You cannot provide both.
The original document score or rank from the search service. Amazon Kendra Intelligent Ranking gives the document a new score or rank based on its intelligent search algorithms.
" + } + }, + "documentation":"Information about a document from a search service such as OpenSearch (self managed). Amazon Kendra Intelligent Ranking uses this information to rank and score on.
" + }, + "DocumentBody":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^\\P{C}*$" + }, + "DocumentId":{ + "type":"string", + "max":2048, + "min":1 + }, + "DocumentList":{ + "type":"list", + "member":{"shape":"Document"}, + "min":1 + }, + "DocumentTitle":{ + "type":"string", + "max":1024, + "min":1 + }, + "ErrorMessage":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^\\P{C}*$" + }, + "Float":{ + "type":"float", + "max":100000, + "min":-100000 + }, + "GroupId":{ + "type":"string", + "max":2048, + "min":1 + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Support for help.
", + "exception":true, + "fault":true + }, + "ListRescoreExecutionPlansRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"If the response is truncated, Amazon Kendra Intelligent Ranking returns a pagination token in the response. You can use this pagination token to retrieve the next set of rescore execution plans.
" + }, + "MaxResults":{ + "shape":"MaxResultsIntegerForListRescoreExecutionPlansRequest", + "documentation":"The maximum number of rescore execution plans to return.
" + } + } + }, + "ListRescoreExecutionPlansResponse":{ + "type":"structure", + "members":{ + "SummaryItems":{ + "shape":"RescoreExecutionPlanSummaryList", + "documentation":"An array of summary information for one or more rescore execution plans.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If the response is truncated, Amazon Kendra Intelligent Ranking returns a pagination token in the response.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the rescore execution plan to get a list of tags for.
" + } + }, + "documentation":"The request information for listing tags associated with a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
A list of tags associated with the rescore execution plan.
" + } + }, + "documentation":"If the action is successful, the service sends back an HTTP 200 response.
" + }, + "MaxResultsIntegerForListRescoreExecutionPlansRequest":{ + "type":"integer", + "max":50, + "min":1 + }, + "NextToken":{ + "type":"string", + "max":800, + "min":1, + "pattern":"^\\P{C}*$" + }, + "RescoreCapacityUnit":{ + "type":"integer", + "min":0 + }, + "RescoreExecutionPlanArn":{ + "type":"string", + "max":1284, + "min":0, + "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" + }, + "RescoreExecutionPlanId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9-]*" + }, + "RescoreExecutionPlanName":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "RescoreExecutionPlanStatus":{ + "type":"string", + "enum":[ + "CREATING", + "UPDATING", + "ACTIVE", + "DELETING", + "FAILED" + ] + }, + "RescoreExecutionPlanSummary":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"RescoreExecutionPlanName", + "documentation":"The name of the rescore execution plan.
" + }, + "Id":{ + "shape":"RescoreExecutionPlanId", + "documentation":"The identifier of the rescore execution plan.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The Unix timestamp when the rescore execution plan was created.
" + }, + "UpdatedAt":{ + "shape":"Timestamp", + "documentation":"The Unix timestamp when the rescore execution plan was last updated.
" + }, + "Status":{ + "shape":"RescoreExecutionPlanStatus", + "documentation":"The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution plan is ready for use.
Summary information for a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
The identifier of the rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
The input query from the search service.
" + }, + "Documents":{ + "shape":"DocumentList", + "documentation":"The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.
" + } + } + }, + "RescoreResult":{ + "type":"structure", + "members":{ + "RescoreId":{ + "shape":"RescoreId", + "documentation":"The identifier associated with the scores that Amazon Kendra Intelligent Ranking gives to the results. Amazon Kendra Intelligent Ranking rescores or re-ranks the results for the search service.
" + }, + "ResultItems":{ + "shape":"RescoreResultItemList", + "documentation":"A list of result items for documents with new relevancy scores. The results are in descending order.
" + } + } + }, + "RescoreResultItem":{ + "type":"structure", + "members":{ + "DocumentId":{ + "shape":"DocumentId", + "documentation":"The identifier of the document from the search service.
" + }, + "Score":{ + "shape":"Float", + "documentation":"The relevancy score or rank that Amazon Kendra Intelligent Ranking gives to the result.
" + } + }, + "documentation":"A result item for a document with a new relevancy score.
" + }, + "RescoreResultItemList":{ + "type":"list", + "member":{"shape":"RescoreResultItem"}, + "min":1 + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"The resource you want to use doesn't exist. Please check you have provided the correct resource and try again.
", + "exception":true + }, + "ResourceUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"The resource you want to use is unavailable. Please check you have provided the correct resource information and try again.
", + "exception":true + }, + "SearchQuery":{ + "type":"string", + "max":1000, + "min":1 + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"You have exceeded the set limits for your Amazon Kendra Intelligent Ranking service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
", + "exception":true + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"The key for the tag. Keys are not case sensitive and must be unique.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The value associated with the tag. The value can be an empty string but it can't be null.
" + } + }, + "documentation":"A key-value pair that identifies or categorizes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can also use a tag to help control access to a rescore execution plan. A tag key and value can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
The Amazon Resource Name (ARN) of the rescore execution plan to tag.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A list of tag keys to add to a rescore execution plan. If a tag already exists, the existing value is replaced with the new value.
" + } + }, + "documentation":"The request information for tagging a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
" + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"The request was denied due to request throttling. Please reduce the number of requests and try again.
", + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "TitleTokensList":{ + "type":"list", + "member":{"shape":"Tokens"}, + "min":1 + }, + "Tokens":{ + "type":"string", + "max":2048, + "min":1 + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the rescore execution plan to remove the tag.
" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"A list of tag keys to remove from the rescore execution plan. If a tag key does not exist on the resource, it is ignored.
" + } + }, + "documentation":"The request information to remove a tag from a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
" + }, + "UpdateRescoreExecutionPlanRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"RescoreExecutionPlanId", + "documentation":"The identifier of the rescore execution plan that you want to update.
" + }, + "Name":{ + "shape":"RescoreExecutionPlanName", + "documentation":"A new name for the rescore execution plan.
" + }, + "Description":{ + "shape":"Description", + "documentation":"A new description for the rescore execution plan.
" + }, + "CapacityUnits":{ + "shape":"CapacityUnitsConfiguration", + "documentation":"You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For more information on the default capacity and additional capacity units, see Adjusting capacity.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.
", + "exception":true + } + }, + "documentation":"Amazon Kendra Intelligent Ranking uses Amazon Kendra semantic search capabilities to intelligently re-rank a search service's results.
" +} diff --git a/testbed/boto__botocore/botocore/data/keyspaces/2022-02-10/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/keyspaces/2022-02-10/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..578f4345fa2ec835af56895f69a6117e7af7468c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/keyspaces/2022-02-10/endpoint-rule-set-1.json @@ -0,0 +1,339 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cassandra-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "endpoint": { + "url": "https://cassandra.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cassandra-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cassandra.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cassandra.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/keyspaces/2022-02-10/examples-1.json b/testbed/boto__botocore/botocore/data/keyspaces/2022-02-10/examples-1.json new file mode 100644 index 0000000000000000000000000000000000000000..0ea7e3b0bbe917eb027880396ac01509becd1fa0 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/keyspaces/2022-02-10/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/testbed/boto__botocore/botocore/data/keyspaces/2022-02-10/paginators-1.json b/testbed/boto__botocore/botocore/data/keyspaces/2022-02-10/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..885bf4e250852960c414ce78d3e6cf07d4f193cf --- /dev/null +++ b/testbed/boto__botocore/botocore/data/keyspaces/2022-02-10/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListKeyspaces": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "keyspaces" + }, + "ListTables": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "tables" + }, + "ListTagsForResource": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "tags" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/keyspaces/2022-02-10/service-2.json b/testbed/boto__botocore/botocore/data/keyspaces/2022-02-10/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..087dfd7c3ce729bca7e13cd9c873eec24f9d65c0 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/keyspaces/2022-02-10/service-2.json @@ -0,0 +1,1475 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-02-10", + "endpointPrefix":"cassandra", + "jsonVersion":"1.0", + "protocol":"json", + "serviceFullName":"Amazon Keyspaces", + "serviceId":"Keyspaces", + "signatureVersion":"v4", + "signingName":"cassandra", + "targetPrefix":"KeyspacesService", + "uid":"keyspaces-2022-02-10" + }, + "operations":{ + "CreateKeyspace":{ + "name":"CreateKeyspace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateKeyspaceRequest"}, + "output":{"shape":"CreateKeyspaceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.
CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace by using the GetKeyspace operation.
For more information, see Creating keyspaces in the Amazon Keyspaces Developer Guide.
" + }, + "CreateTable":{ + "name":"CreateTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTableRequest"}, + "output":{"shape":"CreateTableResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.
CreateTable is an asynchronous operation. When the request is received, the status of the table is set to CREATING. You can monitor the creation status of the new table by using the GetTable operation, which returns the current status of the table. You can start using a table when the status is ACTIVE.
For more information, see Creating tables in the Amazon Keyspaces Developer Guide.
" + }, + "DeleteKeyspace":{ + "name":"DeleteKeyspace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteKeyspaceRequest"}, + "output":{"shape":"DeleteKeyspaceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"The DeleteKeyspace operation deletes a keyspace and all of its tables.
The DeleteTable operation deletes a table and all of its data. After a DeleteTable request is received, the specified table is in the DELETING state until Amazon Keyspaces completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is either in the CREATING or UPDATING states, then Amazon Keyspaces returns a ResourceInUseException. If the specified table does not exist, Amazon Keyspaces returns a ResourceNotFoundException. If the table is already in the DELETING state, no error is returned.
Returns the name and the Amazon Resource Name (ARN) of the specified table.
" + }, + "GetTable":{ + "name":"GetTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTableRequest"}, + "output":{"shape":"GetTableResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.
To read table metadata using GetTable, Select action permissions for the table and system tables are required to complete the operation.
Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the Amazon Web Services Region specific auto scaling settings of the table are included.
Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
GetTableAutoScalingSettings can't be used as an action in an IAM policy.
To define permissions for GetTableAutoScalingSettings, you must allow the following two actions in the IAM policy statement's Action element:
application-autoscaling:DescribeScalableTargets
application-autoscaling:DescribeScalingPolicies
Returns a list of keyspaces.
" + }, + "ListTables":{ + "name":"ListTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTablesRequest"}, + "output":{"shape":"ListTablesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns a list of tables for a specified keyspace.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns a list of all tags associated with the specified Amazon Keyspaces resource.
" + }, + "RestoreTable":{ + "name":"RestoreTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreTableRequest"}, + "output":{"shape":"RestoreTableResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Restores the table to the specified point in time within the earliest_restorable_timestamp and the current time. For more information about restore points, see Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide.
Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to the state based on the selected timestamp (day:hour:minute:second) to a new table. The Time to Live (TTL) settings are also restored to the state based on the selected timestamp.
In addition to the table's schema, data, and TTL settings, RestoreTable restores the capacity mode, auto scaling settings, encryption settings, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, these settings are always restored based on the table's settings as of the current time or when the table was deleted.
You can also overwrite these settings during restore:
Read/write capacity mode
Provisioned throughput capacity units
Auto scaling settings
Point-in-time (PITR) settings
Tags
For more information, see PITR restore settings in the Amazon Keyspaces Developer Guide.
Note that the following settings are not restored, and you must configure them manually for the new table:
Identity and Access Management (IAM) policies
Amazon CloudWatch metrics and alarms
Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, see Amazon Keyspaces resource access based on tags in the Amazon Keyspaces Developer Guide.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Removes the association of tags from a Amazon Keyspaces resource.
" + }, + "UpdateTable":{ + "name":"UpdateTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTableRequest"}, + "output":{"shape":"UpdateTableResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Adds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.
" + } + }, + "shapes":{ + "ARN":{ + "type":"string", + "max":1000, + "min":20, + "pattern":"arn:(aws[a-zA-Z0-9-]*):cassandra:.+.*" + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"Description of the error.
" + } + }, + "documentation":"You don't have sufficient access permissions to perform this action.
", + "exception":true + }, + "AutoScalingPolicy":{ + "type":"structure", + "members":{ + "targetTrackingScalingPolicyConfiguration":{ + "shape":"TargetTrackingScalingPolicyConfiguration", + "documentation":"Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A double between 20 and 90.
Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.
This optional parameter enables auto scaling for the table if set to false.
The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).
" + }, + "maximumUnits":{ + "shape":"CapacityUnits", + "documentation":"Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).
" + }, + "scalingPolicy":{ + "shape":"AutoScalingPolicy", + "documentation":"Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.
The optional auto scaling settings for a table with provisioned throughput capacity.
To turn on auto scaling for a table in throughputMode:PROVISIONED, you must specify the following parameters.
Configure the minimum and maximum capacity units. The auto scaling policy ensures that capacity never goes below the minimum or above the maximum range.
minimumUnits: The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).
maximumUnits: The maximum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).
scalingPolicy: Amazon Keyspaces supports the target tracking scaling policy. The auto scaling target is the provisioned capacity of the table.
targetTrackingScalingPolicyConfiguration: To define the target tracking policy, you must define the target value.
targetValue: The target utilization rate of the table. Amazon Keyspaces auto scaling ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90. (Required)
disableScaleIn: A boolean that specifies if scale-in is disabled or enabled for the table. This parameter is disabled by default. To turn on scale-in, set the boolean value to FALSE. This means that capacity for a table can be automatically scaled down on your behalf. (Optional)
scaleInCooldown: A cooldown period in seconds between scaling activities that lets the table stabilize before another scale in activity starts. If no value is provided, the default is 0. (Optional)
scaleOutCooldown: A cooldown period in seconds between scaling activities that lets the table stabilize before another scale out activity starts. If no value is provided, the default is 0. (Optional)
For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
" + }, + "AutoScalingSpecification":{ + "type":"structure", + "members":{ + "writeCapacityAutoScaling":{ + "shape":"AutoScalingSettings", + "documentation":"The auto scaling settings for the table's write capacity.
" + }, + "readCapacityAutoScaling":{ + "shape":"AutoScalingSettings", + "documentation":"The auto scaling settings for the table's read capacity.
" + } + }, + "documentation":"The optional auto scaling capacity settings for a table in provisioned capacity mode.
" + }, + "BooleanObject":{"type":"boolean"}, + "CapacitySpecification":{ + "type":"structure", + "required":["throughputMode"], + "members":{ + "throughputMode":{ + "shape":"ThroughputMode", + "documentation":"The read/write throughput capacity mode for a table. The options are:
throughputMode:PAY_PER_REQUEST and
throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.
The default is throughput_mode:PAY_PER_REQUEST.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
" + }, + "readCapacityUnits":{ + "shape":"CapacityUnits", + "documentation":"The throughput capacity specified for read operations defined in read capacity units (RCUs).
The throughput capacity specified for write operations defined in write capacity units (WCUs).
Amazon Keyspaces has two read/write capacity modes for processing reads and writes on your tables:
On-demand (default)
Provisioned
The read/write capacity mode that you choose controls how you are charged for read and write throughput and how table throughput capacity is managed.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
" + }, + "CapacitySpecificationSummary":{ + "type":"structure", + "required":["throughputMode"], + "members":{ + "throughputMode":{ + "shape":"ThroughputMode", + "documentation":"The read/write throughput capacity mode for a table. The options are:
throughputMode:PAY_PER_REQUEST and
throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.
The default is throughput_mode:PAY_PER_REQUEST.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
" + }, + "readCapacityUnits":{ + "shape":"CapacityUnits", + "documentation":"The throughput capacity specified for read operations defined in read capacity units (RCUs).
The throughput capacity specified for write operations defined in write capacity units (WCUs).
The timestamp of the last operation that changed the provisioned throughput capacity of a table.
" + } + }, + "documentation":"The read/write throughput capacity mode for a table. The options are:
throughputMode:PAY_PER_REQUEST and
throughputMode:PROVISIONED.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
" + }, + "CapacityUnits":{ + "type":"long", + "box":true, + "min":1 + }, + "ClientSideTimestamps":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"ClientSideTimestampsStatus", + "documentation":"Shows how to enable client-side timestamps settings for the specified table.
" + } + }, + "documentation":"The client-side timestamp setting of the table.
For more information, see How it works: Amazon Keyspaces client-side timestamps in the Amazon Keyspaces Developer Guide.
" + }, + "ClientSideTimestampsStatus":{ + "type":"string", + "enum":["ENABLED"] + }, + "ClusteringKey":{ + "type":"structure", + "required":[ + "name", + "orderBy" + ], + "members":{ + "name":{ + "shape":"GenericString", + "documentation":"The name(s) of the clustering column(s).
" + }, + "orderBy":{ + "shape":"SortOrder", + "documentation":"Sets the ascendant (ASC) or descendant (DESC) order modifier.
The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.
" + }, + "ClusteringKeyList":{ + "type":"list", + "member":{"shape":"ClusteringKey"} + }, + "ColumnDefinition":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "name":{ + "shape":"GenericString", + "documentation":"The name of the column.
" + }, + "type":{ + "shape":"GenericString", + "documentation":"The data type of the column. For a list of available data types, see Data types in the Amazon Keyspaces Developer Guide.
" + } + }, + "documentation":"The names and data types of regular columns.
" + }, + "ColumnDefinitionList":{ + "type":"list", + "member":{"shape":"ColumnDefinition"}, + "min":1 + }, + "Comment":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"String", + "documentation":"An optional description of the table.
" + } + }, + "documentation":"An optional comment that describes the table.
" + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"Description of the error.
" + } + }, + "documentation":"Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
", + "exception":true + }, + "CreateKeyspaceRequest":{ + "type":"structure", + "required":["keyspaceName"], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"The name of the keyspace to be created.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"A list of key-value pair tags to be attached to the keyspace.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
" + }, + "replicationSpecification":{ + "shape":"ReplicationSpecification", + "documentation":"The replication specification of the keyspace includes:
replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION.
regionList - if the replicationStrategy is MULTI_REGION, the regionList requires the current Region and at least one additional Amazon Web Services Region where the keyspace is going to be replicated in. The maximum number of supported replication Regions including the current Region is six.
The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
" + } + } + }, + "CreateTableRequest":{ + "type":"structure", + "required":[ + "keyspaceName", + "tableName", + "schemaDefinition" + ], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"The name of the keyspace that the table is going to be created in.
" + }, + "tableName":{ + "shape":"TableName", + "documentation":"The name of the table.
" + }, + "schemaDefinition":{ + "shape":"SchemaDefinition", + "documentation":"The schemaDefinition consists of the following parameters.
For each column to be created:
name - The name of the column.
type - An Amazon Keyspaces data type. For more information, see Data types in the Amazon Keyspaces Developer Guide.
The primary key of the table consists of the following columns:
partitionKeys - The partition key can be a single column, or it can be a compound value composed of two or more columns. The partition key portion of the primary key is required and determines how Amazon Keyspaces stores your data.
name - The name of each partition key column.
clusteringKeys - The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.
name - The name of the clustering column.
orderBy - Sets the ascendant (ASC) or descendant (DESC) order modifier.
To define a column as static use staticColumns - Static columns store values that are shared by all rows in the same partition:
name - The name of the column.
type - An Amazon Keyspaces data type.
This parameter allows to enter a description of the table.
" + }, + "capacitySpecification":{ + "shape":"CapacitySpecification", + "documentation":"Specifies the read/write throughput capacity mode for the table. The options are:
throughputMode:PAY_PER_REQUEST and
throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.
The default is throughput_mode:PAY_PER_REQUEST.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
" + }, + "encryptionSpecification":{ + "shape":"EncryptionSpecification", + "documentation":"Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of the following KMS key (KMS key):
type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.
type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.
The default is type:AWS_OWNED_KMS_KEY.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
" + }, + "pointInTimeRecovery":{ + "shape":"PointInTimeRecovery", + "documentation":"Specifies if pointInTimeRecovery is enabled or disabled for the table. The options are:
status=ENABLED
status=DISABLED
If it's not specified, the default is status=DISABLED.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
" + }, + "ttl":{ + "shape":"TimeToLive", + "documentation":"Enables Time to Live custom settings for the table. The options are:
status:enabled
status:disabled
The default is status:disabled. After ttl is enabled, you can't disable it for the table.
For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
" + }, + "defaultTimeToLive":{ + "shape":"DefaultTimeToLive", + "documentation":"The default Time to Live setting in seconds for the table.
For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"A list of key-value pair tags to be attached to the resource.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
" + }, + "clientSideTimestamps":{ + "shape":"ClientSideTimestamps", + "documentation":"Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option:
status: \"enabled\"
Once client-side timestamps are enabled for a table, this setting cannot be disabled.
" + }, + "autoScalingSpecification":{ + "shape":"AutoScalingSpecification", + "documentation":"The optional auto scaling settings for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity automatically on your behalf.
Auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
By default, auto scaling is disabled for a table.
" + }, + "replicaSpecifications":{ + "shape":"ReplicaSpecificationList", + "documentation":"The optional Amazon Web Services Region specific settings of a multi-Region table. These settings overwrite the general settings of the table for the specified Region.
For a multi-Region table in provisioned capacity mode, you can configure the table's read capacity differently for each Region's replica. The write capacity, however, remains synchronized between all replicas to ensure that there's enough capacity to replicate writes across all Regions. To define the read capacity for a table replica in a specific Region, you can do so by configuring the following parameters.
region: The Region where these settings are applied. (Required)
readCapacityUnits: The provisioned read capacity units. (Optional)
readCapacityAutoScaling: The read capacity auto scaling settings for the table. (Optional)
The unique identifier of the table in the format of an Amazon Resource Name (ARN).
" + } + } + }, + "DefaultTimeToLive":{ + "type":"integer", + "box":true, + "max":630720000, + "min":0 + }, + "DeleteKeyspaceRequest":{ + "type":"structure", + "required":["keyspaceName"], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"The name of the keyspace to be deleted.
" + } + } + }, + "DeleteKeyspaceResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteTableRequest":{ + "type":"structure", + "required":[ + "keyspaceName", + "tableName" + ], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"The name of the keyspace of the to be deleted table.
" + }, + "tableName":{ + "shape":"TableName", + "documentation":"The name of the table to be deleted.
" + } + } + }, + "DeleteTableResponse":{ + "type":"structure", + "members":{ + } + }, + "DoubleObject":{"type":"double"}, + "EncryptionSpecification":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"EncryptionType", + "documentation":"The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):
type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.
type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.
The default is type:AWS_OWNED_KMS_KEY.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
" + }, + "kmsKeyIdentifier":{ + "shape":"kmsKeyARN", + "documentation":"The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN.
Amazon Keyspaces encrypts and decrypts the table data at rest transparently and integrates with Key Management Service for storing and managing the encryption key. You can choose one of the following KMS keys (KMS keys):
Amazon Web Services owned key - This is the default encryption type. The key is owned by Amazon Keyspaces (no additional charge).
Customer managed key - This key is stored in your account and is created, owned, and managed by you. You have full control over the customer managed key (KMS charges apply).
For more information about encryption at rest in Amazon Keyspaces, see Encryption at rest in the Amazon Keyspaces Developer Guide.
For more information about KMS, see KMS management service concepts in the Key Management Service Developer Guide.
" + }, + "EncryptionType":{ + "type":"string", + "enum":[ + "CUSTOMER_MANAGED_KMS_KEY", + "AWS_OWNED_KMS_KEY" + ] + }, + "GenericString":{"type":"string"}, + "GetKeyspaceRequest":{ + "type":"structure", + "required":["keyspaceName"], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"The name of the keyspace.
" + } + } + }, + "GetKeyspaceResponse":{ + "type":"structure", + "required":[ + "keyspaceName", + "resourceArn", + "replicationStrategy" + ], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"The name of the keyspace.
" + }, + "resourceArn":{ + "shape":"ARN", + "documentation":"Returns the ARN of the keyspace.
" + }, + "replicationStrategy":{ + "shape":"rs", + "documentation":" Returns the replication strategy of the keyspace. The options are SINGLE_REGION or MULTI_REGION.
If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication Regions is returned.
The name of the keyspace.
" + }, + "tableName":{ + "shape":"TableName", + "documentation":"The name of the table.
" + } + } + }, + "GetTableAutoScalingSettingsResponse":{ + "type":"structure", + "required":[ + "keyspaceName", + "tableName", + "resourceArn" + ], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"The name of the keyspace.
" + }, + "tableName":{ + "shape":"TableName", + "documentation":"The name of the table.
" + }, + "resourceArn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the table.
" + }, + "autoScalingSpecification":{ + "shape":"AutoScalingSpecification", + "documentation":"The auto scaling settings of the table.
" + }, + "replicaSpecifications":{ + "shape":"ReplicaAutoScalingSpecificationList", + "documentation":"The Amazon Web Services Region specific settings of a multi-Region table. Returns the settings for all Regions the table is replicated in.
" + } + } + }, + "GetTableRequest":{ + "type":"structure", + "required":[ + "keyspaceName", + "tableName" + ], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"The name of the keyspace that the table is stored in.
" + }, + "tableName":{ + "shape":"TableName", + "documentation":"The name of the table.
" + } + } + }, + "GetTableResponse":{ + "type":"structure", + "required":[ + "keyspaceName", + "tableName", + "resourceArn" + ], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"The name of the keyspace that the specified table is stored in.
" + }, + "tableName":{ + "shape":"TableName", + "documentation":"The name of the specified table.
" + }, + "resourceArn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the specified table.
" + }, + "creationTimestamp":{ + "shape":"Timestamp", + "documentation":"The creation timestamp of the specified table.
" + }, + "status":{ + "shape":"TableStatus", + "documentation":"The current status of the specified table.
" + }, + "schemaDefinition":{ + "shape":"SchemaDefinition", + "documentation":"The schema definition of the specified table.
" + }, + "capacitySpecification":{ + "shape":"CapacitySpecificationSummary", + "documentation":"The read/write throughput capacity mode for a table. The options are:
throughputMode:PAY_PER_REQUEST
throughputMode:PROVISIONED
The encryption settings of the specified table.
" + }, + "pointInTimeRecovery":{ + "shape":"PointInTimeRecoverySummary", + "documentation":"The point-in-time recovery status of the specified table.
" + }, + "ttl":{ + "shape":"TimeToLive", + "documentation":"The custom Time to Live settings of the specified table.
" + }, + "defaultTimeToLive":{ + "shape":"DefaultTimeToLive", + "documentation":"The default Time to Live settings in seconds of the specified table.
" + }, + "comment":{ + "shape":"Comment", + "documentation":"The the description of the specified table.
" + }, + "clientSideTimestamps":{ + "shape":"ClientSideTimestamps", + "documentation":"The client-side timestamps setting of the table.
" + }, + "replicaSpecifications":{ + "shape":"ReplicaSpecificationSummaryList", + "documentation":"Returns the Amazon Web Services Region specific settings of all Regions a multi-Region table is replicated in.
" + } + } + }, + "IntegerObject":{"type":"integer"}, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"Description of the error.
" + } + }, + "documentation":"Amazon Keyspaces was unable to fully process this request because of an internal server error.
", + "exception":true, + "fault":true + }, + "KeyspaceName":{ + "type":"string", + "max":48, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_]{0,47}" + }, + "KeyspaceSummary":{ + "type":"structure", + "required":[ + "keyspaceName", + "resourceArn", + "replicationStrategy" + ], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"The name of the keyspace.
" + }, + "resourceArn":{ + "shape":"ARN", + "documentation":"The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
" + }, + "replicationStrategy":{ + "shape":"rs", + "documentation":" This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available values are SINGLE_REGION or MULTI_REGION.
If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication Regions is returned.
Represents the properties of a keyspace.
" + }, + "KeyspaceSummaryList":{ + "type":"list", + "member":{"shape":"KeyspaceSummary"} + }, + "ListKeyspacesRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
The total number of keyspaces to return in the output. If the total number of keyspaces 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.
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
A list of keyspaces.
" + } + } + }, + "ListTablesRequest":{ + "type":"structure", + "required":["keyspaceName"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.
The total number of tables to return in the output. If the total number of tables 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.
The name of the keyspace.
" + } + } + }, + "ListTablesResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
A list of tables.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
The total number of tags to return in the output. If the total number of tags 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.
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
A list of tags.
" + } + } + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "NextToken":{ + "type":"string", + "max":2048, + "min":1 + }, + "PartitionKey":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"GenericString", + "documentation":"The name(s) of the partition key column(s).
" + } + }, + "documentation":"The partition key portion of the primary key is required and determines how Amazon Keyspaces stores the data. The partition key can be a single column, or it can be a compound value composed of two or more columns.
" + }, + "PartitionKeyList":{ + "type":"list", + "member":{"shape":"PartitionKey"}, + "min":1 + }, + "PointInTimeRecovery":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"PointInTimeRecoveryStatus", + "documentation":"The options are:
status=ENABLED
status=DISABLED
Point-in-time recovery (PITR) helps protect your Amazon Keyspaces tables from accidental write or delete operations by providing you continuous backups of your table data.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
" + }, + "PointInTimeRecoveryStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "PointInTimeRecoverySummary":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"PointInTimeRecoveryStatus", + "documentation":"Shows if point-in-time recovery is enabled or disabled for the specified table.
" + }, + "earliestRestorableTimestamp":{ + "shape":"Timestamp", + "documentation":"Specifies the earliest possible restore point of the table in ISO 8601 format.
" + } + }, + "documentation":"The point-in-time recovery status of the specified table.
" + }, + "RegionList":{ + "type":"list", + "member":{"shape":"region"}, + "max":6, + "min":2 + }, + "ReplicaAutoScalingSpecification":{ + "type":"structure", + "members":{ + "region":{ + "shape":"region", + "documentation":"The Amazon Web Services Region.
" + }, + "autoScalingSpecification":{ + "shape":"AutoScalingSpecification", + "documentation":"The auto scaling settings for a multi-Region table in the specified Amazon Web Services Region.
" + } + }, + "documentation":"The auto scaling settings of a multi-Region table in the specified Amazon Web Services Region.
" + }, + "ReplicaAutoScalingSpecificationList":{ + "type":"list", + "member":{"shape":"ReplicaAutoScalingSpecification"}, + "min":0 + }, + "ReplicaSpecification":{ + "type":"structure", + "required":["region"], + "members":{ + "region":{ + "shape":"region", + "documentation":"The Amazon Web Services Region.
" + }, + "readCapacityUnits":{ + "shape":"CapacityUnits", + "documentation":"The provisioned read capacity units for the multi-Region table in the specified Amazon Web Services Region.
" + }, + "readCapacityAutoScaling":{ + "shape":"AutoScalingSettings", + "documentation":"The read capacity auto scaling settings for the multi-Region table in the specified Amazon Web Services Region.
" + } + }, + "documentation":"The Amazon Web Services Region specific settings of a multi-Region table.
For a multi-Region table, you can configure the table's read capacity differently per Amazon Web Services Region. You can do this by configuring the following parameters.
region: The Region where these settings are applied. (Required)
readCapacityUnits: The provisioned read capacity units. (Optional)
readCapacityAutoScaling: The read capacity auto scaling settings for the table. (Optional)
The Amazon Web Services Region.
" + }, + "status":{ + "shape":"TableStatus", + "documentation":"The status of the multi-Region table in the specified Amazon Web Services Region.
" + }, + "capacitySpecification":{"shape":"CapacitySpecificationSummary"} + }, + "documentation":"The Region-specific settings of a multi-Region table in the specified Amazon Web Services Region.
If the multi-Region table is using provisioned capacity and has optional auto scaling policies configured, note that the Region specific summary returns both read and write capacity settings. But only Region specific read capacity settings can be configured for a multi-Region table. In a multi-Region table, your write capacity units will be synced across all Amazon Web Services Regions to ensure that there is enough capacity to replicate write events across Regions.
" + }, + "ReplicaSpecificationSummaryList":{ + "type":"list", + "member":{"shape":"ReplicaSpecificationSummary"}, + "min":0 + }, + "ReplicationSpecification":{ + "type":"structure", + "required":["replicationStrategy"], + "members":{ + "replicationStrategy":{ + "shape":"rs", + "documentation":" The replicationStrategy of a keyspace, the required value is SINGLE_REGION or MULTI_REGION.
The regionList can contain up to six Amazon Web Services Regions where the keyspace is replicated in.
The replication specification of the keyspace includes:
regionList - up to six Amazon Web Services Regions where the keyspace is replicated in.
replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION.
Description of the error.
" + }, + "resourceArn":{ + "shape":"ARN", + "documentation":"The unique identifier in the format of Amazon Resource Name (ARN), for the resource not found.
" + } + }, + "documentation":"The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be ACTIVE.
The keyspace name of the source table.
" + }, + "sourceTableName":{ + "shape":"TableName", + "documentation":"The name of the source table.
" + }, + "targetKeyspaceName":{ + "shape":"KeyspaceName", + "documentation":"The name of the target keyspace.
" + }, + "targetTableName":{ + "shape":"TableName", + "documentation":"The name of the target table.
" + }, + "restoreTimestamp":{ + "shape":"Timestamp", + "documentation":"The restore timestamp in ISO 8601 format.
" + }, + "capacitySpecificationOverride":{ + "shape":"CapacitySpecification", + "documentation":"Specifies the read/write throughput capacity mode for the target table. The options are:
throughputMode:PAY_PER_REQUEST
throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.
The default is throughput_mode:PAY_PER_REQUEST.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
" + }, + "encryptionSpecificationOverride":{ + "shape":"EncryptionSpecification", + "documentation":"Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):
type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.
type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.
The default is type:AWS_OWNED_KMS_KEY.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
" + }, + "pointInTimeRecoveryOverride":{ + "shape":"PointInTimeRecovery", + "documentation":"Specifies the pointInTimeRecovery settings for the target table. The options are:
status=ENABLED
status=DISABLED
If it's not specified, the default is status=DISABLED.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
" + }, + "tagsOverride":{ + "shape":"TagList", + "documentation":"A list of key-value pair tags to be attached to the restored table.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
" + }, + "autoScalingSpecification":{ + "shape":"AutoScalingSpecification", + "documentation":"The optional auto scaling settings for the restored table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic.
For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
" + }, + "replicaSpecifications":{ + "shape":"ReplicaSpecificationList", + "documentation":"The optional Region specific settings of a multi-Regional table.
" + } + } + }, + "RestoreTableResponse":{ + "type":"structure", + "required":["restoredTableARN"], + "members":{ + "restoredTableARN":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the restored table.
" + } + } + }, + "SchemaDefinition":{ + "type":"structure", + "required":[ + "allColumns", + "partitionKeys" + ], + "members":{ + "allColumns":{ + "shape":"ColumnDefinitionList", + "documentation":"The regular columns of the table.
" + }, + "partitionKeys":{ + "shape":"PartitionKeyList", + "documentation":"The columns that are part of the partition key of the table .
" + }, + "clusteringKeys":{ + "shape":"ClusteringKeyList", + "documentation":"The columns that are part of the clustering key of the table.
" + }, + "staticColumns":{ + "shape":"StaticColumnList", + "documentation":"The columns that have been defined as STATIC. Static columns store values that are shared by all rows in the same partition.
Describes the schema of the table.
" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"Description of the error.
" + } + }, + "documentation":"The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
", + "exception":true + }, + "SortOrder":{ + "type":"string", + "enum":[ + "ASC", + "DESC" + ] + }, + "StaticColumn":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"GenericString", + "documentation":"The name of the static column.
" + } + }, + "documentation":"The static columns of the table. Static columns store values that are shared by all rows in the same partition.
" + }, + "StaticColumnList":{ + "type":"list", + "member":{"shape":"StaticColumn"} + }, + "String":{"type":"string"}, + "TableName":{ + "type":"string", + "max":48, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_]{0,47}" + }, + "TableStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "CREATING", + "UPDATING", + "DELETING", + "DELETED", + "RESTORING", + "INACCESSIBLE_ENCRYPTION_CREDENTIALS" + ] + }, + "TableSummary":{ + "type":"structure", + "required":[ + "keyspaceName", + "tableName", + "resourceArn" + ], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"The name of the keyspace that the table is stored in.
" + }, + "tableName":{ + "shape":"TableName", + "documentation":"The name of the table.
" + }, + "resourceArn":{ + "shape":"ARN", + "documentation":"The unique identifier of the table in the format of an Amazon Resource Name (ARN).
" + } + }, + "documentation":"Returns the name of the specified table, the keyspace it is stored in, and the unique identifier in the format of an Amazon Resource Name (ARN).
" + }, + "TableSummaryList":{ + "type":"list", + "member":{"shape":"TableSummary"} + }, + "Tag":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
" + }, + "value":{ + "shape":"TagValue", + "documentation":"The value of the tag. Tag values are case-sensitive and can be null.
" + } + }, + "documentation":"Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource.
Amazon Web Services-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":60, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which to add tags.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags to be assigned to the Amazon Keyspaces resource.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1 + }, + "TargetTrackingScalingPolicyConfiguration":{ + "type":"structure", + "required":["targetValue"], + "members":{ + "disableScaleIn":{ + "shape":"BooleanObject", + "documentation":"Specifies if scale-in is enabled.
When auto scaling automatically decreases capacity for a table, the table scales in. When scaling policies are set, they can't scale in the table lower than its minimum capacity.
" + }, + "scaleInCooldown":{ + "shape":"IntegerObject", + "documentation":"Specifies a scale-in cool down period.
A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.
" + }, + "scaleOutCooldown":{ + "shape":"IntegerObject", + "documentation":"Specifies a scale out cool down period.
A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.
" + }, + "targetValue":{ + "shape":"DoubleObject", + "documentation":"Specifies the target value for the target tracking auto scaling policy.
Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90.
The auto scaling policy that scales a table based on the ratio of consumed to provisioned capacity.
" + }, + "ThroughputMode":{ + "type":"string", + "enum":[ + "PAY_PER_REQUEST", + "PROVISIONED" + ] + }, + "TimeToLive":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"TimeToLiveStatus", + "documentation":"Shows how to enable custom Time to Live (TTL) settings for the specified table.
" + } + }, + "documentation":"Enable custom Time to Live (TTL) settings for rows and columns without setting a TTL default for the specified table.
For more information, see Enabling TTL on tables in the Amazon Keyspaces Developer Guide.
" + }, + "TimeToLiveStatus":{ + "type":"string", + "enum":["ENABLED"] + }, + "Timestamp":{"type":"timestamp"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ARN", + "documentation":"The Amazon Keyspaces resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).
" + }, + "tags":{ + "shape":"TagList", + "documentation":"A list of existing tags to be removed from the Amazon Keyspaces resource.
" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateTableRequest":{ + "type":"structure", + "required":[ + "keyspaceName", + "tableName" + ], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"The name of the keyspace the specified table is stored in.
" + }, + "tableName":{ + "shape":"TableName", + "documentation":"The name of the table.
" + }, + "addColumns":{ + "shape":"ColumnDefinitionList", + "documentation":"For each column to be added to the specified table:
name - The name of the column.
type - An Amazon Keyspaces data type. For more information, see Data types in the Amazon Keyspaces Developer Guide.
Modifies the read/write throughput capacity mode for the table. The options are:
throughputMode:PAY_PER_REQUEST and
throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.
The default is throughput_mode:PAY_PER_REQUEST.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
" + }, + "encryptionSpecification":{ + "shape":"EncryptionSpecification", + "documentation":"Modifies the encryption settings of the table. You can choose one of the following KMS key (KMS key):
type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.
type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.
The default is AWS_OWNED_KMS_KEY.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
" + }, + "pointInTimeRecovery":{ + "shape":"PointInTimeRecovery", + "documentation":"Modifies the pointInTimeRecovery settings of the table. The options are:
status=ENABLED
status=DISABLED
If it's not specified, the default is status=DISABLED.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
" + }, + "ttl":{ + "shape":"TimeToLive", + "documentation":"Modifies Time to Live custom settings for the table. The options are:
status:enabled
status:disabled
The default is status:disabled. After ttl is enabled, you can't disable it for the table.
For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
" + }, + "defaultTimeToLive":{ + "shape":"DefaultTimeToLive", + "documentation":"The default Time to Live setting in seconds for the table.
For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.
" + }, + "clientSideTimestamps":{ + "shape":"ClientSideTimestamps", + "documentation":"Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option:
status: \"enabled\"
Once client-side timestamps are enabled for a table, this setting cannot be disabled.
" + }, + "autoScalingSpecification":{ + "shape":"AutoScalingSpecification", + "documentation":"The optional auto scaling settings to update for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic.
If auto scaling is already enabled for the table, you can use UpdateTable to update the minimum and maximum values or the auto scaling policy settings independently.
For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
" + }, + "replicaSpecifications":{ + "shape":"ReplicaSpecificationList", + "documentation":"The Region specific settings of a multi-Regional table.
" + } + } + }, + "UpdateTableResponse":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the modified table.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"Description of the error.
" + } + }, + "documentation":"The operation failed due to an invalid or malformed request.
", + "exception":true + }, + "kmsKeyARN":{ + "type":"string", + "max":5096, + "min":1 + }, + "region":{ + "type":"string", + "max":25, + "min":2 + }, + "rs":{ + "type":"string", + "enum":[ + "SINGLE_REGION", + "MULTI_REGION" + ], + "max":20, + "min":1 + } + }, + "documentation":"Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate, run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software.
In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI, as well as infrastructure as code (IaC) services and tools such as CloudFormation and Terraform. This API reference describes the supported DDL operations in detail.
For the list of all supported CQL APIs, see Supported Cassandra APIs, operations, and data types in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.
To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see Amazon Keyspaces information in CloudTrail in the Amazon Keyspaces Developer Guide.
For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see Amazon Web Services APIs in the General Reference.
" +} diff --git a/testbed/boto__botocore/botocore/data/keyspaces/2022-02-10/waiters-2.json b/testbed/boto__botocore/botocore/data/keyspaces/2022-02-10/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..4b20636aa4c8b334eca901959d698c0b98cba6d6 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/keyspaces/2022-02-10/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/kinesis-video-webrtc-storage/2018-05-10/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/kinesis-video-webrtc-storage/2018-05-10/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..d6abb57a2f6ad03a425174e41e0f9a428712d20e --- /dev/null +++ b/testbed/boto__botocore/botocore/data/kinesis-video-webrtc-storage/2018-05-10/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kinesisvideo-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kinesisvideo-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kinesisvideo.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kinesisvideo.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/kinesis-video-webrtc-storage/2018-05-10/paginators-1.json b/testbed/boto__botocore/botocore/data/kinesis-video-webrtc-storage/2018-05-10/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..ea142457a6a77d6e6a54942329f1199bc2f2a60c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/kinesis-video-webrtc-storage/2018-05-10/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/testbed/boto__botocore/botocore/data/kinesis-video-webrtc-storage/2018-05-10/service-2.json b/testbed/boto__botocore/botocore/data/kinesis-video-webrtc-storage/2018-05-10/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..db6f10b9f52e7d651c22442cc3635c278b90a7e1 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/kinesis-video-webrtc-storage/2018-05-10/service-2.json @@ -0,0 +1,137 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-05-10", + "endpointPrefix":"kinesisvideo", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon Kinesis Video WebRTC Storage", + "serviceId":"Kinesis Video WebRTC Storage", + "signatureVersion":"v4", + "signingName":"kinesisvideo", + "uid":"kinesis-video-webrtc-storage-2018-05-10" + }, + "operations":{ + "JoinStorageSession":{ + "name":"JoinStorageSession", + "http":{ + "method":"POST", + "requestUri":"/joinStorageSession", + "responseCode":200 + }, + "input":{"shape":"JoinStorageSessionInput"}, + "errors":[ + {"shape":"ClientLimitExceededException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Before using this API, you must call the GetSignalingChannelEndpoint API to request the WEBRTC endpoint. You then specify the endpoint and region in your JoinStorageSession API request.
Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing device for an input channel. If there’s no existing session for the channel, a new streaming session needs to be created, and the Amazon Resource Name (ARN) of the signaling channel must be provided.
Currently for the SINGLE_MASTER type, a video producing device is able to ingest both audio and video media into a stream. Only video producing devices can join the session and record media.
Both audio and video tracks are currently required for WebRTC ingestion.
Current requirements:
Video track: H.264
Audio track: Opus
The resulting ingested video in the Kinesis video stream will have the following parameters: H.264 video and AAC audio.
Once a master participant has negotiated a connection through WebRTC, the ingested media session will be stored in the Kinesis video stream. Multiple viewers are then able to play back real-time media through our Playback APIs.
You can also use existing Kinesis Video Streams features like HLS or DASH playback, image generation via GetImages, and more with ingested WebRTC media.
S3 image delivery and notifications are not currently supported.
Assume that only one video producing device client can be associated with a session for the channel. If more than one client joins the session of a specific channel as a video producing device, the most recent client request takes precedence.
Additional information
Idempotent - This API is not idempotent.
Retry behavior - This is counted as a new API call.
Concurrent calls - Concurrent calls are allowed. An offer is sent once per each call.
Join the ongoing one way-video and/or multi-way audio WebRTC session as a viewer for an input channel. If there’s no existing session for the channel, create a new streaming session and provide the Amazon Resource Name (ARN) of the signaling channel (channelArn) and client id (clientId).
Currently for SINGLE_MASTER type, a video producing device is able to ingest both audio and video media into a stream, while viewers can only ingest audio. Both a video producing device and viewers can join a session first and wait for other participants. While participants are having peer to peer conversations through WebRTC, the ingested media session will be stored into the Kinesis Video Stream. Multiple viewers are able to playback real-time media.
Customers can also use existing Kinesis Video Streams features like HLS or DASH playback, Image generation, and more with ingested WebRTC media. If there’s an existing session with the same clientId that's found in the join session request, the new request takes precedence.
You do not have required permissions to perform this operation.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "ChannelArn":{ + "type":"string", + "pattern":"^arn:(aws[a-zA-Z-]*):kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+$" + }, + "ClientId":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z0-9_.-]+$" + }, + "ClientLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidArgumentException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The value for this input parameter is invalid.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "JoinStorageSessionAsViewerInput":{ + "type":"structure", + "required":[ + "channelArn", + "clientId" + ], + "members":{ + "channelArn":{ + "shape":"ChannelArn", + "documentation":"The Amazon Resource Name (ARN) of the signaling channel.
" + }, + "clientId":{ + "shape":"ClientId", + "documentation":"The unique identifier for the sender client.
" + } + } + }, + "JoinStorageSessionInput":{ + "type":"structure", + "required":["channelArn"], + "members":{ + "channelArn":{ + "shape":"ChannelArn", + "documentation":"The Amazon Resource Name (ARN) of the signaling channel.
" + } + } + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The specified resource is not found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"} + }, + "documentation":"" +} diff --git a/testbed/boto__botocore/botocore/data/license-manager-linux-subscriptions/2018-05-10/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/license-manager-linux-subscriptions/2018-05-10/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..d624f6615f23f07192652258197e9a62c6273831 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/license-manager-linux-subscriptions/2018-05-10/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://license-manager-linux-subscriptions-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://license-manager-linux-subscriptions-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://license-manager-linux-subscriptions.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://license-manager-linux-subscriptions.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/license-manager-linux-subscriptions/2018-05-10/paginators-1.json b/testbed/boto__botocore/botocore/data/license-manager-linux-subscriptions/2018-05-10/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..6d74d22e337068dec93d0af1a920ff0c5c954cbe --- /dev/null +++ b/testbed/boto__botocore/botocore/data/license-manager-linux-subscriptions/2018-05-10/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListLinuxSubscriptionInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Instances" + }, + "ListLinuxSubscriptions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Subscriptions" + }, + "ListRegisteredSubscriptionProviders": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RegisteredSubscriptionProviders" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/license-manager-linux-subscriptions/2018-05-10/service-2.json b/testbed/boto__botocore/botocore/data/license-manager-linux-subscriptions/2018-05-10/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..e3d923c11d1d2b6101effc337760ef07d4c97c52 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/license-manager-linux-subscriptions/2018-05-10/service-2.json @@ -0,0 +1,859 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-05-10", + "endpointPrefix":"license-manager-linux-subscriptions", + "jsonVersion":"1.1", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"AWS License Manager Linux Subscriptions", + "serviceId":"License Manager Linux Subscriptions", + "signatureVersion":"v4", + "signingName":"license-manager-linux-subscriptions", + "uid":"license-manager-linux-subscriptions-2018-05-10", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "DeregisterSubscriptionProvider":{ + "name":"DeregisterSubscriptionProvider", + "http":{ + "method":"POST", + "requestUri":"/subscription/DeregisterSubscriptionProvider", + "responseCode":200 + }, + "input":{"shape":"DeregisterSubscriptionProviderRequest"}, + "output":{"shape":"DeregisterSubscriptionProviderResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"
Remove a third-party subscription provider from the Bring Your Own License (BYOL) subscriptions registered to your account.
", + "idempotent":true + }, + "GetRegisteredSubscriptionProvider":{ + "name":"GetRegisteredSubscriptionProvider", + "http":{ + "method":"POST", + "requestUri":"/subscription/GetRegisteredSubscriptionProvider", + "responseCode":200 + }, + "input":{"shape":"GetRegisteredSubscriptionProviderRequest"}, + "output":{"shape":"GetRegisteredSubscriptionProviderResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Get details for a Bring Your Own License (BYOL) subscription that's registered to your account.
", + "idempotent":true + }, + "GetServiceSettings":{ + "name":"GetServiceSettings", + "http":{ + "method":"POST", + "requestUri":"/subscription/GetServiceSettings", + "responseCode":200 + }, + "input":{"shape":"GetServiceSettingsRequest"}, + "output":{"shape":"GetServiceSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Lists the Linux subscriptions service settings for your account.
", + "idempotent":true + }, + "ListLinuxSubscriptionInstances":{ + "name":"ListLinuxSubscriptionInstances", + "http":{ + "method":"POST", + "requestUri":"/subscription/ListLinuxSubscriptionInstances", + "responseCode":200 + }, + "input":{"shape":"ListLinuxSubscriptionInstancesRequest"}, + "output":{"shape":"ListLinuxSubscriptionInstancesResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Lists the running Amazon EC2 instances that were discovered with commercial Linux subscriptions.
", + "idempotent":true + }, + "ListLinuxSubscriptions":{ + "name":"ListLinuxSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/subscription/ListLinuxSubscriptions", + "responseCode":200 + }, + "input":{"shape":"ListLinuxSubscriptionsRequest"}, + "output":{"shape":"ListLinuxSubscriptionsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Lists the Linux subscriptions that have been discovered. If you have linked your organization, the returned results will include data aggregated across your accounts in Organizations.
", + "idempotent":true + }, + "ListRegisteredSubscriptionProviders":{ + "name":"ListRegisteredSubscriptionProviders", + "http":{ + "method":"POST", + "requestUri":"/subscription/ListRegisteredSubscriptionProviders", + "responseCode":200 + }, + "input":{"shape":"ListRegisteredSubscriptionProvidersRequest"}, + "output":{"shape":"ListRegisteredSubscriptionProvidersResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"List Bring Your Own License (BYOL) subscription registration resources for your account.
", + "idempotent":true + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"List the metadata tags that are assigned to the specified Amazon Web Services resource.
" + }, + "RegisterSubscriptionProvider":{ + "name":"RegisterSubscriptionProvider", + "http":{ + "method":"POST", + "requestUri":"/subscription/RegisterSubscriptionProvider", + "responseCode":200 + }, + "input":{"shape":"RegisterSubscriptionProviderRequest"}, + "output":{"shape":"RegisterSubscriptionProviderResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Register the supported third-party subscription provider for your Bring Your Own License (BYOL) subscription.
", + "idempotent":true + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"PUT", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Add metadata tags to the specified Amazon Web Services resource.
", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Remove one or more metadata tag from the specified Amazon Web Services resource.
", + "idempotent":true + }, + "UpdateServiceSettings":{ + "name":"UpdateServiceSettings", + "http":{ + "method":"POST", + "requestUri":"/subscription/UpdateServiceSettings", + "responseCode":200 + }, + "input":{"shape":"UpdateServiceSettingsRequest"}, + "output":{"shape":"UpdateServiceSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates the service settings for Linux subscriptions.
", + "idempotent":true + } + }, + "shapes":{ + "Boolean":{ + "type":"boolean", + "box":true + }, + "BoxInteger":{ + "type":"integer", + "box":true + }, + "BoxLong":{ + "type":"long", + "box":true + }, + "DeregisterSubscriptionProviderRequest":{ + "type":"structure", + "required":["SubscriptionProviderArn"], + "members":{ + "SubscriptionProviderArn":{ + "shape":"SubscriptionProviderArn", + "documentation":"The Amazon Resource Name (ARN) of the subscription provider resource to deregister.
" + } + } + }, + "DeregisterSubscriptionProviderResponse":{ + "type":"structure", + "members":{ + } + }, + "Filter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"The type of name to filter by.
" + }, + "Operator":{ + "shape":"Operator", + "documentation":"An operator for filtering results.
" + }, + "Values":{ + "shape":"StringList", + "documentation":"One or more values for the name to filter by.
" + } + }, + "documentation":"A filter object that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria.
" + }, + "FilterList":{ + "type":"list", + "member":{"shape":"Filter"} + }, + "GetRegisteredSubscriptionProviderRequest":{ + "type":"structure", + "required":["SubscriptionProviderArn"], + "members":{ + "SubscriptionProviderArn":{ + "shape":"SubscriptionProviderArn", + "documentation":"The Amazon Resource Name (ARN) of the BYOL registration resource to get details for.
" + } + } + }, + "GetRegisteredSubscriptionProviderResponse":{ + "type":"structure", + "members":{ + "LastSuccessfulDataRetrievalTime":{ + "shape":"String", + "documentation":"The timestamp from the last time License Manager retrieved subscription details from your registered third-party Linux subscription provider.
" + }, + "SecretArn":{ + "shape":"SecretArn", + "documentation":"The Amazon Resource Name (ARN) of the third-party access secret stored in Secrets Manager for the BYOL registration resource specified in the request.
" + }, + "SubscriptionProviderArn":{ + "shape":"SubscriptionProviderArn", + "documentation":"The Amazon Resource Name (ARN) for the BYOL registration resource specified in the request.
" + }, + "SubscriptionProviderSource":{ + "shape":"SubscriptionProviderSource", + "documentation":"The subscription provider for the BYOL registration resource specified in the request.
" + }, + "SubscriptionProviderStatus":{ + "shape":"SubscriptionProviderStatus", + "documentation":"The status of the Linux subscription provider access token from the last successful subscription data request.
" + }, + "SubscriptionProviderStatusMessage":{ + "shape":"String", + "documentation":"The detailed message from your subscription provider token status.
" + } + } + }, + "GetServiceSettingsRequest":{ + "type":"structure", + "members":{ + } + }, + "GetServiceSettingsResponse":{ + "type":"structure", + "members":{ + "HomeRegions":{ + "shape":"StringList", + "documentation":"The Region in which License Manager displays the aggregated data for Linux subscriptions.
" + }, + "LinuxSubscriptionsDiscovery":{ + "shape":"LinuxSubscriptionsDiscovery", + "documentation":"Lists if discovery has been enabled for Linux subscriptions.
" + }, + "LinuxSubscriptionsDiscoverySettings":{ + "shape":"LinuxSubscriptionsDiscoverySettings", + "documentation":"Lists the settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.
" + }, + "Status":{ + "shape":"Status", + "documentation":"Indicates the status of Linux subscriptions settings being applied.
" + }, + "StatusMessage":{ + "shape":"StringMap", + "documentation":"A message which details the Linux subscriptions service settings current status.
" + } + } + }, + "Instance":{ + "type":"structure", + "members":{ + "AccountID":{ + "shape":"String", + "documentation":"The account ID which owns the instance.
" + }, + "AmiId":{ + "shape":"String", + "documentation":"The AMI ID used to launch the instance.
" + }, + "DualSubscription":{ + "shape":"String", + "documentation":"Indicates that you have two different license subscriptions for the same software on your instance.
" + }, + "InstanceID":{ + "shape":"String", + "documentation":"The instance ID of the resource.
" + }, + "InstanceType":{ + "shape":"String", + "documentation":"The instance type of the resource.
" + }, + "LastUpdatedTime":{ + "shape":"String", + "documentation":"The time in which the last discovery updated the instance details.
" + }, + "OsVersion":{ + "shape":"String", + "documentation":"The operating system software version that runs on your instance.
" + }, + "ProductCode":{ + "shape":"ProductCodeList", + "documentation":"The product code for the instance. For more information, see Usage operation values in the License Manager User Guide .
" + }, + "Region":{ + "shape":"String", + "documentation":"The Region the instance is running in.
" + }, + "RegisteredWithSubscriptionProvider":{ + "shape":"String", + "documentation":"Indicates that your instance uses a BYOL license subscription from a third-party Linux subscription provider that you've registered with License Manager.
" + }, + "Status":{ + "shape":"String", + "documentation":"The status of the instance.
" + }, + "SubscriptionName":{ + "shape":"String", + "documentation":"The name of the license subscription that the instance uses.
" + }, + "SubscriptionProviderCreateTime":{ + "shape":"String", + "documentation":"The timestamp when you registered the third-party Linux subscription provider for the subscription that the instance uses.
" + }, + "SubscriptionProviderUpdateTime":{ + "shape":"String", + "documentation":"The timestamp from the last time that the instance synced with the registered third-party Linux subscription provider.
" + }, + "UsageOperation":{ + "shape":"String", + "documentation":"The usage operation of the instance. For more information, see For more information, see Usage operation values in the License Manager User Guide.
" + } + }, + "documentation":"Details discovered information about a running instance using Linux subscriptions.
" + }, + "InstanceList":{ + "type":"list", + "member":{"shape":"Instance"} + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"An exception occurred with the service.
", + "exception":true, + "fault":true + }, + "LinuxSubscriptionsDiscovery":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "LinuxSubscriptionsDiscoverySettings":{ + "type":"structure", + "required":[ + "OrganizationIntegration", + "SourceRegions" + ], + "members":{ + "OrganizationIntegration":{ + "shape":"OrganizationIntegration", + "documentation":"Details if you have enabled resource discovery across your accounts in Organizations.
" + }, + "SourceRegions":{ + "shape":"StringList", + "documentation":"The Regions in which to discover data for Linux subscriptions.
" + } + }, + "documentation":"Lists the settings defined for discovering Linux subscriptions.
" + }, + "ListLinuxSubscriptionInstancesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"An array of structures that you can use to filter the results by your specified criteria. For example, you can specify Region in the Name, with the contains operator to list all subscriptions that match a partial string in the Value, such as us-west.
For each filter, you can specify one of the following values for the Name key to streamline results:
AccountID
AmiID
DualSubscription
InstanceID
InstanceType
ProductCode
Region
Status
UsageOperation
For each filter, you can use one of the following Operator values to define the behavior of the filter:
contains
equals
Notequal
The maximum items to return in a request.
" + }, + "NextToken":{ + "shape":"ListLinuxSubscriptionInstancesRequestNextTokenString", + "documentation":"A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" + } + }, + "documentation":"NextToken length limit is half of ddb accepted limit. Increase this limit if parameters in request increases.
" + }, + "ListLinuxSubscriptionInstancesRequestNextTokenString":{ + "type":"string", + "max":16384, + "min":1 + }, + "ListLinuxSubscriptionInstancesResponse":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"InstanceList", + "documentation":"An array that contains instance objects.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" + } + } + }, + "ListLinuxSubscriptionsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify. For example, you can filter by the name of Subscription with an optional operator to see subscriptions that match, partially match, or don't match a certain subscription's name.
The valid names for this filter are:
Subscription
The valid Operators for this filter are:
contains
equals
Notequal
The maximum items to return in a request.
" + }, + "NextToken":{ + "shape":"ListLinuxSubscriptionsRequestNextTokenString", + "documentation":"A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" + } + }, + "documentation":"NextToken length limit is half of ddb accepted limit. Increase this limit if parameters in request increases.
" + }, + "ListLinuxSubscriptionsRequestNextTokenString":{ + "type":"string", + "max":16384, + "min":1 + }, + "ListLinuxSubscriptionsResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" + }, + "Subscriptions":{ + "shape":"SubscriptionList", + "documentation":"An array that contains subscription objects.
" + } + } + }, + "ListRegisteredSubscriptionProvidersRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListRegisteredSubscriptionProvidersRequestMaxResultsInteger", + "documentation":"The maximum items to return in a request.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" + }, + "SubscriptionProviderSources":{ + "shape":"SubscriptionProviderSourceList", + "documentation":"To filter your results, specify which subscription providers to return in the list.
" + } + } + }, + "ListRegisteredSubscriptionProvidersRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListRegisteredSubscriptionProvidersResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" + }, + "RegisteredSubscriptionProviders":{ + "shape":"RegisteredSubscriptionProviderList", + "documentation":"The list of BYOL registration resources that fit the criteria you specified in the request.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"SubscriptionProviderArn", + "documentation":"The Amazon Resource Name (ARN) of the resource for which to list metadata tags.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"Tags", + "documentation":"The metadata tags for the requested resource.
" + } + } + }, + "Operator":{ + "type":"string", + "enum":[ + "Equal", + "NotEqual", + "Contains" + ], + "max":20, + "min":1 + }, + "OrganizationIntegration":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "ProductCodeList":{ + "type":"list", + "member":{"shape":"String"} + }, + "RegisterSubscriptionProviderRequest":{ + "type":"structure", + "required":[ + "SecretArn", + "SubscriptionProviderSource" + ], + "members":{ + "SecretArn":{ + "shape":"SecretArn", + "documentation":"The Amazon Resource Name (ARN) of the secret where you've stored your subscription provider's access token. For RHEL subscriptions managed through the Red Hat Subscription Manager (RHSM), the secret contains your Red Hat Offline token.
" + }, + "SubscriptionProviderSource":{ + "shape":"SubscriptionProviderSource", + "documentation":"The supported Linux subscription provider to register.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"The metadata tags to assign to your registered Linux subscription provider resource.
" + } + } + }, + "RegisterSubscriptionProviderResponse":{ + "type":"structure", + "members":{ + "SubscriptionProviderArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered.
" + }, + "SubscriptionProviderSource":{ + "shape":"SubscriptionProviderSource", + "documentation":"The Linux subscription provider that you registered.
" + }, + "SubscriptionProviderStatus":{ + "shape":"SubscriptionProviderStatus", + "documentation":"Indicates the status of the registration action for the Linux subscription provider that you requested.
" + } + } + }, + "RegisteredSubscriptionProvider":{ + "type":"structure", + "members":{ + "LastSuccessfulDataRetrievalTime":{ + "shape":"String", + "documentation":"The timestamp from the last time that License Manager accessed third-party subscription data for your account from your registered Linux subscription provider.
" + }, + "SecretArn":{ + "shape":"SecretArn", + "documentation":"The Amazon Resource Name (ARN) of the Secrets Manager secret that stores your registered Linux subscription provider access token. For RHEL account subscriptions, this is the offline token.
" + }, + "SubscriptionProviderArn":{ + "shape":"SubscriptionProviderArn", + "documentation":"The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered.
" + }, + "SubscriptionProviderSource":{ + "shape":"SubscriptionProviderSource", + "documentation":"A supported third-party Linux subscription provider. License Manager currently supports Red Hat subscriptions.
" + }, + "SubscriptionProviderStatus":{ + "shape":"SubscriptionProviderStatus", + "documentation":"Indicates the status of your registered Linux subscription provider access token from the last time License Manager retrieved subscription data. For RHEL account subscriptions, this is the status of the offline token.
" + }, + "SubscriptionProviderStatusMessage":{ + "shape":"String", + "documentation":"A detailed message that's associated with your BYOL subscription provider token status.
" + } + }, + "documentation":"A third-party provider for operating system (OS) platform software and license subscriptions, such as Red Hat. When you register a third-party Linux subscription provider, License Manager can get subscription data from the registered provider.
" + }, + "RegisteredSubscriptionProviderList":{ + "type":"list", + "member":{"shape":"RegisteredSubscriptionProvider"} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Unable to find the requested Amazon Web Services resource.
", + "exception":true + }, + "SecretArn":{ + "type":"string", + "pattern":"^arn:[a-z0-9-\\.]{1,63}:secretsmanager:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:secret:[^/]{1,1023}$" + }, + "Status":{ + "type":"string", + "enum":[ + "InProgress", + "Completed", + "Successful", + "Failed" + ] + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"StringListMemberString"}, + "max":100, + "min":1 + }, + "StringListMemberString":{ + "type":"string", + "max":100, + "min":1 + }, + "StringMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "Subscription":{ + "type":"structure", + "members":{ + "InstanceCount":{ + "shape":"BoxLong", + "documentation":"The total amount of running instances using this subscription.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the subscription.
" + }, + "Type":{ + "shape":"String", + "documentation":"The type of subscription. The type can be subscription-included with Amazon EC2, Bring Your Own Subscription model (BYOS), or from the Amazon Web Services Marketplace. Certain subscriptions may use licensing from the Amazon Web Services Marketplace as well as OS licensing from Amazon EC2 or BYOS.
" + } + }, + "documentation":"An object which details a discovered Linux subscription.
" + }, + "SubscriptionList":{ + "type":"list", + "member":{"shape":"Subscription"} + }, + "SubscriptionProviderArn":{ + "type":"string", + "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{1,510}/[a-z0-9-\\.]{1,510}$" + }, + "SubscriptionProviderSource":{ + "type":"string", + "enum":["RedHat"] + }, + "SubscriptionProviderSourceList":{ + "type":"list", + "member":{"shape":"SubscriptionProviderSource"} + }, + "SubscriptionProviderStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "INVALID", + "PENDING" + ] + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"String"}, + "max":50, + "min":0, + "sensitive":true + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"SubscriptionProviderArn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services resource to which to add the specified metadata tags.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"Tags", + "documentation":"The metadata tags to assign to the Amazon Web Services resource. Tags are formatted as key value pairs.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "Tags":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"}, + "max":50, + "min":0, + "sensitive":true + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request was denied due to request throttling.
", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"SubscriptionProviderArn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services resource to remove the metadata tags from.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"A list of metadata tag keys to remove from the requested resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateServiceSettingsRequest":{ + "type":"structure", + "required":[ + "LinuxSubscriptionsDiscovery", + "LinuxSubscriptionsDiscoverySettings" + ], + "members":{ + "AllowUpdate":{ + "shape":"Boolean", + "documentation":"Describes if updates are allowed to the service settings for Linux subscriptions. If you allow updates, you can aggregate Linux subscription data in more than one home Region.
" + }, + "LinuxSubscriptionsDiscovery":{ + "shape":"LinuxSubscriptionsDiscovery", + "documentation":"Describes if the discovery of Linux subscriptions is enabled.
" + }, + "LinuxSubscriptionsDiscoverySettings":{ + "shape":"LinuxSubscriptionsDiscoverySettings", + "documentation":"The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.
" + } + } + }, + "UpdateServiceSettingsResponse":{ + "type":"structure", + "members":{ + "HomeRegions":{ + "shape":"StringList", + "documentation":"The Region in which License Manager displays the aggregated data for Linux subscriptions.
" + }, + "LinuxSubscriptionsDiscovery":{ + "shape":"LinuxSubscriptionsDiscovery", + "documentation":"Lists if discovery has been enabled for Linux subscriptions.
" + }, + "LinuxSubscriptionsDiscoverySettings":{ + "shape":"LinuxSubscriptionsDiscoverySettings", + "documentation":"The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.
" + }, + "Status":{ + "shape":"Status", + "documentation":"Indicates the status of Linux subscriptions settings being applied.
" + }, + "StatusMessage":{ + "shape":"StringMap", + "documentation":"A message which details the Linux subscriptions service settings current status.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The provided input is not valid. Try your request again.
", + "exception":true + } + }, + "documentation":"With License Manager, you can discover and track your commercial Linux subscriptions on running Amazon EC2 instances.
" +} diff --git a/testbed/boto__botocore/botocore/data/license-manager-user-subscriptions/2018-05-10/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/license-manager-user-subscriptions/2018-05-10/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..3e1310cac32a59d5ae7c6af7dcbd393c775e7fcf --- /dev/null +++ b/testbed/boto__botocore/botocore/data/license-manager-user-subscriptions/2018-05-10/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://license-manager-user-subscriptions-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://license-manager-user-subscriptions-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://license-manager-user-subscriptions.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://license-manager-user-subscriptions.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/license-manager-user-subscriptions/2018-05-10/paginators-1.json b/testbed/boto__botocore/botocore/data/license-manager-user-subscriptions/2018-05-10/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..a212681a98721c6c514cfe9508ff3ff6ac8dbdad --- /dev/null +++ b/testbed/boto__botocore/botocore/data/license-manager-user-subscriptions/2018-05-10/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "ListIdentityProviders": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "IdentityProviderSummaries" + }, + "ListInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InstanceSummaries" + }, + "ListProductSubscriptions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ProductUserSummaries" + }, + "ListUserAssociations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InstanceUserSummaries" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/license-manager-user-subscriptions/2018-05-10/service-2.json b/testbed/boto__botocore/botocore/data/license-manager-user-subscriptions/2018-05-10/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..6ee109c18c504d256bb3eb777de6c9d535aad3be --- /dev/null +++ b/testbed/boto__botocore/botocore/data/license-manager-user-subscriptions/2018-05-10/service-2.json @@ -0,0 +1,950 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-05-10", + "endpointPrefix":"license-manager-user-subscriptions", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"AWS License Manager User Subscriptions", + "serviceId":"License Manager User Subscriptions", + "signatureVersion":"v4", + "signingName":"license-manager-user-subscriptions", + "uid":"license-manager-user-subscriptions-2018-05-10" + }, + "operations":{ + "AssociateUser":{ + "name":"AssociateUser", + "http":{ + "method":"POST", + "requestUri":"/user/AssociateUser", + "responseCode":200 + }, + "input":{"shape":"AssociateUserRequest"}, + "output":{"shape":"AssociateUserResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Associates the user to an EC2 instance to utilize user-based subscriptions.
Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.
Deregisters the identity provider from providing user-based subscriptions.
", + "idempotent":true + }, + "DisassociateUser":{ + "name":"DisassociateUser", + "http":{ + "method":"POST", + "requestUri":"/user/DisassociateUser", + "responseCode":200 + }, + "input":{"shape":"DisassociateUserRequest"}, + "output":{"shape":"DisassociateUserResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Disassociates the user from an EC2 instance providing user-based subscriptions.
", + "idempotent":true + }, + "ListIdentityProviders":{ + "name":"ListIdentityProviders", + "http":{ + "method":"POST", + "requestUri":"/identity-provider/ListIdentityProviders", + "responseCode":200 + }, + "input":{"shape":"ListIdentityProvidersRequest"}, + "output":{"shape":"ListIdentityProvidersResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists the identity providers for user-based subscriptions.
" + }, + "ListInstances":{ + "name":"ListInstances", + "http":{ + "method":"POST", + "requestUri":"/instance/ListInstances", + "responseCode":200 + }, + "input":{"shape":"ListInstancesRequest"}, + "output":{"shape":"ListInstancesResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists the EC2 instances providing user-based subscriptions.
" + }, + "ListProductSubscriptions":{ + "name":"ListProductSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/user/ListProductSubscriptions", + "responseCode":200 + }, + "input":{"shape":"ListProductSubscriptionsRequest"}, + "output":{"shape":"ListProductSubscriptionsResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists the user-based subscription products available from an identity provider.
" + }, + "ListUserAssociations":{ + "name":"ListUserAssociations", + "http":{ + "method":"POST", + "requestUri":"/user/ListUserAssociations", + "responseCode":200 + }, + "input":{"shape":"ListUserAssociationsRequest"}, + "output":{"shape":"ListUserAssociationsResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists user associations for an identity provider.
" + }, + "RegisterIdentityProvider":{ + "name":"RegisterIdentityProvider", + "http":{ + "method":"POST", + "requestUri":"/identity-provider/RegisterIdentityProvider", + "responseCode":200 + }, + "input":{"shape":"RegisterIdentityProviderRequest"}, + "output":{"shape":"RegisterIdentityProviderResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Registers an identity provider for user-based subscriptions.
", + "idempotent":true + }, + "StartProductSubscription":{ + "name":"StartProductSubscription", + "http":{ + "method":"POST", + "requestUri":"/user/StartProductSubscription", + "responseCode":200 + }, + "input":{"shape":"StartProductSubscriptionRequest"}, + "output":{"shape":"StartProductSubscriptionResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Starts a product subscription for a user with the specified identity provider.
Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.
Stops a product subscription for a user with the specified identity provider.
" + }, + "UpdateIdentityProviderSettings":{ + "name":"UpdateIdentityProviderSettings", + "http":{ + "method":"POST", + "requestUri":"/identity-provider/UpdateIdentityProviderSettings", + "responseCode":200 + }, + "input":{"shape":"UpdateIdentityProviderSettingsRequest"}, + "output":{"shape":"UpdateIdentityProviderSettingsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates additional product configuration settings for the registered identity provider.
", + "idempotent":true + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"You don't have sufficient access to perform this action.
", + "exception":true + }, + "ActiveDirectoryIdentityProvider":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"String", + "documentation":"The directory ID for an Active Directory identity provider.
" + } + }, + "documentation":"Details about an Active Directory identity provider.
" + }, + "AssociateUserRequest":{ + "type":"structure", + "required":[ + "IdentityProvider", + "InstanceId", + "Username" + ], + "members":{ + "Domain":{ + "shape":"String", + "documentation":"The domain name of the user.
" + }, + "IdentityProvider":{ + "shape":"IdentityProvider", + "documentation":"The identity provider of the user.
" + }, + "InstanceId":{ + "shape":"String", + "documentation":"The ID of the EC2 instance, which provides user-based subscriptions.
" + }, + "Username":{ + "shape":"String", + "documentation":"The user name from the identity provider for the user.
" + } + } + }, + "AssociateUserResponse":{ + "type":"structure", + "required":["InstanceUserSummary"], + "members":{ + "InstanceUserSummary":{ + "shape":"InstanceUserSummary", + "documentation":"Metadata that describes the associate user operation.
" + } + } + }, + "BoxInteger":{ + "type":"integer", + "box":true + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request couldn't be completed because it conflicted with the current state of the resource.
", + "exception":true, + "fault":true + }, + "DeregisterIdentityProviderRequest":{ + "type":"structure", + "required":[ + "IdentityProvider", + "Product" + ], + "members":{ + "IdentityProvider":{ + "shape":"IdentityProvider", + "documentation":"An object that specifies details for the identity provider.
" + }, + "Product":{ + "shape":"String", + "documentation":"The name of the user-based subscription product.
" + } + } + }, + "DeregisterIdentityProviderResponse":{ + "type":"structure", + "required":["IdentityProviderSummary"], + "members":{ + "IdentityProviderSummary":{ + "shape":"IdentityProviderSummary", + "documentation":"Metadata that describes the results of an identity provider operation.
" + } + } + }, + "DisassociateUserRequest":{ + "type":"structure", + "required":[ + "IdentityProvider", + "InstanceId", + "Username" + ], + "members":{ + "Domain":{ + "shape":"String", + "documentation":"The domain name of the user.
" + }, + "IdentityProvider":{ + "shape":"IdentityProvider", + "documentation":"An object that specifies details for the identity provider.
" + }, + "InstanceId":{ + "shape":"String", + "documentation":"The ID of the EC2 instance, which provides user-based subscriptions.
" + }, + "Username":{ + "shape":"String", + "documentation":"The user name from the identity provider for the user.
" + } + } + }, + "DisassociateUserResponse":{ + "type":"structure", + "required":["InstanceUserSummary"], + "members":{ + "InstanceUserSummary":{ + "shape":"InstanceUserSummary", + "documentation":"Metadata that describes the associate user operation.
" + } + } + }, + "Filter":{ + "type":"structure", + "members":{ + "Attribute":{ + "shape":"String", + "documentation":"The name of an attribute to use as a filter.
" + }, + "Operation":{ + "shape":"String", + "documentation":"The type of search (For example, eq, geq, leq)
" + }, + "Value":{ + "shape":"String", + "documentation":"Value of the filter.
" + } + }, + "documentation":"A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
" + }, + "FilterList":{ + "type":"list", + "member":{"shape":"Filter"} + }, + "IdentityProvider":{ + "type":"structure", + "members":{ + "ActiveDirectoryIdentityProvider":{ + "shape":"ActiveDirectoryIdentityProvider", + "documentation":"An object that details an Active Directory identity provider.
" + } + }, + "documentation":"Details about an identity provider.
", + "union":true + }, + "IdentityProviderSummary":{ + "type":"structure", + "required":[ + "IdentityProvider", + "Product", + "Settings", + "Status" + ], + "members":{ + "FailureMessage":{ + "shape":"String", + "documentation":"The failure message associated with an identity provider.
" + }, + "IdentityProvider":{ + "shape":"IdentityProvider", + "documentation":"An object that specifies details for the identity provider.
" + }, + "Product":{ + "shape":"String", + "documentation":"The name of the user-based subscription product.
" + }, + "Settings":{ + "shape":"Settings", + "documentation":"An object that details the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
" + }, + "Status":{ + "shape":"String", + "documentation":"The status of an identity provider.
" + } + }, + "documentation":"Describes an identity provider.
" + }, + "IdentityProviderSummaryList":{ + "type":"list", + "member":{"shape":"IdentityProviderSummary"} + }, + "InstanceSummary":{ + "type":"structure", + "required":[ + "InstanceId", + "Products", + "Status" + ], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"The ID of the EC2 instance, which provides user-based subscriptions.
" + }, + "LastStatusCheckDate":{ + "shape":"String", + "documentation":"The date of the last status check.
" + }, + "Products":{ + "shape":"StringList", + "documentation":"A list of provided user-based subscription products.
" + }, + "Status":{ + "shape":"String", + "documentation":"The status of an EC2 instance resource.
" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"The status message for an EC2 instance.
" + } + }, + "documentation":"Describes an EC2 instance providing user-based subscriptions.
" + }, + "InstanceSummaryList":{ + "type":"list", + "member":{"shape":"InstanceSummary"} + }, + "InstanceUserSummary":{ + "type":"structure", + "required":[ + "IdentityProvider", + "InstanceId", + "Status", + "Username" + ], + "members":{ + "AssociationDate":{ + "shape":"String", + "documentation":"The date a user was associated with an EC2 instance.
" + }, + "DisassociationDate":{ + "shape":"String", + "documentation":"The date a user was disassociated from an EC2 instance.
" + }, + "Domain":{ + "shape":"String", + "documentation":"The domain name of the user.
" + }, + "IdentityProvider":{ + "shape":"IdentityProvider", + "documentation":"An object that specifies details for the identity provider.
" + }, + "InstanceId":{ + "shape":"String", + "documentation":"The ID of the EC2 instance, which provides user-based subscriptions.
" + }, + "Status":{ + "shape":"String", + "documentation":"The status of a user associated with an EC2 instance.
" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"The status message for users of an EC2 instance.
" + }, + "Username":{ + "shape":"String", + "documentation":"The user name from the identity provider for the user.
" + } + }, + "documentation":"Describes users of an EC2 instance providing user-based subscriptions.
" + }, + "InstanceUserSummaryList":{ + "type":"list", + "member":{"shape":"InstanceUserSummary"} + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"An exception occurred with the service.
", + "exception":true, + "fault":true + }, + "ListIdentityProvidersRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"BoxInteger", + "documentation":"Maximum number of results to return in a single call.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Token for the next set of results.
" + } + } + }, + "ListIdentityProvidersResponse":{ + "type":"structure", + "required":["IdentityProviderSummaries"], + "members":{ + "IdentityProviderSummaries":{ + "shape":"IdentityProviderSummaryList", + "documentation":"Metadata that describes the list identity providers operation.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Token for the next set of results.
" + } + } + }, + "ListInstancesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.
" + }, + "MaxResults":{ + "shape":"BoxInteger", + "documentation":"Maximum number of results to return in a single call.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Token for the next set of results.
" + } + } + }, + "ListInstancesResponse":{ + "type":"structure", + "members":{ + "InstanceSummaries":{ + "shape":"InstanceSummaryList", + "documentation":"Metadata that describes the list instances operation.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Token for the next set of results.
" + } + } + }, + "ListProductSubscriptionsRequest":{ + "type":"structure", + "required":[ + "IdentityProvider", + "Product" + ], + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.
" + }, + "IdentityProvider":{ + "shape":"IdentityProvider", + "documentation":"An object that specifies details for the identity provider.
" + }, + "MaxResults":{ + "shape":"BoxInteger", + "documentation":"Maximum number of results to return in a single call.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Token for the next set of results.
" + }, + "Product":{ + "shape":"String", + "documentation":"The name of the user-based subscription product.
" + } + } + }, + "ListProductSubscriptionsResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"Token for the next set of results.
" + }, + "ProductUserSummaries":{ + "shape":"ProductUserSummaryList", + "documentation":"Metadata that describes the list product subscriptions operation.
" + } + } + }, + "ListUserAssociationsRequest":{ + "type":"structure", + "required":[ + "IdentityProvider", + "InstanceId" + ], + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.
" + }, + "IdentityProvider":{ + "shape":"IdentityProvider", + "documentation":"An object that specifies details for the identity provider.
" + }, + "InstanceId":{ + "shape":"String", + "documentation":"The ID of the EC2 instance, which provides user-based subscriptions.
" + }, + "MaxResults":{ + "shape":"BoxInteger", + "documentation":"Maximum number of results to return in a single call.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Token for the next set of results.
" + } + } + }, + "ListUserAssociationsResponse":{ + "type":"structure", + "members":{ + "InstanceUserSummaries":{ + "shape":"InstanceUserSummaryList", + "documentation":"Metadata that describes the list user association operation.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Token for the next set of results.
" + } + } + }, + "ProductUserSummary":{ + "type":"structure", + "required":[ + "IdentityProvider", + "Product", + "Status", + "Username" + ], + "members":{ + "Domain":{ + "shape":"String", + "documentation":"The domain name of the user.
" + }, + "IdentityProvider":{ + "shape":"IdentityProvider", + "documentation":"An object that specifies details for the identity provider.
" + }, + "Product":{ + "shape":"String", + "documentation":"The name of the user-based subscription product.
" + }, + "Status":{ + "shape":"String", + "documentation":"The status of a product for a user.
" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"The status message for a product for a user.
" + }, + "SubscriptionEndDate":{ + "shape":"String", + "documentation":"The end date of a subscription.
" + }, + "SubscriptionStartDate":{ + "shape":"String", + "documentation":"The start date of a subscription.
" + }, + "Username":{ + "shape":"String", + "documentation":"The user name from the identity provider of the user.
" + } + }, + "documentation":"The summary of the user-based subscription products for a user.
" + }, + "ProductUserSummaryList":{ + "type":"list", + "member":{"shape":"ProductUserSummary"} + }, + "RegisterIdentityProviderRequest":{ + "type":"structure", + "required":[ + "IdentityProvider", + "Product" + ], + "members":{ + "IdentityProvider":{ + "shape":"IdentityProvider", + "documentation":"An object that specifies details for the identity provider.
" + }, + "Product":{ + "shape":"String", + "documentation":"The name of the user-based subscription product.
" + }, + "Settings":{ + "shape":"Settings", + "documentation":"The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
" + } + } + }, + "RegisterIdentityProviderResponse":{ + "type":"structure", + "required":["IdentityProviderSummary"], + "members":{ + "IdentityProviderSummary":{ + "shape":"IdentityProviderSummary", + "documentation":"Metadata that describes the results of an identity provider operation.
" + } + } + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The resource couldn't be found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SecurityGroup":{ + "type":"string", + "max":200, + "min":5, + "pattern":"^sg-(([0-9a-z]{8})|([0-9a-z]{17}))$" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request failed because a service quota is exceeded.
", + "exception":true + }, + "Settings":{ + "type":"structure", + "required":[ + "SecurityGroupId", + "Subnets" + ], + "members":{ + "SecurityGroupId":{ + "shape":"SecurityGroup", + "documentation":"A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
" + }, + "Subnets":{ + "shape":"SettingsSubnetsList", + "documentation":"The subnets defined for the registered identity provider.
" + } + }, + "documentation":"The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints, and the security group ID that is associated with the VPC endpoints. The security group should permit inbound TCP port 1688 communication from resources in the VPC.
" + }, + "SettingsSubnetsList":{ + "type":"list", + "member":{"shape":"Subnet"}, + "min":1 + }, + "StartProductSubscriptionRequest":{ + "type":"structure", + "required":[ + "IdentityProvider", + "Product", + "Username" + ], + "members":{ + "Domain":{ + "shape":"String", + "documentation":"The domain name of the user.
" + }, + "IdentityProvider":{ + "shape":"IdentityProvider", + "documentation":"An object that specifies details for the identity provider.
" + }, + "Product":{ + "shape":"String", + "documentation":"The name of the user-based subscription product.
" + }, + "Username":{ + "shape":"String", + "documentation":"The user name from the identity provider of the user.
" + } + } + }, + "StartProductSubscriptionResponse":{ + "type":"structure", + "required":["ProductUserSummary"], + "members":{ + "ProductUserSummary":{ + "shape":"ProductUserSummary", + "documentation":"Metadata that describes the start product subscription operation.
" + } + } + }, + "StopProductSubscriptionRequest":{ + "type":"structure", + "required":[ + "IdentityProvider", + "Product", + "Username" + ], + "members":{ + "Domain":{ + "shape":"String", + "documentation":"The domain name of the user.
" + }, + "IdentityProvider":{ + "shape":"IdentityProvider", + "documentation":"An object that specifies details for the identity provider.
" + }, + "Product":{ + "shape":"String", + "documentation":"The name of the user-based subscription product.
" + }, + "Username":{ + "shape":"String", + "documentation":"The user name from the identity provider for the user.
" + } + } + }, + "StopProductSubscriptionResponse":{ + "type":"structure", + "required":["ProductUserSummary"], + "members":{ + "ProductUserSummary":{ + "shape":"ProductUserSummary", + "documentation":"Metadata that describes the start product subscription operation.
" + } + } + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Subnet":{ + "type":"string", + "pattern":"subnet-[a-z0-9]{8,17}" + }, + "Subnets":{ + "type":"list", + "member":{"shape":"Subnet"} + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request was denied because of request throttling. Retry the request.
", + "exception":true + }, + "UpdateIdentityProviderSettingsRequest":{ + "type":"structure", + "required":[ + "IdentityProvider", + "Product", + "UpdateSettings" + ], + "members":{ + "IdentityProvider":{"shape":"IdentityProvider"}, + "Product":{ + "shape":"String", + "documentation":"The name of the user-based subscription product.
" + }, + "UpdateSettings":{ + "shape":"UpdateSettings", + "documentation":"Updates the registered identity provider’s product related configuration settings. You can update any combination of settings in a single operation such as the:
Subnets which you want to add to provision VPC endpoints.
Subnets which you want to remove the VPC endpoints from.
Security group ID which permits traffic to the VPC endpoints.
The ID of one or more subnets in which License Manager will create a VPC endpoint for products that require connectivity to activation servers.
" + }, + "RemoveSubnets":{ + "shape":"Subnets", + "documentation":"The ID of one or more subnets to remove.
" + }, + "SecurityGroupId":{ + "shape":"SecurityGroup", + "documentation":"A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoints for activation servers.
" + } + }, + "documentation":"Updates the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
" + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"A parameter is not valid.
", + "exception":true + } + }, + "documentation":"With License Manager, you can create user-based subscriptions to utilize licensed software with a per user subscription fee on Amazon EC2 instances.
" +} diff --git a/testbed/boto__botocore/botocore/data/m2/2021-04-28/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/m2/2021-04-28/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..7d21c70a90fb43fd380066dd228147b6fd8fe02b --- /dev/null +++ b/testbed/boto__botocore/botocore/data/m2/2021-04-28/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://m2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://m2-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://m2.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://m2.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/m2/2021-04-28/paginators-1.json b/testbed/boto__botocore/botocore/data/m2/2021-04-28/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..e7cd269f307627eb3f8d7086c359f0fd5f2c3659 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/m2/2021-04-28/paginators-1.json @@ -0,0 +1,58 @@ +{ + "pagination": { + "ListApplicationVersions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "applicationVersions" + }, + "ListApplications": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "applications" + }, + "ListBatchJobDefinitions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "batchJobDefinitions" + }, + "ListBatchJobExecutions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "batchJobExecutions" + }, + "ListDataSetImportHistory": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "dataSetImportTasks" + }, + "ListDataSets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "dataSets" + }, + "ListDeployments": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "deployments" + }, + "ListEngineVersions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "engineVersions" + }, + "ListEnvironments": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "environments" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/m2/2021-04-28/service-2.json b/testbed/boto__botocore/botocore/data/m2/2021-04-28/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..621d8ee061048f381ea61a66a3de03bb6735583a --- /dev/null +++ b/testbed/boto__botocore/botocore/data/m2/2021-04-28/service-2.json @@ -0,0 +1,3704 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-04-28", + "endpointPrefix":"m2", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"AWSMainframeModernization", + "serviceId":"m2", + "signatureVersion":"v4", + "signingName":"m2", + "uid":"m2-2021-04-28" + }, + "operations":{ + "CancelBatchJobExecution":{ + "name":"CancelBatchJobExecution", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/batch-job-executions/{executionId}/cancel", + "responseCode":200 + }, + "input":{"shape":"CancelBatchJobExecutionRequest"}, + "output":{"shape":"CancelBatchJobExecutionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Cancels the running of a specific batch job execution.
" + }, + "CreateApplication":{ + "name":"CreateApplication", + "http":{ + "method":"POST", + "requestUri":"/applications", + "responseCode":200 + }, + "input":{"shape":"CreateApplicationRequest"}, + "output":{"shape":"CreateApplicationResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a new application with given parameters. Requires an existing runtime environment and application definition file.
", + "idempotent":true + }, + "CreateDataSetImportTask":{ + "name":"CreateDataSetImportTask", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/dataset-import-task", + "responseCode":200 + }, + "input":{"shape":"CreateDataSetImportTaskRequest"}, + "output":{"shape":"CreateDataSetImportTaskResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Starts a data set import task for a specific application.
", + "idempotent":true + }, + "CreateDeployment":{ + "name":"CreateDeployment", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/deployments", + "responseCode":200 + }, + "input":{"shape":"CreateDeploymentRequest"}, + "output":{"shape":"CreateDeploymentResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates and starts a deployment to deploy an application into a runtime environment.
", + "idempotent":true + }, + "CreateEnvironment":{ + "name":"CreateEnvironment", + "http":{ + "method":"POST", + "requestUri":"/environments", + "responseCode":200 + }, + "input":{"shape":"CreateEnvironmentRequest"}, + "output":{"shape":"CreateEnvironmentResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a runtime environment for a given runtime engine.
", + "idempotent":true + }, + "DeleteApplication":{ + "name":"DeleteApplication", + "http":{ + "method":"DELETE", + "requestUri":"/applications/{applicationId}", + "responseCode":200 + }, + "input":{"shape":"DeleteApplicationRequest"}, + "output":{"shape":"DeleteApplicationResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes a specific application. You cannot delete a running application.
", + "idempotent":true + }, + "DeleteApplicationFromEnvironment":{ + "name":"DeleteApplicationFromEnvironment", + "http":{ + "method":"DELETE", + "requestUri":"/applications/{applicationId}/environment/{environmentId}", + "responseCode":200 + }, + "input":{"shape":"DeleteApplicationFromEnvironmentRequest"}, + "output":{"shape":"DeleteApplicationFromEnvironmentResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes a specific application from the specific runtime environment where it was previously deployed. You cannot delete a runtime environment using DeleteEnvironment if any application has ever been deployed to it. This API removes the association of the application with the runtime environment so you can delete the environment smoothly.
" + }, + "DeleteEnvironment":{ + "name":"DeleteEnvironment", + "http":{ + "method":"DELETE", + "requestUri":"/environments/{environmentId}", + "responseCode":200 + }, + "input":{"shape":"DeleteEnvironmentRequest"}, + "output":{"shape":"DeleteEnvironmentResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes a specific runtime environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment.
", + "idempotent":true + }, + "GetApplication":{ + "name":"GetApplication", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}", + "responseCode":200 + }, + "input":{"shape":"GetApplicationRequest"}, + "output":{"shape":"GetApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Describes the details of a specific application.
" + }, + "GetApplicationVersion":{ + "name":"GetApplicationVersion", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/versions/{applicationVersion}", + "responseCode":200 + }, + "input":{"shape":"GetApplicationVersionRequest"}, + "output":{"shape":"GetApplicationVersionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns details about a specific version of a specific application.
" + }, + "GetBatchJobExecution":{ + "name":"GetBatchJobExecution", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/batch-job-executions/{executionId}", + "responseCode":200 + }, + "input":{"shape":"GetBatchJobExecutionRequest"}, + "output":{"shape":"GetBatchJobExecutionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets the details of a specific batch job execution for a specific application.
" + }, + "GetDataSetDetails":{ + "name":"GetDataSetDetails", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/datasets/{dataSetName}", + "responseCode":200 + }, + "input":{"shape":"GetDataSetDetailsRequest"}, + "output":{"shape":"GetDataSetDetailsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ExecutionTimeoutException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets the details of a specific data set.
" + }, + "GetDataSetImportTask":{ + "name":"GetDataSetImportTask", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/dataset-import-tasks/{taskId}", + "responseCode":200 + }, + "input":{"shape":"GetDataSetImportTaskRequest"}, + "output":{"shape":"GetDataSetImportTaskResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
" + }, + "GetDeployment":{ + "name":"GetDeployment", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/deployments/{deploymentId}", + "responseCode":200 + }, + "input":{"shape":"GetDeploymentRequest"}, + "output":{"shape":"GetDeploymentResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets details of a specific deployment with a given deployment identifier.
" + }, + "GetEnvironment":{ + "name":"GetEnvironment", + "http":{ + "method":"GET", + "requestUri":"/environments/{environmentId}", + "responseCode":200 + }, + "input":{"shape":"GetEnvironmentRequest"}, + "output":{"shape":"GetEnvironmentResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Describes a specific runtime environment.
" + }, + "GetSignedBluinsightsUrl":{ + "name":"GetSignedBluinsightsUrl", + "http":{ + "method":"GET", + "requestUri":"/signed-bi-url", + "responseCode":200 + }, + "output":{"shape":"GetSignedBluinsightsUrlResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets a single sign-on URL that can be used to connect to AWS Blu Insights.
" + }, + "ListApplicationVersions":{ + "name":"ListApplicationVersions", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/versions", + "responseCode":200 + }, + "input":{"shape":"ListApplicationVersionsRequest"}, + "output":{"shape":"ListApplicationVersionsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns a list of the application versions for a specific application.
" + }, + "ListApplications":{ + "name":"ListApplications", + "http":{ + "method":"GET", + "requestUri":"/applications", + "responseCode":200 + }, + "input":{"shape":"ListApplicationsRequest"}, + "output":{"shape":"ListApplicationsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific runtime environment in a query parameter to see all applications associated with that environment.
" + }, + "ListBatchJobDefinitions":{ + "name":"ListBatchJobDefinitions", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/batch-job-definitions", + "responseCode":200 + }, + "input":{"shape":"ListBatchJobDefinitionsRequest"}, + "output":{"shape":"ListBatchJobDefinitionsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. You can use the batch job definitions in the list to start a batch job.
" + }, + "ListBatchJobExecutions":{ + "name":"ListBatchJobExecutions", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/batch-job-executions", + "responseCode":200 + }, + "input":{"shape":"ListBatchJobExecutionsRequest"}, + "output":{"shape":"ListBatchJobExecutionsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists historical, current, and scheduled batch job executions for a specific application.
" + }, + "ListBatchJobRestartPoints":{ + "name":"ListBatchJobRestartPoints", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/batch-job-executions/{executionId}/steps", + "responseCode":200 + }, + "input":{"shape":"ListBatchJobRestartPointsRequest"}, + "output":{"shape":"ListBatchJobRestartPointsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists all the job steps for JCL files to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above.
" + }, + "ListDataSetImportHistory":{ + "name":"ListDataSetImportHistory", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/dataset-import-tasks", + "responseCode":200 + }, + "input":{"shape":"ListDataSetImportHistoryRequest"}, + "output":{"shape":"ListDataSetImportHistoryResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists the data set imports for the specified application.
" + }, + "ListDataSets":{ + "name":"ListDataSets", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/datasets", + "responseCode":200 + }, + "input":{"shape":"ListDataSetsRequest"}, + "output":{"shape":"ListDataSetsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ExecutionTimeoutException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed on runtime environments. This is known as importing data sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask.
" + }, + "ListDeployments":{ + "name":"ListDeployments", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/deployments", + "responseCode":200 + }, + "input":{"shape":"ListDeploymentsRequest"}, + "output":{"shape":"ListDeploymentsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns a list of all deployments of a specific application. A deployment is a combination of a specific application and a specific version of that application. Each deployment is mapped to a particular application version.
" + }, + "ListEngineVersions":{ + "name":"ListEngineVersions", + "http":{ + "method":"GET", + "requestUri":"/engine-versions", + "responseCode":200 + }, + "input":{"shape":"ListEngineVersionsRequest"}, + "output":{"shape":"ListEngineVersionsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists the available engine versions.
" + }, + "ListEnvironments":{ + "name":"ListEnvironments", + "http":{ + "method":"GET", + "requestUri":"/environments", + "responseCode":200 + }, + "input":{"shape":"ListEnvironmentsRequest"}, + "output":{"shape":"ListEnvironmentsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists the runtime environments.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists the tags for the specified resource.
" + }, + "StartApplication":{ + "name":"StartApplication", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/start", + "responseCode":200 + }, + "input":{"shape":"StartApplicationRequest"}, + "output":{"shape":"StartApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Starts an application that is currently stopped.
" + }, + "StartBatchJob":{ + "name":"StartBatchJob", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/batch-job", + "responseCode":200 + }, + "input":{"shape":"StartBatchJobRequest"}, + "output":{"shape":"StartBatchJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job.
" + }, + "StopApplication":{ + "name":"StopApplication", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/stop", + "responseCode":200 + }, + "input":{"shape":"StopApplicationRequest"}, + "output":{"shape":"StopApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Stops a running application.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Adds one or more tags to the specified resource.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Removes one or more tags from the specified resource.
" + }, + "UpdateApplication":{ + "name":"UpdateApplication", + "http":{ + "method":"PATCH", + "requestUri":"/applications/{applicationId}", + "responseCode":200 + }, + "input":{"shape":"UpdateApplicationRequest"}, + "output":{"shape":"UpdateApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates an application and creates a new version.
" + }, + "UpdateEnvironment":{ + "name":"UpdateEnvironment", + "http":{ + "method":"PATCH", + "requestUri":"/environments/{environmentId}", + "responseCode":200 + }, + "input":{"shape":"UpdateEnvironmentRequest"}, + "output":{"shape":"UpdateEnvironmentResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates the configuration details for a specific runtime environment.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The account or role doesn't have the right permissions to make the request.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AlternateKey":{ + "type":"structure", + "required":[ + "length", + "offset" + ], + "members":{ + "allowDuplicates":{ + "shape":"Boolean", + "documentation":"Indicates whether the alternate key values are supposed to be unique for the given data set.
" + }, + "length":{ + "shape":"Integer", + "documentation":"A strictly positive integer value representing the length of the alternate key.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the alternate key.
" + }, + "offset":{ + "shape":"Integer", + "documentation":"A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.
" + } + }, + "documentation":"Defines an alternate key. This value is optional. A legacy data set might not have any alternate key defined but if those alternate keys definitions exist, provide them, as some applications will make use of them.
" + }, + "AlternateKeyList":{ + "type":"list", + "member":{"shape":"AlternateKey"} + }, + "ApplicationDeploymentLifecycle":{ + "type":"string", + "enum":[ + "Deploying", + "Deployed" + ] + }, + "ApplicationLifecycle":{ + "type":"string", + "enum":[ + "Creating", + "Created", + "Available", + "Ready", + "Starting", + "Running", + "Stopping", + "Stopped", + "Failed", + "Deleting", + "Deleting From Environment" + ] + }, + "ApplicationSummary":{ + "type":"structure", + "required":[ + "applicationArn", + "applicationId", + "applicationVersion", + "creationTime", + "engineType", + "name", + "status" + ], + "members":{ + "applicationArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the application.
" + }, + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application.
" + }, + "applicationVersion":{ + "shape":"Version", + "documentation":"The version of the application.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when the application was created.
" + }, + "deploymentStatus":{ + "shape":"ApplicationDeploymentLifecycle", + "documentation":"Indicates either an ongoing deployment or if the application has ever deployed successfully.
" + }, + "description":{ + "shape":"EntityDescription", + "documentation":"The description of the application.
" + }, + "engineType":{ + "shape":"EngineType", + "documentation":"The type of the target platform for this application.
" + }, + "environmentId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the runtime environment that hosts this application.
" + }, + "lastStartTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when you last started the application. Null until the application runs for the first time.
" + }, + "name":{ + "shape":"EntityName", + "documentation":"The name of the application.
" + }, + "roleArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the role associated with the application.
" + }, + "status":{ + "shape":"ApplicationLifecycle", + "documentation":"The status of the application.
" + }, + "versionStatus":{ + "shape":"ApplicationVersionLifecycle", + "documentation":"Indicates the status of the latest version of the application.
" + } + }, + "documentation":"A subset of the possible application attributes. Used in the application list.
" + }, + "ApplicationSummaryList":{ + "type":"list", + "member":{"shape":"ApplicationSummary"} + }, + "ApplicationVersionLifecycle":{ + "type":"string", + "enum":[ + "Creating", + "Available", + "Failed" + ] + }, + "ApplicationVersionSummary":{ + "type":"structure", + "required":[ + "applicationVersion", + "creationTime", + "status" + ], + "members":{ + "applicationVersion":{ + "shape":"Version", + "documentation":"The application version.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when the application version was created.
" + }, + "status":{ + "shape":"ApplicationVersionLifecycle", + "documentation":"The status of the application.
" + }, + "statusReason":{ + "shape":"String", + "documentation":"The reason for the reported status.
" + } + }, + "documentation":"Defines an application version summary.
" + }, + "ApplicationVersionSummaryList":{ + "type":"list", + "member":{"shape":"ApplicationVersionSummary"} + }, + "Arn":{ + "type":"string", + "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}$" + }, + "ArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "min":1 + }, + "BatchJobDefinition":{ + "type":"structure", + "members":{ + "fileBatchJobDefinition":{ + "shape":"FileBatchJobDefinition", + "documentation":"Specifies a file containing a batch job definition.
" + }, + "scriptBatchJobDefinition":{ + "shape":"ScriptBatchJobDefinition", + "documentation":"A script containing a batch job definition.
" + } + }, + "documentation":"Defines the details of a batch job.
", + "union":true + }, + "BatchJobDefinitions":{ + "type":"list", + "member":{"shape":"BatchJobDefinition"} + }, + "BatchJobExecutionStatus":{ + "type":"string", + "enum":[ + "Submitting", + "Holding", + "Dispatching", + "Running", + "Cancelling", + "Cancelled", + "Succeeded", + "Failed", + "Purged", + "Succeeded With Warning" + ] + }, + "BatchJobExecutionSummary":{ + "type":"structure", + "required":[ + "applicationId", + "executionId", + "startTime", + "status" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application that hosts this batch job.
" + }, + "batchJobIdentifier":{ + "shape":"BatchJobIdentifier", + "documentation":"The unique identifier of this batch job.
" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when this batch job execution ended.
" + }, + "executionId":{ + "shape":"Identifier", + "documentation":"The unique identifier of this execution of the batch job.
" + }, + "jobId":{ + "shape":"String100", + "documentation":"The unique identifier of a particular batch job.
" + }, + "jobName":{ + "shape":"String100", + "documentation":"The name of a particular batch job.
" + }, + "jobType":{ + "shape":"BatchJobType", + "documentation":"The type of a particular batch job execution.
" + }, + "returnCode":{ + "shape":"String", + "documentation":"The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see Batch return codes in the IBM WebSphere Application Server documentation.
" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when a particular batch job execution started.
" + }, + "status":{ + "shape":"BatchJobExecutionStatus", + "documentation":"The status of a particular batch job execution.
" + } + }, + "documentation":"A subset of the possible batch job attributes. Used in the batch job list.
" + }, + "BatchJobExecutionSummaryList":{ + "type":"list", + "member":{"shape":"BatchJobExecutionSummary"} + }, + "BatchJobIdentifier":{ + "type":"structure", + "members":{ + "fileBatchJobIdentifier":{ + "shape":"FileBatchJobIdentifier", + "documentation":"Specifies a file associated with a specific batch job.
" + }, + "restartBatchJobIdentifier":{ + "shape":"RestartBatchJobIdentifier", + "documentation":"Specifies the required information for restart, including execution ID and jobsteprestartmarker.
" + }, + "s3BatchJobIdentifier":{ + "shape":"S3BatchJobIdentifier", + "documentation":"Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.
" + }, + "scriptBatchJobIdentifier":{ + "shape":"ScriptBatchJobIdentifier", + "documentation":"A batch job identifier in which the batch job to run is identified by the script name.
" + } + }, + "documentation":"Identifies a specific batch job.
", + "union":true + }, + "BatchJobParametersMap":{ + "type":"map", + "key":{"shape":"BatchParamKey"}, + "value":{"shape":"BatchParamValue"}, + "documentation":"Job parameters are optional. Can contain up to 500 entries.
", + "max":500, + "min":0 + }, + "BatchJobStepList":{ + "type":"list", + "member":{"shape":"JobStep"} + }, + "BatchJobType":{ + "type":"string", + "enum":[ + "VSE", + "JES2", + "JES3" + ] + }, + "BatchParamKey":{ + "type":"string", + "documentation":"See https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl to get details about limits for both keys and values: 8 for keys (variable names), 44 for values (variable values) In addition, keys will be only alphabetic characters and digits, without any space or special characters (dash, underscore, etc ...)
Parameter key: the first character must be alphabetic. Can be of up to 8 alphanumeric characters.
", + "max":32, + "min":1, + "pattern":"^[A-Za-z][A-Za-z0-9]{1,7}$" + }, + "BatchParamValue":{ + "type":"string", + "documentation":"Parameter value can be of up to 44 alphanumeric characters.
", + "max":80, + "min":0 + }, + "Boolean":{"type":"boolean"}, + "CancelBatchJobExecutionRequest":{ + "type":"structure", + "required":[ + "applicationId", + "executionId" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application.
", + "location":"uri", + "locationName":"applicationId" + }, + "executionId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the batch job execution.
", + "location":"uri", + "locationName":"executionId" + } + } + }, + "CancelBatchJobExecutionResponse":{ + "type":"structure", + "members":{ + } + }, + "CapacityValue":{ + "type":"integer", + "box":true + }, + "ConflictException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "resourceId":{ + "shape":"String", + "documentation":"The ID of the conflicting resource.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The type of the conflicting resource.
" + } + }, + "documentation":"The parameters provided in the request conflict with existing resources.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateApplicationRequest":{ + "type":"structure", + "required":[ + "definition", + "engineType", + "name" + ], + "members":{ + "clientToken":{ + "shape":"String", + "documentation":"Unique, case-sensitive identifier the service generates to ensure the idempotency of the request to create an application. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.
", + "idempotencyToken":true + }, + "definition":{ + "shape":"Definition", + "documentation":"The application definition for this application. You can specify either inline JSON or an S3 bucket location.
" + }, + "description":{ + "shape":"EntityDescription", + "documentation":"The description of the application.
" + }, + "engineType":{ + "shape":"EngineType", + "documentation":"The type of the target platform for this application.
" + }, + "kmsKeyId":{ + "shape":"String", + "documentation":"The identifier of a customer managed key.
" + }, + "name":{ + "shape":"EntityName", + "documentation":"The unique identifier of the application.
" + }, + "roleArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) that identifies a role that the application uses to access Amazon Web Services resources that are not part of the application or are in a different Amazon Web Services account.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A list of tags to apply to the application.
" + } + } + }, + "CreateApplicationResponse":{ + "type":"structure", + "required":[ + "applicationArn", + "applicationId", + "applicationVersion" + ], + "members":{ + "applicationArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the application.
" + }, + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique application identifier.
" + }, + "applicationVersion":{ + "shape":"Version", + "documentation":"The version number of the application.
" + } + } + }, + "CreateDataSetImportTaskRequest":{ + "type":"structure", + "required":[ + "applicationId", + "importConfig" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application for which you want to import data sets.
", + "location":"uri", + "locationName":"applicationId" + }, + "clientToken":{ + "shape":"String", + "documentation":"Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a data set import. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.
", + "idempotencyToken":true + }, + "importConfig":{ + "shape":"DataSetImportConfig", + "documentation":"The data set import task configuration.
" + } + } + }, + "CreateDataSetImportTaskResponse":{ + "type":"structure", + "required":["taskId"], + "members":{ + "taskId":{ + "shape":"Identifier", + "documentation":"The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetImportTask operation to obtain the status of this task.
" + } + } + }, + "CreateDeploymentRequest":{ + "type":"structure", + "required":[ + "applicationId", + "applicationVersion", + "environmentId" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The application identifier.
", + "location":"uri", + "locationName":"applicationId" + }, + "applicationVersion":{ + "shape":"Version", + "documentation":"The version of the application to deploy.
" + }, + "clientToken":{ + "shape":"String", + "documentation":"Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a deployment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.
", + "idempotencyToken":true + }, + "environmentId":{ + "shape":"Identifier", + "documentation":"The identifier of the runtime environment where you want to deploy this application.
" + } + } + }, + "CreateDeploymentResponse":{ + "type":"structure", + "required":["deploymentId"], + "members":{ + "deploymentId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the deployment.
" + } + } + }, + "CreateEnvironmentRequest":{ + "type":"structure", + "required":[ + "engineType", + "instanceType", + "name" + ], + "members":{ + "clientToken":{ + "shape":"String", + "documentation":"Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.
", + "idempotencyToken":true + }, + "description":{ + "shape":"EntityDescription", + "documentation":"The description of the runtime environment.
" + }, + "engineType":{ + "shape":"EngineType", + "documentation":"The engine type for the runtime environment.
" + }, + "engineVersion":{ + "shape":"EngineVersion", + "documentation":"The version of the engine type for the runtime environment.
" + }, + "highAvailabilityConfig":{ + "shape":"HighAvailabilityConfig", + "documentation":"The details of a high availability configuration for this runtime environment.
" + }, + "instanceType":{ + "shape":"String20", + "documentation":"The type of instance for the runtime environment.
" + }, + "kmsKeyId":{ + "shape":"String", + "documentation":"The identifier of a customer managed key.
" + }, + "name":{ + "shape":"EntityName", + "documentation":"The name of the runtime environment. Must be unique within the account.
" + }, + "preferredMaintenanceWindow":{ + "shape":"String50", + "documentation":"Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.
If you do not provide a value, a random system-generated value will be assigned.
" + }, + "publiclyAccessible":{ + "shape":"Boolean", + "documentation":"Specifies whether the runtime environment is publicly accessible.
" + }, + "securityGroupIds":{ + "shape":"String50List", + "documentation":"The list of security groups for the VPC associated with this runtime environment.
" + }, + "storageConfigurations":{ + "shape":"StorageConfigurationList", + "documentation":"Optional. The storage configurations for this runtime environment.
" + }, + "subnetIds":{ + "shape":"String50List", + "documentation":"The list of subnets associated with the VPC for this runtime environment.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags for the runtime environment.
" + } + } + }, + "CreateEnvironmentResponse":{ + "type":"structure", + "required":["environmentId"], + "members":{ + "environmentId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the runtime environment.
" + } + } + }, + "DataSet":{ + "type":"structure", + "required":[ + "datasetName", + "datasetOrg", + "recordLength" + ], + "members":{ + "datasetName":{ + "shape":"String", + "documentation":"The logical identifier for a specific data set (in mainframe format).
" + }, + "datasetOrg":{ + "shape":"DatasetOrgAttributes", + "documentation":"The type of dataset. The only supported value is VSAM.
" + }, + "recordLength":{ + "shape":"RecordLength", + "documentation":"The length of a record.
" + }, + "relativePath":{ + "shape":"String", + "documentation":"The relative location of the data set in the database or file system.
" + }, + "storageType":{ + "shape":"String", + "documentation":"The storage type of the data set: database or file system. For Micro Focus, database corresponds to datastore and file system corresponds to EFS/FSX. For Blu Age, there is no support of file system and database corresponds to Blusam.
" + } + }, + "documentation":"Defines a data set.
" + }, + "DataSetImportConfig":{ + "type":"structure", + "members":{ + "dataSets":{ + "shape":"DataSetImportList", + "documentation":"The data sets.
" + }, + "s3Location":{ + "shape":"String2000", + "documentation":"The Amazon S3 location of the data sets.
" + } + }, + "documentation":"Identifies one or more data sets you want to import with the CreateDataSetImportTask operation.
", + "union":true + }, + "DataSetImportItem":{ + "type":"structure", + "required":[ + "dataSet", + "externalLocation" + ], + "members":{ + "dataSet":{ + "shape":"DataSet", + "documentation":"The data set.
" + }, + "externalLocation":{ + "shape":"ExternalLocation", + "documentation":"The location of the data set.
" + } + }, + "documentation":"Identifies a specific data set to import from an external location.
" + }, + "DataSetImportList":{ + "type":"list", + "member":{"shape":"DataSetImportItem"}, + "max":100, + "min":1 + }, + "DataSetImportSummary":{ + "type":"structure", + "required":[ + "failed", + "inProgress", + "pending", + "succeeded", + "total" + ], + "members":{ + "failed":{ + "shape":"Integer", + "documentation":"The number of data set imports that have failed.
" + }, + "inProgress":{ + "shape":"Integer", + "documentation":"The number of data set imports that are in progress.
" + }, + "pending":{ + "shape":"Integer", + "documentation":"The number of data set imports that are pending.
" + }, + "succeeded":{ + "shape":"Integer", + "documentation":"The number of data set imports that have succeeded.
" + }, + "total":{ + "shape":"Integer", + "documentation":"The total number of data set imports.
" + } + }, + "documentation":"Represents a summary of data set imports.
" + }, + "DataSetImportTask":{ + "type":"structure", + "required":[ + "status", + "summary", + "taskId" + ], + "members":{ + "status":{ + "shape":"DataSetTaskLifecycle", + "documentation":"The status of the data set import task.
" + }, + "statusReason":{ + "shape":"String", + "documentation":"If dataset import failed, the failure reason will show here.
" + }, + "summary":{ + "shape":"DataSetImportSummary", + "documentation":"A summary of the data set import task.
" + }, + "taskId":{ + "shape":"Identifier", + "documentation":"The identifier of the data set import task.
" + } + }, + "documentation":"Contains information about a data set import task.
" + }, + "DataSetImportTaskList":{ + "type":"list", + "member":{"shape":"DataSetImportTask"} + }, + "DataSetSummary":{ + "type":"structure", + "required":["dataSetName"], + "members":{ + "creationTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when the data set was created.
" + }, + "dataSetName":{ + "shape":"String200", + "documentation":"The name of the data set.
" + }, + "dataSetOrg":{ + "shape":"String20", + "documentation":"The type of data set. The only supported value is VSAM.
" + }, + "format":{ + "shape":"String20", + "documentation":"The format of the data set.
" + }, + "lastReferencedTime":{ + "shape":"Timestamp", + "documentation":"The last time the data set was referenced.
" + }, + "lastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"The last time the data set was updated.
" + } + }, + "documentation":"A subset of the possible data set attributes.
" + }, + "DataSetTaskLifecycle":{ + "type":"string", + "enum":[ + "Creating", + "Running", + "Completed", + "Failed" + ] + }, + "DataSetsSummaryList":{ + "type":"list", + "member":{"shape":"DataSetSummary"} + }, + "DatasetDetailOrgAttributes":{ + "type":"structure", + "members":{ + "gdg":{ + "shape":"GdgDetailAttributes", + "documentation":"The generation data group of the data set.
" + }, + "po":{ + "shape":"PoDetailAttributes", + "documentation":"The details of a PO type data set.
" + }, + "ps":{ + "shape":"PsDetailAttributes", + "documentation":"The details of a PS type data set.
" + }, + "vsam":{ + "shape":"VsamDetailAttributes", + "documentation":"The details of a VSAM data set.
" + } + }, + "documentation":"Additional details about the data set. Different attributes correspond to different data set organizations. The values are populated based on datasetOrg, storageType and backend (Blu Age or Micro Focus).
", + "union":true + }, + "DatasetOrgAttributes":{ + "type":"structure", + "members":{ + "gdg":{ + "shape":"GdgAttributes", + "documentation":"The generation data group of the data set.
" + }, + "po":{ + "shape":"PoAttributes", + "documentation":"The details of a PO type data set.
" + }, + "ps":{ + "shape":"PsAttributes", + "documentation":"The details of a PS type data set.
" + }, + "vsam":{ + "shape":"VsamAttributes", + "documentation":"The details of a VSAM data set.
" + } + }, + "documentation":"Additional details about the data set. Different attributes correspond to different data set organizations. The values are populated based on datasetOrg, storageType and backend (Blu Age or Micro Focus).
", + "union":true + }, + "Definition":{ + "type":"structure", + "members":{ + "content":{ + "shape":"StringFree65000", + "documentation":"The content of the application definition. This is a JSON object that contains the resource configuration/definitions that identify an application.
" + }, + "s3Location":{ + "shape":"String2000", + "documentation":"The S3 bucket that contains the application definition.
" + } + }, + "documentation":"The application definition for a particular application.
", + "union":true + }, + "DeleteApplicationFromEnvironmentRequest":{ + "type":"structure", + "required":[ + "applicationId", + "environmentId" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application you want to delete.
", + "location":"uri", + "locationName":"applicationId" + }, + "environmentId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the runtime environment where the application was previously deployed.
", + "location":"uri", + "locationName":"environmentId" + } + } + }, + "DeleteApplicationFromEnvironmentResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteApplicationRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application you want to delete.
", + "location":"uri", + "locationName":"applicationId" + } + } + }, + "DeleteApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteEnvironmentRequest":{ + "type":"structure", + "required":["environmentId"], + "members":{ + "environmentId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the runtime environment you want to delete.
", + "location":"uri", + "locationName":"environmentId" + } + } + }, + "DeleteEnvironmentResponse":{ + "type":"structure", + "members":{ + } + }, + "DeployedVersionSummary":{ + "type":"structure", + "required":[ + "applicationVersion", + "status" + ], + "members":{ + "applicationVersion":{ + "shape":"Version", + "documentation":"The version of the deployed application.
" + }, + "status":{ + "shape":"DeploymentLifecycle", + "documentation":"The status of the deployment.
" + }, + "statusReason":{ + "shape":"String", + "documentation":"The reason for the reported status.
" + } + }, + "documentation":"Contains a summary of a deployed application.
" + }, + "DeploymentLifecycle":{ + "type":"string", + "enum":[ + "Deploying", + "Succeeded", + "Failed", + "Updating Deployment" + ] + }, + "DeploymentList":{ + "type":"list", + "member":{"shape":"DeploymentSummary"} + }, + "DeploymentSummary":{ + "type":"structure", + "required":[ + "applicationId", + "applicationVersion", + "creationTime", + "deploymentId", + "environmentId", + "status" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application.
" + }, + "applicationVersion":{ + "shape":"Version", + "documentation":"The version of the application.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when the deployment was created.
" + }, + "deploymentId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the deployment.
" + }, + "environmentId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the runtime environment.
" + }, + "status":{ + "shape":"DeploymentLifecycle", + "documentation":"The current status of the deployment.
" + }, + "statusReason":{ + "shape":"String", + "documentation":"The reason for the reported status.
" + } + }, + "documentation":"A subset of information about a specific deployment.
" + }, + "EfsStorageConfiguration":{ + "type":"structure", + "required":[ + "fileSystemId", + "mountPoint" + ], + "members":{ + "fileSystemId":{ + "shape":"String200", + "documentation":"The file system identifier.
", + "locationName":"file-system-id" + }, + "mountPoint":{ + "shape":"String200", + "documentation":"The mount point for the file system.
", + "locationName":"mount-point" + } + }, + "documentation":"Defines the storage configuration for an Amazon EFS file system.
" + }, + "EngineType":{ + "type":"string", + "enum":[ + "microfocus", + "bluage" + ] + }, + "EngineVersion":{ + "type":"string", + "pattern":"^\\S{1,10}$" + }, + "EngineVersionsSummary":{ + "type":"structure", + "required":[ + "engineType", + "engineVersion" + ], + "members":{ + "engineType":{ + "shape":"String", + "documentation":"The type of target platform for the application.
" + }, + "engineVersion":{ + "shape":"String", + "documentation":"The version of the engine type used by the application.
" + } + }, + "documentation":"A subset of information about the engine version for a specific application.
" + }, + "EngineVersionsSummaryList":{ + "type":"list", + "member":{"shape":"EngineVersionsSummary"} + }, + "EntityDescription":{ + "type":"string", + "max":500, + "min":0 + }, + "EntityName":{ + "type":"string", + "pattern":"^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$" + }, + "EntityNameList":{ + "type":"list", + "member":{"shape":"EntityName"}, + "max":10, + "min":1 + }, + "EnvironmentLifecycle":{ + "type":"string", + "enum":[ + "Creating", + "Available", + "Updating", + "Deleting", + "Failed" + ] + }, + "EnvironmentSummary":{ + "type":"structure", + "required":[ + "creationTime", + "engineType", + "engineVersion", + "environmentArn", + "environmentId", + "instanceType", + "name", + "status" + ], + "members":{ + "creationTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when the runtime environment was created.
" + }, + "engineType":{ + "shape":"EngineType", + "documentation":"The target platform for the runtime environment.
" + }, + "engineVersion":{ + "shape":"EngineVersion", + "documentation":"The version of the runtime engine.
" + }, + "environmentArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of a particular runtime environment.
" + }, + "environmentId":{ + "shape":"Identifier", + "documentation":"The unique identifier of a particular runtime environment.
" + }, + "instanceType":{ + "shape":"String20", + "documentation":"The instance type of the runtime environment.
" + }, + "name":{ + "shape":"EntityName", + "documentation":"The name of the runtime environment.
" + }, + "status":{ + "shape":"EnvironmentLifecycle", + "documentation":"The status of the runtime environment
" + } + }, + "documentation":"Contains a subset of the possible runtime environment attributes. Used in the environment list.
" + }, + "EnvironmentSummaryList":{ + "type":"list", + "member":{"shape":"EnvironmentSummary"} + }, + "ExecutionTimeoutException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Failed to connect to server, or didn’t receive response within expected time period.
", + "error":{"httpStatusCode":504}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "ExternalLocation":{ + "type":"structure", + "members":{ + "s3Location":{ + "shape":"String2000", + "documentation":"The URI of the Amazon S3 bucket.
" + } + }, + "documentation":"Defines an external storage location.
", + "union":true + }, + "FileBatchJobDefinition":{ + "type":"structure", + "required":["fileName"], + "members":{ + "fileName":{ + "shape":"String", + "documentation":"The name of the file containing the batch job definition.
" + }, + "folderPath":{ + "shape":"String", + "documentation":"The path to the file containing the batch job definition.
" + } + }, + "documentation":"A file containing a batch job definition.
" + }, + "FileBatchJobIdentifier":{ + "type":"structure", + "required":["fileName"], + "members":{ + "fileName":{ + "shape":"String", + "documentation":"The file name for the batch job identifier.
" + }, + "folderPath":{ + "shape":"String", + "documentation":"The relative path to the file name for the batch job identifier.
" + } + }, + "documentation":"A batch job identifier in which the batch job to run is identified by the file name and the relative path to the file name.
" + }, + "FsxStorageConfiguration":{ + "type":"structure", + "required":[ + "fileSystemId", + "mountPoint" + ], + "members":{ + "fileSystemId":{ + "shape":"String200", + "documentation":"The file system identifier.
", + "locationName":"file-system-id" + }, + "mountPoint":{ + "shape":"String200", + "documentation":"The mount point for the file system.
", + "locationName":"mount-point" + } + }, + "documentation":"Defines the storage configuration for an Amazon FSx file system.
" + }, + "GdgAttributes":{ + "type":"structure", + "members":{ + "limit":{ + "shape":"Integer", + "documentation":"The maximum number of generation data sets, up to 255, in a GDG.
" + }, + "rollDisposition":{ + "shape":"String", + "documentation":"The disposition of the data set in the catalog.
" + } + }, + "documentation":"The required attributes for a generation data group data set. A generation data set is one of a collection of successive, historically related, catalogued data sets that together are known as a generation data group (GDG). Use this structure when you want to import a GDG. For more information on GDG, see Generation data sets.
" + }, + "GdgDetailAttributes":{ + "type":"structure", + "members":{ + "limit":{ + "shape":"Integer", + "documentation":"The maximum number of generation data sets, up to 255, in a GDG.
" + }, + "rollDisposition":{ + "shape":"String50", + "documentation":"The disposition of the data set in the catalog.
" + } + }, + "documentation":"The required attributes for a generation data group data set. A generation data set is one of a collection of successive, historically related, catalogued data sets that together are known as a generation data group (GDG). Use this structure when you want to import a GDG. For more information on GDG, see Generation data sets.
" + }, + "GetApplicationRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The identifier of the application.
", + "location":"uri", + "locationName":"applicationId" + } + } + }, + "GetApplicationResponse":{ + "type":"structure", + "required":[ + "applicationArn", + "applicationId", + "creationTime", + "engineType", + "latestVersion", + "name", + "status" + ], + "members":{ + "applicationArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the application.
" + }, + "applicationId":{ + "shape":"Identifier", + "documentation":"The identifier of the application.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when this application was created.
" + }, + "deployedVersion":{ + "shape":"DeployedVersionSummary", + "documentation":"The version of the application that is deployed.
" + }, + "description":{ + "shape":"EntityDescription", + "documentation":"The description of the application.
" + }, + "engineType":{ + "shape":"EngineType", + "documentation":"The type of the target platform for the application.
" + }, + "environmentId":{ + "shape":"Identifier", + "documentation":"The identifier of the runtime environment where you want to deploy the application.
" + }, + "kmsKeyId":{ + "shape":"String", + "documentation":"The identifier of a customer managed key.
" + }, + "lastStartTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when you last started the application. Null until the application runs for the first time.
" + }, + "latestVersion":{ + "shape":"ApplicationVersionSummary", + "documentation":"The latest version of the application.
" + }, + "listenerArns":{ + "shape":"ArnList", + "documentation":"The Amazon Resource Name (ARN) for the network load balancer listener created in your Amazon Web Services account. Amazon Web Services Mainframe Modernization creates this listener for you the first time you deploy an application.
" + }, + "listenerPorts":{ + "shape":"PortList", + "documentation":"The port associated with the network load balancer listener created in your Amazon Web Services account.
" + }, + "loadBalancerDnsName":{ + "shape":"String100", + "documentation":"The public DNS name of the load balancer created in your Amazon Web Services account.
" + }, + "logGroups":{ + "shape":"LogGroupSummaries", + "documentation":"The list of log summaries. Each log summary includes the log type as well as the log group identifier. These are CloudWatch logs. Amazon Web Services Mainframe Modernization pushes the application log to CloudWatch under the customer's account.
" + }, + "name":{ + "shape":"EntityName", + "documentation":"The unique identifier of the application.
" + }, + "roleArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the role associated with the application.
" + }, + "status":{ + "shape":"ApplicationLifecycle", + "documentation":"The status of the application.
" + }, + "statusReason":{ + "shape":"String", + "documentation":"The reason for the reported status.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A list of tags associated with the application.
" + }, + "targetGroupArns":{ + "shape":"ArnList", + "documentation":"Returns the Amazon Resource Names (ARNs) of the target groups that are attached to the network load balancer.
" + } + } + }, + "GetApplicationVersionRequest":{ + "type":"structure", + "required":[ + "applicationId", + "applicationVersion" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application.
", + "location":"uri", + "locationName":"applicationId" + }, + "applicationVersion":{ + "shape":"Version", + "documentation":"The specific version of the application.
", + "location":"uri", + "locationName":"applicationVersion" + } + } + }, + "GetApplicationVersionResponse":{ + "type":"structure", + "required":[ + "applicationVersion", + "creationTime", + "definitionContent", + "name", + "status" + ], + "members":{ + "applicationVersion":{ + "shape":"Version", + "documentation":"The specific version of the application.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when the application version was created.
" + }, + "definitionContent":{ + "shape":"StringFree65000", + "documentation":"The content of the application definition. This is a JSON object that contains the resource configuration and definitions that identify an application.
" + }, + "description":{ + "shape":"EntityDescription", + "documentation":"The application description.
" + }, + "name":{ + "shape":"EntityName", + "documentation":"The name of the application version.
" + }, + "status":{ + "shape":"ApplicationVersionLifecycle", + "documentation":"The status of the application version.
" + }, + "statusReason":{ + "shape":"String", + "documentation":"The reason for the reported status.
" + } + } + }, + "GetBatchJobExecutionRequest":{ + "type":"structure", + "required":[ + "applicationId", + "executionId" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The identifier of the application.
", + "location":"uri", + "locationName":"applicationId" + }, + "executionId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the batch job execution.
", + "location":"uri", + "locationName":"executionId" + } + } + }, + "GetBatchJobExecutionResponse":{ + "type":"structure", + "required":[ + "applicationId", + "executionId", + "startTime", + "status" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The identifier of the application.
" + }, + "batchJobIdentifier":{ + "shape":"BatchJobIdentifier", + "documentation":"The unique identifier of this batch job.
" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when the batch job execution ended.
" + }, + "executionId":{ + "shape":"Identifier", + "documentation":"The unique identifier for this batch job execution.
" + }, + "jobId":{ + "shape":"String100", + "documentation":"The unique identifier for this batch job.
" + }, + "jobName":{ + "shape":"String100", + "documentation":"The name of this batch job.
" + }, + "jobStepRestartMarker":{ + "shape":"JobStepRestartMarker", + "documentation":"The restart steps information for the most recent restart operation.
" + }, + "jobType":{ + "shape":"BatchJobType", + "documentation":"The type of job.
" + }, + "jobUser":{ + "shape":"String100", + "documentation":"The user for the job.
" + }, + "returnCode":{ + "shape":"String", + "documentation":"The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see Batch return codes in the IBM WebSphere Application Server documentation.
" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when the batch job execution started.
" + }, + "status":{ + "shape":"BatchJobExecutionStatus", + "documentation":"The status of the batch job execution.
" + }, + "statusReason":{ + "shape":"String", + "documentation":"The reason for the reported status.
" + } + } + }, + "GetDataSetDetailsRequest":{ + "type":"structure", + "required":[ + "applicationId", + "dataSetName" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application that this data set is associated with.
", + "location":"uri", + "locationName":"applicationId" + }, + "dataSetName":{ + "shape":"String200", + "documentation":"The name of the data set.
", + "location":"uri", + "locationName":"dataSetName" + } + } + }, + "GetDataSetDetailsResponse":{ + "type":"structure", + "required":["dataSetName"], + "members":{ + "blocksize":{ + "shape":"Integer", + "documentation":"The size of the block on disk.
", + "box":true + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when the data set was created.
" + }, + "dataSetName":{ + "shape":"String200", + "documentation":"The name of the data set.
" + }, + "dataSetOrg":{ + "shape":"DatasetDetailOrgAttributes", + "documentation":"The type of data set. The only supported value is VSAM.
" + }, + "fileSize":{ + "shape":"Long", + "documentation":"File size of the dataset.
" + }, + "lastReferencedTime":{ + "shape":"Timestamp", + "documentation":"The last time the data set was referenced.
" + }, + "lastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"The last time the data set was updated.
" + }, + "location":{ + "shape":"String2000", + "documentation":"The location where the data set is stored.
" + }, + "recordLength":{ + "shape":"Integer", + "documentation":"The length of records in the data set.
", + "box":true + } + } + }, + "GetDataSetImportTaskRequest":{ + "type":"structure", + "required":[ + "applicationId", + "taskId" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The application identifier.
", + "location":"uri", + "locationName":"applicationId" + }, + "taskId":{ + "shape":"Identifier", + "documentation":"The task identifier returned by the CreateDataSetImportTask operation.
", + "location":"uri", + "locationName":"taskId" + } + } + }, + "GetDataSetImportTaskResponse":{ + "type":"structure", + "required":[ + "status", + "taskId" + ], + "members":{ + "status":{ + "shape":"DataSetTaskLifecycle", + "documentation":"The status of the task.
" + }, + "summary":{ + "shape":"DataSetImportSummary", + "documentation":"A summary of the status of the task.
" + }, + "taskId":{ + "shape":"Identifier", + "documentation":"The task identifier.
" + } + } + }, + "GetDeploymentRequest":{ + "type":"structure", + "required":[ + "applicationId", + "deploymentId" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application.
", + "location":"uri", + "locationName":"applicationId" + }, + "deploymentId":{ + "shape":"Identifier", + "documentation":"The unique identifier for the deployment.
", + "location":"uri", + "locationName":"deploymentId" + } + } + }, + "GetDeploymentResponse":{ + "type":"structure", + "required":[ + "applicationId", + "applicationVersion", + "creationTime", + "deploymentId", + "environmentId", + "status" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application.
" + }, + "applicationVersion":{ + "shape":"Version", + "documentation":"The application version.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when the deployment was created.
" + }, + "deploymentId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the deployment.
" + }, + "environmentId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the runtime environment.
" + }, + "status":{ + "shape":"DeploymentLifecycle", + "documentation":"The status of the deployment.
" + }, + "statusReason":{ + "shape":"String", + "documentation":"The reason for the reported status.
" + } + } + }, + "GetEnvironmentRequest":{ + "type":"structure", + "required":["environmentId"], + "members":{ + "environmentId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the runtime environment.
", + "location":"uri", + "locationName":"environmentId" + } + } + }, + "GetEnvironmentResponse":{ + "type":"structure", + "required":[ + "creationTime", + "engineType", + "engineVersion", + "environmentArn", + "environmentId", + "instanceType", + "name", + "securityGroupIds", + "status", + "subnetIds", + "vpcId" + ], + "members":{ + "actualCapacity":{ + "shape":"CapacityValue", + "documentation":"The number of instances included in the runtime environment. A standalone runtime environment has a maximum of one instance. Currently, a high availability runtime environment has a maximum of two instances.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when the runtime environment was created.
" + }, + "description":{ + "shape":"EntityDescription", + "documentation":"The description of the runtime environment.
" + }, + "engineType":{ + "shape":"EngineType", + "documentation":"The target platform for the runtime environment.
" + }, + "engineVersion":{ + "shape":"EngineVersion", + "documentation":"The version of the runtime engine.
" + }, + "environmentArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the runtime environment.
" + }, + "environmentId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the runtime environment.
" + }, + "highAvailabilityConfig":{ + "shape":"HighAvailabilityConfig", + "documentation":"The desired capacity of the high availability configuration for the runtime environment.
" + }, + "instanceType":{ + "shape":"String20", + "documentation":"The type of instance underlying the runtime environment.
" + }, + "kmsKeyId":{ + "shape":"String", + "documentation":"The identifier of a customer managed key.
" + }, + "loadBalancerArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.
" + }, + "name":{ + "shape":"EntityName", + "documentation":"The name of the runtime environment. Must be unique within the account.
" + }, + "pendingMaintenance":{ + "shape":"PendingMaintenance", + "documentation":"Indicates the pending maintenance scheduled on this environment.
" + }, + "preferredMaintenanceWindow":{ + "shape":"String50", + "documentation":"The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.
" + }, + "publiclyAccessible":{ + "shape":"Boolean", + "documentation":"Whether applications running in this runtime environment are publicly accessible.
" + }, + "securityGroupIds":{ + "shape":"String50List", + "documentation":"The unique identifiers of the security groups assigned to this runtime environment.
" + }, + "status":{ + "shape":"EnvironmentLifecycle", + "documentation":"The status of the runtime environment.
" + }, + "statusReason":{ + "shape":"String", + "documentation":"The reason for the reported status.
" + }, + "storageConfigurations":{ + "shape":"StorageConfigurationList", + "documentation":"The storage configurations defined for the runtime environment.
" + }, + "subnetIds":{ + "shape":"String50List", + "documentation":"The unique identifiers of the subnets assigned to this runtime environment.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags defined for this runtime environment.
" + }, + "vpcId":{ + "shape":"String50", + "documentation":"The unique identifier for the VPC used with this runtime environment.
" + } + } + }, + "GetSignedBluinsightsUrlResponse":{ + "type":"structure", + "required":["signedBiUrl"], + "members":{ + "signedBiUrl":{ + "shape":"String", + "documentation":"Single sign-on AWS Blu Insights URL.
" + } + } + }, + "HighAvailabilityConfig":{ + "type":"structure", + "required":["desiredCapacity"], + "members":{ + "desiredCapacity":{ + "shape":"CapacityValue", + "documentation":"The number of instances in a high availability configuration. The minimum possible value is 1 and the maximum is 100.
" + } + }, + "documentation":"Defines the details of a high availability configuration.
" + }, + "Identifier":{ + "type":"string", + "pattern":"^\\S{1,80}$" + }, + "IdentifierList":{ + "type":"list", + "member":{"shape":"Identifier"}, + "max":10, + "min":1 + }, + "Integer":{"type":"integer"}, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "retryAfterSeconds":{ + "shape":"Integer", + "documentation":"The number of seconds to wait before retrying the request.
", + "location":"header", + "locationName":"Retry-After" + } + }, + "documentation":"An unexpected error occurred during the processing of the request.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "JobIdentifier":{ + "type":"structure", + "members":{ + "fileName":{ + "shape":"String", + "documentation":"The name of the file that contains the batch job definition.
" + }, + "scriptName":{ + "shape":"String", + "documentation":"The name of the script that contains the batch job definition.
" + } + }, + "documentation":"Identifies a specific batch job.
", + "union":true + }, + "JobStep":{ + "type":"structure", + "members":{ + "procStepName":{ + "shape":"String", + "documentation":"The name of a procedure step.
" + }, + "procStepNumber":{ + "shape":"Integer", + "documentation":"The number of a procedure step.
" + }, + "stepCondCode":{ + "shape":"String", + "documentation":"The condition code of a step.
" + }, + "stepName":{ + "shape":"String", + "documentation":"The name of a step.
" + }, + "stepNumber":{ + "shape":"Integer", + "documentation":"The number of a step.
" + }, + "stepRestartable":{ + "shape":"Boolean", + "documentation":"Specifies if a step can be restarted or not.
" + } + }, + "documentation":"Provides information related to a job step.
" + }, + "JobStepRestartMarker":{ + "type":"structure", + "required":["fromStep"], + "members":{ + "fromProcStep":{ + "shape":"String", + "documentation":"The procedure step name that a job was restarted from.
" + }, + "fromStep":{ + "shape":"String", + "documentation":"The step name that a batch job restart was from.
" + }, + "toProcStep":{ + "shape":"String", + "documentation":"The procedure step name that a batch job was restarted to.
" + }, + "toStep":{ + "shape":"String", + "documentation":"The step name that a job was restarted to.
" + } + }, + "documentation":"Provides restart step information for the most recent restart operation.
" + }, + "ListApplicationVersionsRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application.
", + "location":"uri", + "locationName":"applicationId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of application versions to return.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListApplicationVersionsResponse":{ + "type":"structure", + "required":["applicationVersions"], + "members":{ + "applicationVersions":{ + "shape":"ApplicationVersionSummaryList", + "documentation":"The list of application versions.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.
" + } + } + }, + "ListApplicationsRequest":{ + "type":"structure", + "members":{ + "environmentId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the runtime environment where the applications are deployed.
", + "location":"querystring", + "locationName":"environmentId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of applications to return.
", + "location":"querystring", + "locationName":"maxResults" + }, + "names":{ + "shape":"EntityNameList", + "documentation":"The names of the applications.
", + "location":"querystring", + "locationName":"names" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token to control the number of applications displayed in the list.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListApplicationsResponse":{ + "type":"structure", + "required":["applications"], + "members":{ + "applications":{ + "shape":"ApplicationSummaryList", + "documentation":"Returns a list of summary details for all the applications in a runtime environment.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token that's returned when the response doesn't contain all applications.
" + } + } + }, + "ListBatchJobDefinitionsRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The identifier of the application.
", + "location":"uri", + "locationName":"applicationId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of batch job definitions to return.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
", + "location":"querystring", + "locationName":"nextToken" + }, + "prefix":{ + "shape":"String", + "documentation":"If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.
", + "location":"querystring", + "locationName":"prefix" + } + } + }, + "ListBatchJobDefinitionsResponse":{ + "type":"structure", + "required":["batchJobDefinitions"], + "members":{ + "batchJobDefinitions":{ + "shape":"BatchJobDefinitions", + "documentation":"The list of batch job definitions.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.
" + } + } + }, + "ListBatchJobExecutionsRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application.
", + "location":"uri", + "locationName":"applicationId" + }, + "executionIds":{ + "shape":"IdentifierList", + "documentation":"The unique identifier of each batch job execution.
", + "location":"querystring", + "locationName":"executionIds" + }, + "jobName":{ + "shape":"String100", + "documentation":"The name of each batch job execution.
", + "location":"querystring", + "locationName":"jobName" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of batch job executions to return.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token to control the number of batch job executions displayed in the list.
", + "location":"querystring", + "locationName":"nextToken" + }, + "startedAfter":{ + "shape":"Timestamp", + "documentation":"The time after which the batch job executions started.
", + "location":"querystring", + "locationName":"startedAfter" + }, + "startedBefore":{ + "shape":"Timestamp", + "documentation":"The time before the batch job executions started.
", + "location":"querystring", + "locationName":"startedBefore" + }, + "status":{ + "shape":"BatchJobExecutionStatus", + "documentation":"The status of the batch job executions.
", + "location":"querystring", + "locationName":"status" + } + } + }, + "ListBatchJobExecutionsResponse":{ + "type":"structure", + "required":["batchJobExecutions"], + "members":{ + "batchJobExecutions":{ + "shape":"BatchJobExecutionSummaryList", + "documentation":"Returns a list of batch job executions for an application.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token that's returned when the response doesn't contain all batch job executions.
" + } + } + }, + "ListBatchJobRestartPointsRequest":{ + "type":"structure", + "required":[ + "applicationId", + "executionId" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application.
", + "location":"uri", + "locationName":"applicationId" + }, + "executionId":{ + "shape":"Identifier", + "documentation":"The unique identifier of each batch job execution.
", + "location":"uri", + "locationName":"executionId" + } + } + }, + "ListBatchJobRestartPointsResponse":{ + "type":"structure", + "members":{ + "batchJobSteps":{ + "shape":"BatchJobStepList", + "documentation":"Returns all the batch job steps and related information for a batch job that previously ran.
" + } + } + }, + "ListDataSetImportHistoryRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application.
", + "location":"uri", + "locationName":"applicationId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of objects to return.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListDataSetImportHistoryResponse":{ + "type":"structure", + "required":["dataSetImportTasks"], + "members":{ + "dataSetImportTasks":{ + "shape":"DataSetImportTaskList", + "documentation":"The data set import tasks.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.
" + } + } + }, + "ListDataSetsRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application for which you want to list the associated data sets.
", + "location":"uri", + "locationName":"applicationId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of objects to return.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nameFilter":{ + "shape":"String200", + "documentation":"Filter dataset name matching the specified pattern. Can use * and % as wild cards.
", + "location":"querystring", + "locationName":"nameFilter" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
", + "location":"querystring", + "locationName":"nextToken" + }, + "prefix":{ + "shape":"String200", + "documentation":"The prefix of the data set name, which you can use to filter the list of data sets.
", + "location":"querystring", + "locationName":"prefix" + } + } + }, + "ListDataSetsResponse":{ + "type":"structure", + "required":["dataSets"], + "members":{ + "dataSets":{ + "shape":"DataSetsSummaryList", + "documentation":"The list of data sets, containing information including the creation time, the data set name, the data set organization, the data set format, and the last time the data set was referenced or updated.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.
" + } + } + }, + "ListDeploymentsRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The application identifier.
", + "location":"uri", + "locationName":"applicationId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of objects to return.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListDeploymentsResponse":{ + "type":"structure", + "required":["deployments"], + "members":{ + "deployments":{ + "shape":"DeploymentList", + "documentation":"The list of deployments that is returned.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.
" + } + } + }, + "ListEngineVersionsRequest":{ + "type":"structure", + "members":{ + "engineType":{ + "shape":"EngineType", + "documentation":"The type of target platform.
", + "location":"querystring", + "locationName":"engineType" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of objects to return.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListEngineVersionsResponse":{ + "type":"structure", + "required":["engineVersions"], + "members":{ + "engineVersions":{ + "shape":"EngineVersionsSummaryList", + "documentation":"Returns the engine versions.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.
" + } + } + }, + "ListEnvironmentsRequest":{ + "type":"structure", + "members":{ + "engineType":{ + "shape":"EngineType", + "documentation":"The engine type for the runtime environment.
", + "location":"querystring", + "locationName":"engineType" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of runtime environments to return.
", + "location":"querystring", + "locationName":"maxResults" + }, + "names":{ + "shape":"EntityNameList", + "documentation":"The names of the runtime environments. Must be unique within the account.
", + "location":"querystring", + "locationName":"names" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token to control the number of runtime environments displayed in the list.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListEnvironmentsResponse":{ + "type":"structure", + "required":["environments"], + "members":{ + "environments":{ + "shape":"EnvironmentSummaryList", + "documentation":"Returns a list of summary details for all the runtime environments in your account.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token that's returned when the response doesn't contain all the runtime environments.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"The tags for the resource.
" + } + } + }, + "LogGroupIdentifier":{ + "type":"string", + "max":512, + "min":1 + }, + "LogGroupSummaries":{ + "type":"list", + "member":{"shape":"LogGroupSummary"} + }, + "LogGroupSummary":{ + "type":"structure", + "required":[ + "logGroupName", + "logType" + ], + "members":{ + "logGroupName":{ + "shape":"LogGroupIdentifier", + "documentation":"The name of the log group.
" + }, + "logType":{ + "shape":"String20", + "documentation":"The type of log.
" + } + }, + "documentation":"A subset of the attributes that describe a log group. In CloudWatch a log group is a group of log streams that share the same retention, monitoring, and access control settings.
" + }, + "Long":{ + "type":"long", + "box":true + }, + "MaintenanceSchedule":{ + "type":"structure", + "members":{ + "endTime":{ + "shape":"Timestamp", + "documentation":"The time the scheduled maintenance is to end.
" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"The time the scheduled maintenance is to start.
" + } + }, + "documentation":"The information about the maintenance schedule.
" + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":2000, + "min":1 + }, + "NextToken":{ + "type":"string", + "pattern":"^\\S{1,2000}$" + }, + "PendingMaintenance":{ + "type":"structure", + "members":{ + "engineVersion":{ + "shape":"String", + "documentation":"The specific runtime engine that the maintenance schedule applies to.
" + }, + "schedule":{ + "shape":"MaintenanceSchedule", + "documentation":"The maintenance schedule for the runtime engine version.
" + } + }, + "documentation":"The scheduled maintenance for a runtime engine.
" + }, + "PoAttributes":{ + "type":"structure", + "required":[ + "format", + "memberFileExtensions" + ], + "members":{ + "encoding":{ + "shape":"String", + "documentation":"The character set encoding of the data set.
" + }, + "format":{ + "shape":"String", + "documentation":"The format of the data set records.
" + }, + "memberFileExtensions":{ + "shape":"String20List", + "documentation":"An array containing one or more filename extensions, allowing you to specify which files to be included as PDS member.
" + } + }, + "documentation":"The supported properties for a PO type data set.
" + }, + "PoDetailAttributes":{ + "type":"structure", + "required":[ + "encoding", + "format" + ], + "members":{ + "encoding":{ + "shape":"String", + "documentation":"The character set encoding of the data set.
" + }, + "format":{ + "shape":"String", + "documentation":"The format of the data set records.
" + } + }, + "documentation":"The supported properties for a PO type data set.
" + }, + "PortList":{ + "type":"list", + "member":{"shape":"Integer"}, + "min":1 + }, + "PrimaryKey":{ + "type":"structure", + "required":[ + "length", + "offset" + ], + "members":{ + "length":{ + "shape":"Integer", + "documentation":"A strictly positive integer value representing the length of the primary key.
" + }, + "name":{ + "shape":"String", + "documentation":"A name for the Primary Key.
" + }, + "offset":{ + "shape":"Integer", + "documentation":"A positive integer value representing the offset to mark the start of the primary key in the record byte array.
" + } + }, + "documentation":"The primary key for a KSDS data set.
" + }, + "PsAttributes":{ + "type":"structure", + "required":["format"], + "members":{ + "encoding":{ + "shape":"String", + "documentation":"The character set encoding of the data set.
" + }, + "format":{ + "shape":"String", + "documentation":"The format of the data set records.
" + } + }, + "documentation":"The supported properties for a PS type data set.
" + }, + "PsDetailAttributes":{ + "type":"structure", + "required":[ + "encoding", + "format" + ], + "members":{ + "encoding":{ + "shape":"String", + "documentation":"The character set encoding of the data set.
" + }, + "format":{ + "shape":"String", + "documentation":"The format of the data set records.
" + } + }, + "documentation":"The supported properties for a PS type data set.
" + }, + "RecordLength":{ + "type":"structure", + "required":[ + "max", + "min" + ], + "members":{ + "max":{ + "shape":"Integer", + "documentation":"The maximum record length. In case of fixed, both minimum and maximum are the same.
" + }, + "min":{ + "shape":"Integer", + "documentation":"The minimum record length of a record.
" + } + }, + "documentation":"The length of the records in the data set.
" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "resourceId":{ + "shape":"String", + "documentation":"The ID of the missing resource.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The type of the missing resource.
" + } + }, + "documentation":"The specified resource was not found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "RestartBatchJobIdentifier":{ + "type":"structure", + "required":[ + "executionId", + "jobStepRestartMarker" + ], + "members":{ + "executionId":{ + "shape":"Identifier", + "documentation":"The executionId from the StartBatchJob response when the job ran for the first time.
" + }, + "jobStepRestartMarker":{ + "shape":"JobStepRestartMarker", + "documentation":"The restart step information for the most recent restart operation.
" + } + }, + "documentation":"An identifier for the StartBatchJob API to show that it is a restart operation.
" + }, + "S3BatchJobIdentifier":{ + "type":"structure", + "required":[ + "bucket", + "identifier" + ], + "members":{ + "bucket":{ + "shape":"String", + "documentation":"The Amazon S3 bucket that contains the batch job definitions.
" + }, + "identifier":{ + "shape":"JobIdentifier", + "documentation":"Identifies the batch job definition. This identifier can also point to any batch job definition that already exists in the application or to one of the batch job definitions within the directory that is specified in keyPrefix.
The key prefix that specifies the path to the folder in the S3 bucket that has the batch job definitions.
" + } + }, + "documentation":"A batch job identifier in which the batch jobs to run are identified by an Amazon S3 location.
" + }, + "ScriptBatchJobDefinition":{ + "type":"structure", + "required":["scriptName"], + "members":{ + "scriptName":{ + "shape":"String", + "documentation":"The name of the script containing the batch job definition.
" + } + }, + "documentation":"A batch job definition contained in a script.
" + }, + "ScriptBatchJobIdentifier":{ + "type":"structure", + "required":["scriptName"], + "members":{ + "scriptName":{ + "shape":"String", + "documentation":"The name of the script containing the batch job definition.
" + } + }, + "documentation":"A batch job identifier in which the batch job to run is identified by the script name.
" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "quotaCode":{ + "shape":"String", + "documentation":"The identifier of the exceeded quota.
" + }, + "resourceId":{ + "shape":"String", + "documentation":"The ID of the resource that is exceeding the quota limit.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The type of resource that is exceeding the quota limit for Amazon Web Services Mainframe Modernization.
" + }, + "serviceCode":{ + "shape":"String", + "documentation":"A code that identifies the service that the exceeded quota belongs to.
" + } + }, + "documentation":"One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Server cannot process the request at the moment.
", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "StartApplicationRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application you want to start.
", + "location":"uri", + "locationName":"applicationId" + } + } + }, + "StartApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "StartBatchJobRequest":{ + "type":"structure", + "required":[ + "applicationId", + "batchJobIdentifier" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application associated with this batch job.
", + "location":"uri", + "locationName":"applicationId" + }, + "batchJobIdentifier":{ + "shape":"BatchJobIdentifier", + "documentation":"The unique identifier of the batch job.
" + }, + "jobParams":{ + "shape":"BatchJobParametersMap", + "documentation":"The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.
" + } + } + }, + "StartBatchJobResponse":{ + "type":"structure", + "required":["executionId"], + "members":{ + "executionId":{ + "shape":"Identifier", + "documentation":"The unique identifier of this execution of the batch job.
" + } + } + }, + "StopApplicationRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application you want to stop.
", + "location":"uri", + "locationName":"applicationId" + }, + "forceStop":{ + "shape":"Boolean", + "documentation":"Stopping an application process can take a long time. Setting this parameter to true lets you force stop the application so you don't need to wait until the process finishes to apply another action on the application. The default value is false.
" + } + } + }, + "StopApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "StorageConfiguration":{ + "type":"structure", + "members":{ + "efs":{ + "shape":"EfsStorageConfiguration", + "documentation":"Defines the storage configuration for an Amazon EFS file system.
" + }, + "fsx":{ + "shape":"FsxStorageConfiguration", + "documentation":"Defines the storage configuration for an Amazon FSx file system.
" + } + }, + "documentation":"Defines the storage configuration for a runtime environment.
", + "union":true + }, + "StorageConfigurationList":{ + "type":"list", + "member":{"shape":"StorageConfiguration"} + }, + "String":{"type":"string"}, + "String100":{ + "type":"string", + "pattern":"^\\S{1,100}$" + }, + "String20":{ + "type":"string", + "pattern":"^\\S{1,20}$" + }, + "String200":{ + "type":"string", + "pattern":"^\\S{1,200}$" + }, + "String2000":{ + "type":"string", + "pattern":"^\\S{1,2000}$" + }, + "String20List":{ + "type":"list", + "member":{"shape":"String20"}, + "max":10, + "min":1 + }, + "String50":{ + "type":"string", + "pattern":"^\\S{1,50}$" + }, + "String50List":{ + "type":"list", + "member":{"shape":"String50"} + }, + "StringFree65000":{ + "type":"string", + "max":65000, + "min":1 + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:).+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags to add to the resource.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "quotaCode":{ + "shape":"String", + "documentation":"The identifier of the throttled request.
" + }, + "retryAfterSeconds":{ + "shape":"Integer", + "documentation":"The number of seconds to wait before retrying the request.
", + "location":"header", + "locationName":"Retry-After" + }, + "serviceCode":{ + "shape":"String", + "documentation":"The identifier of the service that the throttled request was made to.
" + } + }, + "documentation":"The number of requests made exceeds the limit.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":true} + }, + "Timestamp":{"type":"timestamp"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"The keys of the tags to remove.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateApplicationRequest":{ + "type":"structure", + "required":[ + "applicationId", + "currentApplicationVersion" + ], + "members":{ + "applicationId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the application you want to update.
", + "location":"uri", + "locationName":"applicationId" + }, + "currentApplicationVersion":{ + "shape":"Version", + "documentation":"The current version of the application to update.
" + }, + "definition":{ + "shape":"Definition", + "documentation":"The application definition for this application. You can specify either inline JSON or an S3 bucket location.
" + }, + "description":{ + "shape":"EntityDescription", + "documentation":"The description of the application to update.
" + } + } + }, + "UpdateApplicationResponse":{ + "type":"structure", + "required":["applicationVersion"], + "members":{ + "applicationVersion":{ + "shape":"Version", + "documentation":"The new version of the application.
" + } + } + }, + "UpdateEnvironmentRequest":{ + "type":"structure", + "required":["environmentId"], + "members":{ + "applyDuringMaintenanceWindow":{ + "shape":"Boolean", + "documentation":"Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.
The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.
" + }, + "engineVersion":{ + "shape":"EngineVersion", + "documentation":"The version of the runtime engine for the runtime environment.
" + }, + "environmentId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the runtime environment that you want to update.
", + "location":"uri", + "locationName":"environmentId" + }, + "forceUpdate":{ + "shape":"Boolean", + "documentation":"Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.
If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.
This option is not needed if the attribute being updated is preferredMaintenanceWindow.
The instance type for the runtime environment to update.
" + }, + "preferredMaintenanceWindow":{ + "shape":"String", + "documentation":"Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.
If you do not provide a value, a random system-generated value will be assigned.
" + } + } + }, + "UpdateEnvironmentResponse":{ + "type":"structure", + "required":["environmentId"], + "members":{ + "environmentId":{ + "shape":"Identifier", + "documentation":"The unique identifier of the runtime environment that was updated.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "fieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"The list of fields that failed service validation.
" + }, + "message":{"shape":"String"}, + "reason":{ + "shape":"ValidationExceptionReason", + "documentation":"The reason why it failed service validation.
" + } + }, + "documentation":"One or more parameters provided in the request is not valid.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "message", + "name" + ], + "members":{ + "message":{ + "shape":"String", + "documentation":"The message of the exception field.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the exception field.
" + } + }, + "documentation":"Contains information about a validation exception field.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "unknownOperation", + "cannotParse", + "featureNotAvailable", + "unsupportedEngineVersion", + "fieldValidationFailed", + "other" + ] + }, + "Version":{ + "type":"integer", + "box":true, + "min":1 + }, + "VsamAttributes":{ + "type":"structure", + "required":["format"], + "members":{ + "alternateKeys":{ + "shape":"AlternateKeyList", + "documentation":"The alternate key definitions, if any. A legacy dataset might not have any alternate key defined, but if those alternate keys definitions exist, provide them as some applications will make use of them.
" + }, + "compressed":{ + "shape":"Boolean", + "documentation":"Indicates whether indexes for this dataset are stored as compressed values. If you have a large data set (typically > 100 Mb), consider setting this flag to True.
" + }, + "encoding":{ + "shape":"String", + "documentation":"The character set used by the data set. Can be ASCII, EBCDIC, or unknown.
" + }, + "format":{ + "shape":"String", + "documentation":"The record format of the data set.
" + }, + "primaryKey":{ + "shape":"PrimaryKey", + "documentation":"The primary key of the data set.
" + } + }, + "documentation":"The attributes of a VSAM type data set.
" + }, + "VsamDetailAttributes":{ + "type":"structure", + "members":{ + "alternateKeys":{ + "shape":"AlternateKeyList", + "documentation":"The alternate key definitions, if any. A legacy dataset might not have any alternate key defined, but if those alternate keys definitions exist, provide them as some applications will make use of them.
" + }, + "cacheAtStartup":{ + "shape":"Boolean", + "documentation":"If set to True, enforces loading the data set into cache before it’s used by the application.
", + "box":true + }, + "compressed":{ + "shape":"Boolean", + "documentation":"Indicates whether indexes for this dataset are stored as compressed values. If you have a large data set (typically > 100 Mb), consider setting this flag to True.
", + "box":true + }, + "encoding":{ + "shape":"String20", + "documentation":"The character set used by the data set. Can be ASCII, EBCDIC, or unknown.
" + }, + "primaryKey":{ + "shape":"PrimaryKey", + "documentation":"The primary key of the data set.
" + }, + "recordFormat":{ + "shape":"String20", + "documentation":"The record format of the data set.
" + } + }, + "documentation":"The attributes of a VSAM type data set.
" + } + }, + "documentation":"Amazon Web Services Mainframe Modernization provides tools and resources to help you plan and implement migration and modernization from mainframes to Amazon Web Services managed runtime environments. It provides tools for analyzing existing mainframe applications, developing or updating mainframe applications using COBOL or PL/I, and implementing an automated pipeline for continuous integration and continuous delivery (CI/CD) of the applications.
" +} diff --git a/testbed/boto__botocore/botocore/data/mailmanager/2023-10-17/service-2.json b/testbed/boto__botocore/botocore/data/mailmanager/2023-10-17/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..ddfb826d08cc1d407409f088a9813a05eb76bb9f --- /dev/null +++ b/testbed/boto__botocore/botocore/data/mailmanager/2023-10-17/service-2.json @@ -0,0 +1,4070 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2023-10-17", + "endpointPrefix":"mail-manager", + "jsonVersion":"1.0", + "protocol":"json", + "protocols":["json"], + "serviceFullName":"MailManager", + "serviceId":"MailManager", + "signatureVersion":"v4", + "signingName":"ses", + "targetPrefix":"MailManagerSvc", + "uid":"mailmanager-2023-10-17", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "CreateAddonInstance":{ + "name":"CreateAddonInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAddonInstanceRequest"}, + "output":{"shape":"CreateAddonInstanceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.
", + "idempotent":true + }, + "CreateAddonSubscription":{ + "name":"CreateAddonSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAddonSubscriptionRequest"}, + "output":{"shape":"CreateAddonSubscriptionResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"} + ], + "documentation":"Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies.
", + "idempotent":true + }, + "CreateArchive":{ + "name":"CreateArchive", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateArchiveRequest"}, + "output":{"shape":"CreateArchiveResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Creates a new email archive resource for storing and retaining emails.
", + "idempotent":true + }, + "CreateIngressPoint":{ + "name":"CreateIngressPoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateIngressPointRequest"}, + "output":{"shape":"CreateIngressPointResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"} + ], + "documentation":"Provision a new ingress endpoint resource.
", + "idempotent":true + }, + "CreateRelay":{ + "name":"CreateRelay", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRelayRequest"}, + "output":{"shape":"CreateRelayResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"} + ], + "documentation":"Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.
", + "idempotent":true + }, + "CreateRuleSet":{ + "name":"CreateRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRuleSetRequest"}, + "output":{"shape":"CreateRuleSetResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"} + ], + "documentation":"Provision a new rule set.
", + "idempotent":true + }, + "CreateTrafficPolicy":{ + "name":"CreateTrafficPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTrafficPolicyRequest"}, + "output":{"shape":"CreateTrafficPolicyResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"} + ], + "documentation":"Provision a new traffic policy resource.
", + "idempotent":true + }, + "DeleteAddonInstance":{ + "name":"DeleteAddonInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAddonInstanceRequest"}, + "output":{"shape":"DeleteAddonInstanceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes an Add On instance.
", + "idempotent":true + }, + "DeleteAddonSubscription":{ + "name":"DeleteAddonSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAddonSubscriptionRequest"}, + "output":{"shape":"DeleteAddonSubscriptionResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes an Add On subscription.
", + "idempotent":true + }, + "DeleteArchive":{ + "name":"DeleteArchive", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteArchiveRequest"}, + "output":{"shape":"DeleteArchiveResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Initiates deletion of an email archive. This changes the archive state to pending deletion. In this state, no new emails can be added, and existing archived emails become inaccessible (search, export, download). The archive and all of its contents will be permanently deleted 30 days after entering the pending deletion state, regardless of the configured retention period.
", + "idempotent":true + }, + "DeleteIngressPoint":{ + "name":"DeleteIngressPoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIngressPointRequest"}, + "output":{"shape":"DeleteIngressPointResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Delete an ingress endpoint resource.
", + "idempotent":true + }, + "DeleteRelay":{ + "name":"DeleteRelay", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRelayRequest"}, + "output":{"shape":"DeleteRelayResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Deletes an existing relay resource.
", + "idempotent":true + }, + "DeleteRuleSet":{ + "name":"DeleteRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRuleSetRequest"}, + "output":{"shape":"DeleteRuleSetResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Delete a rule set.
", + "idempotent":true + }, + "DeleteTrafficPolicy":{ + "name":"DeleteTrafficPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTrafficPolicyRequest"}, + "output":{"shape":"DeleteTrafficPolicyResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Delete a traffic policy resource.
", + "idempotent":true + }, + "GetAddonInstance":{ + "name":"GetAddonInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAddonInstanceRequest"}, + "output":{"shape":"GetAddonInstanceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Gets detailed information about an Add On instance.
" + }, + "GetAddonSubscription":{ + "name":"GetAddonSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAddonSubscriptionRequest"}, + "output":{"shape":"GetAddonSubscriptionResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Gets detailed information about an Add On subscription.
" + }, + "GetArchive":{ + "name":"GetArchive", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetArchiveRequest"}, + "output":{"shape":"GetArchiveResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves the full details and current state of a specified email archive.
" + }, + "GetArchiveExport":{ + "name":"GetArchiveExport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetArchiveExportRequest"}, + "output":{"shape":"GetArchiveExportResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves the details and current status of a specific email archive export job.
" + }, + "GetArchiveMessage":{ + "name":"GetArchiveMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetArchiveMessageRequest"}, + "output":{"shape":"GetArchiveMessageResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.
" + }, + "GetArchiveMessageContent":{ + "name":"GetArchiveMessageContent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetArchiveMessageContentRequest"}, + "output":{"shape":"GetArchiveMessageContentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns the textual content of a specific email message stored in the archive. Attachments are not included.
" + }, + "GetArchiveSearch":{ + "name":"GetArchiveSearch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetArchiveSearchRequest"}, + "output":{"shape":"GetArchiveSearchResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves the details and current status of a specific email archive search job.
" + }, + "GetArchiveSearchResults":{ + "name":"GetArchiveSearchResults", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetArchiveSearchResultsRequest"}, + "output":{"shape":"GetArchiveSearchResultsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns the results of a completed email archive search job.
" + }, + "GetIngressPoint":{ + "name":"GetIngressPoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIngressPointRequest"}, + "output":{"shape":"GetIngressPointResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Fetch ingress endpoint resource attributes.
" + }, + "GetRelay":{ + "name":"GetRelay", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRelayRequest"}, + "output":{"shape":"GetRelayResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Fetch the relay resource and it's attributes.
" + }, + "GetRuleSet":{ + "name":"GetRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRuleSetRequest"}, + "output":{"shape":"GetRuleSetResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Fetch attributes of a rule set.
" + }, + "GetTrafficPolicy":{ + "name":"GetTrafficPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTrafficPolicyRequest"}, + "output":{"shape":"GetTrafficPolicyResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Fetch attributes of a traffic policy resource.
" + }, + "ListAddonInstances":{ + "name":"ListAddonInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAddonInstancesRequest"}, + "output":{"shape":"ListAddonInstancesResponse"}, + "errors":[ + {"shape":"ValidationException"} + ], + "documentation":"Lists all Add On instances in your account.
" + }, + "ListAddonSubscriptions":{ + "name":"ListAddonSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAddonSubscriptionsRequest"}, + "output":{"shape":"ListAddonSubscriptionsResponse"}, + "errors":[ + {"shape":"ValidationException"} + ], + "documentation":"Lists all Add On subscriptions in your account.
" + }, + "ListArchiveExports":{ + "name":"ListArchiveExports", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListArchiveExportsRequest"}, + "output":{"shape":"ListArchiveExportsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a list of email archive export jobs.
" + }, + "ListArchiveSearches":{ + "name":"ListArchiveSearches", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListArchiveSearchesRequest"}, + "output":{"shape":"ListArchiveSearchesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a list of email archive search jobs.
" + }, + "ListArchives":{ + "name":"ListArchives", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListArchivesRequest"}, + "output":{"shape":"ListArchivesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a list of all email archives in your account.
" + }, + "ListIngressPoints":{ + "name":"ListIngressPoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListIngressPointsRequest"}, + "output":{"shape":"ListIngressPointsResponse"}, + "errors":[ + {"shape":"ValidationException"} + ], + "documentation":"List all ingress endpoint resources.
" + }, + "ListRelays":{ + "name":"ListRelays", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRelaysRequest"}, + "output":{"shape":"ListRelaysResponse"}, + "errors":[ + {"shape":"ValidationException"} + ], + "documentation":"Lists all the existing relay resources.
" + }, + "ListRuleSets":{ + "name":"ListRuleSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRuleSetsRequest"}, + "output":{"shape":"ListRuleSetsResponse"}, + "errors":[ + {"shape":"ValidationException"} + ], + "documentation":"List rule sets for this account.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves the list of tags (keys and values) assigned to the resource.
" + }, + "ListTrafficPolicies":{ + "name":"ListTrafficPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTrafficPoliciesRequest"}, + "output":{"shape":"ListTrafficPoliciesResponse"}, + "errors":[ + {"shape":"ValidationException"} + ], + "documentation":"List traffic policy resources.
" + }, + "StartArchiveExport":{ + "name":"StartArchiveExport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartArchiveExportRequest"}, + "output":{"shape":"StartArchiveExportResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Initiates an export of emails from the specified archive.
" + }, + "StartArchiveSearch":{ + "name":"StartArchiveSearch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartArchiveSearchRequest"}, + "output":{"shape":"StartArchiveSearchResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Initiates a search across emails in the specified archive.
" + }, + "StopArchiveExport":{ + "name":"StopArchiveExport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopArchiveExportRequest"}, + "output":{"shape":"StopArchiveExportResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Stops an in-progress export of emails from an archive.
" + }, + "StopArchiveSearch":{ + "name":"StopArchiveSearch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopArchiveSearchRequest"}, + "output":{"shape":"StopArchiveSearchResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Stops an in-progress archive search job.
", + "idempotent":true + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Adds one or more tags (keys and values) to a specified resource.
", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Remove one or more tags (keys and values) from a specified resource.
", + "idempotent":true + }, + "UpdateArchive":{ + "name":"UpdateArchive", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateArchiveRequest"}, + "output":{"shape":"UpdateArchiveResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Updates the attributes of an existing email archive.
", + "idempotent":true + }, + "UpdateIngressPoint":{ + "name":"UpdateIngressPoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateIngressPointRequest"}, + "output":{"shape":"UpdateIngressPointResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Update attributes of a provisioned ingress endpoint resource.
", + "idempotent":true + }, + "UpdateRelay":{ + "name":"UpdateRelay", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRelayRequest"}, + "output":{"shape":"UpdateRelayResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Updates the attributes of an existing relay resource.
", + "idempotent":true + }, + "UpdateRuleSet":{ + "name":"UpdateRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRuleSetRequest"}, + "output":{"shape":"UpdateRuleSetResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Update attributes of an already provisioned rule set.
", + "idempotent":true + }, + "UpdateTrafficPolicy":{ + "name":"UpdateTrafficPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTrafficPolicyRequest"}, + "output":{"shape":"UpdateTrafficPolicyResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Update attributes of an already provisioned traffic policy resource.
", + "idempotent":true + } + }, + "shapes":{ + "AcceptAction":{ + "type":"string", + "enum":[ + "ALLOW", + "DENY" + ] + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"Occurs when a user is denied access to a specific resource or action.
", + "exception":true + }, + "ActionFailurePolicy":{ + "type":"string", + "enum":[ + "CONTINUE", + "DROP" + ] + }, + "AddHeaderAction":{ + "type":"structure", + "required":[ + "HeaderName", + "HeaderValue" + ], + "members":{ + "HeaderName":{ + "shape":"HeaderName", + "documentation":"The name of the header to add to an email. The header must be prefixed with \"X-\". Headers are added regardless of whether the header name pre-existed in the email.
" + }, + "HeaderValue":{ + "shape":"HeaderValue", + "documentation":"The value of the header to add to the email.
" + } + }, + "documentation":"The action to add a header to a message. When executed, this action will add the given header to the message.
" + }, + "AddonInstance":{ + "type":"structure", + "members":{ + "AddonInstanceArn":{ + "shape":"AddonInstanceArn", + "documentation":"The Amazon Resource Name (ARN) of the Add On instance.
" + }, + "AddonInstanceId":{ + "shape":"AddonInstanceId", + "documentation":"The unique ID of the Add On instance.
" + }, + "AddonName":{ + "shape":"AddonName", + "documentation":"The name of the Add On for the instance.
" + }, + "AddonSubscriptionId":{ + "shape":"AddonSubscriptionId", + "documentation":"The subscription ID for the instance.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the Add On instance was created.
" + } + }, + "documentation":"An Add On instance represents a specific configuration of an Add On.
" + }, + "AddonInstanceArn":{"type":"string"}, + "AddonInstanceId":{ + "type":"string", + "max":67, + "min":4, + "pattern":"^ai-[a-zA-Z0-9]{1,64}$" + }, + "AddonInstances":{ + "type":"list", + "member":{"shape":"AddonInstance"} + }, + "AddonName":{"type":"string"}, + "AddonSubscription":{ + "type":"structure", + "members":{ + "AddonName":{ + "shape":"AddonName", + "documentation":"The name of the Add On.
" + }, + "AddonSubscriptionArn":{ + "shape":"AddonSubscriptionArn", + "documentation":"The Amazon Resource Name (ARN) of the Add On subscription.
" + }, + "AddonSubscriptionId":{ + "shape":"AddonSubscriptionId", + "documentation":"The unique ID of the Add On subscription.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the Add On subscription was created.
" + } + }, + "documentation":"A subscription for an Add On representing the acceptance of its terms of use and additional pricing.
" + }, + "AddonSubscriptionArn":{"type":"string"}, + "AddonSubscriptionId":{ + "type":"string", + "max":67, + "min":4, + "pattern":"^as-[a-zA-Z0-9]{1,64}$" + }, + "AddonSubscriptions":{ + "type":"list", + "member":{"shape":"AddonSubscription"} + }, + "Analysis":{ + "type":"structure", + "required":[ + "Analyzer", + "ResultField" + ], + "members":{ + "Analyzer":{ + "shape":"AnalyzerArn", + "documentation":"The Amazon Resource Name (ARN) of an Add On.
" + }, + "ResultField":{ + "shape":"ResultField", + "documentation":"The returned value from an Add On.
" + } + }, + "documentation":"The result of an analysis can be used in conditions to trigger actions. Analyses can inspect the email content and report a certain aspect of the email.
" + }, + "AnalyzerArn":{ + "type":"string", + "pattern":"^[a-zA-Z0-9:_/+=,@.#-]+$" + }, + "Archive":{ + "type":"structure", + "required":["ArchiveId"], + "members":{ + "ArchiveId":{ + "shape":"ArchiveIdString", + "documentation":"The unique identifier of the archive.
" + }, + "ArchiveName":{ + "shape":"ArchiveNameString", + "documentation":"The unique name assigned to the archive.
" + }, + "ArchiveState":{ + "shape":"ArchiveState", + "documentation":"The current state of the archive:
ACTIVE – The archive is ready and available for use.
PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.
The timestamp of when the archive was last updated.
" + } + }, + "documentation":"An archive resource for storing and retaining emails.
" + }, + "ArchiveAction":{ + "type":"structure", + "required":["TargetArchive"], + "members":{ + "ActionFailurePolicy":{ + "shape":"ActionFailurePolicy", + "documentation":"A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified archive has been deleted.
" + }, + "TargetArchive":{ + "shape":"NameOrArn", + "documentation":"The identifier of the archive to send the email to.
" + } + }, + "documentation":"The action to archive the email by delivering the email to an Amazon SES archive.
" + }, + "ArchiveArn":{"type":"string"}, + "ArchiveBooleanEmailAttribute":{ + "type":"string", + "enum":["HAS_ATTACHMENTS"] + }, + "ArchiveBooleanExpression":{ + "type":"structure", + "required":[ + "Evaluate", + "Operator" + ], + "members":{ + "Evaluate":{ + "shape":"ArchiveBooleanToEvaluate", + "documentation":"The email attribute value to evaluate.
" + }, + "Operator":{ + "shape":"ArchiveBooleanOperator", + "documentation":"The boolean operator to use for evaluation.
" + } + }, + "documentation":"A boolean expression to evaluate email attribute values.
" + }, + "ArchiveBooleanOperator":{ + "type":"string", + "enum":[ + "IS_TRUE", + "IS_FALSE" + ] + }, + "ArchiveBooleanToEvaluate":{ + "type":"structure", + "members":{ + "Attribute":{ + "shape":"ArchiveBooleanEmailAttribute", + "documentation":"The name of the email attribute to evaluate.
" + } + }, + "documentation":"The attribute to evaluate in a boolean expression.
", + "union":true + }, + "ArchiveFilterCondition":{ + "type":"structure", + "members":{ + "BooleanExpression":{ + "shape":"ArchiveBooleanExpression", + "documentation":"A boolean expression to evaluate against email attributes.
" + }, + "StringExpression":{ + "shape":"ArchiveStringExpression", + "documentation":"A string expression to evaluate against email attributes.
" + } + }, + "documentation":"A filter condition used to include or exclude emails when exporting from or searching an archive.
", + "union":true + }, + "ArchiveFilterConditions":{ + "type":"list", + "member":{"shape":"ArchiveFilterCondition"}, + "max":10, + "min":0 + }, + "ArchiveFilters":{ + "type":"structure", + "members":{ + "Include":{ + "shape":"ArchiveFilterConditions", + "documentation":"The filter conditions for emails to include.
" + }, + "Unless":{ + "shape":"ArchiveFilterConditions", + "documentation":"The filter conditions for emails to exclude.
" + } + }, + "documentation":"A set of filter conditions to include and/or exclude emails.
" + }, + "ArchiveId":{ + "type":"string", + "max":66, + "min":3, + "pattern":"^a-[\\w]{1,64}$" + }, + "ArchiveIdString":{ + "type":"string", + "max":66, + "min":1 + }, + "ArchiveNameString":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]$" + }, + "ArchiveRetention":{ + "type":"structure", + "members":{ + "RetentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"The enum value sets the period for retaining emails in an archive.
" + } + }, + "documentation":"The retention policy for an email archive that specifies how long emails are kept before being automatically deleted.
", + "union":true + }, + "ArchiveState":{ + "type":"string", + "enum":[ + "ACTIVE", + "PENDING_DELETION" + ] + }, + "ArchiveStringEmailAttribute":{ + "type":"string", + "enum":[ + "TO", + "FROM", + "CC", + "SUBJECT" + ] + }, + "ArchiveStringExpression":{ + "type":"structure", + "required":[ + "Evaluate", + "Operator", + "Values" + ], + "members":{ + "Evaluate":{ + "shape":"ArchiveStringToEvaluate", + "documentation":"The attribute of the email to evaluate.
" + }, + "Operator":{ + "shape":"ArchiveStringOperator", + "documentation":"The operator to use when evaluating the string values.
" + }, + "Values":{ + "shape":"StringValueList", + "documentation":"The list of string values to evaluate the email attribute against.
" + } + }, + "documentation":"A string expression to evaluate an email attribute value against one or more string values.
" + }, + "ArchiveStringOperator":{ + "type":"string", + "enum":["CONTAINS"] + }, + "ArchiveStringToEvaluate":{ + "type":"structure", + "members":{ + "Attribute":{ + "shape":"ArchiveStringEmailAttribute", + "documentation":"The name of the email attribute to evaluate.
" + } + }, + "documentation":"Specifies the email attribute to evaluate in a string expression.
", + "union":true + }, + "ArchivedMessageId":{"type":"string"}, + "ArchivesList":{ + "type":"list", + "member":{"shape":"Archive"} + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"The request configuration has conflicts. For details, see the accompanying error message.
", + "exception":true + }, + "CreateAddonInstanceRequest":{ + "type":"structure", + "required":["AddonSubscriptionId"], + "members":{ + "AddonSubscriptionId":{ + "shape":"AddonSubscriptionId", + "documentation":"The unique ID of a previously created subscription that an Add On instance is created for. You can only have one instance per subscription.
" + }, + "ClientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + } + } + }, + "CreateAddonInstanceResponse":{ + "type":"structure", + "required":["AddonInstanceId"], + "members":{ + "AddonInstanceId":{ + "shape":"AddonInstanceId", + "documentation":"The unique ID of the Add On instance created by this API.
" + } + } + }, + "CreateAddonSubscriptionRequest":{ + "type":"structure", + "required":["AddonName"], + "members":{ + "AddonName":{ + "shape":"AddonName", + "documentation":"The name of the Add On to subscribe to. You can only have one subscription for each Add On name.
" + }, + "ClientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + } + } + }, + "CreateAddonSubscriptionResponse":{ + "type":"structure", + "required":["AddonSubscriptionId"], + "members":{ + "AddonSubscriptionId":{ + "shape":"AddonSubscriptionId", + "documentation":"The unique ID of the Add On subscription created by this API.
" + } + } + }, + "CreateArchiveRequest":{ + "type":"structure", + "required":["ArchiveName"], + "members":{ + "ArchiveName":{ + "shape":"ArchiveNameString", + "documentation":"A unique name for the new archive.
" + }, + "ClientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique token Amazon SES uses to recognize retries of this request.
", + "idempotencyToken":true + }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
" + }, + "Retention":{ + "shape":"ArchiveRetention", + "documentation":"The period for retaining emails in the archive before automatic deletion.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + } + }, + "documentation":"The request to create a new email archive.
" + }, + "CreateArchiveResponse":{ + "type":"structure", + "required":["ArchiveId"], + "members":{ + "ArchiveId":{ + "shape":"ArchiveIdString", + "documentation":"The unique identifier for the newly created archive.
" + } + }, + "documentation":"The response from creating a new email archive.
" + }, + "CreateIngressPointRequest":{ + "type":"structure", + "required":[ + "IngressPointName", + "RuleSetId", + "TrafficPolicyId", + "Type" + ], + "members":{ + "ClientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", + "idempotencyToken":true + }, + "IngressPointConfiguration":{ + "shape":"IngressPointConfiguration", + "documentation":"If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
" + }, + "IngressPointName":{ + "shape":"IngressPointName", + "documentation":"A user friendly name for an ingress endpoint resource.
" + }, + "RuleSetId":{ + "shape":"RuleSetId", + "documentation":"The identifier of an existing rule set that you attach to an ingress endpoint resource.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + }, + "TrafficPolicyId":{ + "shape":"TrafficPolicyId", + "documentation":"The identifier of an existing traffic policy that you attach to an ingress endpoint resource.
" + }, + "Type":{ + "shape":"IngressPointType", + "documentation":"The type of the ingress endpoint to create.
" + } + } + }, + "CreateIngressPointResponse":{ + "type":"structure", + "required":["IngressPointId"], + "members":{ + "IngressPointId":{ + "shape":"IngressPointId", + "documentation":"The unique identifier for a previously created ingress endpoint.
" + } + } + }, + "CreateRelayRequest":{ + "type":"structure", + "required":[ + "Authentication", + "RelayName", + "ServerName", + "ServerPort" + ], + "members":{ + "Authentication":{ + "shape":"RelayAuthentication", + "documentation":"Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.
" + }, + "ClientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", + "idempotencyToken":true + }, + "RelayName":{ + "shape":"RelayName", + "documentation":"The unique name of the relay resource.
" + }, + "ServerName":{ + "shape":"RelayServerName", + "documentation":"The destination relay server address.
" + }, + "ServerPort":{ + "shape":"RelayServerPort", + "documentation":"The destination relay server port.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + } + } + }, + "CreateRelayResponse":{ + "type":"structure", + "required":["RelayId"], + "members":{ + "RelayId":{ + "shape":"RelayId", + "documentation":"A unique identifier of the created relay resource.
" + } + } + }, + "CreateRuleSetRequest":{ + "type":"structure", + "required":[ + "RuleSetName", + "Rules" + ], + "members":{ + "ClientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", + "idempotencyToken":true + }, + "RuleSetName":{ + "shape":"RuleSetName", + "documentation":"A user-friendly name for the rule set.
" + }, + "Rules":{ + "shape":"Rules", + "documentation":"Conditional rules that are evaluated for determining actions on email.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + } + } + }, + "CreateRuleSetResponse":{ + "type":"structure", + "required":["RuleSetId"], + "members":{ + "RuleSetId":{ + "shape":"RuleSetId", + "documentation":"The identifier of the created rule set.
" + } + } + }, + "CreateTrafficPolicyRequest":{ + "type":"structure", + "required":[ + "DefaultAction", + "PolicyStatements", + "TrafficPolicyName" + ], + "members":{ + "ClientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", + "idempotencyToken":true + }, + "DefaultAction":{ + "shape":"AcceptAction", + "documentation":"Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements
" + }, + "MaxMessageSizeBytes":{ + "shape":"MaxMessageSizeBytes", + "documentation":"The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
" + }, + "PolicyStatements":{ + "shape":"PolicyStatementList", + "documentation":"Conditional statements for filtering email traffic.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + }, + "TrafficPolicyName":{ + "shape":"TrafficPolicyName", + "documentation":"A user-friendly name for the traffic policy resource.
" + } + } + }, + "CreateTrafficPolicyResponse":{ + "type":"structure", + "required":["TrafficPolicyId"], + "members":{ + "TrafficPolicyId":{ + "shape":"TrafficPolicyId", + "documentation":"The identifier of the traffic policy resource.
" + } + } + }, + "DeleteAddonInstanceRequest":{ + "type":"structure", + "required":["AddonInstanceId"], + "members":{ + "AddonInstanceId":{ + "shape":"AddonInstanceId", + "documentation":"The Add On instance ID to delete.
" + } + } + }, + "DeleteAddonInstanceResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteAddonSubscriptionRequest":{ + "type":"structure", + "required":["AddonSubscriptionId"], + "members":{ + "AddonSubscriptionId":{ + "shape":"AddonSubscriptionId", + "documentation":"The Add On subscription ID to delete.
" + } + } + }, + "DeleteAddonSubscriptionResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteArchiveRequest":{ + "type":"structure", + "required":["ArchiveId"], + "members":{ + "ArchiveId":{ + "shape":"ArchiveIdString", + "documentation":"The identifier of the archive to delete.
" + } + }, + "documentation":"The request to initiate deletion of an email archive.
" + }, + "DeleteArchiveResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"The response indicating if the archive deletion was successfully initiated.
On success, returns an HTTP 200 status code. On failure, returns an error message.
" + }, + "DeleteIngressPointRequest":{ + "type":"structure", + "required":["IngressPointId"], + "members":{ + "IngressPointId":{ + "shape":"IngressPointId", + "documentation":"The identifier of the ingress endpoint resource that you want to delete.
" + } + } + }, + "DeleteIngressPointResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteRelayRequest":{ + "type":"structure", + "required":["RelayId"], + "members":{ + "RelayId":{ + "shape":"RelayId", + "documentation":"The unique relay identifier.
" + } + } + }, + "DeleteRelayResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteRuleSetRequest":{ + "type":"structure", + "required":["RuleSetId"], + "members":{ + "RuleSetId":{ + "shape":"RuleSetId", + "documentation":"The identifier of an existing rule set resource to delete.
" + } + } + }, + "DeleteRuleSetResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteTrafficPolicyRequest":{ + "type":"structure", + "required":["TrafficPolicyId"], + "members":{ + "TrafficPolicyId":{ + "shape":"TrafficPolicyId", + "documentation":"The identifier of the traffic policy that you want to delete.
" + } + } + }, + "DeleteTrafficPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeliverToMailboxAction":{ + "type":"structure", + "required":[ + "MailboxArn", + "RoleArn" + ], + "members":{ + "ActionFailurePolicy":{ + "shape":"ActionFailurePolicy", + "documentation":"A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the mailbox ARN is no longer valid.
" + }, + "MailboxArn":{ + "shape":"NameOrArn", + "documentation":"The Amazon Resource Name (ARN) of a WorkMail organization to deliver the email to.
" + }, + "RoleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) of an IAM role to use to execute this action. The role must have access to the workmail:DeliverToMailbox API.
" + } + }, + "documentation":"This action to delivers an email to a mailbox.
" + }, + "Double":{ + "type":"double", + "box":true + }, + "DropAction":{ + "type":"structure", + "members":{ + }, + "documentation":"This action causes processing to stop and the email to be dropped. If the action applies only to certain recipients, only those recipients are dropped, and processing continues for other recipients.
" + }, + "EmailAddress":{ + "type":"string", + "max":254, + "min":0, + "pattern":"^[0-9A-Za-z@+.-]+$", + "sensitive":true + }, + "EmailReceivedHeadersList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ErrorMessage":{"type":"string"}, + "ExportDestinationConfiguration":{ + "type":"structure", + "members":{ + "S3":{ + "shape":"S3ExportDestinationConfiguration", + "documentation":"Configuration for delivering to an Amazon S3 bucket.
" + } + }, + "documentation":"The destination configuration for delivering exported email data.
", + "union":true + }, + "ExportId":{ + "type":"string", + "max":64, + "min":1 + }, + "ExportMaxResults":{ + "type":"integer", + "box":true + }, + "ExportState":{ + "type":"string", + "enum":[ + "QUEUED", + "PREPROCESSING", + "PROCESSING", + "COMPLETED", + "FAILED", + "CANCELLED" + ] + }, + "ExportStatus":{ + "type":"structure", + "members":{ + "CompletionTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the export job completed (if finished).
" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"An error message if the export job failed.
" + }, + "State":{ + "shape":"ExportState", + "documentation":"The current state of the export job.
" + }, + "SubmissionTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the export job was submitted.
" + } + }, + "documentation":"The current status of an archive export job.
" + }, + "ExportSummary":{ + "type":"structure", + "members":{ + "ExportId":{ + "shape":"ExportId", + "documentation":"The unique identifier of the export job.
" + }, + "Status":{ + "shape":"ExportStatus", + "documentation":"The current status of the export job.
" + } + }, + "documentation":"Summary statuses of an archive export job.
" + }, + "ExportSummaryList":{ + "type":"list", + "member":{"shape":"ExportSummary"} + }, + "GetAddonInstanceRequest":{ + "type":"structure", + "required":["AddonInstanceId"], + "members":{ + "AddonInstanceId":{ + "shape":"AddonInstanceId", + "documentation":"The Add On instance ID to retrieve information for.
" + } + } + }, + "GetAddonInstanceResponse":{ + "type":"structure", + "members":{ + "AddonInstanceArn":{ + "shape":"AddonInstanceArn", + "documentation":"The Amazon Resource Name (ARN) of the Add On instance.
" + }, + "AddonName":{ + "shape":"AddonName", + "documentation":"The name of the Add On provider associated to the subscription of the instance.
" + }, + "AddonSubscriptionId":{ + "shape":"AddonSubscriptionId", + "documentation":"The subscription ID associated to the instance.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the Add On instance was created.
" + } + } + }, + "GetAddonSubscriptionRequest":{ + "type":"structure", + "required":["AddonSubscriptionId"], + "members":{ + "AddonSubscriptionId":{ + "shape":"AddonSubscriptionId", + "documentation":"The Add On subscription ID to retrieve information for.
" + } + } + }, + "GetAddonSubscriptionResponse":{ + "type":"structure", + "members":{ + "AddonName":{ + "shape":"AddonName", + "documentation":"The name of the Add On for the subscription.
" + }, + "AddonSubscriptionArn":{ + "shape":"AddonSubscriptionArn", + "documentation":"Amazon Resource Name (ARN) for the subscription.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the Add On subscription was created.
" + } + } + }, + "GetArchiveExportRequest":{ + "type":"structure", + "required":["ExportId"], + "members":{ + "ExportId":{ + "shape":"ExportId", + "documentation":"The identifier of the export job to get details for.
" + } + }, + "documentation":"The request to retrieve details of a specific archive export job.
" + }, + "GetArchiveExportResponse":{ + "type":"structure", + "members":{ + "ArchiveId":{ + "shape":"ArchiveId", + "documentation":"The identifier of the archive the email export was performed from.
" + }, + "ExportDestinationConfiguration":{ + "shape":"ExportDestinationConfiguration", + "documentation":"Where the exported emails are being delivered.
" + }, + "Filters":{ + "shape":"ArchiveFilters", + "documentation":"The criteria used to filter emails included in the export.
" + }, + "FromTimestamp":{ + "shape":"Timestamp", + "documentation":"The start of the timestamp range the exported emails cover.
" + }, + "MaxResults":{ + "shape":"ExportMaxResults", + "documentation":"The maximum number of email items included in the export.
" + }, + "Status":{ + "shape":"ExportStatus", + "documentation":"The current status of the export job.
" + }, + "ToTimestamp":{ + "shape":"Timestamp", + "documentation":"The end of the date range the exported emails cover.
" + } + }, + "documentation":"The response containing details of the specified archive export job.
" + }, + "GetArchiveMessageContentRequest":{ + "type":"structure", + "required":["ArchivedMessageId"], + "members":{ + "ArchivedMessageId":{ + "shape":"ArchivedMessageId", + "documentation":"The unique identifier of the archived email message.
" + } + }, + "documentation":"The request to get the textual content of a specific email message stored in an archive.
" + }, + "GetArchiveMessageContentResponse":{ + "type":"structure", + "members":{ + "Body":{ + "shape":"MessageBody", + "documentation":"The textual body content of the email message.
" + } + }, + "documentation":"The response containing the textual content of the requested archived email message.
" + }, + "GetArchiveMessageRequest":{ + "type":"structure", + "required":["ArchivedMessageId"], + "members":{ + "ArchivedMessageId":{ + "shape":"ArchivedMessageId", + "documentation":"The unique identifier of the archived email message.
" + } + }, + "documentation":"The request to get details of a specific email message stored in an archive.
" + }, + "GetArchiveMessageResponse":{ + "type":"structure", + "members":{ + "MessageDownloadLink":{ + "shape":"S3PresignedURL", + "documentation":"A pre-signed URL to temporarily download the full message content.
" + } + }, + "documentation":"The response containing details about the requested archived email message.
" + }, + "GetArchiveRequest":{ + "type":"structure", + "required":["ArchiveId"], + "members":{ + "ArchiveId":{ + "shape":"ArchiveIdString", + "documentation":"The identifier of the archive to retrieve.
" + } + }, + "documentation":"The request to retrieve details of an email archive.
" + }, + "GetArchiveResponse":{ + "type":"structure", + "required":[ + "ArchiveArn", + "ArchiveId", + "ArchiveName", + "ArchiveState", + "Retention" + ], + "members":{ + "ArchiveArn":{ + "shape":"ArchiveArn", + "documentation":"The Amazon Resource Name (ARN) of the archive.
" + }, + "ArchiveId":{ + "shape":"ArchiveIdString", + "documentation":"The unique identifier of the archive.
" + }, + "ArchiveName":{ + "shape":"ArchiveNameString", + "documentation":"The unique name assigned to the archive.
" + }, + "ArchiveState":{ + "shape":"ArchiveState", + "documentation":"The current state of the archive:
ACTIVE – The archive is ready and available for use.
PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.
The timestamp of when the archive was created.
" + }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.
" + }, + "LastUpdatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the archive was modified.
" + }, + "Retention":{ + "shape":"ArchiveRetention", + "documentation":"The retention period for emails in this archive.
" + } + }, + "documentation":"The response containing details of the requested archive.
" + }, + "GetArchiveSearchRequest":{ + "type":"structure", + "required":["SearchId"], + "members":{ + "SearchId":{ + "shape":"SearchId", + "documentation":"The identifier of the search job to get details for.
" + } + }, + "documentation":"The request to retrieve details of a specific archive search job.
" + }, + "GetArchiveSearchResponse":{ + "type":"structure", + "members":{ + "ArchiveId":{ + "shape":"ArchiveId", + "documentation":"The identifier of the archive the email search was performed in.
" + }, + "Filters":{ + "shape":"ArchiveFilters", + "documentation":"The criteria used to filter emails included in the search.
" + }, + "FromTimestamp":{ + "shape":"Timestamp", + "documentation":"The start timestamp of the range the searched emails cover.
" + }, + "MaxResults":{ + "shape":"SearchMaxResults", + "documentation":"The maximum number of search results to return.
" + }, + "Status":{ + "shape":"SearchStatus", + "documentation":"The current status of the search job.
" + }, + "ToTimestamp":{ + "shape":"Timestamp", + "documentation":"The end timestamp of the range the searched emails cover.
" + } + }, + "documentation":"The response containing details of the specified archive search job.
" + }, + "GetArchiveSearchResultsRequest":{ + "type":"structure", + "required":["SearchId"], + "members":{ + "SearchId":{ + "shape":"SearchId", + "documentation":"The identifier of the completed search job.
" + } + }, + "documentation":"The request to retrieve results from a completed archive search job.
" + }, + "GetArchiveSearchResultsResponse":{ + "type":"structure", + "members":{ + "Rows":{ + "shape":"RowsList", + "documentation":"The list of email result objects matching the search criteria.
" + } + }, + "documentation":"The response containing search results from a completed archive search.
" + }, + "GetIngressPointRequest":{ + "type":"structure", + "required":["IngressPointId"], + "members":{ + "IngressPointId":{ + "shape":"IngressPointId", + "documentation":"The identifier of an ingress endpoint.
" + } + } + }, + "GetIngressPointResponse":{ + "type":"structure", + "required":[ + "IngressPointId", + "IngressPointName" + ], + "members":{ + "ARecord":{ + "shape":"IngressPointARecord", + "documentation":"The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the ingress endpoint was created.
" + }, + "IngressPointArn":{ + "shape":"IngressPointArn", + "documentation":"The Amazon Resource Name (ARN) of the ingress endpoint resource.
" + }, + "IngressPointAuthConfiguration":{ + "shape":"IngressPointAuthConfiguration", + "documentation":"The authentication configuration of the ingress endpoint resource.
" + }, + "IngressPointId":{ + "shape":"IngressPointId", + "documentation":"The identifier of an ingress endpoint resource.
" + }, + "IngressPointName":{ + "shape":"IngressPointName", + "documentation":"A user friendly name for the ingress endpoint.
" + }, + "LastUpdatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the ingress endpoint was last updated.
" + }, + "RuleSetId":{ + "shape":"RuleSetId", + "documentation":"The identifier of a rule set resource associated with the ingress endpoint.
" + }, + "Status":{ + "shape":"IngressPointStatus", + "documentation":"The status of the ingress endpoint resource.
" + }, + "TrafficPolicyId":{ + "shape":"TrafficPolicyId", + "documentation":"The identifier of the traffic policy resource associated with the ingress endpoint.
" + }, + "Type":{ + "shape":"IngressPointType", + "documentation":"The type of ingress endpoint.
" + } + } + }, + "GetRelayRequest":{ + "type":"structure", + "required":["RelayId"], + "members":{ + "RelayId":{ + "shape":"RelayId", + "documentation":"A unique relay identifier.
" + } + } + }, + "GetRelayResponse":{ + "type":"structure", + "required":["RelayId"], + "members":{ + "Authentication":{ + "shape":"RelayAuthentication", + "documentation":"The authentication attribute—contains the secret ARN where the customer relay server credentials are stored.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the relay was created.
" + }, + "LastModifiedTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when relay was last updated.
" + }, + "RelayArn":{ + "shape":"RelayArn", + "documentation":"The Amazon Resource Name (ARN) of the relay.
" + }, + "RelayId":{ + "shape":"RelayId", + "documentation":"The unique relay identifier.
" + }, + "RelayName":{ + "shape":"RelayName", + "documentation":"The unique name of the relay.
" + }, + "ServerName":{ + "shape":"RelayServerName", + "documentation":"The destination relay server address.
" + }, + "ServerPort":{ + "shape":"RelayServerPort", + "documentation":"The destination relay server port.
" + } + } + }, + "GetRuleSetRequest":{ + "type":"structure", + "required":["RuleSetId"], + "members":{ + "RuleSetId":{ + "shape":"RuleSetId", + "documentation":"The identifier of an existing rule set to be retrieved.
" + } + } + }, + "GetRuleSetResponse":{ + "type":"structure", + "required":[ + "CreatedDate", + "LastModificationDate", + "RuleSetArn", + "RuleSetId", + "RuleSetName", + "Rules" + ], + "members":{ + "CreatedDate":{ + "shape":"Timestamp", + "documentation":"The date of when then rule set was created.
" + }, + "LastModificationDate":{ + "shape":"Timestamp", + "documentation":"The date of when the rule set was last modified.
" + }, + "RuleSetArn":{ + "shape":"RuleSetArn", + "documentation":"The Amazon Resource Name (ARN) of the rule set resource.
" + }, + "RuleSetId":{ + "shape":"RuleSetId", + "documentation":"The identifier of the rule set resource.
" + }, + "RuleSetName":{ + "shape":"RuleSetName", + "documentation":"A user-friendly name for the rule set resource.
" + }, + "Rules":{ + "shape":"Rules", + "documentation":"The rules contained in the rule set.
" + } + } + }, + "GetTrafficPolicyRequest":{ + "type":"structure", + "required":["TrafficPolicyId"], + "members":{ + "TrafficPolicyId":{ + "shape":"TrafficPolicyId", + "documentation":"The identifier of the traffic policy resource.
" + } + } + }, + "GetTrafficPolicyResponse":{ + "type":"structure", + "required":[ + "TrafficPolicyId", + "TrafficPolicyName" + ], + "members":{ + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the traffic policy was created.
" + }, + "DefaultAction":{ + "shape":"AcceptAction", + "documentation":"The default action of the traffic policy.
" + }, + "LastUpdatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the traffic policy was last updated.
" + }, + "MaxMessageSizeBytes":{ + "shape":"MaxMessageSizeBytes", + "documentation":"The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
" + }, + "PolicyStatements":{ + "shape":"PolicyStatementList", + "documentation":"The list of conditions which are in the traffic policy resource.
" + }, + "TrafficPolicyArn":{ + "shape":"TrafficPolicyArn", + "documentation":"The Amazon Resource Name (ARN) of the traffic policy resource.
" + }, + "TrafficPolicyId":{ + "shape":"TrafficPolicyId", + "documentation":"The identifier of the traffic policy resource.
" + }, + "TrafficPolicyName":{ + "shape":"TrafficPolicyName", + "documentation":"A user-friendly name for the traffic policy resource.
" + } + } + }, + "HeaderName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[xX]\\-[a-zA-Z0-9\\-]+$" + }, + "HeaderValue":{ + "type":"string", + "max":128, + "min":1 + }, + "IamRoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^[a-zA-Z0-9:_/+=,@.#-]+$" + }, + "IdOrArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^[a-zA-Z0-9:_/+=,@.#-]+$" + }, + "IdempotencyToken":{ + "type":"string", + "max":128, + "min":1 + }, + "IngressAnalysis":{ + "type":"structure", + "required":[ + "Analyzer", + "ResultField" + ], + "members":{ + "Analyzer":{ + "shape":"AnalyzerArn", + "documentation":"The Amazon Resource Name (ARN) of an Add On.
" + }, + "ResultField":{ + "shape":"ResultField", + "documentation":"The returned value from an Add On.
" + } + }, + "documentation":"The Add On ARN and its returned value that is evaluated in a policy statement's conditional expression to either deny or block the incoming email.
" + }, + "IngressBooleanExpression":{ + "type":"structure", + "required":[ + "Evaluate", + "Operator" + ], + "members":{ + "Evaluate":{ + "shape":"IngressBooleanToEvaluate", + "documentation":"The operand on which to perform a boolean condition operation.
" + }, + "Operator":{ + "shape":"IngressBooleanOperator", + "documentation":"The matching operator for a boolean condition expression.
" + } + }, + "documentation":"The structure for a boolean condition matching on the incoming mail.
" + }, + "IngressBooleanOperator":{ + "type":"string", + "enum":[ + "IS_TRUE", + "IS_FALSE" + ] + }, + "IngressBooleanToEvaluate":{ + "type":"structure", + "members":{ + "Analysis":{ + "shape":"IngressAnalysis", + "documentation":"The structure type for a boolean condition stating the Add On ARN and its returned value.
" + } + }, + "documentation":"The union type representing the allowed types of operands for a boolean condition.
", + "union":true + }, + "IngressIpOperator":{ + "type":"string", + "enum":[ + "CIDR_MATCHES", + "NOT_CIDR_MATCHES" + ] + }, + "IngressIpToEvaluate":{ + "type":"structure", + "members":{ + "Attribute":{ + "shape":"IngressIpv4Attribute", + "documentation":"An enum type representing the allowed attribute types for an IP condition.
" + } + }, + "documentation":"The structure for an IP based condition matching on the incoming mail.
", + "union":true + }, + "IngressIpv4Attribute":{ + "type":"string", + "enum":["SENDER_IP"] + }, + "IngressIpv4Expression":{ + "type":"structure", + "required":[ + "Evaluate", + "Operator", + "Values" + ], + "members":{ + "Evaluate":{ + "shape":"IngressIpToEvaluate", + "documentation":"The left hand side argument of an IP condition expression.
" + }, + "Operator":{ + "shape":"IngressIpOperator", + "documentation":"The matching operator for an IP condition expression.
" + }, + "Values":{ + "shape":"Ipv4Cidrs", + "documentation":"The right hand side argument of an IP condition expression.
" + } + }, + "documentation":"The union type representing the allowed types for the left hand side of an IP condition.
" + }, + "IngressPoint":{ + "type":"structure", + "required":[ + "IngressPointId", + "IngressPointName", + "Status", + "Type" + ], + "members":{ + "ARecord":{ + "shape":"IngressPointARecord", + "documentation":"The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.
" + }, + "IngressPointId":{ + "shape":"IngressPointId", + "documentation":"The identifier of the ingress endpoint resource.
" + }, + "IngressPointName":{ + "shape":"IngressPointName", + "documentation":"A user friendly name for the ingress endpoint resource.
" + }, + "Status":{ + "shape":"IngressPointStatus", + "documentation":"The status of the ingress endpoint resource.
" + }, + "Type":{ + "shape":"IngressPointType", + "documentation":"The type of ingress endpoint resource.
" + } + }, + "documentation":"The structure of an ingress endpoint resource.
" + }, + "IngressPointARecord":{"type":"string"}, + "IngressPointArn":{"type":"string"}, + "IngressPointAuthConfiguration":{ + "type":"structure", + "members":{ + "IngressPointPasswordConfiguration":{ + "shape":"IngressPointPasswordConfiguration", + "documentation":"The ingress endpoint password configuration for the ingress endpoint resource.
" + }, + "SecretArn":{ + "shape":"SecretArn", + "documentation":"The ingress endpoint SecretsManager::Secret ARN configuration for the ingress endpoint resource.
" + } + }, + "documentation":"The authentication configuration for the ingress endpoint resource.
" + }, + "IngressPointConfiguration":{ + "type":"structure", + "members":{ + "SecretArn":{ + "shape":"SecretArn", + "documentation":"The SecretsManager::Secret ARN of the ingress endpoint resource.
" + }, + "SmtpPassword":{ + "shape":"SmtpPassword", + "documentation":"The password of the ingress endpoint resource.
" + } + }, + "documentation":"The configuration of the ingress endpoint resource.
", + "union":true + }, + "IngressPointId":{ + "type":"string", + "max":100, + "min":1 + }, + "IngressPointName":{ + "type":"string", + "max":63, + "min":3, + "pattern":"^[A-Za-z0-9_\\-]+$" + }, + "IngressPointPasswordConfiguration":{ + "type":"structure", + "members":{ + "PreviousSmtpPasswordExpiryTimestamp":{ + "shape":"Timestamp", + "documentation":"The previous password expiry timestamp of the ingress endpoint resource.
" + }, + "PreviousSmtpPasswordVersion":{ + "shape":"String", + "documentation":"The previous password version of the ingress endpoint resource.
" + }, + "SmtpPasswordVersion":{ + "shape":"String", + "documentation":"The current password expiry timestamp of the ingress endpoint resource.
" + } + }, + "documentation":"The password configuration of the ingress endpoint resource.
" + }, + "IngressPointStatus":{ + "type":"string", + "enum":[ + "PROVISIONING", + "DEPROVISIONING", + "UPDATING", + "ACTIVE", + "CLOSED", + "FAILED" + ] + }, + "IngressPointStatusToUpdate":{ + "type":"string", + "enum":[ + "ACTIVE", + "CLOSED" + ] + }, + "IngressPointType":{ + "type":"string", + "enum":[ + "OPEN", + "AUTH" + ] + }, + "IngressPointsList":{ + "type":"list", + "member":{"shape":"IngressPoint"} + }, + "IngressStringEmailAttribute":{ + "type":"string", + "enum":["RECIPIENT"] + }, + "IngressStringExpression":{ + "type":"structure", + "required":[ + "Evaluate", + "Operator", + "Values" + ], + "members":{ + "Evaluate":{ + "shape":"IngressStringToEvaluate", + "documentation":"The left hand side argument of a string condition expression.
" + }, + "Operator":{ + "shape":"IngressStringOperator", + "documentation":"The matching operator for a string condition expression.
" + }, + "Values":{ + "shape":"StringList", + "documentation":"The right hand side argument of a string condition expression.
" + } + }, + "documentation":"The structure for a string based condition matching on the incoming mail.
" + }, + "IngressStringOperator":{ + "type":"string", + "enum":[ + "EQUALS", + "NOT_EQUALS", + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS" + ] + }, + "IngressStringToEvaluate":{ + "type":"structure", + "members":{ + "Attribute":{ + "shape":"IngressStringEmailAttribute", + "documentation":"The enum type representing the allowed attribute types for a string condition.
" + } + }, + "documentation":"The union type representing the allowed types for the left hand side of a string condition.
", + "union":true + }, + "IngressTlsAttribute":{ + "type":"string", + "enum":["TLS_PROTOCOL"] + }, + "IngressTlsProtocolAttribute":{ + "type":"string", + "enum":[ + "TLS1_2", + "TLS1_3" + ] + }, + "IngressTlsProtocolExpression":{ + "type":"structure", + "required":[ + "Evaluate", + "Operator", + "Value" + ], + "members":{ + "Evaluate":{ + "shape":"IngressTlsProtocolToEvaluate", + "documentation":"The left hand side argument of a TLS condition expression.
" + }, + "Operator":{ + "shape":"IngressTlsProtocolOperator", + "documentation":"The matching operator for a TLS condition expression.
" + }, + "Value":{ + "shape":"IngressTlsProtocolAttribute", + "documentation":"The right hand side argument of a TLS condition expression.
" + } + }, + "documentation":"The structure for a TLS related condition matching on the incoming mail.
" + }, + "IngressTlsProtocolOperator":{ + "type":"string", + "enum":[ + "MINIMUM_TLS_VERSION", + "IS" + ] + }, + "IngressTlsProtocolToEvaluate":{ + "type":"structure", + "members":{ + "Attribute":{ + "shape":"IngressTlsAttribute", + "documentation":"The enum type representing the allowed attribute types for the TLS condition.
" + } + }, + "documentation":"The union type representing the allowed types for the left hand side of a TLS condition.
", + "union":true + }, + "Integer":{ + "type":"integer", + "box":true + }, + "Ipv4Cidr":{ + "type":"string", + "pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/([0-9]|[12][0-9]|3[0-2])$" + }, + "Ipv4Cidrs":{ + "type":"list", + "member":{"shape":"Ipv4Cidr"} + }, + "KmsKeyArn":{ + "type":"string", + "pattern":"^arn:aws(|-cn|-us-gov):kms:[a-z0-9-]{1,20}:[0-9]{12}:(key|alias)/.+$" + }, + "KmsKeyId":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^[a-zA-Z0-9-:/]+$" + }, + "ListAddonInstancesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.
" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.
" + } + } + }, + "ListAddonInstancesResponse":{ + "type":"structure", + "members":{ + "AddonInstances":{ + "shape":"AddonInstances", + "documentation":"The list of ingress endpoints.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" + } + } + }, + "ListAddonSubscriptionsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.
" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.
" + } + } + }, + "ListAddonSubscriptionsResponse":{ + "type":"structure", + "members":{ + "AddonSubscriptions":{ + "shape":"AddonSubscriptions", + "documentation":"The list of ingress endpoints.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" + } + } + }, + "ListArchiveExportsRequest":{ + "type":"structure", + "required":["ArchiveId"], + "members":{ + "ArchiveId":{ + "shape":"ArchiveId", + "documentation":"The identifier of the archive.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"The maximum number of archive export jobs that are returned per call. You can use NextToken to obtain further pages of archives.
" + } + }, + "documentation":"The request to list archive export jobs in your account.
" + }, + "ListArchiveExportsResponse":{ + "type":"structure", + "members":{ + "Exports":{ + "shape":"ExportSummaryList", + "documentation":"The list of export job identifiers and statuses.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If present, use to retrieve the next page of results.
" + } + }, + "documentation":"The response containing a list of archive export jobs and their statuses.
" + }, + "ListArchiveSearchesRequest":{ + "type":"structure", + "required":["ArchiveId"], + "members":{ + "ArchiveId":{ + "shape":"ArchiveId", + "documentation":"The identifier of the archive.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives.
" + } + }, + "documentation":"The request to list archive search jobs in your account.
" + }, + "ListArchiveSearchesResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If present, use to retrieve the next page of results.
" + }, + "Searches":{ + "shape":"SearchSummaryList", + "documentation":"The list of search job identifiers and statuses.
" + } + }, + "documentation":"The response containing a list of archive search jobs and their statuses.
" + }, + "ListArchivesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives.
" + } + }, + "documentation":"The request to list email archives in your account.
" + }, + "ListArchivesResponse":{ + "type":"structure", + "required":["Archives"], + "members":{ + "Archives":{ + "shape":"ArchivesList", + "documentation":"The list of archive details.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If present, use to retrieve the next page of results.
" + } + }, + "documentation":"The response containing a list of your email archives.
" + }, + "ListIngressPointsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.
" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.
" + } + } + }, + "ListIngressPointsResponse":{ + "type":"structure", + "members":{ + "IngressPoints":{ + "shape":"IngressPointsList", + "documentation":"The list of ingress endpoints.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" + } + } + }, + "ListRelaysRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.
" + }, + "PageSize":{ + "shape":"Integer", + "documentation":"The number of relays to be returned in one request.
" + } + } + }, + "ListRelaysResponse":{ + "type":"structure", + "required":["Relays"], + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" + }, + "Relays":{ + "shape":"Relays", + "documentation":"The list of returned relays.
" + } + } + }, + "ListRuleSetsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.
" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"The maximum number of rule set resources that are returned per call. You can use NextToken to obtain further rule sets.
" + } + } + }, + "ListRuleSetsResponse":{ + "type":"structure", + "required":["RuleSets"], + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" + }, + "RuleSets":{ + "shape":"RuleSets", + "documentation":"The list of rule sets.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"TaggableResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the resource to retrieve tags from.
" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + } + } + }, + "ListTrafficPoliciesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.
" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.
" + } + } + }, + "ListTrafficPoliciesResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" + }, + "TrafficPolicies":{ + "shape":"TrafficPolicyList", + "documentation":"The list of traffic policies.
" + } + } + }, + "MailFrom":{ + "type":"string", + "enum":[ + "REPLACE", + "PRESERVE" + ] + }, + "MaxMessageSizeBytes":{ + "type":"integer", + "box":true, + "min":1 + }, + "MessageBody":{ + "type":"structure", + "members":{ + "Html":{ + "shape":"String", + "documentation":"The HTML body content of the message.
" + }, + "MessageMalformed":{ + "shape":"Boolean", + "documentation":"A flag indicating if the email was malformed.
" + }, + "Text":{ + "shape":"String", + "documentation":"The plain text body content of the message.
" + } + }, + "documentation":"The textual body content of an email message.
" + }, + "MimeHeaderAttribute":{ + "type":"string", + "pattern":"^X-[a-zA-Z0-9-]{1,256}$" + }, + "NameOrArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^[a-zA-Z0-9:_/+=,@.#-]+$" + }, + "NoAuthentication":{ + "type":"structure", + "members":{ + }, + "documentation":"Explicitly indicate that the relay destination server does not require SMTP credential authentication.
" + }, + "PageSize":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "PaginationToken":{ + "type":"string", + "max":2048, + "min":1 + }, + "PolicyCondition":{ + "type":"structure", + "members":{ + "BooleanExpression":{ + "shape":"IngressBooleanExpression", + "documentation":"This represents a boolean type condition matching on the incoming mail. It performs the boolean operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.
" + }, + "IpExpression":{ + "shape":"IngressIpv4Expression", + "documentation":"This represents an IP based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.
" + }, + "StringExpression":{ + "shape":"IngressStringExpression", + "documentation":"This represents a string based condition matching on the incoming mail. It performs the string operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.
" + }, + "TlsExpression":{ + "shape":"IngressTlsProtocolExpression", + "documentation":"This represents a TLS based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.
" + } + }, + "documentation":"The email traffic filtering conditions which are contained in a traffic policy resource.
", + "union":true + }, + "PolicyConditions":{ + "type":"list", + "member":{"shape":"PolicyCondition"}, + "min":1 + }, + "PolicyStatement":{ + "type":"structure", + "required":[ + "Action", + "Conditions" + ], + "members":{ + "Action":{ + "shape":"AcceptAction", + "documentation":"The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.
" + }, + "Conditions":{ + "shape":"PolicyConditions", + "documentation":"The list of conditions to apply to incoming messages for filtering email traffic.
" + } + }, + "documentation":"The structure containing traffic policy conditions and actions.
" + }, + "PolicyStatementList":{ + "type":"list", + "member":{"shape":"PolicyStatement"} + }, + "Recipients":{ + "type":"list", + "member":{"shape":"EmailAddress"}, + "max":100, + "min":1 + }, + "Relay":{ + "type":"structure", + "members":{ + "LastModifiedTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the relay was last modified.
" + }, + "RelayId":{ + "shape":"RelayId", + "documentation":"The unique relay identifier.
" + }, + "RelayName":{ + "shape":"RelayName", + "documentation":"The unique relay name.
" + } + }, + "documentation":"The relay resource that can be used as a rule to relay receiving emails to the destination relay server.
" + }, + "RelayAction":{ + "type":"structure", + "required":["Relay"], + "members":{ + "ActionFailurePolicy":{ + "shape":"ActionFailurePolicy", + "documentation":"A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified relay has been deleted.
" + }, + "MailFrom":{ + "shape":"MailFrom", + "documentation":"This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server.
" + }, + "Relay":{ + "shape":"IdOrArn", + "documentation":"The identifier of the relay resource to be used when relaying an email.
" + } + }, + "documentation":"The action relays the email via SMTP to another specific SMTP server.
" + }, + "RelayArn":{"type":"string"}, + "RelayAuthentication":{ + "type":"structure", + "members":{ + "NoAuthentication":{ + "shape":"NoAuthentication", + "documentation":"Keep an empty structure if the relay destination server does not require SMTP credential authentication.
" + }, + "SecretArn":{ + "shape":"SecretArn", + "documentation":"The ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored.
" + } + }, + "documentation":"Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored, or specify an empty NoAuthentication structure if the relay destination server does not require SMTP credential authentication.
", + "union":true + }, + "RelayId":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[a-zA-Z0-9-]+$" + }, + "RelayName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[a-zA-Z0-9-_]+$" + }, + "RelayServerName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[a-zA-Z0-9-\\.]+$" + }, + "RelayServerPort":{ + "type":"integer", + "box":true, + "max":65535, + "min":1 + }, + "Relays":{ + "type":"list", + "member":{"shape":"Relay"} + }, + "ReplaceRecipientAction":{ + "type":"structure", + "members":{ + "ReplaceWith":{ + "shape":"Recipients", + "documentation":"This action specifies the replacement recipient email addresses to insert.
" + } + }, + "documentation":"This action replaces the email envelope recipients with the given list of recipients. If the condition of this action applies only to a subset of recipients, only those recipients are replaced with the recipients specified in the action. The message contents and headers are unaffected by this action, only the envelope recipients are updated.
" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"Occurs when a requested resource is not found.
", + "exception":true + }, + "ResultField":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[\\sa-zA-Z0-9_]+$" + }, + "RetentionPeriod":{ + "type":"string", + "enum":[ + "THREE_MONTHS", + "SIX_MONTHS", + "NINE_MONTHS", + "ONE_YEAR", + "EIGHTEEN_MONTHS", + "TWO_YEARS", + "THIRTY_MONTHS", + "THREE_YEARS", + "FOUR_YEARS", + "FIVE_YEARS", + "SIX_YEARS", + "SEVEN_YEARS", + "EIGHT_YEARS", + "NINE_YEARS", + "TEN_YEARS", + "PERMANENT" + ] + }, + "Row":{ + "type":"structure", + "members":{ + "ArchivedMessageId":{ + "shape":"ArchivedMessageId", + "documentation":"The unique identifier of the archived message.
" + }, + "Cc":{ + "shape":"String", + "documentation":"The email addresses in the CC header.
" + }, + "Date":{ + "shape":"String", + "documentation":"The date the email was sent.
" + }, + "From":{ + "shape":"String", + "documentation":"The email address of the sender.
" + }, + "HasAttachments":{ + "shape":"Boolean", + "documentation":"A flag indicating if the email has attachments.
" + }, + "InReplyTo":{ + "shape":"String", + "documentation":"The email message ID this is a reply to.
" + }, + "MessageId":{ + "shape":"String", + "documentation":"The unique message ID of the email.
" + }, + "ReceivedHeaders":{ + "shape":"EmailReceivedHeadersList", + "documentation":"The received headers from the email delivery path.
" + }, + "ReceivedTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the email was received.
" + }, + "Subject":{ + "shape":"String", + "documentation":"The subject header value of the email.
" + }, + "To":{ + "shape":"String", + "documentation":"The email addresses in the To header.
" + }, + "XMailer":{ + "shape":"String", + "documentation":"The user agent that sent the email.
" + }, + "XOriginalMailer":{ + "shape":"String", + "documentation":"The original user agent that sent the email.
" + }, + "XPriority":{ + "shape":"String", + "documentation":"The priority level of the email.
" + } + }, + "documentation":"A result row containing metadata for an archived email message.
" + }, + "RowsList":{ + "type":"list", + "member":{"shape":"Row"} + }, + "Rule":{ + "type":"structure", + "required":["Actions"], + "members":{ + "Actions":{ + "shape":"RuleActions", + "documentation":"The list of actions to execute when the conditions match the incoming email, and none of the \"unless conditions\" match.
" + }, + "Conditions":{ + "shape":"RuleConditions", + "documentation":"The conditions of this rule. All conditions must match the email for the actions to be executed. An empty list of conditions means that all emails match, but are still subject to any \"unless conditions\"
" + }, + "Name":{ + "shape":"RuleName", + "documentation":"The user-friendly name of the rule.
" + }, + "Unless":{ + "shape":"RuleConditions", + "documentation":"The \"unless conditions\" of this rule. None of the conditions can match the email for the actions to be executed. If any of these conditions do match the email, then the actions are not executed.
" + } + }, + "documentation":"A rule contains conditions, \"unless conditions\" and actions. For each envelope recipient of an email, if all conditions match and none of the \"unless conditions\" match, then all of the actions are executed sequentially. If no conditions are provided, the rule always applies and the actions are implicitly executed. If only \"unless conditions\" are provided, the rule applies if the email does not match the evaluation of the \"unless conditions\".
" + }, + "RuleAction":{ + "type":"structure", + "members":{ + "AddHeader":{ + "shape":"AddHeaderAction", + "documentation":"This action adds a header. This can be used to add arbitrary email headers.
" + }, + "Archive":{ + "shape":"ArchiveAction", + "documentation":"This action archives the email. This can be used to deliver an email to an archive.
" + }, + "DeliverToMailbox":{ + "shape":"DeliverToMailboxAction", + "documentation":"This action delivers an email to a WorkMail mailbox.
" + }, + "Drop":{ + "shape":"DropAction", + "documentation":"This action terminates the evaluation of rules in the rule set.
" + }, + "Relay":{ + "shape":"RelayAction", + "documentation":"This action relays the email to another SMTP server.
" + }, + "ReplaceRecipient":{ + "shape":"ReplaceRecipientAction", + "documentation":"The action replaces certain or all recipients with a different set of recipients.
" + }, + "Send":{ + "shape":"SendAction", + "documentation":"This action sends the email to the internet.
" + }, + "WriteToS3":{ + "shape":"S3Action", + "documentation":"This action writes the MIME content of the email to an S3 bucket.
" + } + }, + "documentation":"The action for a rule to take. Only one of the contained actions can be set.
", + "union":true + }, + "RuleActions":{ + "type":"list", + "member":{"shape":"RuleAction"}, + "max":10, + "min":1 + }, + "RuleBooleanEmailAttribute":{ + "type":"string", + "enum":[ + "READ_RECEIPT_REQUESTED", + "TLS", + "TLS_WRAPPED" + ] + }, + "RuleBooleanExpression":{ + "type":"structure", + "required":[ + "Evaluate", + "Operator" + ], + "members":{ + "Evaluate":{ + "shape":"RuleBooleanToEvaluate", + "documentation":"The operand on which to perform a boolean condition operation.
" + }, + "Operator":{ + "shape":"RuleBooleanOperator", + "documentation":"The matching operator for a boolean condition expression.
" + } + }, + "documentation":"A boolean expression to be used in a rule condition.
" + }, + "RuleBooleanOperator":{ + "type":"string", + "enum":[ + "IS_TRUE", + "IS_FALSE" + ] + }, + "RuleBooleanToEvaluate":{ + "type":"structure", + "members":{ + "Attribute":{ + "shape":"RuleBooleanEmailAttribute", + "documentation":"The boolean type representing the allowed attribute types for an email.
" + } + }, + "documentation":"The union type representing the allowed types of operands for a boolean condition.
", + "union":true + }, + "RuleCondition":{ + "type":"structure", + "members":{ + "BooleanExpression":{ + "shape":"RuleBooleanExpression", + "documentation":"The condition applies to a boolean expression passed in this field.
" + }, + "DmarcExpression":{ + "shape":"RuleDmarcExpression", + "documentation":"The condition applies to a DMARC policy expression passed in this field.
" + }, + "IpExpression":{ + "shape":"RuleIpExpression", + "documentation":"The condition applies to an IP address expression passed in this field.
" + }, + "NumberExpression":{ + "shape":"RuleNumberExpression", + "documentation":"The condition applies to a number expression passed in this field.
" + }, + "StringExpression":{ + "shape":"RuleStringExpression", + "documentation":"The condition applies to a string expression passed in this field.
" + }, + "VerdictExpression":{ + "shape":"RuleVerdictExpression", + "documentation":"The condition applies to a verdict expression passed in this field.
" + } + }, + "documentation":"The conditional expression used to evaluate an email for determining if a rule action should be taken.
", + "union":true + }, + "RuleConditions":{ + "type":"list", + "member":{"shape":"RuleCondition"}, + "max":10, + "min":0 + }, + "RuleDmarcExpression":{ + "type":"structure", + "required":[ + "Operator", + "Values" + ], + "members":{ + "Operator":{ + "shape":"RuleDmarcOperator", + "documentation":"The operator to apply to the DMARC policy of the incoming email.
" + }, + "Values":{ + "shape":"RuleDmarcValueList", + "documentation":"The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match.
" + } + }, + "documentation":"A DMARC policy expression. The condition matches if the given DMARC policy matches that of the incoming email.
" + }, + "RuleDmarcOperator":{ + "type":"string", + "enum":[ + "EQUALS", + "NOT_EQUALS" + ] + }, + "RuleDmarcPolicy":{ + "type":"string", + "enum":[ + "NONE", + "QUARANTINE", + "REJECT" + ] + }, + "RuleDmarcValueList":{ + "type":"list", + "member":{"shape":"RuleDmarcPolicy"}, + "max":10, + "min":1 + }, + "RuleIpEmailAttribute":{ + "type":"string", + "enum":["SOURCE_IP"] + }, + "RuleIpExpression":{ + "type":"structure", + "required":[ + "Evaluate", + "Operator", + "Values" + ], + "members":{ + "Evaluate":{ + "shape":"RuleIpToEvaluate", + "documentation":"The IP address to evaluate in this condition.
" + }, + "Operator":{ + "shape":"RuleIpOperator", + "documentation":"The operator to evaluate the IP address.
" + }, + "Values":{ + "shape":"RuleIpValueList", + "documentation":"The IP CIDR blocks in format \"x.y.z.w/n\" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges.
" + } + }, + "documentation":"An IP address expression matching certain IP addresses within a given range of IP addresses.
" + }, + "RuleIpOperator":{ + "type":"string", + "enum":[ + "CIDR_MATCHES", + "NOT_CIDR_MATCHES" + ] + }, + "RuleIpStringValue":{ + "type":"string", + "max":18, + "min":1, + "pattern":"^(([0-9]|.|/)*)$" + }, + "RuleIpToEvaluate":{ + "type":"structure", + "members":{ + "Attribute":{ + "shape":"RuleIpEmailAttribute", + "documentation":"The attribute of the email to evaluate.
" + } + }, + "documentation":"The IP address to evaluate for this condition.
", + "union":true + }, + "RuleIpValueList":{ + "type":"list", + "member":{"shape":"RuleIpStringValue"}, + "max":10, + "min":1 + }, + "RuleName":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^[a-zA-Z0-9_.-]+$" + }, + "RuleNumberEmailAttribute":{ + "type":"string", + "enum":["MESSAGE_SIZE"] + }, + "RuleNumberExpression":{ + "type":"structure", + "required":[ + "Evaluate", + "Operator", + "Value" + ], + "members":{ + "Evaluate":{ + "shape":"RuleNumberToEvaluate", + "documentation":"The number to evaluate in a numeric condition expression.
" + }, + "Operator":{ + "shape":"RuleNumberOperator", + "documentation":"The operator for a numeric condition expression.
" + }, + "Value":{ + "shape":"Double", + "documentation":"The value to evaluate in a numeric condition expression.
" + } + }, + "documentation":"A number expression to match numeric conditions with integers from the incoming email.
" + }, + "RuleNumberOperator":{ + "type":"string", + "enum":[ + "EQUALS", + "NOT_EQUALS", + "LESS_THAN", + "GREATER_THAN", + "LESS_THAN_OR_EQUAL", + "GREATER_THAN_OR_EQUAL" + ] + }, + "RuleNumberToEvaluate":{ + "type":"structure", + "members":{ + "Attribute":{ + "shape":"RuleNumberEmailAttribute", + "documentation":"An email attribute that is used as the number to evaluate.
" + } + }, + "documentation":"The number to evaluate in a numeric condition expression.
", + "union":true + }, + "RuleSet":{ + "type":"structure", + "members":{ + "LastModificationDate":{ + "shape":"Timestamp", + "documentation":"The last modification date of the rule set.
" + }, + "RuleSetId":{ + "shape":"RuleSetId", + "documentation":"The identifier of the rule set.
" + }, + "RuleSetName":{ + "shape":"RuleSetName", + "documentation":"A user-friendly name for the rule set.
" + } + }, + "documentation":"A rule set contains a list of rules that are evaluated in order. Each rule is evaluated sequentially for each email.
" + }, + "RuleSetArn":{"type":"string"}, + "RuleSetId":{ + "type":"string", + "max":100, + "min":1 + }, + "RuleSetName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[a-zA-Z0-9_.-]+$" + }, + "RuleSets":{ + "type":"list", + "member":{"shape":"RuleSet"} + }, + "RuleStringEmailAttribute":{ + "type":"string", + "enum":[ + "MAIL_FROM", + "HELO", + "RECIPIENT", + "SENDER", + "FROM", + "SUBJECT", + "TO", + "CC" + ] + }, + "RuleStringExpression":{ + "type":"structure", + "required":[ + "Evaluate", + "Operator", + "Values" + ], + "members":{ + "Evaluate":{ + "shape":"RuleStringToEvaluate", + "documentation":"The string to evaluate in a string condition expression.
" + }, + "Operator":{ + "shape":"RuleStringOperator", + "documentation":"The matching operator for a string condition expression.
" + }, + "Values":{ + "shape":"RuleStringList", + "documentation":"The string(s) to be evaluated in a string condition expression. For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email's string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email's string.
" + } + }, + "documentation":"A string expression is evaluated against strings or substrings of the email.
" + }, + "RuleStringList":{ + "type":"list", + "member":{"shape":"RuleStringValue"}, + "max":10, + "min":1 + }, + "RuleStringOperator":{ + "type":"string", + "enum":[ + "EQUALS", + "NOT_EQUALS", + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS" + ] + }, + "RuleStringToEvaluate":{ + "type":"structure", + "members":{ + "Attribute":{ + "shape":"RuleStringEmailAttribute", + "documentation":"The email attribute to evaluate in a string condition expression.
" + }, + "MimeHeaderAttribute":{ + "shape":"MimeHeaderAttribute", + "documentation":"The email MIME X-Header attribute to evaluate in a string condition expression.
" + } + }, + "documentation":"The string to evaluate in a string condition expression.
", + "union":true + }, + "RuleStringValue":{ + "type":"string", + "max":4096, + "min":1 + }, + "RuleVerdict":{ + "type":"string", + "enum":[ + "PASS", + "FAIL", + "GRAY", + "PROCESSING_FAILED" + ] + }, + "RuleVerdictAttribute":{ + "type":"string", + "enum":[ + "SPF", + "DKIM" + ] + }, + "RuleVerdictExpression":{ + "type":"structure", + "required":[ + "Evaluate", + "Operator", + "Values" + ], + "members":{ + "Evaluate":{ + "shape":"RuleVerdictToEvaluate", + "documentation":"The verdict to evaluate in a verdict condition expression.
" + }, + "Operator":{ + "shape":"RuleVerdictOperator", + "documentation":"The matching operator for a verdict condition expression.
" + }, + "Values":{ + "shape":"RuleVerdictValueList", + "documentation":"The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email.
" + } + }, + "documentation":"A verdict expression is evaluated against verdicts of the email.
" + }, + "RuleVerdictOperator":{ + "type":"string", + "enum":[ + "EQUALS", + "NOT_EQUALS" + ] + }, + "RuleVerdictToEvaluate":{ + "type":"structure", + "members":{ + "Analysis":{ + "shape":"Analysis", + "documentation":"The Add On ARN and its returned value to evaluate in a verdict condition expression.
" + }, + "Attribute":{ + "shape":"RuleVerdictAttribute", + "documentation":"The email verdict attribute to evaluate in a string verdict expression.
" + } + }, + "documentation":"The verdict to evaluate in a verdict condition expression.
", + "union":true + }, + "RuleVerdictValueList":{ + "type":"list", + "member":{"shape":"RuleVerdict"}, + "max":10, + "min":1 + }, + "Rules":{ + "type":"list", + "member":{"shape":"Rule"}, + "max":40, + "min":0 + }, + "S3Action":{ + "type":"structure", + "required":[ + "RoleArn", + "S3Bucket" + ], + "members":{ + "ActionFailurePolicy":{ + "shape":"ActionFailurePolicy", + "documentation":"A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.
" + }, + "RoleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.
" + }, + "S3Bucket":{ + "shape":"S3Bucket", + "documentation":"The bucket name of the S3 bucket to write to.
" + }, + "S3Prefix":{ + "shape":"S3Prefix", + "documentation":"The S3 prefix to use for the write to the s3 bucket.
" + }, + "S3SseKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"The KMS Key ID to use to encrypt the message in S3.
" + } + }, + "documentation":"Writes the MIME content of the email to an S3 bucket.
" + }, + "S3Bucket":{ + "type":"string", + "max":62, + "min":1, + "pattern":"^[a-zA-Z0-9.-]+$" + }, + "S3ExportDestinationConfiguration":{ + "type":"structure", + "members":{ + "S3Location":{ + "shape":"S3Location", + "documentation":"The S3 location to deliver the exported email data.
" + } + }, + "documentation":"The configuration for exporting email data to an Amazon S3 bucket.
" + }, + "S3Location":{ + "type":"string", + "pattern":"^s3://[a-zA-Z0-9.-]{3,63}(/[a-zA-Z0-9!_.*'()/-]*)*$" + }, + "S3Prefix":{ + "type":"string", + "max":62, + "min":1, + "pattern":"^[a-zA-Z0-9!_.*'()/-]+$" + }, + "S3PresignedURL":{"type":"string"}, + "SearchId":{ + "type":"string", + "max":64, + "min":1 + }, + "SearchMaxResults":{ + "type":"integer", + "box":true, + "max":1000, + "min":0 + }, + "SearchState":{ + "type":"string", + "enum":[ + "QUEUED", + "RUNNING", + "COMPLETED", + "FAILED", + "CANCELLED" + ] + }, + "SearchStatus":{ + "type":"structure", + "members":{ + "CompletionTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the search completed (if finished).
" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"An error message if the search failed.
" + }, + "State":{ + "shape":"SearchState", + "documentation":"The current state of the search job.
" + }, + "SubmissionTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the search was submitted.
" + } + }, + "documentation":"The current status of an archive search job.
" + }, + "SearchSummary":{ + "type":"structure", + "members":{ + "SearchId":{ + "shape":"SearchId", + "documentation":"The unique identifier of the search job.
" + }, + "Status":{ + "shape":"SearchStatus", + "documentation":"The current status of the search job.
" + } + }, + "documentation":"Summary details of an archive search job.
" + }, + "SearchSummaryList":{ + "type":"list", + "member":{"shape":"SearchSummary"} + }, + "SecretArn":{ + "type":"string", + "pattern":"^arn:(aws|aws-cn|aws-us-gov):secretsmanager:[a-z0-9-]+:\\d{12}:secret:[a-zA-Z0-9/_+=,.@-]+$" + }, + "SendAction":{ + "type":"structure", + "required":["RoleArn"], + "members":{ + "ActionFailurePolicy":{ + "shape":"ActionFailurePolicy", + "documentation":"A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the sendRawEmail API.
" + }, + "RoleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the ses:SendRawEmail API.
" + } + }, + "documentation":"Sends the email to the internet using the ses:SendRawEmail API.
" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"Occurs when an operation exceeds a predefined service quota or limit.
", + "exception":true + }, + "SmtpPassword":{ + "type":"string", + "max":64, + "min":8, + "pattern":"^[A-Za-z0-9!@#$%^&*()_+\\-=\\[\\]{}|.,?]+$", + "sensitive":true + }, + "StartArchiveExportRequest":{ + "type":"structure", + "required":[ + "ArchiveId", + "ExportDestinationConfiguration", + "FromTimestamp", + "ToTimestamp" + ], + "members":{ + "ArchiveId":{ + "shape":"ArchiveId", + "documentation":"The identifier of the archive to export emails from.
" + }, + "ExportDestinationConfiguration":{ + "shape":"ExportDestinationConfiguration", + "documentation":"Details on where to deliver the exported email data.
" + }, + "Filters":{ + "shape":"ArchiveFilters", + "documentation":"Criteria to filter which emails are included in the export.
" + }, + "FromTimestamp":{ + "shape":"Timestamp", + "documentation":"The start of the timestamp range to include emails from.
" + }, + "MaxResults":{ + "shape":"ExportMaxResults", + "documentation":"The maximum number of email items to include in the export.
" + }, + "ToTimestamp":{ + "shape":"Timestamp", + "documentation":"The end of the timestamp range to include emails from.
" + } + }, + "documentation":"The request to initiate an export of emails from an archive.
" + }, + "StartArchiveExportResponse":{ + "type":"structure", + "members":{ + "ExportId":{ + "shape":"ExportId", + "documentation":"The unique identifier for the initiated export job.
" + } + }, + "documentation":"The response from initiating an archive export.
" + }, + "StartArchiveSearchRequest":{ + "type":"structure", + "required":[ + "ArchiveId", + "FromTimestamp", + "MaxResults", + "ToTimestamp" + ], + "members":{ + "ArchiveId":{ + "shape":"ArchiveId", + "documentation":"The identifier of the archive to search emails in.
" + }, + "Filters":{ + "shape":"ArchiveFilters", + "documentation":"Criteria to filter which emails are included in the search results.
" + }, + "FromTimestamp":{ + "shape":"Timestamp", + "documentation":"The start timestamp of the range to search emails from.
" + }, + "MaxResults":{ + "shape":"SearchMaxResults", + "documentation":"The maximum number of search results to return.
" + }, + "ToTimestamp":{ + "shape":"Timestamp", + "documentation":"The end timestamp of the range to search emails from.
" + } + }, + "documentation":"The request to initiate a search across emails in an archive.
" + }, + "StartArchiveSearchResponse":{ + "type":"structure", + "members":{ + "SearchId":{ + "shape":"SearchId", + "documentation":"The unique identifier for the initiated search job.
" + } + }, + "documentation":"The response from initiating an archive search.
" + }, + "StopArchiveExportRequest":{ + "type":"structure", + "required":["ExportId"], + "members":{ + "ExportId":{ + "shape":"ExportId", + "documentation":"The identifier of the export job to stop.
" + } + }, + "documentation":"The request to stop an in-progress archive export job.
" + }, + "StopArchiveExportResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"The response indicating if the request to stop the export job succeeded.
On success, returns an HTTP 200 status code. On failure, returns an error message.
" + }, + "StopArchiveSearchRequest":{ + "type":"structure", + "required":["SearchId"], + "members":{ + "SearchId":{ + "shape":"SearchId", + "documentation":"The identifier of the search job to stop.
" + } + }, + "documentation":"The request to stop an in-progress archive search job.
" + }, + "StopArchiveSearchResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"The response indicating if the request to stop the search job succeeded.
On success, returns an HTTP 200 status code. On failure, returns an error message.
" + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "StringValue":{ + "type":"string", + "max":2048, + "min":1 + }, + "StringValueList":{ + "type":"list", + "member":{"shape":"StringValue"}, + "max":10, + "min":1 + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"The key of the key-value tag.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The value of the key-value tag.
" + } + }, + "documentation":"A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", + "sensitive":true + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"TaggableResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the resource that you want to tag.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", + "sensitive":true + }, + "TaggableResourceArn":{ + "type":"string", + "max":1011, + "min":20, + "pattern":"^arn:aws(|-cn|-us-gov):ses:[a-z0-9-]{1,20}:[0-9]{12}:(mailmanager-|addon-).+$" + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
", + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "TrafficPolicy":{ + "type":"structure", + "required":[ + "DefaultAction", + "TrafficPolicyId", + "TrafficPolicyName" + ], + "members":{ + "DefaultAction":{ + "shape":"AcceptAction", + "documentation":"Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements
" + }, + "TrafficPolicyId":{ + "shape":"TrafficPolicyId", + "documentation":"The identifier of the traffic policy resource.
" + }, + "TrafficPolicyName":{ + "shape":"TrafficPolicyName", + "documentation":"A user-friendly name of the traffic policy resource.
" + } + }, + "documentation":"The structure of a traffic policy resource which is a container for policy statements.
" + }, + "TrafficPolicyArn":{"type":"string"}, + "TrafficPolicyId":{ + "type":"string", + "max":100, + "min":1 + }, + "TrafficPolicyList":{ + "type":"list", + "member":{"shape":"TrafficPolicy"} + }, + "TrafficPolicyName":{ + "type":"string", + "max":63, + "min":3, + "pattern":"^[A-Za-z0-9_\\-]+$" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"TaggableResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the resource that you want to untag.
" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.
" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateArchiveRequest":{ + "type":"structure", + "required":["ArchiveId"], + "members":{ + "ArchiveId":{ + "shape":"ArchiveIdString", + "documentation":"The identifier of the archive to update.
" + }, + "ArchiveName":{ + "shape":"ArchiveNameString", + "documentation":"A new, unique name for the archive.
" + }, + "Retention":{ + "shape":"ArchiveRetention", + "documentation":"A new retention period for emails in the archive.
" + } + }, + "documentation":"The request to update properties of an existing email archive.
" + }, + "UpdateArchiveResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"The response indicating if the archive update succeeded or failed.
On success, returns an HTTP 200 status code. On failure, returns an error message.
" + }, + "UpdateIngressPointRequest":{ + "type":"structure", + "required":["IngressPointId"], + "members":{ + "IngressPointConfiguration":{ + "shape":"IngressPointConfiguration", + "documentation":"If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
" + }, + "IngressPointId":{ + "shape":"IngressPointId", + "documentation":"The identifier for the ingress endpoint you want to update.
" + }, + "IngressPointName":{ + "shape":"IngressPointName", + "documentation":"A user friendly name for the ingress endpoint resource.
" + }, + "RuleSetId":{ + "shape":"RuleSetId", + "documentation":"The identifier of an existing rule set that you attach to an ingress endpoint resource.
" + }, + "StatusToUpdate":{ + "shape":"IngressPointStatusToUpdate", + "documentation":"The update status of an ingress endpoint.
" + }, + "TrafficPolicyId":{ + "shape":"TrafficPolicyId", + "documentation":"The identifier of an existing traffic policy that you attach to an ingress endpoint resource.
" + } + } + }, + "UpdateIngressPointResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateRelayRequest":{ + "type":"structure", + "required":["RelayId"], + "members":{ + "Authentication":{ + "shape":"RelayAuthentication", + "documentation":"Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.
" + }, + "RelayId":{ + "shape":"RelayId", + "documentation":"The unique relay identifier.
" + }, + "RelayName":{ + "shape":"RelayName", + "documentation":"The name of the relay resource.
" + }, + "ServerName":{ + "shape":"RelayServerName", + "documentation":"The destination relay server address.
" + }, + "ServerPort":{ + "shape":"RelayServerPort", + "documentation":"The destination relay server port.
" + } + } + }, + "UpdateRelayResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateRuleSetRequest":{ + "type":"structure", + "required":["RuleSetId"], + "members":{ + "RuleSetId":{ + "shape":"RuleSetId", + "documentation":"The identifier of a rule set you want to update.
" + }, + "RuleSetName":{ + "shape":"RuleSetName", + "documentation":"A user-friendly name for the rule set resource.
" + }, + "Rules":{ + "shape":"Rules", + "documentation":"A new set of rules to replace the current rules of the rule set—these rules will override all the rules of the rule set.
" + } + } + }, + "UpdateRuleSetResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateTrafficPolicyRequest":{ + "type":"structure", + "required":["TrafficPolicyId"], + "members":{ + "DefaultAction":{ + "shape":"AcceptAction", + "documentation":"Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements
" + }, + "MaxMessageSizeBytes":{ + "shape":"MaxMessageSizeBytes", + "documentation":"The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
" + }, + "PolicyStatements":{ + "shape":"PolicyStatementList", + "documentation":"The list of conditions to be updated for filtering email traffic.
" + }, + "TrafficPolicyId":{ + "shape":"TrafficPolicyId", + "documentation":"The identifier of the traffic policy that you want to update.
" + }, + "TrafficPolicyName":{ + "shape":"TrafficPolicyName", + "documentation":"A user-friendly name for the traffic policy resource.
" + } + } + }, + "UpdateTrafficPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"The request validation has failed. For details, see the accompanying error message.
", + "exception":true + } + }, + "documentation":"The Amazon SES Mail Manager API contains operations and data types that comprise the Mail Manager feature of Amazon Simple Email Service (SES).
Mail Manager is a set of Amazon SES email gateway features designed to help you strengthen your organization's email infrastructure, simplify email workflow management, and streamline email compliance control. To learn more, see the Mail Manager chapter in the Amazon SES Developer Guide.
" +} diff --git a/testbed/boto__botocore/botocore/data/managedblockchain-query/2023-05-04/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/managedblockchain-query/2023-05-04/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..92521932287f161104b0bbeba9af8592c8f9a74e --- /dev/null +++ b/testbed/boto__botocore/botocore/data/managedblockchain-query/2023-05-04/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://managedblockchain-query-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://managedblockchain-query-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://managedblockchain-query.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://managedblockchain-query.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/managedblockchain-query/2023-05-04/paginators-1.json b/testbed/boto__botocore/botocore/data/managedblockchain-query/2023-05-04/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..61eb591992abf650b7599a7eb7ed417be3b9e7be --- /dev/null +++ b/testbed/boto__botocore/botocore/data/managedblockchain-query/2023-05-04/paginators-1.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "ListTokenBalances": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "tokenBalances" + }, + "ListTransactionEvents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "events" + }, + "ListTransactions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "transactions" + }, + "ListAssetContracts": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "contracts" + }, + "ListFilteredTransactionEvents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "events" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/managedblockchain-query/2023-05-04/service-2.json b/testbed/boto__botocore/botocore/data/managedblockchain-query/2023-05-04/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..5d816d5eb31e56f9b2fd3815466dbc617def146d --- /dev/null +++ b/testbed/boto__botocore/botocore/data/managedblockchain-query/2023-05-04/service-2.json @@ -0,0 +1,1423 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2023-05-04", + "endpointPrefix":"managedblockchain-query", + "jsonVersion":"1.1", + "protocol":"rest-json", + "ripServiceName":"chainquery", + "serviceFullName":"Amazon Managed Blockchain Query", + "serviceId":"ManagedBlockchain Query", + "signatureVersion":"v4", + "signingName":"managedblockchain-query", + "uid":"managedblockchain-query-2023-05-04" + }, + "operations":{ + "BatchGetTokenBalance":{ + "name":"BatchGetTokenBalance", + "http":{ + "method":"POST", + "requestUri":"/batch-get-token-balance", + "responseCode":200 + }, + "input":{"shape":"BatchGetTokenBalanceInput"}, + "output":{"shape":"BatchGetTokenBalanceOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Gets the token balance for a batch of tokens by using the BatchGetTokenBalance action for every token in the request.
Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.
Gets the information about a specific contract deployed on the blockchain.
The Bitcoin blockchain networks do not support this operation.
Metadata is currently only available for some ERC-20 contracts. Metadata will be available for additional contracts in the future.
Gets the balance of a specific token, including native tokens, for a given address (wallet or contract) on the blockchain.
Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.
Gets the details of a transaction.
This action will return transaction details for all transactions that are confirmed on the blockchain, even if they have not reached finality.
Lists all the contracts for a given contract type deployed by an address (either a contract address or a wallet address).
The Bitcoin blockchain networks do not support this operation.
" + }, + "ListFilteredTransactionEvents":{ + "name":"ListFilteredTransactionEvents", + "http":{ + "method":"POST", + "requestUri":"/list-filtered-transaction-events", + "responseCode":200 + }, + "input":{"shape":"ListFilteredTransactionEventsInput"}, + "output":{"shape":"ListFilteredTransactionEventsOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Lists all the transaction events for an address on the blockchain.
This operation is only supported on the Bitcoin networks.
This action returns the following for a given blockchain network:
Lists all token balances owned by an address (either a contract address or a wallet address).
Lists all token balances for all tokens created by a contract.
Lists all token balances for a given token.
You must always specify the network property of the tokenFilter when using this operation.
Lists all the transaction events for a transaction
This action will return transaction details for all transactions that are confirmed on the blockchain, even if they have not reached finality.
Lists all the transaction events for a transaction.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The container for the exception message.
" + } + }, + "documentation":"The Amazon Web Services account doesn’t have access to this resource.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AddressIdentifierFilter":{ + "type":"structure", + "required":["transactionEventToAddress"], + "members":{ + "transactionEventToAddress":{ + "shape":"AddressIdentifierFilterTransactionEventToAddressList", + "documentation":"The container for the recipient address of the transaction.
" + } + }, + "documentation":"This is the container for the unique public address on the blockchain.
" + }, + "AddressIdentifierFilterTransactionEventToAddressList":{ + "type":"list", + "member":{"shape":"ChainAddress"}, + "max":1, + "min":1 + }, + "AssetContract":{ + "type":"structure", + "required":[ + "contractIdentifier", + "tokenStandard", + "deployerAddress" + ], + "members":{ + "contractIdentifier":{ + "shape":"ContractIdentifier", + "documentation":"The container for the contract identifier containing its blockchain network and address.
" + }, + "tokenStandard":{ + "shape":"QueryTokenStandard", + "documentation":"The token standard of the contract.
" + }, + "deployerAddress":{ + "shape":"ChainAddress", + "documentation":"The address of the contract deployer.
" + } + }, + "documentation":"This container contains information about an contract.
" + }, + "AssetContractList":{ + "type":"list", + "member":{"shape":"AssetContract"}, + "max":250, + "min":0 + }, + "BatchGetTokenBalanceErrorItem":{ + "type":"structure", + "required":[ + "errorCode", + "errorMessage", + "errorType" + ], + "members":{ + "tokenIdentifier":{"shape":"TokenIdentifier"}, + "ownerIdentifier":{"shape":"OwnerIdentifier"}, + "atBlockchainInstant":{"shape":"BlockchainInstant"}, + "errorCode":{ + "shape":"String", + "documentation":"The error code associated with the error.
" + }, + "errorMessage":{ + "shape":"String", + "documentation":"The message associated with the error.
" + }, + "errorType":{ + "shape":"ErrorType", + "documentation":"The type of error.
" + } + }, + "documentation":"Error generated from a failed BatchGetTokenBalance request.
An array of BatchGetTokenBalanceInputItem objects whose balance is being requested.
The container for the input for getting a token balance.
" + }, + "BatchGetTokenBalanceOutput":{ + "type":"structure", + "required":[ + "tokenBalances", + "errors" + ], + "members":{ + "tokenBalances":{ + "shape":"BatchGetTokenBalanceOutputList", + "documentation":"An array of BatchGetTokenBalanceOutputItem objects returned by the response.
An array of BatchGetTokenBalanceErrorItem objects returned from the request.
The container for the token balance.
" + }, + "atBlockchainInstant":{"shape":"BlockchainInstant"}, + "lastUpdatedTime":{"shape":"BlockchainInstant"} + }, + "documentation":"The container for the properties of a token balance output.
" + }, + "BatchGetTokenBalanceOutputList":{ + "type":"list", + "member":{"shape":"BatchGetTokenBalanceOutputItem"}, + "max":10, + "min":0 + }, + "BlockHash":{ + "type":"string", + "pattern":"(0x[A-Fa-f0-9]{64}|[A-Fa-f0-9]{64})" + }, + "BlockchainInstant":{ + "type":"structure", + "members":{ + "time":{ + "shape":"Timestamp", + "documentation":"The container of the Timestamp of the blockchain instant.
This timestamp will only be recorded up to the second.
The container for time.
" + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ChainAddress":{ + "type":"string", + "pattern":"[-A-Za-z0-9]{13,74}" + }, + "ConfirmationStatus":{ + "type":"string", + "enum":[ + "FINAL", + "NONFINAL" + ] + }, + "ConfirmationStatusFilter":{ + "type":"structure", + "required":["include"], + "members":{ + "include":{ + "shape":"ConfirmationStatusIncludeList", + "documentation":"The container to determine whether to list results that have only reached finality . Transactions that have reached finality are always part of the response.
" + } + }, + "documentation":"The container for the ConfirmationStatusFilter that filters for the finality of the results.
The blockchain network of the contract.
" + }, + "tokenStandard":{ + "shape":"QueryTokenStandard", + "documentation":"The container for the token standard.
" + }, + "deployerAddress":{ + "shape":"ChainAddress", + "documentation":"The network address of the deployer.
" + } + }, + "documentation":"The contract or wallet address by which to filter the request.
" + }, + "ContractIdentifier":{ + "type":"structure", + "required":[ + "network", + "contractAddress" + ], + "members":{ + "network":{ + "shape":"QueryNetwork", + "documentation":"The blockchain network of the contract.
" + }, + "contractAddress":{ + "shape":"ChainAddress", + "documentation":"Container for the blockchain address about a contract.
" + } + }, + "documentation":"Container for the blockchain address and network information about a contract.
" + }, + "ContractMetadata":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of the token contract.
" + }, + "symbol":{ + "shape":"String", + "documentation":"The symbol of the token contract.
" + }, + "decimals":{ + "shape":"Integer", + "documentation":"The decimals used by the token contract.
" + } + }, + "documentation":"The metadata of the contract.
" + }, + "ErrorType":{ + "type":"string", + "enum":[ + "VALIDATION_EXCEPTION", + "RESOURCE_NOT_FOUND_EXCEPTION" + ] + }, + "ExceptionMessage":{ + "type":"string", + "min":1 + }, + "ExecutionStatus":{ + "type":"string", + "enum":[ + "FAILED", + "SUCCEEDED" + ] + }, + "GetAssetContractInput":{ + "type":"structure", + "required":["contractIdentifier"], + "members":{ + "contractIdentifier":{ + "shape":"ContractIdentifier", + "documentation":"Contains the blockchain address and network information about the contract.
" + } + } + }, + "GetAssetContractOutput":{ + "type":"structure", + "required":[ + "contractIdentifier", + "tokenStandard", + "deployerAddress" + ], + "members":{ + "contractIdentifier":{ + "shape":"ContractIdentifier", + "documentation":"Contains the blockchain address and network information about the contract.
" + }, + "tokenStandard":{ + "shape":"QueryTokenStandard", + "documentation":"The token standard of the contract requested.
" + }, + "deployerAddress":{ + "shape":"ChainAddress", + "documentation":"The address of the deployer of contract.
" + }, + "metadata":{"shape":"ContractMetadata"} + } + }, + "GetTokenBalanceInput":{ + "type":"structure", + "required":[ + "tokenIdentifier", + "ownerIdentifier" + ], + "members":{ + "tokenIdentifier":{ + "shape":"TokenIdentifier", + "documentation":"The container for the identifier for the token, including the unique token ID and its blockchain network.
" + }, + "ownerIdentifier":{ + "shape":"OwnerIdentifier", + "documentation":"The container for the identifier for the owner.
" + }, + "atBlockchainInstant":{ + "shape":"BlockchainInstant", + "documentation":"The time for when the TokenBalance is requested or the current time if a time is not provided in the request.
This time will only be recorded up to the second.
The container for the token balance.
" + }, + "atBlockchainInstant":{"shape":"BlockchainInstant"}, + "lastUpdatedTime":{"shape":"BlockchainInstant"} + } + }, + "GetTransactionInput":{ + "type":"structure", + "required":["network"], + "members":{ + "transactionHash":{ + "shape":"QueryTransactionHash", + "documentation":"The hash of a transaction. It is generated when a transaction is created.
" + }, + "transactionId":{ + "shape":"QueryTransactionId", + "documentation":"The identifier of a Bitcoin transaction. It is generated when a transaction is created.
transactionId is only supported on the Bitcoin networks.
The blockchain network where the transaction occurred.
" + } + } + }, + "GetTransactionOutput":{ + "type":"structure", + "required":["transaction"], + "members":{ + "transaction":{ + "shape":"Transaction", + "documentation":"Contains the details of the transaction.
" + } + } + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The container for the exception message.
" + }, + "retryAfterSeconds":{ + "shape":"Integer", + "documentation":"Specifies the retryAfterSeconds value.
The request processing has failed because of an internal error in the service.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "ListAssetContractsInput":{ + "type":"structure", + "required":["contractFilter"], + "members":{ + "contractFilter":{ + "shape":"ContractFilter", + "documentation":"Contains the filter parameter for the request.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token that indicates the next set of results to retrieve.
" + }, + "maxResults":{ + "shape":"ListAssetContractsInputMaxResultsInteger", + "documentation":"The maximum number of contracts to list.
Default: 100
Even if additional results can be retrieved, the request can return less results than maxResults or an empty array of results.
To retrieve the next set of results, make another request with the returned nextToken value. The value of nextToken is null when there are no more results to return
An array of contract objects that contain the properties for each contract.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token that indicates the next set of results to retrieve.
" + } + } + }, + "ListFilteredTransactionEventsInput":{ + "type":"structure", + "required":[ + "network", + "addressIdentifierFilter" + ], + "members":{ + "network":{ + "shape":"String", + "documentation":"The blockchain network where the transaction occurred.
Valid Values: BITCOIN_MAINNET | BITCOIN_TESTNET
This is the unique public address on the blockchain for which the transaction events are being requested.
" + }, + "timeFilter":{ + "shape":"TimeFilter", + "documentation":"This container specifies the time frame for the transaction events returned in the response.
" + }, + "voutFilter":{ + "shape":"VoutFilter", + "documentation":"This container specifies filtering attributes related to BITCOIN_VOUT event types
" + }, + "confirmationStatusFilter":{"shape":"ConfirmationStatusFilter"}, + "sort":{ + "shape":"ListFilteredTransactionEventsSort", + "documentation":"The order by which the results will be sorted.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token that indicates the next set of results to retrieve.
" + }, + "maxResults":{ + "shape":"ListFilteredTransactionEventsInputMaxResultsInteger", + "documentation":"The maximum number of transaction events to list.
Default: 100
Even if additional results can be retrieved, the request can return less results than maxResults or an empty array of results.
To retrieve the next set of results, make another request with the returned nextToken value. The value of nextToken is null when there are no more results to return
The transaction events returned by the request.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token that indicates the next set of results to retrieve.
" + } + } + }, + "ListFilteredTransactionEventsSort":{ + "type":"structure", + "members":{ + "sortBy":{ + "shape":"ListFilteredTransactionEventsSortBy", + "documentation":"Container on how the results will be sorted by?
" + }, + "sortOrder":{ + "shape":"SortOrder", + "documentation":"The container for the sort order for ListFilteredTransactionEvents. The SortOrder field only accepts the values ASCENDING and DESCENDING. Not providing SortOrder will default to ASCENDING.
Lists all the transaction events for an address on the blockchain.
This operation is only supported on the Bitcoin blockchain networks.
The contract or wallet address on the blockchain network by which to filter the request. You must specify the address property of the ownerFilter when listing balances of tokens owned by the address.
The contract address or a token identifier on the blockchain network by which to filter the request. You must specify the contractAddress property of this container when listing tokens minted by a contract.
You must always specify the network property of this container when using this operation.
The pagination token that indicates the next set of results to retrieve.
" + }, + "maxResults":{ + "shape":"ListTokenBalancesInputMaxResultsInteger", + "documentation":"The maximum number of token balances to return.
Default: 100
Even if additional results can be retrieved, the request can return less results than maxResults or an empty array of results.
To retrieve the next set of results, make another request with the returned nextToken value. The value of nextToken is null when there are no more results to return
An array of TokenBalance objects. Each object contains details about the token balance.
The pagination token that indicates the next set of results to retrieve.
" + } + } + }, + "ListTransactionEventsInput":{ + "type":"structure", + "required":["network"], + "members":{ + "transactionHash":{ + "shape":"QueryTransactionHash", + "documentation":"The hash of a transaction. It is generated when a transaction is created.
" + }, + "transactionId":{ + "shape":"QueryTransactionId", + "documentation":"The identifier of a Bitcoin transaction. It is generated when a transaction is created.
transactionId is only supported on the Bitcoin networks.
The blockchain network where the transaction events occurred.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token that indicates the next set of results to retrieve.
" + }, + "maxResults":{ + "shape":"ListTransactionEventsInputMaxResultsInteger", + "documentation":"The maximum number of transaction events to list.
Default: 100
Even if additional results can be retrieved, the request can return less results than maxResults or an empty array of results.
To retrieve the next set of results, make another request with the returned nextToken value. The value of nextToken is null when there are no more results to return
An array of TransactionEvent objects. Each object contains details about the transaction events.
The pagination token that indicates the next set of results to retrieve.
" + } + } + }, + "ListTransactionsInput":{ + "type":"structure", + "required":[ + "address", + "network" + ], + "members":{ + "address":{ + "shape":"ChainAddress", + "documentation":"The address (either a contract or wallet), whose transactions are being requested.
" + }, + "network":{ + "shape":"QueryNetwork", + "documentation":"The blockchain network where the transactions occurred.
" + }, + "fromBlockchainInstant":{"shape":"BlockchainInstant"}, + "toBlockchainInstant":{"shape":"BlockchainInstant"}, + "sort":{ + "shape":"ListTransactionsSort", + "documentation":"The order by which the results will be sorted.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token that indicates the next set of results to retrieve.
" + }, + "maxResults":{ + "shape":"ListTransactionsInputMaxResultsInteger", + "documentation":"The maximum number of transactions to list.
Default: 100
Even if additional results can be retrieved, the request can return less results than maxResults or an empty array of results.
To retrieve the next set of results, make another request with the returned nextToken value. The value of nextToken is null when there are no more results to return
This filter is used to include transactions in the response that haven't reached finality . Transactions that have reached finality are always part of the response.
" + } + } + }, + "ListTransactionsInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":250, + "min":1 + }, + "ListTransactionsOutput":{ + "type":"structure", + "required":["transactions"], + "members":{ + "transactions":{ + "shape":"TransactionOutputList", + "documentation":"The array of transactions returned by the request.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token that indicates the next set of results to retrieve.
" + } + } + }, + "ListTransactionsSort":{ + "type":"structure", + "members":{ + "sortBy":{ + "shape":"ListTransactionsSortBy", + "documentation":"Defaults to the value TRANSACTION_TIMESTAMP.
The container for the sort order for ListTransactions. The SortOrder field only accepts the values ASCENDING and DESCENDING. Not providing SortOrder will default to ASCENDING.
The container for determining how the list transaction result will be sorted.
" + }, + "ListTransactionsSortBy":{ + "type":"string", + "enum":["TRANSACTION_TIMESTAMP"] + }, + "Long":{ + "type":"long", + "box":true + }, + "NextToken":{ + "type":"string", + "max":131070, + "min":0 + }, + "OwnerFilter":{ + "type":"structure", + "required":["address"], + "members":{ + "address":{ + "shape":"ChainAddress", + "documentation":"The contract or wallet address.
" + } + }, + "documentation":"The container for the owner information to filter by.
" + }, + "OwnerIdentifier":{ + "type":"structure", + "required":["address"], + "members":{ + "address":{ + "shape":"ChainAddress", + "documentation":"The contract or wallet address for the owner.
" + } + }, + "documentation":"The container for the owner identifier.
" + }, + "QueryNetwork":{ + "type":"string", + "enum":[ + "ETHEREUM_MAINNET", + "ETHEREUM_SEPOLIA_TESTNET", + "BITCOIN_MAINNET", + "BITCOIN_TESTNET" + ] + }, + "QueryTokenId":{ + "type":"string", + "pattern":"[a-zA-Z0-9]{1,66}" + }, + "QueryTokenStandard":{ + "type":"string", + "enum":[ + "ERC20", + "ERC721", + "ERC1155" + ] + }, + "QueryTransactionEventType":{ + "type":"string", + "enum":[ + "ERC20_TRANSFER", + "ERC20_MINT", + "ERC20_BURN", + "ERC20_DEPOSIT", + "ERC20_WITHDRAWAL", + "ERC721_TRANSFER", + "ERC1155_TRANSFER", + "BITCOIN_VIN", + "BITCOIN_VOUT", + "INTERNAL_ETH_TRANSFER", + "ETH_TRANSFER" + ] + }, + "QueryTransactionHash":{ + "type":"string", + "pattern":"(0x[A-Fa-f0-9]{64}|[A-Fa-f0-9]{64})" + }, + "QueryTransactionId":{ + "type":"string", + "pattern":"(0x[A-Fa-f0-9]{64}|[A-Fa-f0-9]{64})" + }, + "QuotaCode":{"type":"string"}, + "ResourceId":{"type":"string"}, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The container for the exception message.
" + }, + "resourceId":{ + "shape":"ResourceId", + "documentation":"The resourceId of the resource that caused the exception.
The resourceType of the resource that caused the exception.
The resource was not found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceType":{ + "type":"string", + "enum":["collection"] + }, + "ServiceCode":{"type":"string"}, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType", + "serviceCode", + "quotaCode" + ], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The container for the exception message.
" + }, + "resourceId":{ + "shape":"ResourceId", + "documentation":"The resourceId of the resource that caused the exception.
The resourceType of the resource that caused the exception.
The container for the serviceCode.
The container for the quotaCode.
The service quota has been exceeded for this resource.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SortOrder":{ + "type":"string", + "enum":[ + "ASCENDING", + "DESCENDING" + ] + }, + "String":{"type":"string"}, + "ThrottlingException":{ + "type":"structure", + "required":[ + "message", + "serviceCode", + "quotaCode" + ], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The container for the exception message.
" + }, + "serviceCode":{ + "shape":"ServiceCode", + "documentation":"The container for the serviceCode.
The container for the quotaCode.
The container of the retryAfterSeconds value.
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is when you create resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources, if possible.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":true} + }, + "TimeFilter":{ + "type":"structure", + "members":{ + "from":{"shape":"BlockchainInstant"}, + "to":{"shape":"BlockchainInstant"} + }, + "documentation":"This container is used to specify a time frame.
" + }, + "Timestamp":{"type":"timestamp"}, + "TokenBalance":{ + "type":"structure", + "required":[ + "balance", + "atBlockchainInstant" + ], + "members":{ + "ownerIdentifier":{ + "shape":"OwnerIdentifier", + "documentation":"The container for the identifier of the owner.
" + }, + "tokenIdentifier":{ + "shape":"TokenIdentifier", + "documentation":"The identifier for the token, including the unique token ID and its blockchain network.
" + }, + "balance":{ + "shape":"String", + "documentation":"The container of the token balance.
" + }, + "atBlockchainInstant":{ + "shape":"BlockchainInstant", + "documentation":"The time for when the TokenBalance is requested or the current time if a time is not provided in the request.
This time will only be recorded up to the second.
The Timestamp of the last transaction at which the balance for the token in the wallet was updated.
The balance of the token.
" + }, + "TokenBalanceList":{ + "type":"list", + "member":{"shape":"TokenBalance"}, + "max":250, + "min":0 + }, + "TokenFilter":{ + "type":"structure", + "required":["network"], + "members":{ + "network":{ + "shape":"QueryNetwork", + "documentation":"The blockchain network of the token.
" + }, + "contractAddress":{ + "shape":"ChainAddress", + "documentation":"This is the address of the contract.
" + }, + "tokenId":{ + "shape":"QueryTokenId", + "documentation":"The unique identifier of the token.
" + } + }, + "documentation":"The container of the token filter like the contract address on a given blockchain network or a unique token identifier on a given blockchain network.
You must always specify the network property of this container when using this operation.
The blockchain network of the token.
" + }, + "contractAddress":{ + "shape":"ChainAddress", + "documentation":"This is the token's contract address.
" + }, + "tokenId":{ + "shape":"QueryTokenId", + "documentation":"The unique identifier of the token.
For native tokens, use the 3 character abbreviation that best matches your token. For example, btc for Bitcoin, eth for Ether, etc. For all other token types you must specify the tokenId in the 64 character hexadecimal tokenid format.
The container for the identifier for the token including the unique token ID and its blockchain network.
Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.
The blockchain network where the transaction occurred.
" + }, + "blockHash":{ + "shape":"BlockHash", + "documentation":"The block hash is a unique identifier for a block. It is a fixed-size string that is calculated by using the information in the block. The block hash is used to verify the integrity of the data in the block.
" + }, + "transactionHash":{ + "shape":"QueryTransactionHash", + "documentation":"The hash of a transaction. It is generated when a transaction is created.
" + }, + "blockNumber":{ + "shape":"String", + "documentation":"The block number in which the transaction is recorded.
" + }, + "transactionTimestamp":{ + "shape":"Timestamp", + "documentation":"The Timestamp of the transaction.
The index of the transaction within a blockchain.
" + }, + "numberOfTransactions":{ + "shape":"Long", + "documentation":"The number of transactions in the block.
" + }, + "to":{ + "shape":"ChainAddress", + "documentation":"The identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
" + }, + "from":{ + "shape":"ChainAddress", + "documentation":"The initiator of the transaction. It is either in the form a public key or a contract address.
" + }, + "contractAddress":{ + "shape":"ChainAddress", + "documentation":"The blockchain address for the contract.
" + }, + "gasUsed":{ + "shape":"String", + "documentation":"The amount of gas used for the transaction.
" + }, + "cumulativeGasUsed":{ + "shape":"String", + "documentation":"The amount of gas used up to the specified point in the block.
" + }, + "effectiveGasPrice":{ + "shape":"String", + "documentation":"The effective gas price.
" + }, + "signatureV":{ + "shape":"Integer", + "documentation":"The signature of the transaction. The Z coordinate of a point V.
" + }, + "signatureR":{ + "shape":"String", + "documentation":"The signature of the transaction. The X coordinate of a point R.
" + }, + "signatureS":{ + "shape":"String", + "documentation":"The signature of the transaction. The Y coordinate of a point S.
" + }, + "transactionFee":{ + "shape":"String", + "documentation":"The transaction fee.
" + }, + "transactionId":{ + "shape":"String", + "documentation":"The identifier of a Bitcoin transaction. It is generated when a transaction is created.
" + }, + "confirmationStatus":{ + "shape":"ConfirmationStatus", + "documentation":"Specifies whether the transaction has reached Finality.
" + }, + "executionStatus":{ + "shape":"ExecutionStatus", + "documentation":"Identifies whether the transaction has succeeded or failed.
" + } + }, + "documentation":"There are two possible types of transactions used for this data type:
A Bitcoin transaction is a movement of BTC from one address to another.
An Ethereum transaction refers to an action initiated by an externally owned account, which is an account managed by a human, not a contract. For example, if Bob sends Alice 1 ETH, Bob's account must be debited and Alice's must be credited. This state-changing action occurs within a transaction.
The blockchain network where the transaction occurred.
" + }, + "transactionHash":{ + "shape":"QueryTransactionHash", + "documentation":"The hash of a transaction. It is generated when a transaction is created.
" + }, + "eventType":{ + "shape":"QueryTransactionEventType", + "documentation":"The type of transaction event.
" + }, + "from":{ + "shape":"ChainAddress", + "documentation":"The wallet address initiating the transaction. It can either be a public key or a contract.
" + }, + "to":{ + "shape":"ChainAddress", + "documentation":"The wallet address receiving the transaction. It can either be a public key or a contract.
" + }, + "value":{ + "shape":"String", + "documentation":"The value that was transacted.
" + }, + "contractAddress":{ + "shape":"ChainAddress", + "documentation":"The blockchain address for the contract
" + }, + "tokenId":{ + "shape":"QueryTokenId", + "documentation":"The unique identifier for the token involved in the transaction.
" + }, + "transactionId":{ + "shape":"String", + "documentation":"The identifier of a Bitcoin transaction. It is generated when a transaction is created.
" + }, + "voutIndex":{ + "shape":"Integer", + "documentation":"The position of the transaction output in the transaction output list.
" + }, + "voutSpent":{ + "shape":"Boolean", + "documentation":"Specifies if the transaction output is spent or unspent. This is only returned for BITCOIN_VOUT event types.
This is only returned for BITCOIN_VOUT event types.
The transactionId that created the spent transaction output.
This is only returned for BITCOIN_VIN event types.
The transactionHash that created the spent transaction output.
This is only returned for BITCOIN_VIN event types.
The position of the spent transaction output in the output list of the creating transaction.
This is only returned for BITCOIN_VIN event types.
This container specifies whether the transaction has reached Finality.
" + } + }, + "documentation":"The container for the properties of a transaction event.
" + }, + "TransactionEventList":{ + "type":"list", + "member":{"shape":"TransactionEvent"}, + "max":250, + "min":0 + }, + "TransactionOutputItem":{ + "type":"structure", + "required":[ + "transactionHash", + "network", + "transactionTimestamp" + ], + "members":{ + "transactionHash":{ + "shape":"QueryTransactionHash", + "documentation":"The hash of a transaction. It is generated when a transaction is created.
" + }, + "transactionId":{ + "shape":"QueryTransactionId", + "documentation":"The identifier of a Bitcoin transaction. It is generated when a transaction is created.
" + }, + "network":{ + "shape":"QueryNetwork", + "documentation":"The blockchain network where the transaction occurred.
" + }, + "transactionTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the transaction occurred.
" + }, + "confirmationStatus":{ + "shape":"ConfirmationStatus", + "documentation":"Specifies whether to list transactions that have not reached Finality.
" + } + }, + "documentation":"The container of the transaction output.
" + }, + "TransactionOutputList":{ + "type":"list", + "member":{"shape":"TransactionOutputItem"}, + "max":250, + "min":0 + }, + "ValidationException":{ + "type":"structure", + "required":[ + "message", + "reason" + ], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The container for the exception message.
" + }, + "reason":{ + "shape":"ValidationExceptionReason", + "documentation":"The container for the reason for the exception
" + }, + "fieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"The container for the fieldList of the exception.
The resource passed is invalid.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "name", + "message" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of the field that triggered the ValidationException.
The ValidationException message.
The resource passed is invalid.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "unknownOperation", + "cannotParse", + "fieldValidationFailed", + "other" + ] + }, + "VoutFilter":{ + "type":"structure", + "required":["voutSpent"], + "members":{ + "voutSpent":{ + "shape":"Boolean", + "documentation":"Specifies if the transaction output is spent or unspent.
" + } + }, + "documentation":"This container specifies filtering attributes related to BITCOIN_VOUT event types
Amazon Managed Blockchain (AMB) Query provides you with convenient access to multi-blockchain network data, which makes it easier for you to extract contextual data related to blockchain activity. You can use AMB Query to read data from public blockchain networks, such as Bitcoin Mainnet and Ethereum Mainnet. You can also get information such as the current and historical balances of addresses, or you can get a list of blockchain transactions for a given time period. Additionally, you can get details of a given transaction, such as transaction events, which you can further analyze or use in business logic for your applications.
" +} diff --git a/testbed/boto__botocore/botocore/data/managedblockchain-query/2023-05-04/waiters-2.json b/testbed/boto__botocore/botocore/data/managedblockchain-query/2023-05-04/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..13f60ee66be6a3d75208653e2bd7b563561adacc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/managedblockchain-query/2023-05-04/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/testbed/boto__botocore/botocore/data/mediapackagev2/2022-12-25/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/mediapackagev2/2022-12-25/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..989dda667e26cf1095164ee243d52fe213940c72 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/mediapackagev2/2022-12-25/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://mediapackagev2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://mediapackagev2-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://mediapackagev2.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://mediapackagev2.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/mediapackagev2/2022-12-25/paginators-1.json b/testbed/boto__botocore/botocore/data/mediapackagev2/2022-12-25/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..92079806f5dcbaf96c25cbeb652a5605969f9d05 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/mediapackagev2/2022-12-25/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListChannelGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Items" + }, + "ListChannels": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Items" + }, + "ListOriginEndpoints": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Items" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/mediapackagev2/2022-12-25/service-2.json b/testbed/boto__botocore/botocore/data/mediapackagev2/2022-12-25/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..09aab1a184db3a9b423b31271ff3a897c39fddd5 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/mediapackagev2/2022-12-25/service-2.json @@ -0,0 +1,2925 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-12-25", + "endpointPrefix":"mediapackagev2", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceAbbreviation":"mediapackagev2", + "serviceFullName":"AWS Elemental MediaPackage v2", + "serviceId":"MediaPackageV2", + "signatureVersion":"v4", + "signingName":"mediapackagev2", + "uid":"mediapackagev2-2022-12-25" + }, + "operations":{ + "CreateChannel":{ + "name":"CreateChannel", + "http":{ + "method":"POST", + "requestUri":"/channelGroup/{ChannelGroupName}/channel", + "responseCode":200 + }, + "input":{"shape":"CreateChannelRequest"}, + "output":{"shape":"CreateChannelResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Create a channel to start receiving content streams. The channel represents the input to MediaPackage for incoming live content from an encoder such as AWS Elemental MediaLive. The channel receives content, and after packaging it, outputs it through an origin endpoint to downstream devices (such as video players or CDNs) that request the content. You can create only one channel with each request. We recommend that you spread out channels between channel groups, such as putting redundant channels in the same AWS Region in different channel groups.
", + "idempotent":true + }, + "CreateChannelGroup":{ + "name":"CreateChannelGroup", + "http":{ + "method":"POST", + "requestUri":"/channelGroup", + "responseCode":200 + }, + "input":{"shape":"CreateChannelGroupRequest"}, + "output":{"shape":"CreateChannelGroupResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Create a channel group to group your channels and origin endpoints. A channel group is the top-level resource that consists of channels and origin endpoints that are associated with it and that provides predictable URLs for stream delivery. All channels and origin endpoints within the channel group are guaranteed to share the DNS. You can create only one channel group with each request.
", + "idempotent":true + }, + "CreateOriginEndpoint":{ + "name":"CreateOriginEndpoint", + "http":{ + "method":"POST", + "requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint", + "responseCode":200 + }, + "input":{"shape":"CreateOriginEndpointRequest"}, + "output":{"shape":"CreateOriginEndpointResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"The endpoint is attached to a channel, and represents the output of the live content. You can associate multiple endpoints to a single channel. Each endpoint gives players and downstream CDNs (such as Amazon CloudFront) access to the content for playback. Content can't be served from a channel until it has an endpoint. You can create only one endpoint with each request.
", + "idempotent":true + }, + "DeleteChannel":{ + "name":"DeleteChannel", + "http":{ + "method":"DELETE", + "requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/", + "responseCode":200 + }, + "input":{"shape":"DeleteChannelRequest"}, + "output":{"shape":"DeleteChannelResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Delete a channel to stop AWS Elemental MediaPackage from receiving further content. You must delete the channel's origin endpoints before you can delete the channel.
", + "idempotent":true + }, + "DeleteChannelGroup":{ + "name":"DeleteChannelGroup", + "http":{ + "method":"DELETE", + "requestUri":"/channelGroup/{ChannelGroupName}", + "responseCode":200 + }, + "input":{"shape":"DeleteChannelGroupRequest"}, + "output":{"shape":"DeleteChannelGroupResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Delete a channel group. You must delete the channel group's channels and origin endpoints before you can delete the channel group. If you delete a channel group, you'll lose access to the egress domain and will have to create a new channel group to replace it.
", + "idempotent":true + }, + "DeleteChannelPolicy":{ + "name":"DeleteChannelPolicy", + "http":{ + "method":"DELETE", + "requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/policy", + "responseCode":200 + }, + "input":{"shape":"DeleteChannelPolicyRequest"}, + "output":{"shape":"DeleteChannelPolicyResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Delete a channel policy.
", + "idempotent":true + }, + "DeleteOriginEndpoint":{ + "name":"DeleteOriginEndpoint", + "http":{ + "method":"DELETE", + "requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint/{OriginEndpointName}", + "responseCode":200 + }, + "input":{"shape":"DeleteOriginEndpointRequest"}, + "output":{"shape":"DeleteOriginEndpointResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Origin endpoints can serve content until they're deleted. Delete the endpoint if it should no longer respond to playback requests. You must delete all endpoints from a channel before you can delete the channel.
", + "idempotent":true + }, + "DeleteOriginEndpointPolicy":{ + "name":"DeleteOriginEndpointPolicy", + "http":{ + "method":"DELETE", + "requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint/{OriginEndpointName}/policy", + "responseCode":200 + }, + "input":{"shape":"DeleteOriginEndpointPolicyRequest"}, + "output":{"shape":"DeleteOriginEndpointPolicyResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Delete an origin endpoint policy.
", + "idempotent":true + }, + "GetChannel":{ + "name":"GetChannel", + "http":{ + "method":"GET", + "requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/", + "responseCode":200 + }, + "input":{"shape":"GetChannelRequest"}, + "output":{"shape":"GetChannelResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
" + }, + "GetChannelGroup":{ + "name":"GetChannelGroup", + "http":{ + "method":"GET", + "requestUri":"/channelGroup/{ChannelGroupName}", + "responseCode":200 + }, + "input":{"shape":"GetChannelGroupRequest"}, + "output":{"shape":"GetChannelGroupResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
" + }, + "GetChannelPolicy":{ + "name":"GetChannelPolicy", + "http":{ + "method":"GET", + "requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/policy", + "responseCode":200 + }, + "input":{"shape":"GetChannelPolicyRequest"}, + "output":{"shape":"GetChannelPolicyResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources.
" + }, + "GetOriginEndpoint":{ + "name":"GetOriginEndpoint", + "http":{ + "method":"GET", + "requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint/{OriginEndpointName}", + "responseCode":200 + }, + "input":{"shape":"GetOriginEndpointRequest"}, + "output":{"shape":"GetOriginEndpointResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using.
" + }, + "GetOriginEndpointPolicy":{ + "name":"GetOriginEndpointPolicy", + "http":{ + "method":"GET", + "requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint/{OriginEndpointName}/policy", + "responseCode":200 + }, + "input":{"shape":"GetOriginEndpointPolicyRequest"}, + "output":{"shape":"GetOriginEndpointPolicyResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
" + }, + "ListChannelGroups":{ + "name":"ListChannelGroups", + "http":{ + "method":"GET", + "requestUri":"/channelGroup", + "responseCode":200 + }, + "input":{"shape":"ListChannelGroupsRequest"}, + "output":{"shape":"ListChannelGroupsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
" + }, + "ListChannels":{ + "name":"ListChannels", + "http":{ + "method":"GET", + "requestUri":"/channelGroup/{ChannelGroupName}/channel", + "responseCode":200 + }, + "input":{"shape":"ListChannelsRequest"}, + "output":{"shape":"ListChannelsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
" + }, + "ListOriginEndpoints":{ + "name":"ListOriginEndpoints", + "http":{ + "method":"GET", + "requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint", + "responseCode":200 + }, + "input":{"shape":"ListOriginEndpointsRequest"}, + "output":{"shape":"ListOriginEndpointsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{ResourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ValidationException"} + ], + "documentation":"Lists the tags assigned to a resource.
" + }, + "PutChannelPolicy":{ + "name":"PutChannelPolicy", + "http":{ + "method":"PUT", + "requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/policy", + "responseCode":200 + }, + "input":{"shape":"PutChannelPolicyRequest"}, + "output":{"shape":"PutChannelPolicyResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Attaches an IAM policy to the specified channel. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources. You can attach only one policy with each request.
", + "idempotent":true + }, + "PutOriginEndpointPolicy":{ + "name":"PutOriginEndpointPolicy", + "http":{ + "method":"POST", + "requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint/{OriginEndpointName}/policy", + "responseCode":200 + }, + "input":{"shape":"PutOriginEndpointPolicyRequest"}, + "output":{"shape":"PutOriginEndpointPolicyResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.
", + "idempotent":true + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{ResourceArn}", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"ValidationException"} + ], + "documentation":"Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{ResourceArn}", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"ValidationException"} + ], + "documentation":"Removes one or more tags from the specified resource.
", + "idempotent":true + }, + "UpdateChannel":{ + "name":"UpdateChannel", + "http":{ + "method":"PUT", + "requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/", + "responseCode":200 + }, + "input":{"shape":"UpdateChannelRequest"}, + "output":{"shape":"UpdateChannelResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details.
Any edits you make that impact the video output may not be reflected for a few minutes.
", + "idempotent":true + }, + "UpdateChannelGroup":{ + "name":"UpdateChannelGroup", + "http":{ + "method":"PUT", + "requestUri":"/channelGroup/{ChannelGroupName}", + "responseCode":200 + }, + "input":{"shape":"UpdateChannelGroupRequest"}, + "output":{"shape":"UpdateChannelGroupResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group.
Any edits you make that impact the video output may not be reflected for a few minutes.
", + "idempotent":true + }, + "UpdateOriginEndpoint":{ + "name":"UpdateOriginEndpoint", + "http":{ + "method":"PUT", + "requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint/{OriginEndpointName}", + "responseCode":200 + }, + "input":{"shape":"UpdateOriginEndpointRequest"}, + "output":{"shape":"UpdateOriginEndpointResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint.
Any edits you make that impact the video output may not be reflected for a few minutes.
", + "idempotent":true + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AdMarkerDash":{ + "type":"string", + "enum":[ + "BINARY", + "XML" + ] + }, + "AdMarkerHls":{ + "type":"string", + "enum":["DATERANGE"] + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ChannelGroupListConfiguration":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "Arn", + "CreatedAt", + "ModifiedAt" + ], + "members":{ + "ChannelGroupName":{ + "shape":"String", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
" + }, + "Arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with the resource.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel group was created.
" + }, + "ModifiedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel group was modified.
" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"Any descriptive information that you want to add to the channel group for future identification purposes.
" + } + }, + "documentation":"The configuration of the channel group.
" + }, + "ChannelGroupsList":{ + "type":"list", + "member":{"shape":"ChannelGroupListConfiguration"} + }, + "ChannelList":{ + "type":"list", + "member":{"shape":"ChannelListConfiguration"} + }, + "ChannelListConfiguration":{ + "type":"structure", + "required":[ + "Arn", + "ChannelName", + "ChannelGroupName", + "CreatedAt", + "ModifiedAt" + ], + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with the resource.
" + }, + "ChannelName":{ + "shape":"String", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
" + }, + "ChannelGroupName":{ + "shape":"String", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel was created.
" + }, + "ModifiedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel was modified.
" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"Any descriptive information that you want to add to the channel for future identification purposes.
" + }, + "InputType":{ + "shape":"InputType", + "documentation":"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).
The configuration of the channel.
" + }, + "CmafEncryptionMethod":{ + "type":"string", + "enum":[ + "CENC", + "CBCS" + ] + }, + "ConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ConflictExceptionType":{ + "shape":"ConflictExceptionType", + "documentation":"The type of ConflictException.
" + } + }, + "documentation":"Updating or deleting this resource can cause an inconsistent state.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ConflictExceptionType":{ + "type":"string", + "enum":[ + "RESOURCE_IN_USE", + "RESOURCE_ALREADY_EXISTS", + "IDEMPOTENT_PARAMETER_MISMATCH", + "CONFLICTING_OPERATION" + ] + }, + "ContainerType":{ + "type":"string", + "enum":[ + "TS", + "CMAF" + ] + }, + "CreateChannelGroupRequest":{ + "type":"structure", + "required":["ChannelGroupName"], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. You can't use spaces in the name. You can't change the name after you create the channel group.
" + }, + "ClientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique, case-sensitive token that you provide to ensure the idempotency of the request.
", + "idempotencyToken":true, + "location":"header", + "locationName":"x-amzn-client-token" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"Enter any descriptive text that helps you to identify the channel group.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"A comma-separated list of tag key:value pairs that you define. For example:
\"Key1\": \"Value1\",
\"Key2\": \"Value2\"
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
" + }, + "Arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with the resource.
" + }, + "EgressDomain":{ + "shape":"String", + "documentation":"The output domain where the source stream should be sent. Integrate the egress domain with a downstream CDN (such as Amazon CloudFront) or playback device.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel group was created.
" + }, + "ModifiedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel group was modified.
" + }, + "ETag":{ + "shape":"EntityTag", + "documentation":"The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"The description for your channel group.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The comma-separated list of tag key:value pairs assigned to the channel group.
" + } + } + }, + "CreateChannelRequest":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.
" + }, + "ClientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique, case-sensitive token that you provide to ensure the idempotency of the request.
", + "idempotencyToken":true, + "location":"header", + "locationName":"x-amzn-client-token" + }, + "InputType":{ + "shape":"InputType", + "documentation":"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).
Enter any descriptive text that helps you to identify the channel.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"A comma-separated list of tag key:value pairs that you define. For example:
\"Key1\": \"Value1\",
\"Key2\": \"Value2\"
The Amazon Resource Name (ARN) associated with the resource.
" + }, + "ChannelName":{ + "shape":"String", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
" + }, + "ChannelGroupName":{ + "shape":"String", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel was created.
" + }, + "ModifiedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel was modified.
" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"The description for your channel.
" + }, + "IngestEndpoints":{"shape":"IngestEndpointList"}, + "InputType":{ + "shape":"InputType", + "documentation":"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).
The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The comma-separated list of tag key:value pairs assigned to the channel.
" + } + } + }, + "CreateDashManifestConfiguration":{ + "type":"structure", + "required":["ManifestName"], + "members":{ + "ManifestName":{ + "shape":"ManifestName", + "documentation":"A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint.
" + }, + "ManifestWindowSeconds":{ + "shape":"CreateDashManifestConfigurationManifestWindowSecondsInteger", + "documentation":"The total duration (in seconds) of the manifest's content.
" + }, + "FilterConfiguration":{"shape":"FilterConfiguration"}, + "MinUpdatePeriodSeconds":{ + "shape":"CreateDashManifestConfigurationMinUpdatePeriodSecondsInteger", + "documentation":"Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.
" + }, + "MinBufferTimeSeconds":{ + "shape":"CreateDashManifestConfigurationMinBufferTimeSecondsInteger", + "documentation":"Minimum amount of content (in seconds) that a player must keep available in the buffer.
" + }, + "SuggestedPresentationDelaySeconds":{ + "shape":"CreateDashManifestConfigurationSuggestedPresentationDelaySecondsInteger", + "documentation":"The amount of time (in seconds) that the player should be from the end of the manifest.
" + }, + "SegmentTemplateFormat":{ + "shape":"DashSegmentTemplateFormat", + "documentation":"Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.
Value description:
NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.
A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type ADS to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.
The SCTE configuration.
" + }, + "DrmSignaling":{ + "shape":"DashDrmSignaling", + "documentation":"Determines how the DASH manifest signals the DRM content.
" + }, + "UtcTiming":{ + "shape":"DashUtcTiming", + "documentation":"Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
" + } + }, + "documentation":"Create a DASH manifest configuration.
" + }, + "CreateDashManifestConfigurationManifestWindowSecondsInteger":{ + "type":"integer", + "box":true, + "min":30 + }, + "CreateDashManifestConfigurationMinBufferTimeSecondsInteger":{ + "type":"integer", + "box":true, + "max":3600, + "min":0 + }, + "CreateDashManifestConfigurationMinUpdatePeriodSecondsInteger":{ + "type":"integer", + "box":true, + "max":3600, + "min":1 + }, + "CreateDashManifestConfigurationSuggestedPresentationDelaySecondsInteger":{ + "type":"integer", + "box":true, + "max":3600, + "min":0 + }, + "CreateDashManifests":{ + "type":"list", + "member":{"shape":"CreateDashManifestConfiguration"} + }, + "CreateHlsManifestConfiguration":{ + "type":"structure", + "required":["ManifestName"], + "members":{ + "ManifestName":{ + "shape":"ManifestName", + "documentation":"A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
" + }, + "ChildManifestName":{ + "shape":"ManifestName", + "documentation":"A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
" + }, + "ScteHls":{"shape":"ScteHls"}, + "ManifestWindowSeconds":{ + "shape":"CreateHlsManifestConfigurationManifestWindowSecondsInteger", + "documentation":"The total duration (in seconds) of the manifest's content.
" + }, + "ProgramDateTimeIntervalSeconds":{ + "shape":"CreateHlsManifestConfigurationProgramDateTimeIntervalSecondsInteger", + "documentation":"Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
" + }, + "FilterConfiguration":{"shape":"FilterConfiguration"} + }, + "documentation":"Create an HTTP live streaming (HLS) manifest configuration.
" + }, + "CreateHlsManifestConfigurationManifestWindowSecondsInteger":{ + "type":"integer", + "box":true, + "min":30 + }, + "CreateHlsManifestConfigurationProgramDateTimeIntervalSecondsInteger":{ + "type":"integer", + "box":true, + "max":1209600, + "min":1 + }, + "CreateHlsManifests":{ + "type":"list", + "member":{"shape":"CreateHlsManifestConfiguration"} + }, + "CreateLowLatencyHlsManifestConfiguration":{ + "type":"structure", + "required":["ManifestName"], + "members":{ + "ManifestName":{ + "shape":"ManifestName", + "documentation":"A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
" + }, + "ChildManifestName":{ + "shape":"ManifestName", + "documentation":"A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
" + }, + "ScteHls":{"shape":"ScteHls"}, + "ManifestWindowSeconds":{ + "shape":"CreateLowLatencyHlsManifestConfigurationManifestWindowSecondsInteger", + "documentation":"The total duration (in seconds) of the manifest's content.
" + }, + "ProgramDateTimeIntervalSeconds":{ + "shape":"CreateLowLatencyHlsManifestConfigurationProgramDateTimeIntervalSecondsInteger", + "documentation":"Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
" + }, + "FilterConfiguration":{"shape":"FilterConfiguration"} + }, + "documentation":"Create a low-latency HTTP live streaming (HLS) manifest configuration.
" + }, + "CreateLowLatencyHlsManifestConfigurationManifestWindowSecondsInteger":{ + "type":"integer", + "box":true, + "min":30 + }, + "CreateLowLatencyHlsManifestConfigurationProgramDateTimeIntervalSecondsInteger":{ + "type":"integer", + "box":true, + "max":1209600, + "min":1 + }, + "CreateLowLatencyHlsManifests":{ + "type":"list", + "member":{"shape":"CreateLowLatencyHlsManifestConfiguration"} + }, + "CreateOriginEndpointRequest":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName", + "OriginEndpointName", + "ContainerType" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
", + "location":"uri", + "locationName":"ChannelName" + }, + "OriginEndpointName":{ + "shape":"ResourceName", + "documentation":"The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and must be unique for your account in the AWS Region and channel. You can't use spaces in the name. You can't change the name after you create the endpoint.
" + }, + "ContainerType":{ + "shape":"ContainerType", + "documentation":"The type of container to attach to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. You can't change the container type after you create the endpoint.
" + }, + "Segment":{ + "shape":"Segment", + "documentation":"The segment configuration, including the segment name, duration, and other configuration values.
" + }, + "ClientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique, case-sensitive token that you provide to ensure the idempotency of the request.
", + "idempotencyToken":true, + "location":"header", + "locationName":"x-amzn-client-token" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"Enter any descriptive text that helps you to identify the origin endpoint.
" + }, + "StartoverWindowSeconds":{ + "shape":"CreateOriginEndpointRequestStartoverWindowSecondsInteger", + "documentation":"The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).
" + }, + "HlsManifests":{ + "shape":"CreateHlsManifests", + "documentation":"An HTTP live streaming (HLS) manifest configuration.
" + }, + "LowLatencyHlsManifests":{ + "shape":"CreateLowLatencyHlsManifests", + "documentation":"A low-latency HLS manifest configuration.
" + }, + "DashManifests":{ + "shape":"CreateDashManifests", + "documentation":"A DASH manifest configuration.
" + }, + "ForceEndpointErrorConfiguration":{ + "shape":"ForceEndpointErrorConfiguration", + "documentation":"The failover settings for the endpoint.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"A comma-separated list of tag key:value pairs that you define. For example:
\"Key1\": \"Value1\",
\"Key2\": \"Value2\"
The Amazon Resource Name (ARN) associated with the resource.
" + }, + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
" + }, + "OriginEndpointName":{ + "shape":"ResourceName", + "documentation":"The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
" + }, + "ContainerType":{ + "shape":"ContainerType", + "documentation":"The type of container attached to this origin endpoint.
" + }, + "Segment":{ + "shape":"Segment", + "documentation":"The segment configuration, including the segment name, duration, and other configuration values.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the origin endpoint was created.
" + }, + "ModifiedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the origin endpoint was modified.
" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"The description for your origin endpoint.
" + }, + "StartoverWindowSeconds":{ + "shape":"Integer", + "documentation":"The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.
" + }, + "HlsManifests":{ + "shape":"GetHlsManifests", + "documentation":"An HTTP live streaming (HLS) manifest configuration.
" + }, + "LowLatencyHlsManifests":{ + "shape":"GetLowLatencyHlsManifests", + "documentation":"A low-latency HLS manifest configuration.
" + }, + "DashManifests":{ + "shape":"GetDashManifests", + "documentation":"A DASH manifest configuration.
" + }, + "ForceEndpointErrorConfiguration":{ + "shape":"ForceEndpointErrorConfiguration", + "documentation":"The failover settings for the endpoint.
" + }, + "ETag":{ + "shape":"EntityTag", + "documentation":"The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The comma-separated list of tag key:value pairs assigned to the origin endpoint.
" + } + } + }, + "DashDrmSignaling":{ + "type":"string", + "enum":[ + "INDIVIDUAL", + "REFERENCED" + ] + }, + "DashPeriodTrigger":{ + "type":"string", + "enum":[ + "AVAILS", + "DRM_KEY_ROTATION", + "SOURCE_CHANGES", + "SOURCE_DISRUPTIONS", + "NONE" + ] + }, + "DashPeriodTriggers":{ + "type":"list", + "member":{"shape":"DashPeriodTrigger"}, + "max":100, + "min":0 + }, + "DashSegmentTemplateFormat":{ + "type":"string", + "enum":["NUMBER_WITH_TIMELINE"] + }, + "DashUtcTiming":{ + "type":"structure", + "members":{ + "TimingMode":{ + "shape":"DashUtcTimingMode", + "documentation":"The UTC timing mode.
" + }, + "TimingSource":{ + "shape":"DashUtcTimingTimingSourceString", + "documentation":"The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.
" + } + }, + "documentation":"Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
" + }, + "DashUtcTimingMode":{ + "type":"string", + "enum":[ + "HTTP_HEAD", + "HTTP_ISO", + "HTTP_XSDATE", + "UTC_DIRECT" + ] + }, + "DashUtcTimingTimingSourceString":{ + "type":"string", + "max":1024, + "min":1 + }, + "DeleteChannelGroupRequest":{ + "type":"structure", + "required":["ChannelGroupName"], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + } + } + }, + "DeleteChannelGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteChannelPolicyRequest":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
", + "location":"uri", + "locationName":"ChannelName" + } + } + }, + "DeleteChannelPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteChannelRequest":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
", + "location":"uri", + "locationName":"ChannelName" + } + } + }, + "DeleteChannelResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteOriginEndpointPolicyRequest":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName", + "OriginEndpointName" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
", + "location":"uri", + "locationName":"ChannelName" + }, + "OriginEndpointName":{ + "shape":"ResourceName", + "documentation":"The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
", + "location":"uri", + "locationName":"OriginEndpointName" + } + } + }, + "DeleteOriginEndpointPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteOriginEndpointRequest":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName", + "OriginEndpointName" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
", + "location":"uri", + "locationName":"ChannelName" + }, + "OriginEndpointName":{ + "shape":"ResourceName", + "documentation":"The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
", + "location":"uri", + "locationName":"OriginEndpointName" + } + } + }, + "DeleteOriginEndpointResponse":{ + "type":"structure", + "members":{ + } + }, + "DrmSystem":{ + "type":"string", + "enum":[ + "CLEAR_KEY_AES_128", + "FAIRPLAY", + "PLAYREADY", + "WIDEVINE", + "IRDETO" + ] + }, + "Encryption":{ + "type":"structure", + "required":[ + "EncryptionMethod", + "SpekeKeyProvider" + ], + "members":{ + "ConstantInitializationVector":{ + "shape":"EncryptionConstantInitializationVectorString", + "documentation":"A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).
" + }, + "EncryptionMethod":{ + "shape":"EncryptionMethod", + "documentation":"The encryption method to use.
" + }, + "KeyRotationIntervalSeconds":{ + "shape":"EncryptionKeyRotationIntervalSecondsInteger", + "documentation":"The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.
The following example setting causes the service to rotate keys every thirty minutes: 1800
The parameters for the SPEKE key provider.
" + } + }, + "documentation":"The parameters for encrypting content.
" + }, + "EncryptionConstantInitializationVectorString":{ + "type":"string", + "max":32, + "min":32, + "pattern":"[0-9a-fA-F]+" + }, + "EncryptionContractConfiguration":{ + "type":"structure", + "required":[ + "PresetSpeke20Audio", + "PresetSpeke20Video" + ], + "members":{ + "PresetSpeke20Audio":{ + "shape":"PresetSpeke20Audio", + "documentation":"A collection of audio encryption presets.
Value description:
PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.
PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.
PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.
SHARED - Use the same content key for all of the audio and video tracks in your stream.
UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.
A collection of video encryption presets.
Value description:
PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.
PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.
PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
SHARED - Use the same content key for all of the video and audio tracks in your stream.
UNENCRYPTED - Don't encrypt any of the video tracks in your stream.
Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.
" + }, + "EncryptionKeyRotationIntervalSecondsInteger":{ + "type":"integer", + "box":true, + "max":31536000, + "min":300 + }, + "EncryptionMethod":{ + "type":"structure", + "members":{ + "TsEncryptionMethod":{ + "shape":"TsEncryptionMethod", + "documentation":"The encryption method to use.
" + }, + "CmafEncryptionMethod":{ + "shape":"CmafEncryptionMethod", + "documentation":"The encryption method to use.
" + } + }, + "documentation":"The encryption type.
" + }, + "EndpointErrorCondition":{ + "type":"string", + "enum":[ + "STALE_MANIFEST", + "INCOMPLETE_MANIFEST", + "MISSING_DRM_KEY", + "SLATE_INPUT" + ] + }, + "EndpointErrorConditions":{ + "type":"list", + "member":{"shape":"EndpointErrorCondition"} + }, + "EntityTag":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\S]+" + }, + "FilterConfiguration":{ + "type":"structure", + "members":{ + "ManifestFilter":{ + "shape":"FilterConfigurationManifestFilterString", + "documentation":"Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.
" + }, + "Start":{ + "shape":"Timestamp", + "documentation":"Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.
" + }, + "End":{ + "shape":"Timestamp", + "documentation":"Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.
" + }, + "TimeDelaySeconds":{ + "shape":"FilterConfigurationTimeDelaySecondsInteger", + "documentation":"Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.
" + } + }, + "documentation":"Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.
" + }, + "FilterConfigurationManifestFilterString":{ + "type":"string", + "max":1024, + "min":1 + }, + "FilterConfigurationTimeDelaySecondsInteger":{ + "type":"integer", + "box":true, + "max":1209600, + "min":0 + }, + "ForceEndpointErrorConfiguration":{ + "type":"structure", + "members":{ + "EndpointErrorConditions":{ + "shape":"EndpointErrorConditions", + "documentation":"The failover conditions for the endpoint. The options are:
STALE_MANIFEST - The manifest stalled and there are no new segments or parts.
INCOMPLETE_MANIFEST - There is a gap in the manifest.
MISSING_DRM_KEY - Key rotation is enabled but we're unable to fetch the key for the current key period.
SLATE_INPUT - The segments which contain slate content are considered to be missing content.
The failover settings for the endpoint.
" + }, + "GetChannelGroupRequest":{ + "type":"structure", + "required":["ChannelGroupName"], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + } + } + }, + "GetChannelGroupResponse":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "Arn", + "EgressDomain", + "CreatedAt", + "ModifiedAt" + ], + "members":{ + "ChannelGroupName":{ + "shape":"String", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
" + }, + "Arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with the resource.
" + }, + "EgressDomain":{ + "shape":"String", + "documentation":"The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel group was created.
" + }, + "ModifiedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel group was modified.
" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"The description for your channel group.
" + }, + "ETag":{ + "shape":"EntityTag", + "documentation":"The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The comma-separated list of tag key:value pairs assigned to the channel group.
", + "locationName":"tags" + } + } + }, + "GetChannelPolicyRequest":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
", + "location":"uri", + "locationName":"ChannelName" + } + } + }, + "GetChannelPolicyResponse":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName", + "Policy" + ], + "members":{ + "ChannelGroupName":{ + "shape":"String", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
" + }, + "ChannelName":{ + "shape":"String", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
" + }, + "Policy":{ + "shape":"PolicyText", + "documentation":"The policy assigned to the channel.
" + } + } + }, + "GetChannelRequest":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
", + "location":"uri", + "locationName":"ChannelName" + } + } + }, + "GetChannelResponse":{ + "type":"structure", + "required":[ + "Arn", + "ChannelName", + "ChannelGroupName", + "CreatedAt", + "ModifiedAt" + ], + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with the resource.
" + }, + "ChannelName":{ + "shape":"String", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
" + }, + "ChannelGroupName":{ + "shape":"String", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel was created.
" + }, + "ModifiedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel was modified.
" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"The description for your channel.
" + }, + "IngestEndpoints":{"shape":"IngestEndpointList"}, + "InputType":{ + "shape":"InputType", + "documentation":"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).
The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The comma-separated list of tag key:value pairs assigned to the channel.
" + } + } + }, + "GetDashManifestConfiguration":{ + "type":"structure", + "required":[ + "ManifestName", + "Url" + ], + "members":{ + "ManifestName":{ + "shape":"ResourceName", + "documentation":"A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.
" + }, + "Url":{ + "shape":"String", + "documentation":"The egress domain URL for stream delivery from MediaPackage.
" + }, + "ManifestWindowSeconds":{ + "shape":"Integer", + "documentation":"The total duration (in seconds) of the manifest's content.
" + }, + "FilterConfiguration":{"shape":"FilterConfiguration"}, + "MinUpdatePeriodSeconds":{ + "shape":"Integer", + "documentation":"Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.
" + }, + "MinBufferTimeSeconds":{ + "shape":"Integer", + "documentation":"Minimum amount of content (in seconds) that a player must keep available in the buffer.
" + }, + "SuggestedPresentationDelaySeconds":{ + "shape":"Integer", + "documentation":"The amount of time (in seconds) that the player should be from the end of the manifest.
" + }, + "SegmentTemplateFormat":{ + "shape":"DashSegmentTemplateFormat", + "documentation":"Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.
Value description:
NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.
A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.
" + }, + "ScteDash":{ + "shape":"ScteDash", + "documentation":"The SCTE configuration.
" + }, + "DrmSignaling":{ + "shape":"DashDrmSignaling", + "documentation":"Determines how the DASH manifest signals the DRM content.
" + }, + "UtcTiming":{ + "shape":"DashUtcTiming", + "documentation":"Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
" + } + }, + "documentation":"Retrieve the DASH manifest configuration.
" + }, + "GetDashManifests":{ + "type":"list", + "member":{"shape":"GetDashManifestConfiguration"} + }, + "GetHlsManifestConfiguration":{ + "type":"structure", + "required":[ + "ManifestName", + "Url" + ], + "members":{ + "ManifestName":{ + "shape":"ResourceName", + "documentation":"A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
" + }, + "Url":{ + "shape":"String", + "documentation":"The egress domain URL for stream delivery from MediaPackage.
" + }, + "ChildManifestName":{ + "shape":"ResourceName", + "documentation":"A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
" + }, + "ManifestWindowSeconds":{ + "shape":"Integer", + "documentation":"The total duration (in seconds) of the manifest's content.
" + }, + "ProgramDateTimeIntervalSeconds":{ + "shape":"Integer", + "documentation":"Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
" + }, + "ScteHls":{"shape":"ScteHls"}, + "FilterConfiguration":{"shape":"FilterConfiguration"} + }, + "documentation":"Retrieve the HTTP live streaming (HLS) manifest configuration.
" + }, + "GetHlsManifests":{ + "type":"list", + "member":{"shape":"GetHlsManifestConfiguration"} + }, + "GetLowLatencyHlsManifestConfiguration":{ + "type":"structure", + "required":[ + "ManifestName", + "Url" + ], + "members":{ + "ManifestName":{ + "shape":"ResourceName", + "documentation":"A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
" + }, + "Url":{ + "shape":"String", + "documentation":"The egress domain URL for stream delivery from MediaPackage.
" + }, + "ChildManifestName":{ + "shape":"ResourceName", + "documentation":"A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
" + }, + "ManifestWindowSeconds":{ + "shape":"Integer", + "documentation":"The total duration (in seconds) of the manifest's content.
" + }, + "ProgramDateTimeIntervalSeconds":{ + "shape":"Integer", + "documentation":"Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
" + }, + "ScteHls":{"shape":"ScteHls"}, + "FilterConfiguration":{"shape":"FilterConfiguration"} + }, + "documentation":"Retrieve the low-latency HTTP live streaming (HLS) manifest configuration.
" + }, + "GetLowLatencyHlsManifests":{ + "type":"list", + "member":{"shape":"GetLowLatencyHlsManifestConfiguration"} + }, + "GetOriginEndpointPolicyRequest":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName", + "OriginEndpointName" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
", + "location":"uri", + "locationName":"ChannelName" + }, + "OriginEndpointName":{ + "shape":"ResourceName", + "documentation":"The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
", + "location":"uri", + "locationName":"OriginEndpointName" + } + } + }, + "GetOriginEndpointPolicyResponse":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName", + "OriginEndpointName", + "Policy" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
" + }, + "OriginEndpointName":{ + "shape":"ResourceName", + "documentation":"The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
" + }, + "Policy":{ + "shape":"PolicyText", + "documentation":"The policy assigned to the origin endpoint.
" + } + } + }, + "GetOriginEndpointRequest":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName", + "OriginEndpointName" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
", + "location":"uri", + "locationName":"ChannelName" + }, + "OriginEndpointName":{ + "shape":"ResourceName", + "documentation":"The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
", + "location":"uri", + "locationName":"OriginEndpointName" + } + } + }, + "GetOriginEndpointResponse":{ + "type":"structure", + "required":[ + "Arn", + "ChannelGroupName", + "ChannelName", + "OriginEndpointName", + "ContainerType", + "Segment", + "CreatedAt", + "ModifiedAt" + ], + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with the resource.
" + }, + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
" + }, + "OriginEndpointName":{ + "shape":"ResourceName", + "documentation":"The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
" + }, + "ContainerType":{ + "shape":"ContainerType", + "documentation":"The type of container attached to this origin endpoint.
" + }, + "Segment":{"shape":"Segment"}, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the origin endpoint was created.
" + }, + "ModifiedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the origin endpoint was modified.
" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"The description for your origin endpoint.
" + }, + "StartoverWindowSeconds":{ + "shape":"Integer", + "documentation":"The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.
" + }, + "HlsManifests":{ + "shape":"GetHlsManifests", + "documentation":"An HTTP live streaming (HLS) manifest configuration.
" + }, + "LowLatencyHlsManifests":{ + "shape":"GetLowLatencyHlsManifests", + "documentation":"A low-latency HLS manifest configuration.
" + }, + "DashManifests":{ + "shape":"GetDashManifests", + "documentation":"A DASH manifest configuration.
" + }, + "ForceEndpointErrorConfiguration":{ + "shape":"ForceEndpointErrorConfiguration", + "documentation":"The failover settings for the endpoint.
" + }, + "ETag":{ + "shape":"EntityTag", + "documentation":"The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The comma-separated list of tag key:value pairs assigned to the origin endpoint.
" + } + } + }, + "IdempotencyToken":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\S]+" + }, + "IngestEndpoint":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"String", + "documentation":"The system-generated unique identifier for the IngestEndpoint.
" + }, + "Url":{ + "shape":"String", + "documentation":"The ingest domain URL where the source stream should be sent.
" + } + }, + "documentation":"The ingest domain URL where the source stream should be sent.
" + }, + "IngestEndpointList":{ + "type":"list", + "member":{"shape":"IngestEndpoint"}, + "documentation":"The list of ingest endpoints.
" + }, + "InputType":{ + "type":"string", + "enum":[ + "HLS", + "CMAF" + ] + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"Indicates that an error from the service occurred while trying to process a request.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "ListChannelGroupsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListResourceMaxResults", + "documentation":"The maximum number of results to return in the response.
", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"The pagination token from the GET list request. Use the token to fetch the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListChannelGroupsResponse":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"ChannelGroupsList", + "documentation":"The objects being returned.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The pagination token from the GET list request. Use the token to fetch the next page of results.
" + } + } + }, + "ListChannelsRequest":{ + "type":"structure", + "required":["ChannelGroupName"], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "MaxResults":{ + "shape":"ListResourceMaxResults", + "documentation":"The maximum number of results to return in the response.
", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"The pagination token from the GET list request. Use the token to fetch the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListChannelsResponse":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"ChannelList", + "documentation":"The objects being returned.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The pagination token from the GET list request.
" + } + } + }, + "ListDashManifestConfiguration":{ + "type":"structure", + "required":["ManifestName"], + "members":{ + "ManifestName":{ + "shape":"ResourceName", + "documentation":"A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.
" + }, + "Url":{ + "shape":"String", + "documentation":"The egress domain URL for stream delivery from MediaPackage.
" + } + }, + "documentation":"List the DASH manifest configuration.
" + }, + "ListDashManifests":{ + "type":"list", + "member":{"shape":"ListDashManifestConfiguration"} + }, + "ListHlsManifestConfiguration":{ + "type":"structure", + "required":["ManifestName"], + "members":{ + "ManifestName":{ + "shape":"ResourceName", + "documentation":"A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
" + }, + "ChildManifestName":{ + "shape":"ResourceName", + "documentation":"A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
" + }, + "Url":{ + "shape":"String", + "documentation":"The egress domain URL for stream delivery from MediaPackage.
" + } + }, + "documentation":"List the HTTP live streaming (HLS) manifest configuration.
" + }, + "ListHlsManifests":{ + "type":"list", + "member":{"shape":"ListHlsManifestConfiguration"} + }, + "ListLowLatencyHlsManifestConfiguration":{ + "type":"structure", + "required":["ManifestName"], + "members":{ + "ManifestName":{ + "shape":"ResourceName", + "documentation":"A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
" + }, + "ChildManifestName":{ + "shape":"ResourceName", + "documentation":"A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
" + }, + "Url":{ + "shape":"String", + "documentation":"The egress domain URL for stream delivery from MediaPackage.
" + } + }, + "documentation":"List the low-latency HTTP live streaming (HLS) manifest configuration.
" + }, + "ListLowLatencyHlsManifests":{ + "type":"list", + "member":{"shape":"ListLowLatencyHlsManifestConfiguration"} + }, + "ListOriginEndpointsRequest":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
", + "location":"uri", + "locationName":"ChannelName" + }, + "MaxResults":{ + "shape":"ListResourceMaxResults", + "documentation":"The maximum number of results to return in the response.
", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"The pagination token from the GET list request. Use the token to fetch the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListOriginEndpointsResponse":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"OriginEndpointsList", + "documentation":"The objects being returned.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The pagination token from the GET list request. Use the token to fetch the next page of results.
" + } + } + }, + "ListResourceMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"TagArn", + "documentation":"The ARN of the CloudWatch resource that you want to view tags for.
", + "location":"uri", + "locationName":"ResourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
", + "locationName":"tags" + } + } + }, + "ManifestName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9-]+" + }, + "OriginEndpointListConfiguration":{ + "type":"structure", + "required":[ + "Arn", + "ChannelGroupName", + "ChannelName", + "OriginEndpointName", + "ContainerType" + ], + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with the resource.
" + }, + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
" + }, + "OriginEndpointName":{ + "shape":"ResourceName", + "documentation":"The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
" + }, + "ContainerType":{ + "shape":"ContainerType", + "documentation":"The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.
" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"Any descriptive information that you want to add to the origin endpoint for future identification purposes.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the origin endpoint was created.
" + }, + "ModifiedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the origin endpoint was modified.
" + }, + "HlsManifests":{ + "shape":"ListHlsManifests", + "documentation":"An HTTP live streaming (HLS) manifest configuration.
" + }, + "LowLatencyHlsManifests":{ + "shape":"ListLowLatencyHlsManifests", + "documentation":"A low-latency HLS manifest configuration.
" + }, + "DashManifests":{ + "shape":"ListDashManifests", + "documentation":"A DASH manifest configuration.
" + }, + "ForceEndpointErrorConfiguration":{ + "shape":"ForceEndpointErrorConfiguration", + "documentation":"The failover settings for the endpoint.
" + } + }, + "documentation":"The configuration of the origin endpoint.
" + }, + "OriginEndpointsList":{ + "type":"list", + "member":{"shape":"OriginEndpointListConfiguration"} + }, + "PolicyText":{ + "type":"string", + "max":6144, + "min":0 + }, + "PresetSpeke20Audio":{ + "type":"string", + "enum":[ + "PRESET_AUDIO_1", + "PRESET_AUDIO_2", + "PRESET_AUDIO_3", + "SHARED", + "UNENCRYPTED" + ] + }, + "PresetSpeke20Video":{ + "type":"string", + "enum":[ + "PRESET_VIDEO_1", + "PRESET_VIDEO_2", + "PRESET_VIDEO_3", + "PRESET_VIDEO_4", + "PRESET_VIDEO_5", + "PRESET_VIDEO_6", + "PRESET_VIDEO_7", + "PRESET_VIDEO_8", + "SHARED", + "UNENCRYPTED" + ] + }, + "PutChannelPolicyRequest":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName", + "Policy" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
", + "location":"uri", + "locationName":"ChannelName" + }, + "Policy":{ + "shape":"PolicyText", + "documentation":"The policy to attach to the specified channel.
" + } + } + }, + "PutChannelPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "PutOriginEndpointPolicyRequest":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName", + "OriginEndpointName", + "Policy" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
", + "location":"uri", + "locationName":"ChannelName" + }, + "OriginEndpointName":{ + "shape":"ResourceName", + "documentation":"The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
", + "location":"uri", + "locationName":"OriginEndpointName" + }, + "Policy":{ + "shape":"PolicyText", + "documentation":"The policy to attach to the specified origin endpoint.
" + } + } + }, + "PutOriginEndpointPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "ResourceDescription":{ + "type":"string", + "max":1024, + "min":0 + }, + "ResourceName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ResourceTypeNotFound":{ + "shape":"ResourceTypeNotFound", + "documentation":"The specified resource type wasn't found.
" + } + }, + "documentation":"The specified resource doesn't exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceTypeNotFound":{ + "type":"string", + "enum":[ + "CHANNEL_GROUP", + "CHANNEL", + "ORIGIN_ENDPOINT" + ] + }, + "Scte":{ + "type":"structure", + "members":{ + "ScteFilter":{ + "shape":"ScteFilterList", + "documentation":"The SCTE-35 message types that you want to be treated as ad markers in the output.
" + } + }, + "documentation":"The SCTE configuration.
" + }, + "ScteDash":{ + "type":"structure", + "members":{ + "AdMarkerDash":{ + "shape":"AdMarkerDash", + "documentation":"Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.
Value description:
Binary - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.
XML - The SCTE marker is expressed fully in XML.
The SCTE configuration.
" + }, + "ScteFilter":{ + "type":"string", + "enum":[ + "SPLICE_INSERT", + "BREAK", + "PROVIDER_ADVERTISEMENT", + "DISTRIBUTOR_ADVERTISEMENT", + "PROVIDER_PLACEMENT_OPPORTUNITY", + "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", + "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", + "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY", + "PROGRAM" + ] + }, + "ScteFilterList":{ + "type":"list", + "member":{"shape":"ScteFilter"}, + "max":100, + "min":0 + }, + "ScteHls":{ + "type":"structure", + "members":{ + "AdMarkerHls":{ + "shape":"AdMarkerHls", + "documentation":"Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.
Value description:
DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.
The SCTE configuration.
" + }, + "Segment":{ + "type":"structure", + "members":{ + "SegmentDurationSeconds":{ + "shape":"SegmentSegmentDurationSecondsInteger", + "documentation":"The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.
" + }, + "SegmentName":{ + "shape":"SegmentSegmentNameString", + "documentation":"The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.
" + }, + "TsUseAudioRenditionGroup":{ + "shape":"Boolean", + "documentation":"When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.
" + }, + "IncludeIframeOnlyStreams":{ + "shape":"Boolean", + "documentation":"When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.
" + }, + "TsIncludeDvbSubtitles":{ + "shape":"Boolean", + "documentation":"By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.
" + }, + "Scte":{ + "shape":"Scte", + "documentation":"The SCTE configuration options in the segment settings.
" + }, + "Encryption":{"shape":"Encryption"} + }, + "documentation":"The segment configuration, including the segment name, duration, and other configuration values.
" + }, + "SegmentSegmentDurationSecondsInteger":{ + "type":"integer", + "box":true, + "max":30, + "min":1 + }, + "SegmentSegmentNameString":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request would cause a service quota to be exceeded.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SpekeKeyProvider":{ + "type":"structure", + "required":[ + "EncryptionContractConfiguration", + "ResourceId", + "DrmSystems", + "RoleArn", + "Url" + ], + "members":{ + "EncryptionContractConfiguration":{ + "shape":"EncryptionContractConfiguration", + "documentation":"Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.
" + }, + "ResourceId":{ + "shape":"SpekeKeyProviderResourceIdString", + "documentation":"The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
The following example shows a resource ID: MovieNight20171126093045
The DRM solution provider you're using to protect your content during distribution.
" + }, + "RoleArn":{ + "shape":"SpekeKeyProviderRoleArnString", + "documentation":"The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess
The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.
The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection
The parameters for the SPEKE key provider.
" + }, + "SpekeKeyProviderDrmSystemsList":{ + "type":"list", + "member":{"shape":"DrmSystem"}, + "max":4, + "min":1 + }, + "SpekeKeyProviderResourceIdString":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[0-9a-zA-Z_-]+" + }, + "SpekeKeyProviderRoleArnString":{ + "type":"string", + "max":2048, + "min":1 + }, + "SpekeKeyProviderUrlString":{ + "type":"string", + "max":1024, + "min":1 + }, + "String":{"type":"string"}, + "TagArn":{"type":"string"}, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"TagArn", + "documentation":"The ARN of the MediaPackage resource that you're adding tags to.
", + "location":"uri", + "locationName":"ResourceArn" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
", + "locationName":"tags" + } + } + }, + "TagValue":{"type":"string"}, + "ThrottlingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request throughput limit was exceeded.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "TsEncryptionMethod":{ + "type":"string", + "enum":[ + "AES_128", + "SAMPLE_AES" + ] + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"TagArn", + "documentation":"The ARN of the MediaPackage resource that you're removing tags from.
", + "location":"uri", + "locationName":"ResourceArn" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"The list of tag keys to remove from the resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UpdateChannelGroupRequest":{ + "type":"structure", + "required":["ChannelGroupName"], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ETag":{ + "shape":"EntityTag", + "documentation":"The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.
", + "location":"header", + "locationName":"x-amzn-update-if-match" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"Any descriptive information that you want to add to the channel group for future identification purposes.
" + } + } + }, + "UpdateChannelGroupResponse":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "Arn", + "EgressDomain", + "CreatedAt", + "ModifiedAt" + ], + "members":{ + "ChannelGroupName":{ + "shape":"String", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
" + }, + "Arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with the resource.
" + }, + "EgressDomain":{ + "shape":"String", + "documentation":"The output domain where the source stream is sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel group was created.
" + }, + "ModifiedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel group was modified.
" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"The description for your channel group.
" + }, + "ETag":{ + "shape":"EntityTag", + "documentation":"The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The comma-separated list of tag key:value pairs assigned to the channel group.
", + "locationName":"tags" + } + } + }, + "UpdateChannelRequest":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
", + "location":"uri", + "locationName":"ChannelName" + }, + "ETag":{ + "shape":"EntityTag", + "documentation":"The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.
", + "location":"header", + "locationName":"x-amzn-update-if-match" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"Any descriptive information that you want to add to the channel for future identification purposes.
" + } + } + }, + "UpdateChannelResponse":{ + "type":"structure", + "required":[ + "Arn", + "ChannelName", + "ChannelGroupName", + "CreatedAt", + "ModifiedAt" + ], + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with the resource.
" + }, + "ChannelName":{ + "shape":"String", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
" + }, + "ChannelGroupName":{ + "shape":"String", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel was created.
" + }, + "ModifiedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the channel was modified.
" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"The description for your channel.
" + }, + "IngestEndpoints":{"shape":"IngestEndpointList"}, + "InputType":{ + "shape":"InputType", + "documentation":"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).
The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The comma-separated list of tag key:value pairs assigned to the channel.
", + "locationName":"tags" + } + } + }, + "UpdateOriginEndpointRequest":{ + "type":"structure", + "required":[ + "ChannelGroupName", + "ChannelName", + "OriginEndpointName", + "ContainerType" + ], + "members":{ + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
", + "location":"uri", + "locationName":"ChannelGroupName" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
", + "location":"uri", + "locationName":"ChannelName" + }, + "OriginEndpointName":{ + "shape":"ResourceName", + "documentation":"The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
", + "location":"uri", + "locationName":"OriginEndpointName" + }, + "ContainerType":{ + "shape":"ContainerType", + "documentation":"The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.
" + }, + "Segment":{ + "shape":"Segment", + "documentation":"The segment configuration, including the segment name, duration, and other configuration values.
" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"Any descriptive information that you want to add to the origin endpoint for future identification purposes.
" + }, + "StartoverWindowSeconds":{ + "shape":"UpdateOriginEndpointRequestStartoverWindowSecondsInteger", + "documentation":"The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).
" + }, + "HlsManifests":{ + "shape":"CreateHlsManifests", + "documentation":"An HTTP live streaming (HLS) manifest configuration.
" + }, + "LowLatencyHlsManifests":{ + "shape":"CreateLowLatencyHlsManifests", + "documentation":"A low-latency HLS manifest configuration.
" + }, + "DashManifests":{ + "shape":"CreateDashManifests", + "documentation":"A DASH manifest configuration.
" + }, + "ForceEndpointErrorConfiguration":{ + "shape":"ForceEndpointErrorConfiguration", + "documentation":"The failover settings for the endpoint.
" + }, + "ETag":{ + "shape":"EntityTag", + "documentation":"The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.
", + "location":"header", + "locationName":"x-amzn-update-if-match" + } + } + }, + "UpdateOriginEndpointRequestStartoverWindowSecondsInteger":{ + "type":"integer", + "box":true, + "max":1209600, + "min":60 + }, + "UpdateOriginEndpointResponse":{ + "type":"structure", + "required":[ + "Arn", + "ChannelGroupName", + "ChannelName", + "OriginEndpointName", + "ContainerType", + "Segment", + "CreatedAt", + "ModifiedAt" + ], + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The ARN associated with the resource.
" + }, + "ChannelGroupName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
" + }, + "ChannelName":{ + "shape":"ResourceName", + "documentation":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
" + }, + "OriginEndpointName":{ + "shape":"ResourceName", + "documentation":"The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
" + }, + "ContainerType":{ + "shape":"ContainerType", + "documentation":"The type of container attached to this origin endpoint.
" + }, + "Segment":{ + "shape":"Segment", + "documentation":"The segment configuration, including the segment name, duration, and other configuration values.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the origin endpoint was created.
" + }, + "ModifiedAt":{ + "shape":"Timestamp", + "documentation":"The date and time the origin endpoint was modified.
" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"The description of the origin endpoint.
" + }, + "StartoverWindowSeconds":{ + "shape":"Integer", + "documentation":"The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.
" + }, + "HlsManifests":{ + "shape":"GetHlsManifests", + "documentation":"An HTTP live streaming (HLS) manifest configuration.
" + }, + "LowLatencyHlsManifests":{ + "shape":"GetLowLatencyHlsManifests", + "documentation":"A low-latency HLS manifest configuration.
" + }, + "ForceEndpointErrorConfiguration":{ + "shape":"ForceEndpointErrorConfiguration", + "documentation":"The failover settings for the endpoint.
" + }, + "ETag":{ + "shape":"EntityTag", + "documentation":"The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The comma-separated list of tag key:value pairs assigned to the origin endpoint.
", + "locationName":"tags" + }, + "DashManifests":{ + "shape":"GetDashManifests", + "documentation":"A DASH manifest configuration.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ValidationExceptionType":{ + "shape":"ValidationExceptionType", + "documentation":"The type of ValidationException.
" + } + }, + "documentation":"The input failed to meet the constraints specified by the AWS service.
", + "exception":true + }, + "ValidationExceptionType":{ + "type":"string", + "enum":[ + "CONTAINER_TYPE_IMMUTABLE", + "INVALID_PAGINATION_TOKEN", + "INVALID_PAGINATION_MAX_RESULTS", + "INVALID_POLICY", + "INVALID_ROLE_ARN", + "MANIFEST_NAME_COLLISION", + "ENCRYPTION_METHOD_CONTAINER_TYPE_MISMATCH", + "CENC_IV_INCOMPATIBLE", + "ENCRYPTION_CONTRACT_WITHOUT_AUDIO_RENDITION_INCOMPATIBLE", + "ENCRYPTION_CONTRACT_UNENCRYPTED", + "ENCRYPTION_CONTRACT_SHARED", + "NUM_MANIFESTS_LOW", + "NUM_MANIFESTS_HIGH", + "MANIFEST_DRM_SYSTEMS_INCOMPATIBLE", + "DRM_SYSTEMS_ENCRYPTION_METHOD_INCOMPATIBLE", + "ROLE_ARN_NOT_ASSUMABLE", + "ROLE_ARN_LENGTH_OUT_OF_RANGE", + "ROLE_ARN_INVALID_FORMAT", + "URL_INVALID", + "URL_SCHEME", + "URL_USER_INFO", + "URL_PORT", + "URL_UNKNOWN_HOST", + "URL_LOCAL_ADDRESS", + "URL_LOOPBACK_ADDRESS", + "URL_LINK_LOCAL_ADDRESS", + "URL_MULTICAST_ADDRESS", + "MEMBER_INVALID", + "MEMBER_MISSING", + "MEMBER_MIN_VALUE", + "MEMBER_MAX_VALUE", + "MEMBER_MIN_LENGTH", + "MEMBER_MAX_LENGTH", + "MEMBER_INVALID_ENUM_VALUE", + "MEMBER_DOES_NOT_MATCH_PATTERN", + "INVALID_MANIFEST_FILTER", + "INVALID_TIME_DELAY_SECONDS", + "END_TIME_EARLIER_THAN_START_TIME", + "TS_CONTAINER_TYPE_WITH_DASH_MANIFEST", + "DIRECT_MODE_WITH_TIMING_SOURCE", + "NONE_MODE_WITH_TIMING_SOURCE", + "TIMING_SOURCE_MISSING", + "UPDATE_PERIOD_SMALLER_THAN_SEGMENT_DURATION", + "PERIOD_TRIGGERS_NONE_SPECIFIED_WITH_ADDITIONAL_VALUES", + "DRM_SIGNALING_MISMATCH_SEGMENT_ENCRYPTION_STATUS", + "ONLY_CMAF_INPUT_TYPE_ALLOW_FORCE_ENDPOINT_ERROR_CONFIGURATION", + "SOURCE_DISRUPTIONS_ENABLED_INCORRECTLY" + ] + } + }, + "documentation":"This guide is intended for creating AWS Elemental MediaPackage resources in MediaPackage Version 2 (v2) starting from May 2023. To get started with MediaPackage v2, create your MediaPackage resources. There isn't an automated process to migrate your resources from MediaPackage v1 to MediaPackage v2.
The names of the entities that you use to access this API, like URLs and ARNs, all have the versioning information added, like \"v2\", to distinguish from the prior version. If you used MediaPackage prior to this release, you can't use the MediaPackage v2 CLI or the MediaPackage v2 API to access any MediaPackage v1 resources.
If you created resources in MediaPackage v1, use video on demand (VOD) workflows, and aren't looking to migrate to MediaPackage v2 yet, see the MediaPackage v1 Live API Reference.
This is the AWS Elemental MediaPackage v2 Live REST API Reference. It describes all the MediaPackage API operations for live content in detail, and provides sample requests, responses, and errors for the supported web services protocols.
We assume that you have the IAM permissions that you need to use MediaPackage via the REST API. We also assume that you are familiar with the features and operations of MediaPackage, as described in the AWS Elemental MediaPackage User Guide.
" +} diff --git a/testbed/boto__botocore/botocore/data/mediapackagev2/2022-12-25/waiters-2.json b/testbed/boto__botocore/botocore/data/mediapackagev2/2022-12-25/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..13f60ee66be6a3d75208653e2bd7b563561adacc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/mediapackagev2/2022-12-25/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/testbed/boto__botocore/botocore/data/medical-imaging/2023-07-19/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/medical-imaging/2023-07-19/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..f7497e444363be8dc00fb14c1e90ed77250001f1 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/medical-imaging/2023-07-19/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://medical-imaging-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://medical-imaging-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://medical-imaging.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://medical-imaging.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/medical-imaging/2023-07-19/paginators-1.json b/testbed/boto__botocore/botocore/data/medical-imaging/2023-07-19/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..807d05276fb8f18ef7eca06b0a34eb62478c551a --- /dev/null +++ b/testbed/boto__botocore/botocore/data/medical-imaging/2023-07-19/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "ListDICOMImportJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "jobSummaries" + }, + "ListDatastores": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "datastoreSummaries" + }, + "ListImageSetVersions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "imageSetPropertiesList" + }, + "SearchImageSets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "imageSetsMetadataSummaries" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/medical-imaging/2023-07-19/paginators-1.sdk-extras.json b/testbed/boto__botocore/botocore/data/medical-imaging/2023-07-19/paginators-1.sdk-extras.json new file mode 100644 index 0000000000000000000000000000000000000000..383da17d3bbd9721e8fcf9177bc28bc16f0791e8 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/medical-imaging/2023-07-19/paginators-1.sdk-extras.json @@ -0,0 +1,12 @@ +{ + "version": 1.0, + "merge": { + "pagination": { + "SearchImageSets": { + "non_aggregate_keys": [ + "sort" + ] + } + } + } +} diff --git a/testbed/boto__botocore/botocore/data/medical-imaging/2023-07-19/service-2.json b/testbed/boto__botocore/botocore/data/medical-imaging/2023-07-19/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..4f4168da52efec47754987b4c23bab2c9d4e3782 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/medical-imaging/2023-07-19/service-2.json @@ -0,0 +1,2215 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2023-07-19", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"medical-imaging", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"AWS Health Imaging", + "serviceId":"Medical Imaging", + "signatureVersion":"v4", + "signingName":"medical-imaging", + "uid":"medical-imaging-2023-07-19" + }, + "operations":{ + "CopyImageSet":{ + "name":"CopyImageSet", + "http":{ + "method":"POST", + "requestUri":"/datastore/{datastoreId}/imageSet/{sourceImageSetId}/copyImageSet", + "responseCode":200 + }, + "input":{"shape":"CopyImageSetRequest"}, + "output":{"shape":"CopyImageSetResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Copy an image set.
", + "endpoint":{"hostPrefix":"runtime-"} + }, + "CreateDatastore":{ + "name":"CreateDatastore", + "http":{ + "method":"POST", + "requestUri":"/datastore", + "responseCode":200 + }, + "input":{"shape":"CreateDatastoreRequest"}, + "output":{"shape":"CreateDatastoreResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Create a data store.
", + "idempotent":true + }, + "DeleteDatastore":{ + "name":"DeleteDatastore", + "http":{ + "method":"DELETE", + "requestUri":"/datastore/{datastoreId}", + "responseCode":200 + }, + "input":{"shape":"DeleteDatastoreRequest"}, + "output":{"shape":"DeleteDatastoreResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Delete a data store.
Before a data store can be deleted, you must first delete all image sets within it.
Delete an image set.
", + "endpoint":{"hostPrefix":"runtime-"}, + "idempotent":true + }, + "GetDICOMImportJob":{ + "name":"GetDICOMImportJob", + "http":{ + "method":"GET", + "requestUri":"/getDICOMImportJob/datastore/{datastoreId}/job/{jobId}", + "responseCode":200 + }, + "input":{"shape":"GetDICOMImportJobRequest"}, + "output":{"shape":"GetDICOMImportJobResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Get the import job properties to learn more about the job or job progress.
The jobStatus refers to the execution of the import job. Therefore, an import job can return a jobStatus as COMPLETED even if validation issues are discovered during the import process. If a jobStatus returns as COMPLETED, we still recommend you review the output manifests written to S3, as they provide details on the success or failure of individual P10 object imports.
Get data store properties.
" + }, + "GetImageFrame":{ + "name":"GetImageFrame", + "http":{ + "method":"POST", + "requestUri":"/datastore/{datastoreId}/imageSet/{imageSetId}/getImageFrame", + "responseCode":200 + }, + "input":{"shape":"GetImageFrameRequest"}, + "output":{"shape":"GetImageFrameResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Get an image frame (pixel data) for an image set.
", + "endpoint":{"hostPrefix":"runtime-"} + }, + "GetImageSet":{ + "name":"GetImageSet", + "http":{ + "method":"POST", + "requestUri":"/datastore/{datastoreId}/imageSet/{imageSetId}/getImageSet", + "responseCode":200 + }, + "input":{"shape":"GetImageSetRequest"}, + "output":{"shape":"GetImageSetResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Get image set properties.
", + "endpoint":{"hostPrefix":"runtime-"} + }, + "GetImageSetMetadata":{ + "name":"GetImageSetMetadata", + "http":{ + "method":"POST", + "requestUri":"/datastore/{datastoreId}/imageSet/{imageSetId}/getImageSetMetadata", + "responseCode":200 + }, + "input":{"shape":"GetImageSetMetadataRequest"}, + "output":{"shape":"GetImageSetMetadataResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Get metadata attributes for an image set.
", + "endpoint":{"hostPrefix":"runtime-"} + }, + "ListDICOMImportJobs":{ + "name":"ListDICOMImportJobs", + "http":{ + "method":"GET", + "requestUri":"/listDICOMImportJobs/datastore/{datastoreId}", + "responseCode":200 + }, + "input":{"shape":"ListDICOMImportJobsRequest"}, + "output":{"shape":"ListDICOMImportJobsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"List import jobs created for a specific data store.
" + }, + "ListDatastores":{ + "name":"ListDatastores", + "http":{ + "method":"GET", + "requestUri":"/datastore", + "responseCode":200 + }, + "input":{"shape":"ListDatastoresRequest"}, + "output":{"shape":"ListDatastoresResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"List data stores.
" + }, + "ListImageSetVersions":{ + "name":"ListImageSetVersions", + "http":{ + "method":"POST", + "requestUri":"/datastore/{datastoreId}/imageSet/{imageSetId}/listImageSetVersions", + "responseCode":200 + }, + "input":{"shape":"ListImageSetVersionsRequest"}, + "output":{"shape":"ListImageSetVersionsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"List image set versions.
", + "endpoint":{"hostPrefix":"runtime-"} + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Lists all tags associated with a medical imaging resource.
" + }, + "SearchImageSets":{ + "name":"SearchImageSets", + "http":{ + "method":"POST", + "requestUri":"/datastore/{datastoreId}/searchImageSets", + "responseCode":200 + }, + "input":{"shape":"SearchImageSetsRequest"}, + "output":{"shape":"SearchImageSetsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Search image sets based on defined input attributes.
SearchImageSets accepts a single search query parameter and returns a paginated response of all image sets that have the matching criteria. All date range queries must be input as (lowerBound, upperBound).
By default, SearchImageSets uses the updatedAt field for sorting in descending order from newest to oldest.
Start importing bulk data into an ACTIVE data store. The import job imports DICOM P10 files found in the S3 prefix specified by the inputS3Uri parameter. The import job stores processing results in the file specified by the outputS3Uri parameter.
Adds a user-specifed key and value tag to a medical imaging resource.
", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Removes tags from a medical imaging resource.
", + "idempotent":true + }, + "UpdateImageSetMetadata":{ + "name":"UpdateImageSetMetadata", + "http":{ + "method":"POST", + "requestUri":"/datastore/{datastoreId}/imageSet/{imageSetId}/updateImageSetMetadata", + "responseCode":200 + }, + "input":{"shape":"UpdateImageSetMetadataRequest"}, + "output":{"shape":"UpdateImageSetMetadataResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Update image set metadata attributes.
", + "endpoint":{"hostPrefix":"runtime-"} + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The user does not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "Arn":{ + "type":"string", + "pattern":"arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:medical-imaging:[a-z0-9-]+:[0-9]{12}:datastore/[0-9a-z]{32}(/imageset/[0-9a-z]{32})?" + }, + "AwsAccountId":{ + "type":"string", + "max":12, + "min":12, + "pattern":"\\d+" + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ClientToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z0-9._-]+" + }, + "ConflictException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Updating or deleting a resource can cause an inconsistent state.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CopiableAttributes":{ + "type":"string", + "max":260000, + "min":1, + "sensitive":true + }, + "CopyDestinationImageSet":{ + "type":"structure", + "required":[ + "imageSetId", + "latestVersionId" + ], + "members":{ + "imageSetId":{ + "shape":"ImageSetId", + "documentation":"The image set identifier for the destination image set.
" + }, + "latestVersionId":{ + "shape":"ImageSetExternalVersionId", + "documentation":"The latest version identifier for the destination image set.
" + } + }, + "documentation":"Copy the destination image set.
" + }, + "CopyDestinationImageSetProperties":{ + "type":"structure", + "required":[ + "imageSetId", + "latestVersionId" + ], + "members":{ + "imageSetId":{ + "shape":"ImageSetId", + "documentation":"The image set identifier of the copied image set properties.
" + }, + "latestVersionId":{ + "shape":"ImageSetExternalVersionId", + "documentation":"The latest version identifier for the destination image set properties.
" + }, + "imageSetState":{ + "shape":"ImageSetState", + "documentation":"The image set state of the destination image set properties.
" + }, + "imageSetWorkflowStatus":{ + "shape":"ImageSetWorkflowStatus", + "documentation":"The image set workflow status of the destination image set properties.
" + }, + "createdAt":{ + "shape":"Date", + "documentation":"The timestamp when the destination image set properties were created.
" + }, + "updatedAt":{ + "shape":"Date", + "documentation":"The timestamp when the destination image set properties were last updated.
" + }, + "imageSetArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) assigned to the destination image set.
" + } + }, + "documentation":"Copy the image set properties of the destination image set.
" + }, + "CopyImageSetInformation":{ + "type":"structure", + "required":["sourceImageSet"], + "members":{ + "sourceImageSet":{ + "shape":"CopySourceImageSetInformation", + "documentation":"The source image set.
" + }, + "destinationImageSet":{ + "shape":"CopyDestinationImageSet", + "documentation":"The destination image set.
" + } + }, + "documentation":"Copy image set information.
" + }, + "CopyImageSetRequest":{ + "type":"structure", + "required":[ + "datastoreId", + "sourceImageSetId", + "copyImageSetInformation" + ], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
", + "location":"uri", + "locationName":"datastoreId" + }, + "sourceImageSetId":{ + "shape":"ImageSetId", + "documentation":"The source image set identifier.
", + "location":"uri", + "locationName":"sourceImageSetId" + }, + "copyImageSetInformation":{ + "shape":"CopyImageSetInformation", + "documentation":"Copy image set information.
" + }, + "force":{ + "shape":"Boolean", + "documentation":"Setting this flag will force the CopyImageSet operation, even if Patient, Study, or Series level metadata are mismatched across the sourceImageSet and destinationImageSet.
The data store identifier.
" + }, + "sourceImageSetProperties":{ + "shape":"CopySourceImageSetProperties", + "documentation":"The properties of the source image set.
" + }, + "destinationImageSetProperties":{ + "shape":"CopyDestinationImageSetProperties", + "documentation":"The properties of the destination image set.
" + } + } + }, + "CopySourceImageSetInformation":{ + "type":"structure", + "required":["latestVersionId"], + "members":{ + "latestVersionId":{ + "shape":"ImageSetExternalVersionId", + "documentation":"The latest version identifier for the source image set.
" + }, + "DICOMCopies":{ + "shape":"MetadataCopies", + "documentation":"Contains MetadataCopies structure and wraps information related to specific copy use cases. For example, when copying subsets.
Copy source image set information.
" + }, + "CopySourceImageSetProperties":{ + "type":"structure", + "required":[ + "imageSetId", + "latestVersionId" + ], + "members":{ + "imageSetId":{ + "shape":"ImageSetId", + "documentation":"The image set identifier for the copied source image set.
" + }, + "latestVersionId":{ + "shape":"ImageSetExternalVersionId", + "documentation":"The latest version identifier for the copied source image set.
" + }, + "imageSetState":{ + "shape":"ImageSetState", + "documentation":"The image set state of the copied source image set.
" + }, + "imageSetWorkflowStatus":{ + "shape":"ImageSetWorkflowStatus", + "documentation":"The workflow status of the copied source image set.
" + }, + "createdAt":{ + "shape":"Date", + "documentation":"The timestamp when the source image set properties were created.
" + }, + "updatedAt":{ + "shape":"Date", + "documentation":"The timestamp when the source image set properties were updated.
" + }, + "imageSetArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) assigned to the source image set.
" + } + }, + "documentation":"Copy source image set properties.
" + }, + "CreateDatastoreRequest":{ + "type":"structure", + "required":["clientToken"], + "members":{ + "datastoreName":{ + "shape":"DatastoreName", + "documentation":"The data store name.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique identifier for API idempotency.
", + "idempotencyToken":true + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags provided when creating a data store.
" + }, + "kmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.
" + } + } + }, + "CreateDatastoreResponse":{ + "type":"structure", + "required":[ + "datastoreId", + "datastoreStatus" + ], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
" + }, + "datastoreStatus":{ + "shape":"DatastoreStatus", + "documentation":"The data store status.
" + } + } + }, + "DICOMAccessionNumber":{ + "type":"string", + "max":256, + "min":0, + "sensitive":true + }, + "DICOMAttribute":{ + "type":"blob", + "max":10000, + "min":1, + "sensitive":true + }, + "DICOMImportJobProperties":{ + "type":"structure", + "required":[ + "jobId", + "jobName", + "jobStatus", + "datastoreId", + "dataAccessRoleArn", + "inputS3Uri", + "outputS3Uri" + ], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"The import job identifier.
" + }, + "jobName":{ + "shape":"JobName", + "documentation":"The import job name.
" + }, + "jobStatus":{ + "shape":"JobStatus", + "documentation":"The filters for listing import jobs based on status.
" + }, + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
" + }, + "dataAccessRoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.
" + }, + "endedAt":{ + "shape":"Date", + "documentation":"The timestamp for when the import job was ended.
" + }, + "submittedAt":{ + "shape":"Date", + "documentation":"The timestamp for when the import job was submitted.
" + }, + "inputS3Uri":{ + "shape":"S3Uri", + "documentation":"The input prefix path for the S3 bucket that contains the DICOM P10 files to be imported.
" + }, + "outputS3Uri":{ + "shape":"S3Uri", + "documentation":"The output prefix of the S3 bucket to upload the results of the DICOM import job.
" + }, + "message":{ + "shape":"Message", + "documentation":"The error message thrown if an import job fails.
" + } + }, + "documentation":"Properties of the import job.
" + }, + "DICOMImportJobSummaries":{ + "type":"list", + "member":{"shape":"DICOMImportJobSummary"} + }, + "DICOMImportJobSummary":{ + "type":"structure", + "required":[ + "jobId", + "jobName", + "jobStatus", + "datastoreId" + ], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"The import job identifier.
" + }, + "jobName":{ + "shape":"JobName", + "documentation":"The import job name.
" + }, + "jobStatus":{ + "shape":"JobStatus", + "documentation":"The filters for listing import jobs based on status.
" + }, + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
" + }, + "dataAccessRoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.
" + }, + "endedAt":{ + "shape":"Date", + "documentation":"The timestamp when an import job ended.
" + }, + "submittedAt":{ + "shape":"Date", + "documentation":"The timestamp when an import job was submitted.
" + }, + "message":{ + "shape":"Message", + "documentation":"The error message thrown if an import job fails.
" + } + }, + "documentation":"Summary of import job.
" + }, + "DICOMNumberOfStudyRelatedInstances":{ + "type":"integer", + "max":10000, + "min":0 + }, + "DICOMNumberOfStudyRelatedSeries":{ + "type":"integer", + "max":1000000, + "min":0 + }, + "DICOMPatientBirthDate":{ + "type":"string", + "max":18, + "min":0, + "sensitive":true + }, + "DICOMPatientId":{ + "type":"string", + "max":256, + "min":0, + "sensitive":true + }, + "DICOMPatientName":{ + "type":"string", + "max":256, + "min":0, + "sensitive":true + }, + "DICOMPatientSex":{ + "type":"string", + "max":16, + "min":0, + "sensitive":true + }, + "DICOMSeriesBodyPart":{ + "type":"string", + "max":64, + "min":0, + "sensitive":true + }, + "DICOMSeriesInstanceUID":{ + "type":"string", + "max":256, + "min":0, + "pattern":"(?:[0-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*", + "sensitive":true + }, + "DICOMSeriesModality":{ + "type":"string", + "max":16, + "min":0, + "sensitive":true + }, + "DICOMSeriesNumber":{ + "type":"integer", + "box":true, + "max":2147483647, + "min":-2147483648, + "sensitive":true + }, + "DICOMStudyDate":{ + "type":"string", + "max":18, + "min":0, + "sensitive":true + }, + "DICOMStudyDateAndTime":{ + "type":"structure", + "required":["DICOMStudyDate"], + "members":{ + "DICOMStudyDate":{ + "shape":"DICOMStudyDate", + "documentation":"The DICOM study date provided in yyMMdd format.
The DICOM study time provided in HHmmss.FFFFFF format.
The aggregated structure to store DICOM study date and study time for search capabilities.
" + }, + "DICOMStudyDescription":{ + "type":"string", + "max":64, + "min":0, + "sensitive":true + }, + "DICOMStudyId":{ + "type":"string", + "max":16, + "min":0, + "sensitive":true + }, + "DICOMStudyInstanceUID":{ + "type":"string", + "max":256, + "min":0, + "pattern":"(?:[0-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*", + "sensitive":true + }, + "DICOMStudyTime":{ + "type":"string", + "max":28, + "min":0, + "sensitive":true + }, + "DICOMTags":{ + "type":"structure", + "members":{ + "DICOMPatientId":{ + "shape":"DICOMPatientId", + "documentation":"The unique identifier for a patient in a DICOM Study.
" + }, + "DICOMPatientName":{ + "shape":"DICOMPatientName", + "documentation":"The patient name.
" + }, + "DICOMPatientBirthDate":{ + "shape":"DICOMPatientBirthDate", + "documentation":"The patient birth date.
" + }, + "DICOMPatientSex":{ + "shape":"DICOMPatientSex", + "documentation":"The patient sex.
" + }, + "DICOMStudyInstanceUID":{ + "shape":"DICOMStudyInstanceUID", + "documentation":"The DICOM provided identifier for the Study Instance UID.
" + }, + "DICOMStudyId":{ + "shape":"DICOMStudyId", + "documentation":"The DICOM provided identifier for the Study ID.
" + }, + "DICOMStudyDescription":{ + "shape":"DICOMStudyDescription", + "documentation":"The DICOM provided Study Description.
" + }, + "DICOMNumberOfStudyRelatedSeries":{ + "shape":"DICOMNumberOfStudyRelatedSeries", + "documentation":"The total number of series in the DICOM study.
" + }, + "DICOMNumberOfStudyRelatedInstances":{ + "shape":"DICOMNumberOfStudyRelatedInstances", + "documentation":"The total number of instances in the DICOM study.
" + }, + "DICOMAccessionNumber":{ + "shape":"DICOMAccessionNumber", + "documentation":"The accession number for the DICOM study.
" + }, + "DICOMSeriesInstanceUID":{ + "shape":"DICOMSeriesInstanceUID", + "documentation":"The DICOM provided identifier for the Series Instance UID.
" + }, + "DICOMSeriesModality":{ + "shape":"DICOMSeriesModality", + "documentation":"The DICOM provided identifier for the series Modality.
" + }, + "DICOMSeriesBodyPart":{ + "shape":"DICOMSeriesBodyPart", + "documentation":"The DICOM provided identifier for the series Body Part Examined.
" + }, + "DICOMSeriesNumber":{ + "shape":"DICOMSeriesNumber", + "documentation":"The DICOM provided identifier for the Series Number.
" + }, + "DICOMStudyDate":{ + "shape":"DICOMStudyDate", + "documentation":"The study date.
" + }, + "DICOMStudyTime":{ + "shape":"DICOMStudyTime", + "documentation":"The study time.
" + } + }, + "documentation":"The DICOM attributes returned as a part of a response. Each image set has these properties as part of a search result.
" + }, + "DICOMUpdates":{ + "type":"structure", + "members":{ + "removableAttributes":{ + "shape":"DICOMAttribute", + "documentation":"The DICOM tags to be removed from ImageSetMetadata.
The DICOM tags that need to be updated in ImageSetMetadata.
The object containing removableAttributes and updatableAttributes.
The data store identifier.
" + }, + "datastoreName":{ + "shape":"DatastoreName", + "documentation":"The data store name.
" + }, + "datastoreStatus":{ + "shape":"DatastoreStatus", + "documentation":"The data store status.
" + }, + "kmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.
" + }, + "datastoreArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) for the data store.
" + }, + "createdAt":{ + "shape":"Date", + "documentation":"The timestamp when the data store was created.
" + }, + "updatedAt":{ + "shape":"Date", + "documentation":"The timestamp when the data store was last updated.
" + } + }, + "documentation":"The properties associated with the data store.
" + }, + "DatastoreStatus":{ + "type":"string", + "enum":[ + "CREATING", + "CREATE_FAILED", + "ACTIVE", + "DELETING", + "DELETED" + ] + }, + "DatastoreSummaries":{ + "type":"list", + "member":{"shape":"DatastoreSummary"} + }, + "DatastoreSummary":{ + "type":"structure", + "required":[ + "datastoreId", + "datastoreName", + "datastoreStatus" + ], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
" + }, + "datastoreName":{ + "shape":"DatastoreName", + "documentation":"The data store name.
" + }, + "datastoreStatus":{ + "shape":"DatastoreStatus", + "documentation":"The data store status.
" + }, + "datastoreArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) for the data store.
" + }, + "createdAt":{ + "shape":"Date", + "documentation":"The timestamp when the data store was created.
" + }, + "updatedAt":{ + "shape":"Date", + "documentation":"The timestamp when the data store was last updated.
" + } + }, + "documentation":"List of summaries of data stores.
" + }, + "Date":{"type":"timestamp"}, + "DeleteDatastoreRequest":{ + "type":"structure", + "required":["datastoreId"], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
", + "location":"uri", + "locationName":"datastoreId" + } + } + }, + "DeleteDatastoreResponse":{ + "type":"structure", + "required":[ + "datastoreId", + "datastoreStatus" + ], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
" + }, + "datastoreStatus":{ + "shape":"DatastoreStatus", + "documentation":"The data store status.
" + } + } + }, + "DeleteImageSetRequest":{ + "type":"structure", + "required":[ + "datastoreId", + "imageSetId" + ], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
", + "location":"uri", + "locationName":"datastoreId" + }, + "imageSetId":{ + "shape":"ImageSetId", + "documentation":"The image set identifier.
", + "location":"uri", + "locationName":"imageSetId" + } + } + }, + "DeleteImageSetResponse":{ + "type":"structure", + "required":[ + "datastoreId", + "imageSetId", + "imageSetState", + "imageSetWorkflowStatus" + ], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
" + }, + "imageSetId":{ + "shape":"ImageSetId", + "documentation":"The image set identifier.
" + }, + "imageSetState":{ + "shape":"ImageSetState", + "documentation":"The image set state.
" + }, + "imageSetWorkflowStatus":{ + "shape":"ImageSetWorkflowStatus", + "documentation":"The image set workflow status.
" + } + } + }, + "GetDICOMImportJobRequest":{ + "type":"structure", + "required":[ + "datastoreId", + "jobId" + ], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
", + "location":"uri", + "locationName":"datastoreId" + }, + "jobId":{ + "shape":"JobId", + "documentation":"The import job identifier.
", + "location":"uri", + "locationName":"jobId" + } + } + }, + "GetDICOMImportJobResponse":{ + "type":"structure", + "required":["jobProperties"], + "members":{ + "jobProperties":{ + "shape":"DICOMImportJobProperties", + "documentation":"The properties of the import job.
" + } + } + }, + "GetDatastoreRequest":{ + "type":"structure", + "required":["datastoreId"], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
", + "location":"uri", + "locationName":"datastoreId" + } + } + }, + "GetDatastoreResponse":{ + "type":"structure", + "required":["datastoreProperties"], + "members":{ + "datastoreProperties":{ + "shape":"DatastoreProperties", + "documentation":"The data store properties.
" + } + } + }, + "GetImageFrameRequest":{ + "type":"structure", + "required":[ + "datastoreId", + "imageSetId", + "imageFrameInformation" + ], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
", + "location":"uri", + "locationName":"datastoreId" + }, + "imageSetId":{ + "shape":"ImageSetId", + "documentation":"The image set identifier.
", + "location":"uri", + "locationName":"imageSetId" + }, + "imageFrameInformation":{ + "shape":"ImageFrameInformation", + "documentation":"Information about the image frame (pixel data) identifier.
" + } + }, + "payload":"imageFrameInformation" + }, + "GetImageFrameResponse":{ + "type":"structure", + "required":["imageFrameBlob"], + "members":{ + "imageFrameBlob":{ + "shape":"PayloadBlob", + "documentation":"The blob containing the aggregated image frame information.
" + }, + "contentType":{ + "shape":"String", + "documentation":"The format in which the image frame information is returned to the customer. Default is application/octet-stream.
The data store identifier.
", + "location":"uri", + "locationName":"datastoreId" + }, + "imageSetId":{ + "shape":"ImageSetId", + "documentation":"The image set identifier.
", + "location":"uri", + "locationName":"imageSetId" + }, + "versionId":{ + "shape":"ImageSetExternalVersionId", + "documentation":"The image set version identifier.
", + "location":"querystring", + "locationName":"version" + } + } + }, + "GetImageSetMetadataResponse":{ + "type":"structure", + "required":["imageSetMetadataBlob"], + "members":{ + "imageSetMetadataBlob":{ + "shape":"ImageSetMetadataBlob", + "documentation":"The blob containing the aggregated metadata information for the image set.
" + }, + "contentType":{ + "shape":"String", + "documentation":"The format in which the study metadata is returned to the customer. Default is text/plain.
The compression format in which image set metadata attributes are returned.
", + "location":"header", + "locationName":"Content-Encoding" + } + }, + "payload":"imageSetMetadataBlob" + }, + "GetImageSetRequest":{ + "type":"structure", + "required":[ + "datastoreId", + "imageSetId" + ], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
", + "location":"uri", + "locationName":"datastoreId" + }, + "imageSetId":{ + "shape":"ImageSetId", + "documentation":"The image set identifier.
", + "location":"uri", + "locationName":"imageSetId" + }, + "versionId":{ + "shape":"ImageSetExternalVersionId", + "documentation":"The image set version identifier.
", + "location":"querystring", + "locationName":"version" + } + } + }, + "GetImageSetResponse":{ + "type":"structure", + "required":[ + "datastoreId", + "imageSetId", + "versionId", + "imageSetState" + ], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
" + }, + "imageSetId":{ + "shape":"ImageSetId", + "documentation":"The image set identifier.
" + }, + "versionId":{ + "shape":"ImageSetExternalVersionId", + "documentation":"The image set version identifier.
" + }, + "imageSetState":{ + "shape":"ImageSetState", + "documentation":"The image set state.
" + }, + "imageSetWorkflowStatus":{ + "shape":"ImageSetWorkflowStatus", + "documentation":"The image set workflow status.
" + }, + "createdAt":{ + "shape":"Date", + "documentation":"The timestamp when image set properties were created.
" + }, + "updatedAt":{ + "shape":"Date", + "documentation":"The timestamp when image set properties were updated.
" + }, + "deletedAt":{ + "shape":"Date", + "documentation":"The timestamp when the image set properties were deleted.
" + }, + "message":{ + "shape":"Message", + "documentation":"The error message thrown if an image set action fails.
" + }, + "imageSetArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) assigned to the image set.
" + }, + "overrides":{ + "shape":"Overrides", + "documentation":"This object contains the details of any overrides used while creating a specific image set version. If an image set was copied or updated using the force flag, this object will contain the forced flag.
The image frame (pixel data) identifier.
" + } + }, + "documentation":"Information about the image frame (pixel data) identifier.
" + }, + "ImageSetExternalVersionId":{ + "type":"string", + "pattern":"\\d+" + }, + "ImageSetId":{ + "type":"string", + "pattern":"[0-9a-z]{32}" + }, + "ImageSetMetadataBlob":{ + "type":"blob", + "streaming":true + }, + "ImageSetProperties":{ + "type":"structure", + "required":[ + "imageSetId", + "versionId", + "imageSetState" + ], + "members":{ + "imageSetId":{ + "shape":"ImageSetId", + "documentation":"The image set identifier.
" + }, + "versionId":{ + "shape":"ImageSetExternalVersionId", + "documentation":"The image set version identifier.
" + }, + "imageSetState":{ + "shape":"ImageSetState", + "documentation":"The image set state.
" + }, + "ImageSetWorkflowStatus":{ + "shape":"ImageSetWorkflowStatus", + "documentation":"The image set workflow status.
" + }, + "createdAt":{ + "shape":"Date", + "documentation":"The timestamp when the image set properties were created.
" + }, + "updatedAt":{ + "shape":"Date", + "documentation":"The timestamp when the image set properties were updated.
" + }, + "deletedAt":{ + "shape":"Date", + "documentation":"The timestamp when the image set properties were deleted.
" + }, + "message":{ + "shape":"Message", + "documentation":"The error message thrown if an image set action fails.
" + }, + "overrides":{ + "shape":"Overrides", + "documentation":"Contains details on overrides used when creating the returned version of an image set. For example, if forced exists, the forced flag was used when creating the image set.
The image set properties.
" + }, + "ImageSetPropertiesList":{ + "type":"list", + "member":{"shape":"ImageSetProperties"} + }, + "ImageSetState":{ + "type":"string", + "enum":[ + "ACTIVE", + "LOCKED", + "DELETED" + ] + }, + "ImageSetWorkflowStatus":{ + "type":"string", + "enum":[ + "CREATED", + "COPIED", + "COPYING", + "COPYING_WITH_READ_ONLY_ACCESS", + "COPY_FAILED", + "UPDATING", + "UPDATED", + "UPDATE_FAILED", + "DELETING", + "DELETED" + ] + }, + "ImageSetsMetadataSummaries":{ + "type":"list", + "member":{"shape":"ImageSetsMetadataSummary"} + }, + "ImageSetsMetadataSummary":{ + "type":"structure", + "required":["imageSetId"], + "members":{ + "imageSetId":{ + "shape":"ImageSetId", + "documentation":"The image set identifier.
" + }, + "version":{ + "shape":"Integer", + "documentation":"The image set version.
" + }, + "createdAt":{ + "shape":"Date", + "documentation":"The time an image set is created. Sample creation date is provided in 1985-04-12T23:20:50.52Z format.
The time an image set was last updated.
" + }, + "DICOMTags":{ + "shape":"DICOMTags", + "documentation":"The DICOM tags associated with the image set.
" + } + }, + "documentation":"Summary of the image set metadata.
" + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"An unexpected error occurred during processing of the request.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "JobId":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[0-9a-z]+" + }, + "JobName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z0-9._/#-]+" + }, + "JobStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + }, + "KmsKeyArn":{ + "type":"string", + "documentation":"ARN referencing a KMS key or KMS key alias.
", + "max":512, + "min":1, + "pattern":"arn:aws[a-zA-Z-]{0,16}:kms:[a-z]{2}(-[a-z]{1,16}){1,3}-\\d{1}:\\d{12}:((key/[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})|(alias/[a-zA-Z0-9:/_-]{1,256}))" + }, + "ListDICOMImportJobsRequest":{ + "type":"structure", + "required":["datastoreId"], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
", + "location":"uri", + "locationName":"datastoreId" + }, + "jobStatus":{ + "shape":"JobStatus", + "documentation":"The filters for listing import jobs based on status.
", + "location":"querystring", + "locationName":"jobStatus" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token used to request the list of import jobs on the next page.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"ListDICOMImportJobsRequestMaxResultsInteger", + "documentation":"The max results count. The upper bound is determined by load testing.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListDICOMImportJobsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "ListDICOMImportJobsResponse":{ + "type":"structure", + "required":["jobSummaries"], + "members":{ + "jobSummaries":{ + "shape":"DICOMImportJobSummaries", + "documentation":"A list of job summaries.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token used to retrieve the list of import jobs on the next page.
" + } + } + }, + "ListDatastoresRequest":{ + "type":"structure", + "members":{ + "datastoreStatus":{ + "shape":"DatastoreStatus", + "documentation":"The data store status.
", + "location":"querystring", + "locationName":"datastoreStatus" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token used to request the list of data stores on the next page.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"ListDatastoresRequestMaxResultsInteger", + "documentation":"Valid Range: Minimum value of 1. Maximum value of 50.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListDatastoresRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "ListDatastoresResponse":{ + "type":"structure", + "members":{ + "datastoreSummaries":{ + "shape":"DatastoreSummaries", + "documentation":"The list of summaries of data stores.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token used to retrieve the list of data stores on the next page.
" + } + } + }, + "ListImageSetVersionsRequest":{ + "type":"structure", + "required":[ + "datastoreId", + "imageSetId" + ], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
", + "location":"uri", + "locationName":"datastoreId" + }, + "imageSetId":{ + "shape":"ImageSetId", + "documentation":"The image set identifier.
", + "location":"uri", + "locationName":"imageSetId" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token used to request the list of image set versions on the next page.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"ListImageSetVersionsRequestMaxResultsInteger", + "documentation":"The max results count.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListImageSetVersionsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "ListImageSetVersionsResponse":{ + "type":"structure", + "required":["imageSetPropertiesList"], + "members":{ + "imageSetPropertiesList":{ + "shape":"ImageSetPropertiesList", + "documentation":"Lists all properties associated with an image set.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token used to retrieve the list of image set versions on the next page.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the medical imaging resource to list tags for.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"A list of all tags associated with a medical imaging resource.
" + } + } + }, + "Message":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[\\w -:]+" + }, + "MetadataCopies":{ + "type":"structure", + "required":["copiableAttributes"], + "members":{ + "copiableAttributes":{ + "shape":"CopiableAttributes", + "documentation":"The JSON string used to specify a subset of SOP Instances to copy from source to destination image set.
" + } + }, + "documentation":"Contains copiable Attributes structure and wraps information related to specific copy use cases. For example, when copying subsets.
The object containing removableAttributes and updatableAttributes.
Specifies the previous image set version ID to revert the current image set back to.
You must provide either revertToVersionId or DICOMUpdates in your request. A ValidationException error is thrown if both parameters are provided at the same time.
Contains DICOMUpdates.
", + "union":true + }, + "NextToken":{ + "type":"string", + "max":8192, + "min":1, + "pattern":"\\p{ASCII}{0,8192}" + }, + "Operator":{ + "type":"string", + "enum":[ + "EQUAL", + "BETWEEN" + ] + }, + "Overrides":{ + "type":"structure", + "members":{ + "forced":{ + "shape":"Boolean", + "documentation":"Setting this flag will force the CopyImageSet and UpdateImageSetMetadata operations, even if Patient, Study, or Series level metadata are mismatched.
Specifies the overrides used in image set modification calls to CopyImageSet and UpdateImageSetMetadata.
The request references a resource which does not exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "RoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+" + }, + "S3Uri":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?" + }, + "SearchByAttributeValue":{ + "type":"structure", + "members":{ + "DICOMPatientId":{ + "shape":"DICOMPatientId", + "documentation":"The patient ID input for search.
" + }, + "DICOMAccessionNumber":{ + "shape":"DICOMAccessionNumber", + "documentation":"The DICOM accession number for search.
" + }, + "DICOMStudyId":{ + "shape":"DICOMStudyId", + "documentation":"The DICOM study ID for search.
" + }, + "DICOMStudyInstanceUID":{ + "shape":"DICOMStudyInstanceUID", + "documentation":"The DICOM study instance UID for search.
" + }, + "DICOMSeriesInstanceUID":{ + "shape":"DICOMSeriesInstanceUID", + "documentation":"The Series Instance UID input for search.
" + }, + "createdAt":{ + "shape":"Date", + "documentation":"The created at time of the image set provided for search.
" + }, + "updatedAt":{ + "shape":"Date", + "documentation":"The timestamp input for search.
" + }, + "DICOMStudyDateAndTime":{ + "shape":"DICOMStudyDateAndTime", + "documentation":"The aggregated structure containing DICOM study date and study time for search.
" + } + }, + "documentation":"The search input attribute value.
", + "union":true + }, + "SearchCriteria":{ + "type":"structure", + "members":{ + "filters":{ + "shape":"SearchCriteriaFiltersList", + "documentation":"The filters for the search criteria.
" + }, + "sort":{ + "shape":"Sort", + "documentation":"The sort input for search criteria.
" + } + }, + "documentation":"The search criteria.
", + "sensitive":true + }, + "SearchCriteriaFiltersList":{ + "type":"list", + "member":{"shape":"SearchFilter"}, + "max":2, + "min":1 + }, + "SearchFilter":{ + "type":"structure", + "required":[ + "values", + "operator" + ], + "members":{ + "values":{ + "shape":"SearchFilterValuesList", + "documentation":"The search filter values.
" + }, + "operator":{ + "shape":"Operator", + "documentation":"The search filter operator for imageSetDateTime.
The search filter.
" + }, + "SearchFilterValuesList":{ + "type":"list", + "member":{"shape":"SearchByAttributeValue"}, + "max":2, + "min":1 + }, + "SearchImageSetsRequest":{ + "type":"structure", + "required":["datastoreId"], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The identifier of the data store where the image sets reside.
", + "location":"uri", + "locationName":"datastoreId" + }, + "searchCriteria":{ + "shape":"SearchCriteria", + "documentation":"The search criteria that filters by applying a maximum of 1 item to SearchByAttribute.
The maximum number of results that can be returned in a search.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.
", + "location":"querystring", + "locationName":"nextToken" + } + }, + "payload":"searchCriteria" + }, + "SearchImageSetsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "SearchImageSetsResponse":{ + "type":"structure", + "required":["imageSetsMetadataSummaries"], + "members":{ + "imageSetsMetadataSummaries":{ + "shape":"ImageSetsMetadataSummaries", + "documentation":"The model containing the image set results.
" + }, + "sort":{ + "shape":"Sort", + "documentation":"The sort order for image set search results.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for pagination results.
" + } + } + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request caused a service quota to be exceeded.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "Sort":{ + "type":"structure", + "required":[ + "sortOrder", + "sortField" + ], + "members":{ + "sortOrder":{ + "shape":"SortOrder", + "documentation":"The sort order for search criteria.
" + }, + "sortField":{ + "shape":"SortField", + "documentation":"The sort field for search criteria.
" + } + }, + "documentation":"Sort search results.
" + }, + "SortField":{ + "type":"string", + "enum":[ + "updatedAt", + "createdAt", + "DICOMStudyDateAndTime" + ] + }, + "SortOrder":{ + "type":"string", + "enum":[ + "ASC", + "DESC" + ] + }, + "StartDICOMImportJobRequest":{ + "type":"structure", + "required":[ + "dataAccessRoleArn", + "clientToken", + "datastoreId", + "inputS3Uri", + "outputS3Uri" + ], + "members":{ + "jobName":{ + "shape":"JobName", + "documentation":"The import job name.
" + }, + "dataAccessRoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role that grants permission to access medical imaging resources.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique identifier for API idempotency.
", + "idempotencyToken":true + }, + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
", + "location":"uri", + "locationName":"datastoreId" + }, + "inputS3Uri":{ + "shape":"S3Uri", + "documentation":"The input prefix path for the S3 bucket that contains the DICOM files to be imported.
" + }, + "outputS3Uri":{ + "shape":"S3Uri", + "documentation":"The output prefix of the S3 bucket to upload the results of the DICOM import job.
" + }, + "inputOwnerAccountId":{ + "shape":"AwsAccountId", + "documentation":"The account ID of the source S3 bucket owner.
" + } + } + }, + "StartDICOMImportJobResponse":{ + "type":"structure", + "required":[ + "datastoreId", + "jobId", + "jobStatus", + "submittedAt" + ], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
" + }, + "jobId":{ + "shape":"JobId", + "documentation":"The import job identifier.
" + }, + "jobStatus":{ + "shape":"JobStatus", + "documentation":"The import job status.
" + }, + "submittedAt":{ + "shape":"Date", + "documentation":"The timestamp when the import job was submitted.
" + } + } + }, + "String":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"(?!aws:)[a-zA-Z+-=._:/]+" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the medical imaging resource that tags are being added to.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The user-specified key and value tag pairs added to a medical imaging resource.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request was denied due to throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the medical imaging resource that tags are being removed from.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"The keys for the tags to be removed from the medical imaging resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateImageSetMetadataRequest":{ + "type":"structure", + "required":[ + "datastoreId", + "imageSetId", + "latestVersionId", + "updateImageSetMetadataUpdates" + ], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
", + "location":"uri", + "locationName":"datastoreId" + }, + "imageSetId":{ + "shape":"ImageSetId", + "documentation":"The image set identifier.
", + "location":"uri", + "locationName":"imageSetId" + }, + "latestVersionId":{ + "shape":"ImageSetExternalVersionId", + "documentation":"The latest image set version identifier.
", + "location":"querystring", + "locationName":"latestVersion" + }, + "force":{ + "shape":"Boolean", + "documentation":"Setting this flag will force the UpdateImageSetMetadata operation for the following attributes:
Tag.StudyInstanceUID, Tag.SeriesInstanceUID, Tag.SOPInstanceUID, and Tag.StudyID
Adding, removing, or updating private tags for an individual SOP Instance
Update image set metadata updates.
" + } + }, + "payload":"updateImageSetMetadataUpdates" + }, + "UpdateImageSetMetadataResponse":{ + "type":"structure", + "required":[ + "datastoreId", + "imageSetId", + "latestVersionId", + "imageSetState" + ], + "members":{ + "datastoreId":{ + "shape":"DatastoreId", + "documentation":"The data store identifier.
" + }, + "imageSetId":{ + "shape":"ImageSetId", + "documentation":"The image set identifier.
" + }, + "latestVersionId":{ + "shape":"ImageSetExternalVersionId", + "documentation":"The latest image set version identifier.
" + }, + "imageSetState":{ + "shape":"ImageSetState", + "documentation":"The image set state.
" + }, + "imageSetWorkflowStatus":{ + "shape":"ImageSetWorkflowStatus", + "documentation":"The image set workflow status.
" + }, + "createdAt":{ + "shape":"Date", + "documentation":"The timestamp when image set metadata was created.
" + }, + "updatedAt":{ + "shape":"Date", + "documentation":"The timestamp when image set metadata was updated.
" + }, + "message":{ + "shape":"Message", + "documentation":"The error message thrown if an update image set metadata action fails.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The input fails to satisfy the constraints set by the service.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + }, + "documentation":"This is the AWS HealthImaging API Reference. AWS HealthImaging is a HIPAA eligible service that empowers healthcare providers, life science organizations, and their software partners to store, analyze, and share medical images in the cloud at petabyte scale. For an introduction to the service, see the AWS HealthImaging Developer Guide .
We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as they take care of request authentication, serialization, and connection management. For more information, see Tools to build on AWS.
The following sections list AWS HealthImaging API actions categorized according to functionality. Links are provided to actions within this Reference, along with links back to corresponding sections in the AWS HealthImaging Developer Guide where you can view tested code examples.
Data store actions
Import job actions
Image set access actions
Image set modification actions
CopyImageSet – See Copying an image set.
Tagging actions
TagResource – See Tagging a resource.
Creates a migration workflow template.
" + }, + "CreateWorkflow":{ + "name":"CreateWorkflow", + "http":{ + "method":"POST", + "requestUri":"/migrationworkflow/", + "responseCode":200 + }, + "input":{"shape":"CreateMigrationWorkflowRequest"}, + "output":{"shape":"CreateMigrationWorkflowResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Create a workflow to orchestrate your migrations.
" + }, + "CreateWorkflowStep":{ + "name":"CreateWorkflowStep", + "http":{ + "method":"POST", + "requestUri":"/workflowstep", + "responseCode":200 + }, + "input":{"shape":"CreateWorkflowStepRequest"}, + "output":{"shape":"CreateWorkflowStepResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Create a step in the migration workflow.
" + }, + "CreateWorkflowStepGroup":{ + "name":"CreateWorkflowStepGroup", + "http":{ + "method":"POST", + "requestUri":"/workflowstepgroups", + "responseCode":200 + }, + "input":{"shape":"CreateWorkflowStepGroupRequest"}, + "output":{"shape":"CreateWorkflowStepGroupResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Create a step group in a migration workflow.
" + }, + "DeleteTemplate":{ + "name":"DeleteTemplate", + "http":{ + "method":"DELETE", + "requestUri":"/template/{id}", + "responseCode":200 + }, + "input":{"shape":"DeleteTemplateRequest"}, + "output":{"shape":"DeleteTemplateResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Deletes a migration workflow template.
", + "idempotent":true + }, + "DeleteWorkflow":{ + "name":"DeleteWorkflow", + "http":{ + "method":"DELETE", + "requestUri":"/migrationworkflow/{id}", + "responseCode":202 + }, + "input":{"shape":"DeleteMigrationWorkflowRequest"}, + "output":{"shape":"DeleteMigrationWorkflowResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it.
", + "idempotent":true + }, + "DeleteWorkflowStep":{ + "name":"DeleteWorkflowStep", + "http":{ + "method":"DELETE", + "requestUri":"/workflowstep/{id}", + "responseCode":200 + }, + "input":{"shape":"DeleteWorkflowStepRequest"}, + "output":{"shape":"DeleteWorkflowStepResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Delete a step in a migration workflow. Pause the workflow to delete a running step.
", + "idempotent":true + }, + "DeleteWorkflowStepGroup":{ + "name":"DeleteWorkflowStepGroup", + "http":{ + "method":"DELETE", + "requestUri":"/workflowstepgroup/{id}", + "responseCode":202 + }, + "input":{"shape":"DeleteWorkflowStepGroupRequest"}, + "output":{"shape":"DeleteWorkflowStepGroupResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Delete a step group in a migration workflow.
", + "idempotent":true + }, + "GetTemplate":{ + "name":"GetTemplate", + "http":{ + "method":"GET", + "requestUri":"/migrationworkflowtemplate/{id}", + "responseCode":200 + }, + "input":{"shape":"GetMigrationWorkflowTemplateRequest"}, + "output":{"shape":"GetMigrationWorkflowTemplateResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Get the template you want to use for creating a migration workflow.
" + }, + "GetTemplateStep":{ + "name":"GetTemplateStep", + "http":{ + "method":"GET", + "requestUri":"/templatestep/{id}", + "responseCode":200 + }, + "input":{"shape":"GetTemplateStepRequest"}, + "output":{"shape":"GetTemplateStepResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Get a specific step in a template.
" + }, + "GetTemplateStepGroup":{ + "name":"GetTemplateStepGroup", + "http":{ + "method":"GET", + "requestUri":"/templates/{templateId}/stepgroups/{id}", + "responseCode":200 + }, + "input":{"shape":"GetTemplateStepGroupRequest"}, + "output":{"shape":"GetTemplateStepGroupResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Get a step group in a template.
" + }, + "GetWorkflow":{ + "name":"GetWorkflow", + "http":{ + "method":"GET", + "requestUri":"/migrationworkflow/{id}", + "responseCode":200 + }, + "input":{"shape":"GetMigrationWorkflowRequest"}, + "output":{"shape":"GetMigrationWorkflowResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Get migration workflow.
" + }, + "GetWorkflowStep":{ + "name":"GetWorkflowStep", + "http":{ + "method":"GET", + "requestUri":"/workflowstep/{id}", + "responseCode":200 + }, + "input":{"shape":"GetWorkflowStepRequest"}, + "output":{"shape":"GetWorkflowStepResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Get a step in the migration workflow.
" + }, + "GetWorkflowStepGroup":{ + "name":"GetWorkflowStepGroup", + "http":{ + "method":"GET", + "requestUri":"/workflowstepgroup/{id}", + "responseCode":200 + }, + "input":{"shape":"GetWorkflowStepGroupRequest"}, + "output":{"shape":"GetWorkflowStepGroupResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Get the step group of a migration workflow.
" + }, + "ListPlugins":{ + "name":"ListPlugins", + "http":{ + "method":"GET", + "requestUri":"/plugins", + "responseCode":200 + }, + "input":{"shape":"ListPluginsRequest"}, + "output":{"shape":"ListPluginsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"List AWS Migration Hub Orchestrator plugins.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"List the tags added to a resource.
" + }, + "ListTemplateStepGroups":{ + "name":"ListTemplateStepGroups", + "http":{ + "method":"GET", + "requestUri":"/templatestepgroups/{templateId}", + "responseCode":200 + }, + "input":{"shape":"ListTemplateStepGroupsRequest"}, + "output":{"shape":"ListTemplateStepGroupsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"List the step groups in a template.
" + }, + "ListTemplateSteps":{ + "name":"ListTemplateSteps", + "http":{ + "method":"GET", + "requestUri":"/templatesteps", + "responseCode":200 + }, + "input":{"shape":"ListTemplateStepsRequest"}, + "output":{"shape":"ListTemplateStepsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"List the steps in a template.
" + }, + "ListTemplates":{ + "name":"ListTemplates", + "http":{ + "method":"GET", + "requestUri":"/migrationworkflowtemplates", + "responseCode":200 + }, + "input":{"shape":"ListMigrationWorkflowTemplatesRequest"}, + "output":{"shape":"ListMigrationWorkflowTemplatesResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"List the templates available in Migration Hub Orchestrator to create a migration workflow.
" + }, + "ListWorkflowStepGroups":{ + "name":"ListWorkflowStepGroups", + "http":{ + "method":"GET", + "requestUri":"/workflowstepgroups", + "responseCode":200 + }, + "input":{"shape":"ListWorkflowStepGroupsRequest"}, + "output":{"shape":"ListWorkflowStepGroupsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"List the step groups in a migration workflow.
" + }, + "ListWorkflowSteps":{ + "name":"ListWorkflowSteps", + "http":{ + "method":"GET", + "requestUri":"/workflow/{workflowId}/workflowstepgroups/{stepGroupId}/workflowsteps", + "responseCode":200 + }, + "input":{"shape":"ListWorkflowStepsRequest"}, + "output":{"shape":"ListWorkflowStepsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"List the steps in a workflow.
" + }, + "ListWorkflows":{ + "name":"ListWorkflows", + "http":{ + "method":"GET", + "requestUri":"/migrationworkflows", + "responseCode":200 + }, + "input":{"shape":"ListMigrationWorkflowsRequest"}, + "output":{"shape":"ListMigrationWorkflowsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"List the migration workflows.
" + }, + "RetryWorkflowStep":{ + "name":"RetryWorkflowStep", + "http":{ + "method":"POST", + "requestUri":"/retryworkflowstep/{id}", + "responseCode":200 + }, + "input":{"shape":"RetryWorkflowStepRequest"}, + "output":{"shape":"RetryWorkflowStepResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retry a failed step in a migration workflow.
" + }, + "StartWorkflow":{ + "name":"StartWorkflow", + "http":{ + "method":"POST", + "requestUri":"/migrationworkflow/{id}/start", + "responseCode":200 + }, + "input":{"shape":"StartMigrationWorkflowRequest"}, + "output":{"shape":"StartMigrationWorkflowResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Start a migration workflow.
" + }, + "StopWorkflow":{ + "name":"StopWorkflow", + "http":{ + "method":"POST", + "requestUri":"/migrationworkflow/{id}/stop", + "responseCode":200 + }, + "input":{"shape":"StopMigrationWorkflowRequest"}, + "output":{"shape":"StopMigrationWorkflowResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Stop an ongoing migration workflow.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Tag a resource by specifying its Amazon Resource Name (ARN).
", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Deletes the tags for a resource.
", + "idempotent":true + }, + "UpdateTemplate":{ + "name":"UpdateTemplate", + "http":{ + "method":"POST", + "requestUri":"/template/{id}", + "responseCode":200 + }, + "input":{"shape":"UpdateTemplateRequest"}, + "output":{"shape":"UpdateTemplateResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Updates a migration workflow template.
" + }, + "UpdateWorkflow":{ + "name":"UpdateWorkflow", + "http":{ + "method":"POST", + "requestUri":"/migrationworkflow/{id}", + "responseCode":200 + }, + "input":{"shape":"UpdateMigrationWorkflowRequest"}, + "output":{"shape":"UpdateMigrationWorkflowResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Update a migration workflow.
" + }, + "UpdateWorkflowStep":{ + "name":"UpdateWorkflowStep", + "http":{ + "method":"POST", + "requestUri":"/workflowstep/{id}", + "responseCode":200 + }, + "input":{"shape":"UpdateWorkflowStepRequest"}, + "output":{"shape":"UpdateWorkflowStepResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Update a step in a migration workflow.
" + }, + "UpdateWorkflowStepGroup":{ + "name":"UpdateWorkflowStepGroup", + "http":{ + "method":"POST", + "requestUri":"/workflowstepgroup/{id}", + "responseCode":202 + }, + "input":{"shape":"UpdateWorkflowStepGroupRequest"}, + "output":{"shape":"UpdateWorkflowStepGroupResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Update the step group in a migration workflow.
", + "idempotent":true + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":false} + }, + "ApplicationConfigurationName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ClientToken":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[-a-zA-Z0-9]*" + }, + "ConflictException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"This exception is thrown when an attempt to update or delete a resource would cause an inconsistent state.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":false} + }, + "CreateMigrationWorkflowRequest":{ + "type":"structure", + "required":[ + "name", + "templateId", + "inputParameters" + ], + "members":{ + "name":{ + "shape":"CreateMigrationWorkflowRequestNameString", + "documentation":"The name of the migration workflow.
" + }, + "description":{ + "shape":"CreateMigrationWorkflowRequestDescriptionString", + "documentation":"The description of the migration workflow.
" + }, + "templateId":{ + "shape":"CreateMigrationWorkflowRequestTemplateIdString", + "documentation":"The ID of the template.
" + }, + "applicationConfigurationId":{ + "shape":"CreateMigrationWorkflowRequestApplicationConfigurationIdString", + "documentation":"The configuration ID of the application configured in Application Discovery Service.
" + }, + "inputParameters":{ + "shape":"StepInputParameters", + "documentation":"The input parameters required to create a migration workflow.
" + }, + "stepTargets":{ + "shape":"StringList", + "documentation":"The servers on which a step will be run.
" + }, + "tags":{ + "shape":"StringMap", + "documentation":"The tags to add on a migration workflow.
" + } + } + }, + "CreateMigrationWorkflowRequestApplicationConfigurationIdString":{ + "type":"string", + "max":100, + "min":0, + "pattern":"[-a-zA-Z0-9_.+]*" + }, + "CreateMigrationWorkflowRequestDescriptionString":{ + "type":"string", + "max":500, + "min":0, + "pattern":"[-a-zA-Z0-9_.+, ]*" + }, + "CreateMigrationWorkflowRequestNameString":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" + }, + "CreateMigrationWorkflowRequestTemplateIdString":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" + }, + "CreateMigrationWorkflowResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
" + }, + "arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the migration workflow.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the migration workflow.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the migration workflow.
" + }, + "templateId":{ + "shape":"String", + "documentation":"The ID of the template.
" + }, + "adsApplicationConfigurationId":{ + "shape":"String", + "documentation":"The configuration ID of the application configured in Application Discovery Service.
" + }, + "workflowInputs":{ + "shape":"StepInputParameters", + "documentation":"The inputs for creating a migration workflow.
" + }, + "stepTargets":{ + "shape":"StringList", + "documentation":"The servers on which a step will be run.
" + }, + "status":{ + "shape":"MigrationWorkflowStatusEnum", + "documentation":"The status of the migration workflow.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The time at which the migration workflow was created.
" + }, + "tags":{ + "shape":"StringMap", + "documentation":"The tags to add on a migration workflow.
" + } + } + }, + "CreateTemplateRequest":{ + "type":"structure", + "required":[ + "templateName", + "templateSource" + ], + "members":{ + "templateName":{ + "shape":"CreateTemplateRequestTemplateNameString", + "documentation":"The name of the migration workflow template.
" + }, + "templateDescription":{ + "shape":"CreateTemplateRequestTemplateDescriptionString", + "documentation":"A description of the migration workflow template.
" + }, + "templateSource":{ + "shape":"TemplateSource", + "documentation":"The source of the migration workflow template.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Idempotency in the Smithy documentation.
", + "idempotencyToken":true + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags to add to the migration workflow template.
" + } + } + }, + "CreateTemplateRequestTemplateDescriptionString":{ + "type":"string", + "max":250, + "min":0, + "pattern":".*" + }, + "CreateTemplateRequestTemplateNameString":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[ a-zA-Z0-9]*" + }, + "CreateTemplateResponse":{ + "type":"structure", + "members":{ + "templateId":{ + "shape":"String", + "documentation":"The ID of the migration workflow template.
" + }, + "templateArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the migration workflow template. The format for an Migration Hub Orchestrator template ARN is arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The tags added to the migration workflow template.
" + } + } + }, + "CreateWorkflowStepGroupRequest":{ + "type":"structure", + "required":[ + "workflowId", + "name" + ], + "members":{ + "workflowId":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow that will contain the step group.
" + }, + "name":{ + "shape":"StepGroupName", + "documentation":"The name of the step group.
" + }, + "description":{ + "shape":"StepGroupDescription", + "documentation":"The description of the step group.
" + }, + "next":{ + "shape":"StringList", + "documentation":"The next step group.
" + }, + "previous":{ + "shape":"StringList", + "documentation":"The previous step group.
" + } + } + }, + "CreateWorkflowStepGroupResponse":{ + "type":"structure", + "members":{ + "workflowId":{ + "shape":"String", + "documentation":"The ID of the migration workflow that contains the step group.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the step group.
" + }, + "id":{ + "shape":"String", + "documentation":"The ID of the step group.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the step group.
" + }, + "tools":{ + "shape":"ToolsList", + "documentation":"List of AWS services utilized in a migration workflow.
" + }, + "next":{ + "shape":"StringList", + "documentation":"The next step group.
" + }, + "previous":{ + "shape":"StringList", + "documentation":"The previous step group.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The time at which the step group is created.
" + } + } + }, + "CreateWorkflowStepRequest":{ + "type":"structure", + "required":[ + "name", + "stepGroupId", + "workflowId", + "stepActionType" + ], + "members":{ + "name":{ + "shape":"MigrationWorkflowName", + "documentation":"The name of the step.
" + }, + "stepGroupId":{ + "shape":"StepGroupId", + "documentation":"The ID of the step group.
" + }, + "workflowId":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
" + }, + "stepActionType":{ + "shape":"StepActionType", + "documentation":"The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.
" + }, + "description":{ + "shape":"MigrationWorkflowDescription", + "documentation":"The description of the step.
" + }, + "workflowStepAutomationConfiguration":{ + "shape":"WorkflowStepAutomationConfiguration", + "documentation":"The custom script to run tests on source or target environments.
" + }, + "stepTarget":{ + "shape":"StringList", + "documentation":"The servers on which a step will be run.
" + }, + "outputs":{ + "shape":"WorkflowStepOutputList", + "documentation":"The key value pairs added for the expected output.
" + }, + "previous":{ + "shape":"StringList", + "documentation":"The previous step.
" + }, + "next":{ + "shape":"StringList", + "documentation":"The next step.
" + } + } + }, + "CreateWorkflowStepResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"The ID of the step.
" + }, + "stepGroupId":{ + "shape":"String", + "documentation":"The ID of the step group.
" + }, + "workflowId":{ + "shape":"String", + "documentation":"The ID of the migration workflow.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the step.
" + } + } + }, + "DataType":{ + "type":"string", + "enum":[ + "STRING", + "INTEGER", + "STRINGLIST", + "STRINGMAP" + ] + }, + "DeleteMigrationWorkflowRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow you want to delete.
", + "location":"uri", + "locationName":"id" + } + } + }, + "DeleteMigrationWorkflowResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
" + }, + "arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the migration workflow.
" + }, + "status":{ + "shape":"MigrationWorkflowStatusEnum", + "documentation":"The status of the migration workflow.
" + } + } + }, + "DeleteTemplateRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"TemplateId", + "documentation":"The ID of the request to delete a migration workflow template.
", + "location":"uri", + "locationName":"id" + } + } + }, + "DeleteTemplateResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteWorkflowStepGroupRequest":{ + "type":"structure", + "required":[ + "workflowId", + "id" + ], + "members":{ + "workflowId":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
", + "location":"querystring", + "locationName":"workflowId" + }, + "id":{ + "shape":"StepGroupId", + "documentation":"The ID of the step group you want to delete.
", + "location":"uri", + "locationName":"id" + } + } + }, + "DeleteWorkflowStepGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteWorkflowStepRequest":{ + "type":"structure", + "required":[ + "id", + "stepGroupId", + "workflowId" + ], + "members":{ + "id":{ + "shape":"StepId", + "documentation":"The ID of the step you want to delete.
", + "location":"uri", + "locationName":"id" + }, + "stepGroupId":{ + "shape":"StepGroupId", + "documentation":"The ID of the step group that contains the step you want to delete.
", + "location":"querystring", + "locationName":"stepGroupId" + }, + "workflowId":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
", + "location":"querystring", + "locationName":"workflowId" + } + } + }, + "DeleteWorkflowStepResponse":{ + "type":"structure", + "members":{ + } + }, + "GetMigrationWorkflowRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
", + "location":"uri", + "locationName":"id" + } + } + }, + "GetMigrationWorkflowResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
" + }, + "arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the migration workflow.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the migration workflow.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the migration workflow.
" + }, + "templateId":{ + "shape":"String", + "documentation":"The ID of the template.
" + }, + "adsApplicationConfigurationId":{ + "shape":"String", + "documentation":"The configuration ID of the application configured in Application Discovery Service.
" + }, + "adsApplicationName":{ + "shape":"String", + "documentation":"The name of the application configured in Application Discovery Service.
" + }, + "status":{ + "shape":"MigrationWorkflowStatusEnum", + "documentation":"The status of the migration workflow.
" + }, + "statusMessage":{ + "shape":"String", + "documentation":"The status message of the migration workflow.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The time at which the migration workflow was created.
" + }, + "lastStartTime":{ + "shape":"Timestamp", + "documentation":"The time at which the migration workflow was last started.
" + }, + "lastStopTime":{ + "shape":"Timestamp", + "documentation":"The time at which the migration workflow was last stopped.
" + }, + "lastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The time at which the migration workflow was last modified.
" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"The time at which the migration workflow ended.
" + }, + "tools":{ + "shape":"ToolsList", + "documentation":"List of AWS services utilized in a migration workflow.
" + }, + "totalSteps":{ + "shape":"Integer", + "documentation":"The total number of steps in the migration workflow.
" + }, + "completedSteps":{ + "shape":"Integer", + "documentation":"Get a list of completed steps in the migration workflow.
" + }, + "workflowInputs":{ + "shape":"StepInputParameters", + "documentation":"The inputs required for creating the migration workflow.
" + }, + "tags":{ + "shape":"StringMap", + "documentation":"The tags added to the migration workflow.
" + }, + "workflowBucket":{ + "shape":"String", + "documentation":"The Amazon S3 bucket where the migration logs are stored.
" + } + } + }, + "GetMigrationWorkflowTemplateRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"TemplateId", + "documentation":"The ID of the template.
", + "location":"uri", + "locationName":"id" + } + } + }, + "GetMigrationWorkflowTemplateResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"The ID of the template.
" + }, + "templateArn":{ + "shape":"String", + "documentation":">The Amazon Resource Name (ARN) of the migration workflow template. The format for an Migration Hub Orchestrator template ARN is arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The name of the template.
" + }, + "description":{ + "shape":"String", + "documentation":"The time at which the template was last created.
" + }, + "inputs":{ + "shape":"TemplateInputList", + "documentation":"The inputs provided for the creation of the migration workflow.
" + }, + "tools":{ + "shape":"ToolsList", + "documentation":"List of AWS services utilized in a migration workflow.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The time at which the template was last created.
" + }, + "owner":{ + "shape":"String", + "documentation":"The owner of the migration workflow template.
" + }, + "status":{ + "shape":"TemplateStatus", + "documentation":"The status of the template.
" + }, + "statusMessage":{ + "shape":"String", + "documentation":"The status message of retrieving migration workflow templates.
" + }, + "templateClass":{ + "shape":"String", + "documentation":"The class of the migration workflow template. The available template classes are:
A2C
MGN
SAP_MULTI
SQL_EC2
SQL_RDS
VMIE
The tags added to the migration workflow template.
" + } + } + }, + "GetTemplateStepGroupRequest":{ + "type":"structure", + "required":[ + "templateId", + "id" + ], + "members":{ + "templateId":{ + "shape":"TemplateId", + "documentation":"The ID of the template.
", + "location":"uri", + "locationName":"templateId" + }, + "id":{ + "shape":"StepGroupId", + "documentation":"The ID of the step group.
", + "location":"uri", + "locationName":"id" + } + } + }, + "GetTemplateStepGroupResponse":{ + "type":"structure", + "members":{ + "templateId":{ + "shape":"String", + "documentation":"The ID of the template.
" + }, + "id":{ + "shape":"String", + "documentation":"The ID of the step group.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the step group.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the step group.
" + }, + "status":{ + "shape":"StepGroupStatus", + "documentation":"The status of the step group.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The time at which the step group was created.
" + }, + "lastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The time at which the step group was last modified.
" + }, + "tools":{ + "shape":"ToolsList", + "documentation":"List of AWS services utilized in a migration workflow.
" + }, + "previous":{ + "shape":"StringList", + "documentation":"The previous step group.
" + }, + "next":{ + "shape":"StringList", + "documentation":"The next step group.
" + } + } + }, + "GetTemplateStepRequest":{ + "type":"structure", + "required":[ + "id", + "templateId", + "stepGroupId" + ], + "members":{ + "id":{ + "shape":"StepId", + "documentation":"The ID of the step.
", + "location":"uri", + "locationName":"id" + }, + "templateId":{ + "shape":"TemplateId", + "documentation":"The ID of the template.
", + "location":"querystring", + "locationName":"templateId" + }, + "stepGroupId":{ + "shape":"StepGroupId", + "documentation":"The ID of the step group.
", + "location":"querystring", + "locationName":"stepGroupId" + } + } + }, + "GetTemplateStepResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"StepId", + "documentation":"The ID of the step.
" + }, + "stepGroupId":{ + "shape":"StepGroupId", + "documentation":"The ID of the step group.
" + }, + "templateId":{ + "shape":"TemplateId", + "documentation":"The ID of the template.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the step.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the step.
" + }, + "stepActionType":{ + "shape":"StepActionType", + "documentation":"The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.
" + }, + "creationTime":{ + "shape":"String", + "documentation":"The time at which the step was created.
" + }, + "previous":{ + "shape":"StringList", + "documentation":"The previous step.
" + }, + "next":{ + "shape":"StringList", + "documentation":"The next step.
" + }, + "outputs":{ + "shape":"StepOutputList", + "documentation":"The outputs of the step.
" + }, + "stepAutomationConfiguration":{ + "shape":"StepAutomationConfiguration", + "documentation":"The custom script to run tests on source or target environments.
" + } + } + }, + "GetWorkflowStepGroupRequest":{ + "type":"structure", + "required":[ + "id", + "workflowId" + ], + "members":{ + "id":{ + "shape":"StepGroupId", + "documentation":"The ID of the step group.
", + "location":"uri", + "locationName":"id" + }, + "workflowId":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
", + "location":"querystring", + "locationName":"workflowId" + } + } + }, + "GetWorkflowStepGroupResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"StepGroupId", + "documentation":"The ID of the step group.
" + }, + "workflowId":{ + "shape":"String", + "documentation":"The ID of the migration workflow.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the step group.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the step group.
" + }, + "status":{ + "shape":"StepGroupStatus", + "documentation":"The status of the step group.
" + }, + "owner":{ + "shape":"Owner", + "documentation":"The owner of the step group.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The time at which the step group was created.
" + }, + "lastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The time at which the step group was last modified.
" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"The time at which the step group ended.
" + }, + "tools":{ + "shape":"ToolsList", + "documentation":"List of AWS services utilized in a migration workflow.
" + }, + "previous":{ + "shape":"StringList", + "documentation":"The previous step group.
" + }, + "next":{ + "shape":"StringList", + "documentation":"The next step group.
" + } + } + }, + "GetWorkflowStepRequest":{ + "type":"structure", + "required":[ + "workflowId", + "stepGroupId", + "id" + ], + "members":{ + "workflowId":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
", + "location":"querystring", + "locationName":"workflowId" + }, + "stepGroupId":{ + "shape":"StepGroupId", + "documentation":"The ID of the step group.
", + "location":"querystring", + "locationName":"stepGroupId" + }, + "id":{ + "shape":"StepId", + "documentation":"The ID of the step.
", + "location":"uri", + "locationName":"id" + } + } + }, + "GetWorkflowStepResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of the step.
" + }, + "stepGroupId":{ + "shape":"String", + "documentation":"The ID of the step group.
" + }, + "workflowId":{ + "shape":"String", + "documentation":"The ID of the migration workflow.
" + }, + "stepId":{ + "shape":"String", + "documentation":"The ID of the step.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the step.
" + }, + "stepActionType":{ + "shape":"StepActionType", + "documentation":"The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.
" + }, + "owner":{ + "shape":"Owner", + "documentation":"The owner of the step.
" + }, + "workflowStepAutomationConfiguration":{ + "shape":"WorkflowStepAutomationConfiguration", + "documentation":"The custom script to run tests on source or target environments.
" + }, + "stepTarget":{ + "shape":"StringList", + "documentation":"The servers on which a step will be run.
" + }, + "outputs":{ + "shape":"GetWorkflowStepResponseOutputsList", + "documentation":"The outputs of the step.
" + }, + "previous":{ + "shape":"StringList", + "documentation":"The previous step.
" + }, + "next":{ + "shape":"StringList", + "documentation":"The next step.
" + }, + "status":{ + "shape":"StepStatus", + "documentation":"The status of the step.
" + }, + "statusMessage":{ + "shape":"String", + "documentation":"The status message of the migration workflow.
" + }, + "scriptOutputLocation":{ + "shape":"String", + "documentation":"The output location of the script.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The time at which the step was created.
" + }, + "lastStartTime":{ + "shape":"Timestamp", + "documentation":"The time at which the workflow was last started.
" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"The time at which the step ended.
" + }, + "noOfSrvCompleted":{ + "shape":"Integer", + "documentation":"The number of servers that have been migrated.
" + }, + "noOfSrvFailed":{ + "shape":"Integer", + "documentation":"The number of servers that have failed to migrate.
" + }, + "totalNoOfSrv":{ + "shape":"Integer", + "documentation":"The total number of servers that have been migrated.
" + } + } + }, + "GetWorkflowStepResponseOutputsList":{ + "type":"list", + "member":{"shape":"WorkflowStepOutput"}, + "max":5, + "min":0 + }, + "IPAddress":{ + "type":"string", + "max":15, + "min":0, + "pattern":"(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])" + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"An internal error has occurred.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "ListMigrationWorkflowTemplatesRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results that can be returned.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token.
", + "location":"querystring", + "locationName":"nextToken" + }, + "name":{ + "shape":"TemplateName", + "documentation":"The name of the template.
", + "location":"querystring", + "locationName":"name" + } + } + }, + "ListMigrationWorkflowTemplatesResponse":{ + "type":"structure", + "required":["templateSummary"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token.
" + }, + "templateSummary":{ + "shape":"TemplateSummaryList", + "documentation":"The summary of the template.
" + } + } + }, + "ListMigrationWorkflowsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results that can be returned.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token.
", + "location":"querystring", + "locationName":"nextToken" + }, + "templateId":{ + "shape":"TemplateId", + "documentation":"The ID of the template.
", + "location":"querystring", + "locationName":"templateId" + }, + "adsApplicationConfigurationName":{ + "shape":"ApplicationConfigurationName", + "documentation":"The name of the application configured in Application Discovery Service.
", + "location":"querystring", + "locationName":"adsApplicationConfigurationName" + }, + "status":{ + "shape":"MigrationWorkflowStatusEnum", + "documentation":"The status of the migration workflow.
", + "location":"querystring", + "locationName":"status" + }, + "name":{ + "shape":"String", + "documentation":"The name of the migration workflow.
", + "location":"querystring", + "locationName":"name" + } + } + }, + "ListMigrationWorkflowsResponse":{ + "type":"structure", + "required":["migrationWorkflowSummary"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token.
" + }, + "migrationWorkflowSummary":{ + "shape":"MigrationWorkflowSummaryList", + "documentation":"The summary of the migration workflow.
" + } + } + }, + "ListPluginsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of plugins that can be returned.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListPluginsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token.
" + }, + "plugins":{ + "shape":"PluginSummaries", + "documentation":"Migration Hub Orchestrator plugins.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the resource.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"The tags added to a resource.
" + } + } + }, + "ListTemplateStepGroupsRequest":{ + "type":"structure", + "required":["templateId"], + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results that can be returned.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token.
", + "location":"querystring", + "locationName":"nextToken" + }, + "templateId":{ + "shape":"TemplateId", + "documentation":"The ID of the template.
", + "location":"uri", + "locationName":"templateId" + } + } + }, + "ListTemplateStepGroupsResponse":{ + "type":"structure", + "required":["templateStepGroupSummary"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token.
" + }, + "templateStepGroupSummary":{ + "shape":"TemplateStepGroupSummaryList", + "documentation":"The summary of the step group in the template.
" + } + } + }, + "ListTemplateStepsRequest":{ + "type":"structure", + "required":[ + "templateId", + "stepGroupId" + ], + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results that can be returned.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token.
", + "location":"querystring", + "locationName":"nextToken" + }, + "templateId":{ + "shape":"TemplateId", + "documentation":"The ID of the template.
", + "location":"querystring", + "locationName":"templateId" + }, + "stepGroupId":{ + "shape":"StepGroupId", + "documentation":"The ID of the step group.
", + "location":"querystring", + "locationName":"stepGroupId" + } + } + }, + "ListTemplateStepsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token.
" + }, + "templateStepSummaryList":{ + "shape":"TemplateStepSummaryList", + "documentation":"The list of summaries of steps in a template.
" + } + } + }, + "ListWorkflowStepGroupsRequest":{ + "type":"structure", + "required":["workflowId"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results that can be returned.
", + "location":"querystring", + "locationName":"maxResults" + }, + "workflowId":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
", + "location":"querystring", + "locationName":"workflowId" + } + } + }, + "ListWorkflowStepGroupsResponse":{ + "type":"structure", + "required":["workflowStepGroupsSummary"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token.
" + }, + "workflowStepGroupsSummary":{ + "shape":"WorkflowStepGroupsSummaryList", + "documentation":"The summary of step groups in a migration workflow.
" + } + } + }, + "ListWorkflowStepsRequest":{ + "type":"structure", + "required":[ + "workflowId", + "stepGroupId" + ], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results that can be returned.
", + "location":"querystring", + "locationName":"maxResults" + }, + "workflowId":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
", + "location":"uri", + "locationName":"workflowId" + }, + "stepGroupId":{ + "shape":"StepGroupId", + "documentation":"The ID of the step group.
", + "location":"uri", + "locationName":"stepGroupId" + } + } + }, + "ListWorkflowStepsResponse":{ + "type":"structure", + "required":["workflowStepsSummary"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The pagination token.
" + }, + "workflowStepsSummary":{ + "shape":"WorkflowStepsSummaryList", + "documentation":"The summary of steps in a migration workflow.
" + } + } + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":0 + }, + "MaxStringList":{ + "type":"list", + "member":{"shape":"MaxStringValue"} + }, + "MaxStringValue":{ + "type":"string", + "max":2048, + "min":0 + }, + "MigrationWorkflowDescription":{ + "type":"string", + "max":500, + "min":0, + "pattern":"[-a-zA-Z0-9_.+, ]*" + }, + "MigrationWorkflowId":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[a-zA-Z0-9-]+" + }, + "MigrationWorkflowName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" + }, + "MigrationWorkflowStatusEnum":{ + "type":"string", + "enum":[ + "CREATING", + "NOT_STARTED", + "CREATION_FAILED", + "STARTING", + "IN_PROGRESS", + "WORKFLOW_FAILED", + "PAUSED", + "PAUSING", + "PAUSING_FAILED", + "USER_ATTENTION_REQUIRED", + "DELETING", + "DELETION_FAILED", + "DELETED", + "COMPLETED" + ] + }, + "MigrationWorkflowSummary":{ + "type":"structure", + "members":{ + "id":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the migration workflow.
" + }, + "templateId":{ + "shape":"String", + "documentation":"The ID of the template.
" + }, + "adsApplicationConfigurationName":{ + "shape":"String", + "documentation":"The name of the application configured in Application Discovery Service.
" + }, + "status":{ + "shape":"MigrationWorkflowStatusEnum", + "documentation":"The status of the migration workflow.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The time at which the migration workflow was created.
" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"The time at which the migration workflow ended.
" + }, + "statusMessage":{ + "shape":"String", + "documentation":"The status message of the migration workflow.
" + }, + "completedSteps":{ + "shape":"Integer", + "documentation":"The steps completed in the migration workflow.
" + }, + "totalSteps":{ + "shape":"Integer", + "documentation":"All the steps in a migration workflow.
" + } + }, + "documentation":"The summary of a migration workflow.
" + }, + "MigrationWorkflowSummaryList":{ + "type":"list", + "member":{"shape":"MigrationWorkflowSummary"} + }, + "NextToken":{ + "type":"string", + "max":2048, + "min":0, + "pattern":".*\\S.*" + }, + "Owner":{ + "type":"string", + "enum":[ + "AWS_MANAGED", + "CUSTOM" + ] + }, + "PlatformCommand":{ + "type":"structure", + "members":{ + "linux":{ + "shape":"String", + "documentation":"Command for Linux.
" + }, + "windows":{ + "shape":"String", + "documentation":"Command for Windows.
" + } + }, + "documentation":"Command to be run on a particular operating system.
" + }, + "PlatformScriptKey":{ + "type":"structure", + "members":{ + "linux":{ + "shape":"S3Key", + "documentation":"The script location for Linux.
" + }, + "windows":{ + "shape":"S3Key", + "documentation":"The script location for Windows.
" + } + }, + "documentation":"The script location for a particular operating system.
" + }, + "PluginHealth":{ + "type":"string", + "enum":[ + "HEALTHY", + "UNHEALTHY" + ] + }, + "PluginId":{ + "type":"string", + "max":60, + "min":1, + "pattern":".*\\S.*" + }, + "PluginSummaries":{ + "type":"list", + "member":{"shape":"PluginSummary"} + }, + "PluginSummary":{ + "type":"structure", + "members":{ + "pluginId":{ + "shape":"PluginId", + "documentation":"The ID of the plugin.
" + }, + "hostname":{ + "shape":"String", + "documentation":"The name of the host.
" + }, + "status":{ + "shape":"PluginHealth", + "documentation":"The status of the plugin.
" + }, + "ipAddress":{ + "shape":"IPAddress", + "documentation":"The IP address at which the plugin is located.
" + }, + "version":{ + "shape":"PluginVersion", + "documentation":"The version of the plugin.
" + }, + "registeredTime":{ + "shape":"String", + "documentation":"The time at which the plugin was registered.
" + } + }, + "documentation":"The summary of the Migration Hub Orchestrator plugin.
" + }, + "PluginVersion":{ + "type":"string", + "max":1024, + "min":0, + "pattern":".*" + }, + "ResourceArn":{ + "type":"string", + "pattern":"arn:aws:migrationhub-orchestrator:[a-z0-9-]+:[0-9]+:(template|workflow)/[.]*" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The resource is not available.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "RetryWorkflowStepRequest":{ + "type":"structure", + "required":[ + "workflowId", + "stepGroupId", + "id" + ], + "members":{ + "workflowId":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
", + "location":"querystring", + "locationName":"workflowId" + }, + "stepGroupId":{ + "shape":"StepGroupId", + "documentation":"The ID of the step group.
", + "location":"querystring", + "locationName":"stepGroupId" + }, + "id":{ + "shape":"StepId", + "documentation":"The ID of the step.
", + "location":"uri", + "locationName":"id" + } + } + }, + "RetryWorkflowStepResponse":{ + "type":"structure", + "members":{ + "stepGroupId":{ + "shape":"String", + "documentation":"The ID of the step group.
" + }, + "workflowId":{ + "shape":"String", + "documentation":"The ID of the migration workflow.
" + }, + "id":{ + "shape":"String", + "documentation":"The ID of the step.
" + }, + "status":{ + "shape":"StepStatus", + "documentation":"The status of the step.
" + } + } + }, + "RunEnvironment":{ + "type":"string", + "enum":[ + "AWS", + "ONPREMISE" + ] + }, + "S3Bucket":{ + "type":"string", + "max":63, + "min":0, + "pattern":"[0-9a-z]+[0-9a-z\\.\\-]*[0-9a-z]+" + }, + "S3Key":{ + "type":"string", + "max":1024, + "min":0 + }, + "StartMigrationWorkflowRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
", + "location":"uri", + "locationName":"id" + } + } + }, + "StartMigrationWorkflowResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
" + }, + "arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the migration workflow.
" + }, + "status":{ + "shape":"MigrationWorkflowStatusEnum", + "documentation":"The status of the migration workflow.
" + }, + "statusMessage":{ + "shape":"String", + "documentation":"The status message of the migration workflow.
" + }, + "lastStartTime":{ + "shape":"Timestamp", + "documentation":"The time at which the migration workflow was last started.
" + } + } + }, + "StepActionType":{ + "type":"string", + "enum":[ + "MANUAL", + "AUTOMATED" + ] + }, + "StepAutomationConfiguration":{ + "type":"structure", + "members":{ + "scriptLocationS3Bucket":{ + "shape":"String", + "documentation":"The Amazon S3 bucket where the script is located.
" + }, + "scriptLocationS3Key":{ + "shape":"PlatformScriptKey", + "documentation":"The Amazon S3 key for the script location.
" + }, + "command":{ + "shape":"PlatformCommand", + "documentation":"The command to run the script.
" + }, + "runEnvironment":{ + "shape":"RunEnvironment", + "documentation":"The source or target environment.
" + }, + "targetType":{ + "shape":"TargetType", + "documentation":"The servers on which to run the script.
" + } + }, + "documentation":"The custom script to run tests on source or target environments.
" + }, + "StepDescription":{ + "type":"string", + "max":500, + "min":0, + "pattern":"[-a-zA-Z0-9_.+, ]*" + }, + "StepGroupDescription":{ + "type":"string", + "max":500, + "min":0, + "pattern":"[-a-zA-Z0-9_.+, ]*" + }, + "StepGroupId":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[a-zA-Z0-9-]+" + }, + "StepGroupName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" + }, + "StepGroupStatus":{ + "type":"string", + "enum":[ + "AWAITING_DEPENDENCIES", + "READY", + "IN_PROGRESS", + "COMPLETED", + "FAILED", + "PAUSED", + "PAUSING", + "USER_ATTENTION_REQUIRED" + ] + }, + "StepId":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[a-zA-Z0-9-]+" + }, + "StepInput":{ + "type":"structure", + "members":{ + "integerValue":{ + "shape":"Integer", + "documentation":"The value of the integer.
" + }, + "stringValue":{ + "shape":"StringValue", + "documentation":"String value.
" + }, + "listOfStringsValue":{ + "shape":"StringList", + "documentation":"List of string values.
" + }, + "mapOfStringValue":{ + "shape":"StringMap", + "documentation":"Map of string values.
" + } + }, + "documentation":"A map of key value pairs that is generated when you create a migration workflow. The key value pairs will differ based on your selection of the template.
", + "union":true + }, + "StepInputParameters":{ + "type":"map", + "key":{"shape":"StepInputParametersKey"}, + "value":{"shape":"StepInput"}, + "sensitive":true + }, + "StepInputParametersKey":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[a-zA-Z0-9-_ ()]+" + }, + "StepName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" + }, + "StepOutput":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of the step.
" + }, + "dataType":{ + "shape":"DataType", + "documentation":"The data type of the step output.
" + }, + "required":{ + "shape":"Boolean", + "documentation":"Determine if an output is required from a step.
" + } + }, + "documentation":"The output of the step.
" + }, + "StepOutputList":{ + "type":"list", + "member":{"shape":"StepOutput"} + }, + "StepStatus":{ + "type":"string", + "enum":[ + "AWAITING_DEPENDENCIES", + "SKIPPED", + "READY", + "IN_PROGRESS", + "COMPLETED", + "FAILED", + "PAUSED", + "USER_ATTENTION_REQUIRED" + ] + }, + "StopMigrationWorkflowRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
", + "location":"uri", + "locationName":"id" + } + } + }, + "StopMigrationWorkflowResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
" + }, + "arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the migration workflow.
" + }, + "status":{ + "shape":"MigrationWorkflowStatusEnum", + "documentation":"The status of the migration workflow.
" + }, + "statusMessage":{ + "shape":"String", + "documentation":"The status message of the migration workflow.
" + }, + "lastStopTime":{ + "shape":"Timestamp", + "documentation":"The time at which the migration workflow was stopped.
" + } + } + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"StringListMember"} + }, + "StringListMember":{ + "type":"string", + "max":500, + "min":0 + }, + "StringMap":{ + "type":"map", + "key":{"shape":"StringMapKey"}, + "value":{"shape":"StringMapValue"} + }, + "StringMapKey":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[a-zA-Z0-9-_ ()]+" + }, + "StringMapValue":{ + "type":"string", + "max":100, + "min":0 + }, + "StringValue":{ + "type":"string", + "max":100, + "min":0 + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"(?!aws:)[a-zA-Z+-=._:/]+" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the resource to which you want to add tags.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A collection of labels, in the form of key:value pairs, that apply to this resource.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TargetType":{ + "type":"string", + "enum":[ + "SINGLE", + "ALL", + "NONE" + ] + }, + "TemplateId":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" + }, + "TemplateInput":{ + "type":"structure", + "members":{ + "inputName":{ + "shape":"TemplateInputName", + "documentation":"The name of the template.
" + }, + "dataType":{ + "shape":"DataType", + "documentation":"The data type of the template input.
" + }, + "required":{ + "shape":"Boolean", + "documentation":"Determine if an input is required from the template.
" + } + }, + "documentation":"The input parameters of a template.
" + }, + "TemplateInputList":{ + "type":"list", + "member":{"shape":"TemplateInput"} + }, + "TemplateInputName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" + }, + "TemplateName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" + }, + "TemplateSource":{ + "type":"structure", + "members":{ + "workflowId":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the workflow from the source migration workflow template.
" + } + }, + "documentation":"The migration workflow template used as the source for the new template.
", + "union":true + }, + "TemplateStatus":{ + "type":"string", + "enum":[ + "CREATED", + "READY", + "PENDING_CREATION", + "CREATING", + "CREATION_FAILED" + ] + }, + "TemplateStepGroupSummary":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"The ID of the step group.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the step group.
" + }, + "previous":{ + "shape":"StringList", + "documentation":"The previous step group.
" + }, + "next":{ + "shape":"StringList", + "documentation":"The next step group.
" + } + }, + "documentation":"The summary of the step group in the template.
" + }, + "TemplateStepGroupSummaryList":{ + "type":"list", + "member":{"shape":"TemplateStepGroupSummary"} + }, + "TemplateStepSummary":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"The ID of the step.
" + }, + "stepGroupId":{ + "shape":"String", + "documentation":"The ID of the step group.
" + }, + "templateId":{ + "shape":"String", + "documentation":"The ID of the template.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the step.
" + }, + "stepActionType":{ + "shape":"StepActionType", + "documentation":"The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.
" + }, + "targetType":{ + "shape":"TargetType", + "documentation":"The servers on which to run the script.
" + }, + "owner":{ + "shape":"Owner", + "documentation":"The owner of the step.
" + }, + "previous":{ + "shape":"StringList", + "documentation":"The previous step.
" + }, + "next":{ + "shape":"StringList", + "documentation":"The next step.
" + } + }, + "documentation":"The summary of the step.
" + }, + "TemplateStepSummaryList":{ + "type":"list", + "member":{"shape":"TemplateStepSummary"} + }, + "TemplateSummary":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"The ID of the template.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the template.
" + }, + "arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the template.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the template.
" + } + }, + "documentation":"The summary of the template.
" + }, + "TemplateSummaryList":{ + "type":"list", + "member":{"shape":"TemplateSummary"} + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "Tool":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of an AWS service.
" + }, + "url":{ + "shape":"String", + "documentation":"The URL of an AWS service.
" + } + }, + "documentation":"List of AWS services utilized in a migration workflow.
" + }, + "ToolsList":{ + "type":"list", + "member":{"shape":"Tool"} + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the resource from which you want to remove tags.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"One or more tag keys. Specify only the tag keys, not the tag values.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateMigrationWorkflowRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
", + "location":"uri", + "locationName":"id" + }, + "name":{ + "shape":"UpdateMigrationWorkflowRequestNameString", + "documentation":"The name of the migration workflow.
" + }, + "description":{ + "shape":"UpdateMigrationWorkflowRequestDescriptionString", + "documentation":"The description of the migration workflow.
" + }, + "inputParameters":{ + "shape":"StepInputParameters", + "documentation":"The input parameters required to update a migration workflow.
" + }, + "stepTargets":{ + "shape":"StringList", + "documentation":"The servers on which a step will be run.
" + } + } + }, + "UpdateMigrationWorkflowRequestDescriptionString":{ + "type":"string", + "max":500, + "min":0, + "pattern":"[-a-zA-Z0-9_.+, ]*" + }, + "UpdateMigrationWorkflowRequestNameString":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" + }, + "UpdateMigrationWorkflowResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
" + }, + "arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the migration workflow.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the migration workflow.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the migration workflow.
" + }, + "templateId":{ + "shape":"String", + "documentation":"The ID of the template.
" + }, + "adsApplicationConfigurationId":{ + "shape":"String", + "documentation":"The ID of the application configured in Application Discovery Service.
" + }, + "workflowInputs":{ + "shape":"StepInputParameters", + "documentation":"The inputs required to update a migration workflow.
" + }, + "stepTargets":{ + "shape":"StringList", + "documentation":"The servers on which a step will be run.
" + }, + "status":{ + "shape":"MigrationWorkflowStatusEnum", + "documentation":"The status of the migration workflow.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The time at which the migration workflow was created.
" + }, + "lastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The time at which the migration workflow was last modified.
" + }, + "tags":{ + "shape":"StringMap", + "documentation":"The tags added to the migration workflow.
" + } + } + }, + "UpdateTemplateRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"TemplateId", + "documentation":"The ID of the request to update a migration workflow template.
", + "location":"uri", + "locationName":"id" + }, + "templateName":{ + "shape":"UpdateTemplateRequestTemplateNameString", + "documentation":"The name of the migration workflow template to update.
" + }, + "templateDescription":{ + "shape":"UpdateTemplateRequestTemplateDescriptionString", + "documentation":"The description of the migration workflow template to update.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "idempotencyToken":true + } + } + }, + "UpdateTemplateRequestTemplateDescriptionString":{ + "type":"string", + "max":250, + "min":0, + "pattern":".*" + }, + "UpdateTemplateRequestTemplateNameString":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[ a-zA-Z0-9]*" + }, + "UpdateTemplateResponse":{ + "type":"structure", + "members":{ + "templateId":{ + "shape":"String", + "documentation":"The ID of the migration workflow template being updated.
" + }, + "templateArn":{ + "shape":"String", + "documentation":"The ARN of the migration workflow template being updated. The format for an Migration Hub Orchestrator template ARN is arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The tags added to the migration workflow template.
" + } + } + }, + "UpdateWorkflowStepGroupRequest":{ + "type":"structure", + "required":[ + "workflowId", + "id" + ], + "members":{ + "workflowId":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
", + "location":"querystring", + "locationName":"workflowId" + }, + "id":{ + "shape":"StepGroupId", + "documentation":"The ID of the step group.
", + "location":"uri", + "locationName":"id" + }, + "name":{ + "shape":"StepGroupName", + "documentation":"The name of the step group.
" + }, + "description":{ + "shape":"StepGroupDescription", + "documentation":"The description of the step group.
" + }, + "next":{ + "shape":"StringList", + "documentation":"The next step group.
" + }, + "previous":{ + "shape":"StringList", + "documentation":"The previous step group.
" + } + } + }, + "UpdateWorkflowStepGroupResponse":{ + "type":"structure", + "members":{ + "workflowId":{ + "shape":"String", + "documentation":"The ID of the migration workflow.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the step group.
" + }, + "id":{ + "shape":"String", + "documentation":"The ID of the step group.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the step group.
" + }, + "tools":{ + "shape":"ToolsList", + "documentation":"List of AWS services utilized in a migration workflow.
" + }, + "next":{ + "shape":"StringList", + "documentation":"The next step group.
" + }, + "previous":{ + "shape":"StringList", + "documentation":"The previous step group.
" + }, + "lastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The time at which the step group was last modified.
" + } + } + }, + "UpdateWorkflowStepRequest":{ + "type":"structure", + "required":[ + "id", + "stepGroupId", + "workflowId" + ], + "members":{ + "id":{ + "shape":"StepId", + "documentation":"The ID of the step.
", + "location":"uri", + "locationName":"id" + }, + "stepGroupId":{ + "shape":"StepGroupId", + "documentation":"The ID of the step group.
" + }, + "workflowId":{ + "shape":"MigrationWorkflowId", + "documentation":"The ID of the migration workflow.
" + }, + "name":{ + "shape":"StepName", + "documentation":"The name of the step.
" + }, + "description":{ + "shape":"StepDescription", + "documentation":"The description of the step.
" + }, + "stepActionType":{ + "shape":"StepActionType", + "documentation":"The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.
" + }, + "workflowStepAutomationConfiguration":{ + "shape":"WorkflowStepAutomationConfiguration", + "documentation":"The custom script to run tests on the source and target environments.
" + }, + "stepTarget":{ + "shape":"StringList", + "documentation":"The servers on which a step will be run.
" + }, + "outputs":{ + "shape":"WorkflowStepOutputList", + "documentation":"The outputs of a step.
" + }, + "previous":{ + "shape":"StringList", + "documentation":"The previous step.
" + }, + "next":{ + "shape":"StringList", + "documentation":"The next step.
" + }, + "status":{ + "shape":"StepStatus", + "documentation":"The status of the step.
" + } + } + }, + "UpdateWorkflowStepResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"StepId", + "documentation":"The ID of the step.
" + }, + "stepGroupId":{ + "shape":"String", + "documentation":"The ID of the step group.
" + }, + "workflowId":{ + "shape":"String", + "documentation":"The ID of the migration workflow.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the step.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The input fails to satisfy the constraints specified by an AWS service.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":false} + }, + "WorkflowStepAutomationConfiguration":{ + "type":"structure", + "members":{ + "scriptLocationS3Bucket":{ + "shape":"S3Bucket", + "documentation":"The Amazon S3 bucket where the script is located.
" + }, + "scriptLocationS3Key":{ + "shape":"PlatformScriptKey", + "documentation":"The Amazon S3 key for the script location.
" + }, + "command":{ + "shape":"PlatformCommand", + "documentation":"The command required to run the script.
" + }, + "runEnvironment":{ + "shape":"RunEnvironment", + "documentation":"The source or target environment.
" + }, + "targetType":{ + "shape":"TargetType", + "documentation":"The servers on which to run the script.
" + } + }, + "documentation":"The custom script to run tests on source or target environments.
" + }, + "WorkflowStepGroupSummary":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"The ID of the step group.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the step group.
" + }, + "owner":{ + "shape":"Owner", + "documentation":"The owner of the step group.
" + }, + "status":{ + "shape":"StepGroupStatus", + "documentation":"The status of the step group.
" + }, + "previous":{ + "shape":"StringList", + "documentation":"The previous step group.
" + }, + "next":{ + "shape":"StringList", + "documentation":"The next step group.
" + } + }, + "documentation":"The summary of a step group in a workflow.
" + }, + "WorkflowStepGroupsSummaryList":{ + "type":"list", + "member":{"shape":"WorkflowStepGroupSummary"} + }, + "WorkflowStepOutput":{ + "type":"structure", + "members":{ + "name":{ + "shape":"WorkflowStepOutputName", + "documentation":"The name of the step.
" + }, + "dataType":{ + "shape":"DataType", + "documentation":"The data type of the output.
" + }, + "required":{ + "shape":"Boolean", + "documentation":"Determine if an output is required from a step.
" + }, + "value":{ + "shape":"WorkflowStepOutputUnion", + "documentation":"The value of the output.
" + } + }, + "documentation":"The output of a step.
" + }, + "WorkflowStepOutputList":{ + "type":"list", + "member":{"shape":"WorkflowStepOutput"} + }, + "WorkflowStepOutputName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*" + }, + "WorkflowStepOutputUnion":{ + "type":"structure", + "members":{ + "integerValue":{ + "shape":"Integer", + "documentation":"The integer value.
" + }, + "stringValue":{ + "shape":"MaxStringValue", + "documentation":"The string value.
" + }, + "listOfStringValue":{ + "shape":"MaxStringList", + "documentation":"The list of string value.
" + } + }, + "documentation":"A structure to hold multiple values of an output.
", + "union":true + }, + "WorkflowStepSummary":{ + "type":"structure", + "members":{ + "stepId":{ + "shape":"String", + "documentation":"The ID of the step.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the step.
" + }, + "stepActionType":{ + "shape":"StepActionType", + "documentation":"The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.
" + }, + "owner":{ + "shape":"Owner", + "documentation":"The owner of the step.
" + }, + "previous":{ + "shape":"StringList", + "documentation":"The previous step.
" + }, + "next":{ + "shape":"StringList", + "documentation":"The next step.
" + }, + "status":{ + "shape":"StepStatus", + "documentation":"The status of the step.
" + }, + "statusMessage":{ + "shape":"String", + "documentation":"The status message of the migration workflow.
" + }, + "noOfSrvCompleted":{ + "shape":"Integer", + "documentation":"The number of servers that have been migrated.
" + }, + "noOfSrvFailed":{ + "shape":"Integer", + "documentation":"The number of servers that have failed to migrate.
" + }, + "totalNoOfSrv":{ + "shape":"Integer", + "documentation":"The total number of servers that have been migrated.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the step.
" + }, + "scriptLocation":{ + "shape":"String", + "documentation":"The location of the script.
" + } + }, + "documentation":"The summary of the step in a migration workflow.
" + }, + "WorkflowStepsSummaryList":{ + "type":"list", + "member":{"shape":"WorkflowStepSummary"} + } + }, + "documentation":"This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Migration Hub Orchestrator. The topic for each action shows the API request parameters and responses. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using.
" +} diff --git a/testbed/boto__botocore/botocore/data/migrationhuborchestrator/2021-08-28/waiters-2.json b/testbed/boto__botocore/botocore/data/migrationhuborchestrator/2021-08-28/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..13f60ee66be6a3d75208653e2bd7b563561adacc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/migrationhuborchestrator/2021-08-28/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/testbed/boto__botocore/botocore/data/oam/2022-06-10/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/oam/2022-06-10/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..66108a304415cc5d4459adb9f8e3b65bf6def7a5 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/oam/2022-06-10/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://oam-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://oam-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://oam.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://oam.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/oam/2022-06-10/paginators-1.json b/testbed/boto__botocore/botocore/data/oam/2022-06-10/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..3595f00983f127db3e94c40baf5dddf8ff3b565d --- /dev/null +++ b/testbed/boto__botocore/botocore/data/oam/2022-06-10/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListAttachedLinks": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Items" + }, + "ListLinks": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Items" + }, + "ListSinks": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Items" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/oam/2022-06-10/service-2.json b/testbed/boto__botocore/botocore/data/oam/2022-06-10/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..c3c40262542f35b39e26cccd8758ce6a95d64973 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/oam/2022-06-10/service-2.json @@ -0,0 +1,1091 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-06-10", + "endpointPrefix":"oam", + "jsonVersion":"1.1", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"CloudWatch Observability Access Manager", + "serviceId":"OAM", + "signatureVersion":"v4", + "signingName":"oam", + "uid":"oam-2022-06-10" + }, + "operations":{ + "CreateLink":{ + "name":"CreateLink", + "http":{ + "method":"POST", + "requestUri":"/CreateLink", + "responseCode":200 + }, + "input":{"shape":"CreateLinkInput"}, + "output":{"shape":"CreateLinkOutput"}, + "errors":[ + {"shape":"InternalServiceFault"}, + {"shape":"ConflictException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
Before you create a link, you must create a sink in the monitoring account and create a sink policy in that account. The sink policy must permit the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization or to individual accounts.
For more information, see CreateSink and PutSinkPolicy.
Each monitoring account can be linked to as many as 100,000 source accounts.
Each source account can be linked to as many as five monitoring accounts.
" + }, + "CreateSink":{ + "name":"CreateSink", + "http":{ + "method":"POST", + "requestUri":"/CreateSink", + "responseCode":200 + }, + "input":{"shape":"CreateSinkInput"}, + "output":{"shape":"CreateSinkOutput"}, + "errors":[ + {"shape":"InternalServiceFault"}, + {"shape":"ConflictException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data.
After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see PutSinkPolicy.
Each account can contain one sink per Region. If you delete a sink, you can then create a new one in that Region.
" + }, + "DeleteLink":{ + "name":"DeleteLink", + "http":{ + "method":"POST", + "requestUri":"/DeleteLink", + "responseCode":200 + }, + "input":{"shape":"DeleteLinkInput"}, + "output":{"shape":"DeleteLinkOutput"}, + "errors":[ + {"shape":"InternalServiceFault"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Deletes a link between a monitoring account sink and a source account. You must run this operation in the source account.
" + }, + "DeleteSink":{ + "name":"DeleteSink", + "http":{ + "method":"POST", + "requestUri":"/DeleteSink", + "responseCode":200 + }, + "input":{"shape":"DeleteSinkInput"}, + "output":{"shape":"DeleteSinkOutput"}, + "errors":[ + {"shape":"InternalServiceFault"}, + {"shape":"ConflictException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Deletes a sink. You must delete all links to a sink before you can delete that sink.
" + }, + "GetLink":{ + "name":"GetLink", + "http":{ + "method":"POST", + "requestUri":"/GetLink", + "responseCode":200 + }, + "input":{"shape":"GetLinkInput"}, + "output":{"shape":"GetLinkOutput"}, + "errors":[ + {"shape":"InternalServiceFault"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns complete information about one link.
To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.
" + }, + "GetSink":{ + "name":"GetSink", + "http":{ + "method":"POST", + "requestUri":"/GetSink", + "responseCode":200 + }, + "input":{"shape":"GetSinkInput"}, + "output":{"shape":"GetSinkOutput"}, + "errors":[ + {"shape":"InternalServiceFault"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns complete information about one monitoring account sink.
To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
" + }, + "GetSinkPolicy":{ + "name":"GetSinkPolicy", + "http":{ + "method":"POST", + "requestUri":"/GetSinkPolicy", + "responseCode":200 + }, + "input":{"shape":"GetSinkPolicyInput"}, + "output":{"shape":"GetSinkPolicyOutput"}, + "errors":[ + {"shape":"InternalServiceFault"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns the current sink policy attached to this sink. The sink policy specifies what accounts can attach to this sink as source accounts, and what types of data they can share.
" + }, + "ListAttachedLinks":{ + "name":"ListAttachedLinks", + "http":{ + "method":"POST", + "requestUri":"/ListAttachedLinks", + "responseCode":200 + }, + "input":{"shape":"ListAttachedLinksInput"}, + "output":{"shape":"ListAttachedLinksOutput"}, + "errors":[ + {"shape":"InternalServiceFault"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns a list of source account links that are linked to this monitoring account sink.
To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
To find a list of links for one source account, use ListLinks.
" + }, + "ListLinks":{ + "name":"ListLinks", + "http":{ + "method":"POST", + "requestUri":"/ListLinks", + "responseCode":200 + }, + "input":{"shape":"ListLinksInput"}, + "output":{"shape":"ListLinksOutput"}, + "errors":[ + {"shape":"InternalServiceFault"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.
To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.
" + }, + "ListSinks":{ + "name":"ListSinks", + "http":{ + "method":"POST", + "requestUri":"/ListSinks", + "responseCode":200 + }, + "input":{"shape":"ListSinksInput"}, + "output":{"shape":"ListSinksOutput"}, + "errors":[ + {"shape":"InternalServiceFault"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Use this operation in a monitoring account to return the list of sinks created in that account.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{ResourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Displays the tags associated with a resource. Both sinks and links support tagging.
" + }, + "PutSinkPolicy":{ + "name":"PutSinkPolicy", + "http":{ + "method":"POST", + "requestUri":"/PutSinkPolicy", + "responseCode":200 + }, + "input":{"shape":"PutSinkPolicyInput"}, + "output":{"shape":"PutSinkPolicyOutput"}, + "errors":[ + {"shape":"InternalServiceFault"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts.
You can also use a sink policy to limit the types of data that is shared. The three types that you can allow or deny are:
Metrics - Specify with AWS::CloudWatch::Metric
Log groups - Specify with AWS::Logs::LogGroup
Traces - Specify with AWS::XRay::Trace
Application Insights - Applications - Specify with AWS::ApplicationInsights::Application
See the examples in this section to see how to specify permitted source accounts and data types.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"PUT", + "requestUri":"/tags/{ResourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"TooManyTagsException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links can be tagged.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:ResourceTag permission does not allow you to tag and untag links and sinks.
Removes one or more tags from the specified resource.
Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:TagResource permission does not allow you to tag and untag links and sinks.
Use this operation to change what types of data are shared from a source account to its linked monitoring account sink. You can't change the sink or change the monitoring account with this operation.
When you update a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
To update the list of tags associated with the sink, use TagResource.
" + } + }, + "shapes":{ + "Arn":{ + "type":"string", + "pattern":"^arn:(\\w|-)+:oam:.+:.+:.+" + }, + "ConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "amznErrorType":{ + "shape":"String", + "documentation":"The name of the exception.
", + "location":"header", + "locationName":"x-amzn-ErrorType" + } + }, + "documentation":"A resource was in an inconsistent state during an update or a deletion.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateLinkInput":{ + "type":"structure", + "required":[ + "LabelTemplate", + "ResourceTypes", + "SinkIdentifier" + ], + "members":{ + "LabelTemplate":{ + "shape":"LabelTemplate", + "documentation":"Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
You can use a custom label or use the following variables:
$AccountName is the name of the account
$AccountEmail is the globally unique email address of the account
$AccountEmailNoDomain is the email address of the account without the domain name
Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.
" + }, + "ResourceTypes":{ + "shape":"ResourceTypesInput", + "documentation":"An array of strings that define which types of data that the source account shares with the monitoring account.
" + }, + "SinkIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks.
For more information about sinks, see CreateSink.
" + }, + "Tags":{ + "shape":"TagMapInput", + "documentation":"Assigns one or more tags (key-value pairs) to the link.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
" + } + } + }, + "CreateLinkOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The ARN of the link that is newly created.
" + }, + "Id":{ + "shape":"String", + "documentation":"The random ID string that Amazon Web Services generated as part of the link ARN.
" + }, + "Label":{ + "shape":"String", + "documentation":"The label that you assigned to this link. If the labelTemplate includes variables, this field displays the variables resolved to their actual values.
The exact label template that you specified, with the variables not resolved.
" + }, + "LinkConfiguration":{ + "shape":"LinkConfiguration", + "documentation":"This structure includes filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
" + }, + "ResourceTypes":{ + "shape":"ResourceTypesOutput", + "documentation":"The resource types supported by this link.
" + }, + "SinkArn":{ + "shape":"String", + "documentation":"The ARN of the sink that is used for this link.
" + }, + "Tags":{ + "shape":"TagMapOutput", + "documentation":"The tags assigned to the link.
" + } + } + }, + "CreateSinkInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"SinkName", + "documentation":"A name for the sink.
" + }, + "Tags":{ + "shape":"TagMapInput", + "documentation":"Assigns one or more tags (key-value pairs) to the link.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
" + } + } + }, + "CreateSinkOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The ARN of the sink that is newly created.
" + }, + "Id":{ + "shape":"String", + "documentation":"The random ID string that Amazon Web Services generated as part of the sink ARN.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the sink.
" + }, + "Tags":{ + "shape":"TagMapOutput", + "documentation":"The tags assigned to the sink.
" + } + } + }, + "DeleteLinkInput":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"ResourceIdentifier", + "documentation":"The ARN of the link to delete.
" + } + } + }, + "DeleteLinkOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteSinkInput":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"ResourceIdentifier", + "documentation":"The ARN of the sink to delete.
" + } + } + }, + "DeleteSinkOutput":{ + "type":"structure", + "members":{ + } + }, + "GetLinkInput":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"ResourceIdentifier", + "documentation":"The ARN of the link to retrieve information for.
" + } + } + }, + "GetLinkOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The ARN of the link.
" + }, + "Id":{ + "shape":"String", + "documentation":"The random ID string that Amazon Web Services generated as part of the link ARN.
" + }, + "Label":{ + "shape":"String", + "documentation":"The label that you assigned to this link, with the variables resolved to their actual values.
" + }, + "LabelTemplate":{ + "shape":"String", + "documentation":"The exact label template that was specified when the link was created, with the template variables not resolved.
" + }, + "LinkConfiguration":{ + "shape":"LinkConfiguration", + "documentation":"This structure includes filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
" + }, + "ResourceTypes":{ + "shape":"ResourceTypesOutput", + "documentation":"The resource types supported by this link.
" + }, + "SinkArn":{ + "shape":"String", + "documentation":"The ARN of the sink that is used for this link.
" + }, + "Tags":{ + "shape":"TagMapOutput", + "documentation":"The tags assigned to the link.
" + } + } + }, + "GetSinkInput":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"ResourceIdentifier", + "documentation":"The ARN of the sink to retrieve information for.
" + } + } + }, + "GetSinkOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The ARN of the sink.
" + }, + "Id":{ + "shape":"String", + "documentation":"The random ID string that Amazon Web Services generated as part of the sink ARN.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the sink.
" + }, + "Tags":{ + "shape":"TagMapOutput", + "documentation":"The tags assigned to the sink.
" + } + } + }, + "GetSinkPolicyInput":{ + "type":"structure", + "required":["SinkIdentifier"], + "members":{ + "SinkIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"The ARN of the sink to retrieve the policy of.
" + } + } + }, + "GetSinkPolicyOutput":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"String", + "documentation":"The policy that you specified, in JSON format.
" + }, + "SinkArn":{ + "shape":"String", + "documentation":"The ARN of the sink.
" + }, + "SinkId":{ + "shape":"String", + "documentation":"The random ID string that Amazon Web Services generated as part of the sink ARN.
" + } + } + }, + "InternalServiceFault":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "amznErrorType":{ + "shape":"String", + "documentation":"The name of the exception.
", + "location":"header", + "locationName":"x-amzn-ErrorType" + } + }, + "documentation":"Unexpected error while processing the request. Retry the request.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "amznErrorType":{ + "shape":"String", + "documentation":"The name of the exception.
", + "location":"header", + "locationName":"x-amzn-ErrorType" + }, + "message":{"shape":"String"} + }, + "documentation":"A parameter is specified incorrectly.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "LabelTemplate":{ + "type":"string", + "max":64, + "min":1 + }, + "LinkConfiguration":{ + "type":"structure", + "members":{ + "LogGroupConfiguration":{ + "shape":"LogGroupConfiguration", + "documentation":"Use this structure to filter which log groups are to send log events from the source account to the monitoring account.
" + }, + "MetricConfiguration":{ + "shape":"MetricConfiguration", + "documentation":"Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
" + } + }, + "documentation":"Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.
" + }, + "ListAttachedLinksInput":{ + "type":"structure", + "required":["SinkIdentifier"], + "members":{ + "MaxResults":{ + "shape":"ListAttachedLinksMaxResults", + "documentation":"Limits the number of returned links to the specified number.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of items to return. You received this token from a previous call.
" + }, + "SinkIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"The ARN of the sink that you want to retrieve links for.
" + } + } + }, + "ListAttachedLinksItem":{ + "type":"structure", + "members":{ + "Label":{ + "shape":"String", + "documentation":"The label that was assigned to this link at creation, with the variables resolved to their actual values.
" + }, + "LinkArn":{ + "shape":"String", + "documentation":"The ARN of the link.
" + }, + "ResourceTypes":{ + "shape":"ResourceTypesOutput", + "documentation":"The resource types supported by this link.
" + } + }, + "documentation":"A structure that contains information about one link attached to this monitoring account sink.
" + }, + "ListAttachedLinksItems":{ + "type":"list", + "member":{"shape":"ListAttachedLinksItem"} + }, + "ListAttachedLinksMaxResults":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "ListAttachedLinksOutput":{ + "type":"structure", + "required":["Items"], + "members":{ + "Items":{ + "shape":"ListAttachedLinksItems", + "documentation":"An array of structures that contain the information about the attached links.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token to use when requesting the next set of links.
" + } + } + }, + "ListLinksInput":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListLinksMaxResults", + "documentation":"Limits the number of returned links to the specified number.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of items to return. You received this token from a previous call.
" + } + } + }, + "ListLinksItem":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The ARN of the link.
" + }, + "Id":{ + "shape":"String", + "documentation":"The random ID string that Amazon Web Services generated as part of the link ARN.
" + }, + "Label":{ + "shape":"String", + "documentation":"The label that was assigned to this link at creation, with the variables resolved to their actual values.
" + }, + "ResourceTypes":{ + "shape":"ResourceTypesOutput", + "documentation":"The resource types supported by this link.
" + }, + "SinkArn":{ + "shape":"String", + "documentation":"The ARN of the sink that this link is attached to.
" + } + }, + "documentation":"A structure that contains information about one of this source account's links to a monitoring account.
" + }, + "ListLinksItems":{ + "type":"list", + "member":{"shape":"ListLinksItem"} + }, + "ListLinksMaxResults":{ + "type":"integer", + "box":true, + "max":5, + "min":1 + }, + "ListLinksOutput":{ + "type":"structure", + "required":["Items"], + "members":{ + "Items":{ + "shape":"ListLinksItems", + "documentation":"An array of structures that contain the information about the returned links.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token to use when requesting the next set of links.
" + } + } + }, + "ListSinksInput":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListSinksMaxResults", + "documentation":"Limits the number of returned links to the specified number.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of items to return. You received this token from a previous call.
" + } + } + }, + "ListSinksItem":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The ARN of the sink.
" + }, + "Id":{ + "shape":"String", + "documentation":"The random ID string that Amazon Web Services generated as part of the sink ARN.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the sink.
" + } + }, + "documentation":"A structure that contains information about one of this monitoring account's sinks.
" + }, + "ListSinksItems":{ + "type":"list", + "member":{"shape":"ListSinksItem"} + }, + "ListSinksMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListSinksOutput":{ + "type":"structure", + "required":["Items"], + "members":{ + "Items":{ + "shape":"ListSinksItems", + "documentation":"An array of structures that contain the information about the returned sinks.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token to use when requesting the next set of sinks.
" + } + } + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"The ARN of the resource that you want to view tags for.
The ARN format of a sink is arn:aws:oam:Region:account-id:sink/sink-id
The ARN format of a link is arn:aws:oam:Region:account-id:link/link-id
For more information about ARN format, see CloudWatch Logs resources and operations.
Unlike tagging permissions in other Amazon Web Services services, to retrieve the list of tags for links or sinks you must have the oam:RequestTag permission. The aws:ReguestTag permission does not allow you to tag and untag links and sinks.
The list of tags associated with the requested resource.>
" + } + } + }, + "LogGroupConfiguration":{ + "type":"structure", + "required":["Filter"], + "members":{ + "Filter":{ + "shape":"LogsFilter", + "documentation":"Use this field to specify which log groups are to share their log events with the monitoring account. Use the term LogGroupName and one or more of the following operands. Use single quotation marks (') around log group names. The matching of log group names is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are AND and OR.
= and !=
AND
OR
LIKE and NOT LIKE. These can be used only as prefix searches. Include a % at the end of the string that you want to search for and include.
IN and NOT IN, using parentheses ( )
Examples:
LogGroupName IN ('This-Log-Group', 'Other-Log-Group') includes only the log groups with names This-Log-Group and Other-Log-Group.
LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2') includes all log groups except the log groups with names Private-Log-Group and Private-Log-Group-2.
LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%' includes all log groups that have names that start with aws/lambda/ or AWSLogs.
If you are updating a link that uses filters, you can specify * as the only value for the filter parameter to delete the filter and share all log groups with the monitoring account.
This structure contains the Filter parameter which you can use to specify which log groups are to share log events from this source account to the monitoring account.
Use this field to specify which metrics are to be shared with the monitoring account. Use the term Namespace and one or more of the following operands. Use single quotation marks (') around namespace names. The matching of namespace names is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are AND and OR.
= and !=
AND
OR
LIKE and NOT LIKE. These can be used only as prefix searches. Include a % at the end of the string that you want to search for and include.
IN and NOT IN, using parentheses ( )
Examples:
Namespace NOT LIKE 'AWS/%' includes only namespaces that don't start with AWS/, such as custom namespaces.
Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3') includes only the metrics in the EC2, Elastic Load Balancing, and Amazon S3 namespaces.
Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%' includes only the EC2 namespace and your custom namespaces.
If you are updating a link that uses filters, you can specify * as the only value for the filter parameter to delete the filter and share all metric namespaces with the monitoring account.
This structure contains the Filter parameter which you can use to specify which metric namespaces are to be shared from this source account to the monitoring account.
The name of the exception.
", + "location":"header", + "locationName":"x-amzn-ErrorType" + }, + "message":{"shape":"String"} + }, + "documentation":"A required parameter is missing from the request.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "NextToken":{"type":"string"}, + "PutSinkPolicyInput":{ + "type":"structure", + "required":[ + "Policy", + "SinkIdentifier" + ], + "members":{ + "Policy":{ + "shape":"SinkPolicy", + "documentation":"The JSON policy to use. If you are updating an existing policy, the entire existing policy is replaced by what you specify here.
The policy must be in JSON string format with quotation marks escaped and no newlines.
For examples of different types of policies, see the Examples section on this page.
" + }, + "SinkIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"The ARN of the sink to attach this policy to.
" + } + } + }, + "PutSinkPolicyOutput":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"String", + "documentation":"The policy that you specified.
" + }, + "SinkArn":{ + "shape":"String", + "documentation":"The ARN of the sink.
" + }, + "SinkId":{ + "shape":"String", + "documentation":"The random ID string that Amazon Web Services generated as part of the sink ARN.
" + } + } + }, + "ResourceIdentifier":{ + "type":"string", + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_:\\.\\-\\/]{0,2047}$" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "amznErrorType":{ + "shape":"String", + "documentation":"The name of the exception.
", + "location":"header", + "locationName":"x-amzn-ErrorType" + } + }, + "documentation":"The request references a resource that does not exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceType":{ + "type":"string", + "enum":[ + "AWS::CloudWatch::Metric", + "AWS::Logs::LogGroup", + "AWS::XRay::Trace", + "AWS::ApplicationInsights::Application", + "AWS::InternetMonitor::Monitor" + ] + }, + "ResourceTypesInput":{ + "type":"list", + "member":{"shape":"ResourceType"}, + "max":50, + "min":1 + }, + "ResourceTypesOutput":{ + "type":"list", + "member":{"shape":"String"} + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "amznErrorType":{ + "shape":"String", + "documentation":"The name of the exception.
", + "location":"header", + "locationName":"x-amzn-ErrorType" + } + }, + "documentation":"The request would cause a service quota to be exceeded.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "SinkName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_\\.\\-]{1,255}$" + }, + "SinkPolicy":{"type":"string"}, + "String":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagMapInput":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":0 + }, + "TagMapOutput":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"The ARN of the resource that you're adding tags to.
The ARN format of a sink is arn:aws:oam:Region:account-id:sink/sink-id
The ARN format of a link is arn:aws:oam:Region:account-id:link/link-id
For more information about ARN format, see CloudWatch Logs resources and operations.
", + "location":"uri", + "locationName":"ResourceArn" + }, + "Tags":{ + "shape":"TagMapInput", + "documentation":"The list of key-value pairs to associate with the resource.
" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"A resource can have no more than 50 tags.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"The ARN of the resource that you're removing tags from.
The ARN format of a sink is arn:aws:oam:Region:account-id:sink/sink-id
The ARN format of a link is arn:aws:oam:Region:account-id:link/link-id
For more information about ARN format, see CloudWatch Logs resources and operations.
", + "location":"uri", + "locationName":"ResourceArn" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"The list of tag keys to remove from the resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateLinkInput":{ + "type":"structure", + "required":[ + "Identifier", + "ResourceTypes" + ], + "members":{ + "Identifier":{ + "shape":"ResourceIdentifier", + "documentation":"The ARN of the link that you want to update.
" + }, + "LinkConfiguration":{ + "shape":"LinkConfiguration", + "documentation":"Use this structure to filter which metric namespaces and which log groups are to be shared from the source account to the monitoring account.
" + }, + "ResourceTypes":{ + "shape":"ResourceTypesInput", + "documentation":"An array of strings that define which types of data that the source account will send to the monitoring account.
Your input here replaces the current set of data types that are shared.
" + } + } + }, + "UpdateLinkOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The ARN of the link that you have updated.
" + }, + "Id":{ + "shape":"String", + "documentation":"The random ID string that Amazon Web Services generated as part of the sink ARN.
" + }, + "Label":{ + "shape":"String", + "documentation":"The label assigned to this link, with the variables resolved to their actual values.
" + }, + "LabelTemplate":{ + "shape":"LabelTemplate", + "documentation":"The exact label template that was specified when the link was created, with the template variables not resolved.
" + }, + "LinkConfiguration":{ + "shape":"LinkConfiguration", + "documentation":"This structure includes filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
" + }, + "ResourceTypes":{ + "shape":"ResourceTypesOutput", + "documentation":"The resource types now supported by this link.
" + }, + "SinkArn":{ + "shape":"String", + "documentation":"The ARN of the sink that is used for this link.
" + }, + "Tags":{ + "shape":"TagMapOutput", + "documentation":"The tags assigned to the link.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The value of a parameter in the request caused an error.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + }, + "documentation":"Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using CloudWatch cross-account observability. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, and Application Insights applications in any of the linked accounts without account boundaries.
Set up one or more Amazon Web Services accounts as monitoring accounts and link them with multiple source accounts. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, and applications in Amazon CloudWatch Application Insights.
" +} diff --git a/testbed/boto__botocore/botocore/data/omics/2022-11-28/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/omics/2022-11-28/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..9804a00b9c9ab1735d687ce4dc62f2d175c3b9d4 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/omics/2022-11-28/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://omics-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://omics-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://omics.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://omics.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/omics/2022-11-28/paginators-1.json b/testbed/boto__botocore/botocore/data/omics/2022-11-28/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..bbb13cb116f68df834ed67c51e86184145914d0e --- /dev/null +++ b/testbed/boto__botocore/botocore/data/omics/2022-11-28/paginators-1.json @@ -0,0 +1,124 @@ +{ + "pagination": { + "ListAnnotationImportJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "annotationImportJobs" + }, + "ListAnnotationStores": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "annotationStores" + }, + "ListReadSetActivationJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "activationJobs" + }, + "ListReadSetExportJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "exportJobs" + }, + "ListReadSetImportJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "importJobs" + }, + "ListReadSets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "readSets" + }, + "ListReferenceImportJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "importJobs" + }, + "ListReferenceStores": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "referenceStores" + }, + "ListReferences": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "references" + }, + "ListRunGroups": { + "input_token": "startingToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "items" + }, + "ListRunTasks": { + "input_token": "startingToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "items" + }, + "ListRuns": { + "input_token": "startingToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "items" + }, + "ListSequenceStores": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "sequenceStores" + }, + "ListVariantImportJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "variantImportJobs" + }, + "ListVariantStores": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "variantStores" + }, + "ListWorkflows": { + "input_token": "startingToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "items" + }, + "ListMultipartReadSetUploads": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "uploads" + }, + "ListReadSetUploadParts": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "parts" + }, + "ListAnnotationStoreVersions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "annotationStoreVersions" + }, + "ListShares": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "shares" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/omics/2022-11-28/service-2.json b/testbed/boto__botocore/botocore/data/omics/2022-11-28/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..a7213063382b2eb66f6f40be02ce16445d9efcfa --- /dev/null +++ b/testbed/boto__botocore/botocore/data/omics/2022-11-28/service-2.json @@ -0,0 +1,9466 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-11-28", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"omics", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"Amazon Omics", + "serviceId":"Omics", + "signatureVersion":"v4", + "signingName":"omics", + "uid":"omics-2022-11-28" + }, + "operations":{ + "AbortMultipartReadSetUpload":{ + "name":"AbortMultipartReadSetUpload", + "http":{ + "method":"DELETE", + "requestUri":"/sequencestore/{sequenceStoreId}/upload/{uploadId}/abort", + "responseCode":200 + }, + "input":{"shape":"AbortMultipartReadSetUploadRequest"}, + "output":{"shape":"AbortMultipartReadSetUploadResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"NotSupportedOperationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Stops a multipart upload.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "AcceptShare":{ + "name":"AcceptShare", + "http":{ + "method":"POST", + "requestUri":"/share/{shareId}", + "responseCode":200 + }, + "input":{"shape":"AcceptShareRequest"}, + "output":{"shape":"AcceptShareResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Accept a resource share request.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "BatchDeleteReadSet":{ + "name":"BatchDeleteReadSet", + "http":{ + "method":"POST", + "requestUri":"/sequencestore/{sequenceStoreId}/readset/batch/delete", + "responseCode":200 + }, + "input":{"shape":"BatchDeleteReadSetRequest"}, + "output":{"shape":"BatchDeleteReadSetResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Deletes one or more read sets.
", + "endpoint":{"hostPrefix":"control-storage-"}, + "idempotent":true + }, + "CancelAnnotationImportJob":{ + "name":"CancelAnnotationImportJob", + "http":{ + "method":"DELETE", + "requestUri":"/import/annotation/{jobId}", + "responseCode":200 + }, + "input":{"shape":"CancelAnnotationImportRequest"}, + "output":{"shape":"CancelAnnotationImportResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Cancels an annotation import job.
", + "endpoint":{"hostPrefix":"analytics-"}, + "idempotent":true + }, + "CancelRun":{ + "name":"CancelRun", + "http":{ + "method":"POST", + "requestUri":"/run/{id}/cancel", + "responseCode":202 + }, + "input":{"shape":"CancelRunRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Cancels a run.
", + "endpoint":{"hostPrefix":"workflows-"} + }, + "CancelVariantImportJob":{ + "name":"CancelVariantImportJob", + "http":{ + "method":"DELETE", + "requestUri":"/import/variant/{jobId}", + "responseCode":200 + }, + "input":{"shape":"CancelVariantImportRequest"}, + "output":{"shape":"CancelVariantImportResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Cancels a variant import job.
", + "endpoint":{"hostPrefix":"analytics-"}, + "idempotent":true + }, + "CompleteMultipartReadSetUpload":{ + "name":"CompleteMultipartReadSetUpload", + "http":{ + "method":"POST", + "requestUri":"/sequencestore/{sequenceStoreId}/upload/{uploadId}/complete", + "responseCode":200 + }, + "input":{"shape":"CompleteMultipartReadSetUploadRequest"}, + "output":{"shape":"CompleteMultipartReadSetUploadResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"NotSupportedOperationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Concludes a multipart upload once you have uploaded all the components.
", + "endpoint":{"hostPrefix":"storage-"} + }, + "CreateAnnotationStore":{ + "name":"CreateAnnotationStore", + "http":{ + "method":"POST", + "requestUri":"/annotationStore", + "responseCode":200 + }, + "input":{"shape":"CreateAnnotationStoreRequest"}, + "output":{"shape":"CreateAnnotationStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates an annotation store.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "CreateAnnotationStoreVersion":{ + "name":"CreateAnnotationStoreVersion", + "http":{ + "method":"POST", + "requestUri":"/annotationStore/{name}/version", + "responseCode":200 + }, + "input":{"shape":"CreateAnnotationStoreVersionRequest"}, + "output":{"shape":"CreateAnnotationStoreVersionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a new version of an annotation store.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "CreateMultipartReadSetUpload":{ + "name":"CreateMultipartReadSetUpload", + "http":{ + "method":"POST", + "requestUri":"/sequencestore/{sequenceStoreId}/upload", + "responseCode":200 + }, + "input":{"shape":"CreateMultipartReadSetUploadRequest"}, + "output":{"shape":"CreateMultipartReadSetUploadResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"NotSupportedOperationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Begins a multipart read set upload.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "CreateReferenceStore":{ + "name":"CreateReferenceStore", + "http":{ + "method":"POST", + "requestUri":"/referencestore", + "responseCode":200 + }, + "input":{"shape":"CreateReferenceStoreRequest"}, + "output":{"shape":"CreateReferenceStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Creates a reference store.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "CreateRunGroup":{ + "name":"CreateRunGroup", + "http":{ + "method":"POST", + "requestUri":"/runGroup", + "responseCode":201 + }, + "input":{"shape":"CreateRunGroupRequest"}, + "output":{"shape":"CreateRunGroupResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"You can optionally create a run group to limit the compute resources for the runs that you add to the group.
", + "endpoint":{"hostPrefix":"workflows-"} + }, + "CreateSequenceStore":{ + "name":"CreateSequenceStore", + "http":{ + "method":"POST", + "requestUri":"/sequencestore", + "responseCode":200 + }, + "input":{"shape":"CreateSequenceStoreRequest"}, + "output":{"shape":"CreateSequenceStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Creates a sequence store.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "CreateShare":{ + "name":"CreateShare", + "http":{ + "method":"POST", + "requestUri":"/share", + "responseCode":200 + }, + "input":{"shape":"CreateShareRequest"}, + "output":{"shape":"CreateShareResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an AWS user with a different account than the resource owner).
The following resources support cross-account sharing:
HealthOmics variant stores
HealthOmics annotation stores
Private workflows
Creates a variant store.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "CreateWorkflow":{ + "name":"CreateWorkflow", + "http":{ + "method":"POST", + "requestUri":"/workflow", + "responseCode":201 + }, + "input":{"shape":"CreateWorkflowRequest"}, + "output":{"shape":"CreateWorkflowResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Creates a workflow.
", + "endpoint":{"hostPrefix":"workflows-"} + }, + "DeleteAnnotationStore":{ + "name":"DeleteAnnotationStore", + "http":{ + "method":"DELETE", + "requestUri":"/annotationStore/{name}", + "responseCode":200 + }, + "input":{"shape":"DeleteAnnotationStoreRequest"}, + "output":{"shape":"DeleteAnnotationStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes an annotation store.
", + "endpoint":{"hostPrefix":"analytics-"}, + "idempotent":true + }, + "DeleteAnnotationStoreVersions":{ + "name":"DeleteAnnotationStoreVersions", + "http":{ + "method":"POST", + "requestUri":"/annotationStore/{name}/versions/delete", + "responseCode":200 + }, + "input":{"shape":"DeleteAnnotationStoreVersionsRequest"}, + "output":{"shape":"DeleteAnnotationStoreVersionsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes one or multiple versions of an annotation store.
", + "endpoint":{"hostPrefix":"analytics-"}, + "idempotent":true + }, + "DeleteReference":{ + "name":"DeleteReference", + "http":{ + "method":"DELETE", + "requestUri":"/referencestore/{referenceStoreId}/reference/{id}", + "responseCode":200 + }, + "input":{"shape":"DeleteReferenceRequest"}, + "output":{"shape":"DeleteReferenceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Deletes a genome reference.
", + "endpoint":{"hostPrefix":"control-storage-"}, + "idempotent":true + }, + "DeleteReferenceStore":{ + "name":"DeleteReferenceStore", + "http":{ + "method":"DELETE", + "requestUri":"/referencestore/{id}", + "responseCode":200 + }, + "input":{"shape":"DeleteReferenceStoreRequest"}, + "output":{"shape":"DeleteReferenceStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Deletes a genome reference store.
", + "endpoint":{"hostPrefix":"control-storage-"}, + "idempotent":true + }, + "DeleteRun":{ + "name":"DeleteRun", + "http":{ + "method":"DELETE", + "requestUri":"/run/{id}", + "responseCode":202 + }, + "input":{"shape":"DeleteRunRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Deletes a workflow run.
", + "endpoint":{"hostPrefix":"workflows-"}, + "idempotent":true + }, + "DeleteRunGroup":{ + "name":"DeleteRunGroup", + "http":{ + "method":"DELETE", + "requestUri":"/runGroup/{id}", + "responseCode":202 + }, + "input":{"shape":"DeleteRunGroupRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Deletes a workflow run group.
", + "endpoint":{"hostPrefix":"workflows-"}, + "idempotent":true + }, + "DeleteSequenceStore":{ + "name":"DeleteSequenceStore", + "http":{ + "method":"DELETE", + "requestUri":"/sequencestore/{id}", + "responseCode":200 + }, + "input":{"shape":"DeleteSequenceStoreRequest"}, + "output":{"shape":"DeleteSequenceStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Deletes a sequence store.
", + "endpoint":{"hostPrefix":"control-storage-"}, + "idempotent":true + }, + "DeleteShare":{ + "name":"DeleteShare", + "http":{ + "method":"DELETE", + "requestUri":"/share/{shareId}", + "responseCode":200 + }, + "input":{"shape":"DeleteShareRequest"}, + "output":{"shape":"DeleteShareResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a resource share. If you are the resource owner, the subscriber will no longer have access to the shared resource. If you are the subscriber, this operation deletes your access to the share.
", + "endpoint":{"hostPrefix":"analytics-"}, + "idempotent":true + }, + "DeleteVariantStore":{ + "name":"DeleteVariantStore", + "http":{ + "method":"DELETE", + "requestUri":"/variantStore/{name}", + "responseCode":200 + }, + "input":{"shape":"DeleteVariantStoreRequest"}, + "output":{"shape":"DeleteVariantStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a variant store.
", + "endpoint":{"hostPrefix":"analytics-"}, + "idempotent":true + }, + "DeleteWorkflow":{ + "name":"DeleteWorkflow", + "http":{ + "method":"DELETE", + "requestUri":"/workflow/{id}", + "responseCode":202 + }, + "input":{"shape":"DeleteWorkflowRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Deletes a workflow.
", + "endpoint":{"hostPrefix":"workflows-"}, + "idempotent":true + }, + "GetAnnotationImportJob":{ + "name":"GetAnnotationImportJob", + "http":{ + "method":"GET", + "requestUri":"/import/annotation/{jobId}", + "responseCode":200 + }, + "input":{"shape":"GetAnnotationImportRequest"}, + "output":{"shape":"GetAnnotationImportResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets information about an annotation import job.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "GetAnnotationStore":{ + "name":"GetAnnotationStore", + "http":{ + "method":"GET", + "requestUri":"/annotationStore/{name}", + "responseCode":200 + }, + "input":{"shape":"GetAnnotationStoreRequest"}, + "output":{"shape":"GetAnnotationStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets information about an annotation store.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "GetAnnotationStoreVersion":{ + "name":"GetAnnotationStoreVersion", + "http":{ + "method":"GET", + "requestUri":"/annotationStore/{name}/version/{versionName}", + "responseCode":200 + }, + "input":{"shape":"GetAnnotationStoreVersionRequest"}, + "output":{"shape":"GetAnnotationStoreVersionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves the metadata for an annotation store version.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "GetReadSet":{ + "name":"GetReadSet", + "http":{ + "method":"GET", + "requestUri":"/sequencestore/{sequenceStoreId}/readset/{id}", + "responseCode":200 + }, + "input":{"shape":"GetReadSetRequest"}, + "output":{"shape":"GetReadSetResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"RangeNotSatisfiableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Gets a file from a read set.
", + "endpoint":{"hostPrefix":"storage-"} + }, + "GetReadSetActivationJob":{ + "name":"GetReadSetActivationJob", + "http":{ + "method":"GET", + "requestUri":"/sequencestore/{sequenceStoreId}/activationjob/{id}", + "responseCode":200 + }, + "input":{"shape":"GetReadSetActivationJobRequest"}, + "output":{"shape":"GetReadSetActivationJobResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Gets information about a read set activation job.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "GetReadSetExportJob":{ + "name":"GetReadSetExportJob", + "http":{ + "method":"GET", + "requestUri":"/sequencestore/{sequenceStoreId}/exportjob/{id}", + "responseCode":200 + }, + "input":{"shape":"GetReadSetExportJobRequest"}, + "output":{"shape":"GetReadSetExportJobResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Gets information about a read set export job.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "GetReadSetImportJob":{ + "name":"GetReadSetImportJob", + "http":{ + "method":"GET", + "requestUri":"/sequencestore/{sequenceStoreId}/importjob/{id}", + "responseCode":200 + }, + "input":{"shape":"GetReadSetImportJobRequest"}, + "output":{"shape":"GetReadSetImportJobResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Gets information about a read set import job.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "GetReadSetMetadata":{ + "name":"GetReadSetMetadata", + "http":{ + "method":"GET", + "requestUri":"/sequencestore/{sequenceStoreId}/readset/{id}/metadata", + "responseCode":200 + }, + "input":{"shape":"GetReadSetMetadataRequest"}, + "output":{"shape":"GetReadSetMetadataResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Gets details about a read set.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "GetReference":{ + "name":"GetReference", + "http":{ + "method":"GET", + "requestUri":"/referencestore/{referenceStoreId}/reference/{id}", + "responseCode":200 + }, + "input":{"shape":"GetReferenceRequest"}, + "output":{"shape":"GetReferenceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"RangeNotSatisfiableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Gets a reference file.
", + "endpoint":{"hostPrefix":"storage-"} + }, + "GetReferenceImportJob":{ + "name":"GetReferenceImportJob", + "http":{ + "method":"GET", + "requestUri":"/referencestore/{referenceStoreId}/importjob/{id}", + "responseCode":200 + }, + "input":{"shape":"GetReferenceImportJobRequest"}, + "output":{"shape":"GetReferenceImportJobResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Gets information about a reference import job.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "GetReferenceMetadata":{ + "name":"GetReferenceMetadata", + "http":{ + "method":"GET", + "requestUri":"/referencestore/{referenceStoreId}/reference/{id}/metadata", + "responseCode":200 + }, + "input":{"shape":"GetReferenceMetadataRequest"}, + "output":{"shape":"GetReferenceMetadataResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Gets information about a genome reference's metadata.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "GetReferenceStore":{ + "name":"GetReferenceStore", + "http":{ + "method":"GET", + "requestUri":"/referencestore/{id}", + "responseCode":200 + }, + "input":{"shape":"GetReferenceStoreRequest"}, + "output":{"shape":"GetReferenceStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Gets information about a reference store.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "GetRun":{ + "name":"GetRun", + "http":{ + "method":"GET", + "requestUri":"/run/{id}", + "responseCode":200 + }, + "input":{"shape":"GetRunRequest"}, + "output":{"shape":"GetRunResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Gets information about a workflow run.
If a workflow is shared with you, you cannot export information about the run.
", + "endpoint":{"hostPrefix":"workflows-"} + }, + "GetRunGroup":{ + "name":"GetRunGroup", + "http":{ + "method":"GET", + "requestUri":"/runGroup/{id}", + "responseCode":200 + }, + "input":{"shape":"GetRunGroupRequest"}, + "output":{"shape":"GetRunGroupResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Gets information about a workflow run group.
", + "endpoint":{"hostPrefix":"workflows-"} + }, + "GetRunTask":{ + "name":"GetRunTask", + "http":{ + "method":"GET", + "requestUri":"/run/{id}/task/{taskId}", + "responseCode":200 + }, + "input":{"shape":"GetRunTaskRequest"}, + "output":{"shape":"GetRunTaskResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Gets information about a workflow run task.
", + "endpoint":{"hostPrefix":"workflows-"} + }, + "GetSequenceStore":{ + "name":"GetSequenceStore", + "http":{ + "method":"GET", + "requestUri":"/sequencestore/{id}", + "responseCode":200 + }, + "input":{"shape":"GetSequenceStoreRequest"}, + "output":{"shape":"GetSequenceStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Gets information about a sequence store.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "GetShare":{ + "name":"GetShare", + "http":{ + "method":"GET", + "requestUri":"/share/{shareId}", + "responseCode":200 + }, + "input":{"shape":"GetShareRequest"}, + "output":{"shape":"GetShareResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves the metadata for the specified resource share.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "GetVariantImportJob":{ + "name":"GetVariantImportJob", + "http":{ + "method":"GET", + "requestUri":"/import/variant/{jobId}", + "responseCode":200 + }, + "input":{"shape":"GetVariantImportRequest"}, + "output":{"shape":"GetVariantImportResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets information about a variant import job.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "GetVariantStore":{ + "name":"GetVariantStore", + "http":{ + "method":"GET", + "requestUri":"/variantStore/{name}", + "responseCode":200 + }, + "input":{"shape":"GetVariantStoreRequest"}, + "output":{"shape":"GetVariantStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets information about a variant store.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "GetWorkflow":{ + "name":"GetWorkflow", + "http":{ + "method":"GET", + "requestUri":"/workflow/{id}", + "responseCode":200 + }, + "input":{"shape":"GetWorkflowRequest"}, + "output":{"shape":"GetWorkflowResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Gets information about a workflow.
If a workflow is shared with you, you cannot export the workflow.
", + "endpoint":{"hostPrefix":"workflows-"} + }, + "ListAnnotationImportJobs":{ + "name":"ListAnnotationImportJobs", + "http":{ + "method":"POST", + "requestUri":"/import/annotations", + "responseCode":200 + }, + "input":{"shape":"ListAnnotationImportJobsRequest"}, + "output":{"shape":"ListAnnotationImportJobsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of annotation import jobs.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "ListAnnotationStoreVersions":{ + "name":"ListAnnotationStoreVersions", + "http":{ + "method":"POST", + "requestUri":"/annotationStore/{name}/versions", + "responseCode":200 + }, + "input":{"shape":"ListAnnotationStoreVersionsRequest"}, + "output":{"shape":"ListAnnotationStoreVersionsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists the versions of an annotation store.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "ListAnnotationStores":{ + "name":"ListAnnotationStores", + "http":{ + "method":"POST", + "requestUri":"/annotationStores", + "responseCode":200 + }, + "input":{"shape":"ListAnnotationStoresRequest"}, + "output":{"shape":"ListAnnotationStoresResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of annotation stores.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "ListMultipartReadSetUploads":{ + "name":"ListMultipartReadSetUploads", + "http":{ + "method":"POST", + "requestUri":"/sequencestore/{sequenceStoreId}/uploads", + "responseCode":200 + }, + "input":{"shape":"ListMultipartReadSetUploadsRequest"}, + "output":{"shape":"ListMultipartReadSetUploadsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"NotSupportedOperationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Lists multipart read set uploads and for in progress uploads. Once the upload is completed, a read set is created and the upload will no longer be returned in the response.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "ListReadSetActivationJobs":{ + "name":"ListReadSetActivationJobs", + "http":{ + "method":"POST", + "requestUri":"/sequencestore/{sequenceStoreId}/activationjobs", + "responseCode":200 + }, + "input":{"shape":"ListReadSetActivationJobsRequest"}, + "output":{"shape":"ListReadSetActivationJobsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Retrieves a list of read set activation jobs.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "ListReadSetExportJobs":{ + "name":"ListReadSetExportJobs", + "http":{ + "method":"POST", + "requestUri":"/sequencestore/{sequenceStoreId}/exportjobs", + "responseCode":200 + }, + "input":{"shape":"ListReadSetExportJobsRequest"}, + "output":{"shape":"ListReadSetExportJobsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Retrieves a list of read set export jobs.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "ListReadSetImportJobs":{ + "name":"ListReadSetImportJobs", + "http":{ + "method":"POST", + "requestUri":"/sequencestore/{sequenceStoreId}/importjobs", + "responseCode":200 + }, + "input":{"shape":"ListReadSetImportJobsRequest"}, + "output":{"shape":"ListReadSetImportJobsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Retrieves a list of read set import jobs.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "ListReadSetUploadParts":{ + "name":"ListReadSetUploadParts", + "http":{ + "method":"POST", + "requestUri":"/sequencestore/{sequenceStoreId}/upload/{uploadId}/parts", + "responseCode":200 + }, + "input":{"shape":"ListReadSetUploadPartsRequest"}, + "output":{"shape":"ListReadSetUploadPartsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"NotSupportedOperationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"This operation will list all parts in a requested multipart upload for a sequence store.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "ListReadSets":{ + "name":"ListReadSets", + "http":{ + "method":"POST", + "requestUri":"/sequencestore/{sequenceStoreId}/readsets", + "responseCode":200 + }, + "input":{"shape":"ListReadSetsRequest"}, + "output":{"shape":"ListReadSetsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Retrieves a list of read sets.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "ListReferenceImportJobs":{ + "name":"ListReferenceImportJobs", + "http":{ + "method":"POST", + "requestUri":"/referencestore/{referenceStoreId}/importjobs", + "responseCode":200 + }, + "input":{"shape":"ListReferenceImportJobsRequest"}, + "output":{"shape":"ListReferenceImportJobsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Retrieves a list of reference import jobs.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "ListReferenceStores":{ + "name":"ListReferenceStores", + "http":{ + "method":"POST", + "requestUri":"/referencestores", + "responseCode":200 + }, + "input":{"shape":"ListReferenceStoresRequest"}, + "output":{"shape":"ListReferenceStoresResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Retrieves a list of reference stores.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "ListReferences":{ + "name":"ListReferences", + "http":{ + "method":"POST", + "requestUri":"/referencestore/{referenceStoreId}/references", + "responseCode":200 + }, + "input":{"shape":"ListReferencesRequest"}, + "output":{"shape":"ListReferencesResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Retrieves a list of references.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "ListRunGroups":{ + "name":"ListRunGroups", + "http":{ + "method":"GET", + "requestUri":"/runGroup", + "responseCode":200 + }, + "input":{"shape":"ListRunGroupsRequest"}, + "output":{"shape":"ListRunGroupsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Retrieves a list of run groups.
", + "endpoint":{"hostPrefix":"workflows-"} + }, + "ListRunTasks":{ + "name":"ListRunTasks", + "http":{ + "method":"GET", + "requestUri":"/run/{id}/task", + "responseCode":200 + }, + "input":{"shape":"ListRunTasksRequest"}, + "output":{"shape":"ListRunTasksResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Retrieves a list of tasks for a run.
", + "endpoint":{"hostPrefix":"workflows-"} + }, + "ListRuns":{ + "name":"ListRuns", + "http":{ + "method":"GET", + "requestUri":"/run", + "responseCode":200 + }, + "input":{"shape":"ListRunsRequest"}, + "output":{"shape":"ListRunsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Retrieves a list of runs.
", + "endpoint":{"hostPrefix":"workflows-"} + }, + "ListSequenceStores":{ + "name":"ListSequenceStores", + "http":{ + "method":"POST", + "requestUri":"/sequencestores", + "responseCode":200 + }, + "input":{"shape":"ListSequenceStoresRequest"}, + "output":{"shape":"ListSequenceStoresResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Retrieves a list of sequence stores.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "ListShares":{ + "name":"ListShares", + "http":{ + "method":"POST", + "requestUri":"/shares", + "responseCode":200 + }, + "input":{"shape":"ListSharesRequest"}, + "output":{"shape":"ListSharesResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Retrieves a list of tags for a resource.
", + "endpoint":{"hostPrefix":"tags-"} + }, + "ListVariantImportJobs":{ + "name":"ListVariantImportJobs", + "http":{ + "method":"POST", + "requestUri":"/import/variants", + "responseCode":200 + }, + "input":{"shape":"ListVariantImportJobsRequest"}, + "output":{"shape":"ListVariantImportJobsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of variant import jobs.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "ListVariantStores":{ + "name":"ListVariantStores", + "http":{ + "method":"POST", + "requestUri":"/variantStores", + "responseCode":200 + }, + "input":{"shape":"ListVariantStoresRequest"}, + "output":{"shape":"ListVariantStoresResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of variant stores.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "ListWorkflows":{ + "name":"ListWorkflows", + "http":{ + "method":"GET", + "requestUri":"/workflow", + "responseCode":200 + }, + "input":{"shape":"ListWorkflowsRequest"}, + "output":{"shape":"ListWorkflowsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Retrieves a list of workflows.
", + "endpoint":{"hostPrefix":"workflows-"} + }, + "StartAnnotationImportJob":{ + "name":"StartAnnotationImportJob", + "http":{ + "method":"POST", + "requestUri":"/import/annotation", + "responseCode":200 + }, + "input":{"shape":"StartAnnotationImportRequest"}, + "output":{"shape":"StartAnnotationImportResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Starts an annotation import job.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "StartReadSetActivationJob":{ + "name":"StartReadSetActivationJob", + "http":{ + "method":"POST", + "requestUri":"/sequencestore/{sequenceStoreId}/activationjob", + "responseCode":200 + }, + "input":{"shape":"StartReadSetActivationJobRequest"}, + "output":{"shape":"StartReadSetActivationJobResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read sets after 30 days.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "StartReadSetExportJob":{ + "name":"StartReadSetExportJob", + "http":{ + "method":"POST", + "requestUri":"/sequencestore/{sequenceStoreId}/exportjob", + "responseCode":200 + }, + "input":{"shape":"StartReadSetExportJobRequest"}, + "output":{"shape":"StartReadSetExportJobResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Exports a read set to Amazon S3.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "StartReadSetImportJob":{ + "name":"StartReadSetImportJob", + "http":{ + "method":"POST", + "requestUri":"/sequencestore/{sequenceStoreId}/importjob", + "responseCode":200 + }, + "input":{"shape":"StartReadSetImportJobRequest"}, + "output":{"shape":"StartReadSetImportJobResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Starts a read set import job.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "StartReferenceImportJob":{ + "name":"StartReferenceImportJob", + "http":{ + "method":"POST", + "requestUri":"/referencestore/{referenceStoreId}/importjob", + "responseCode":200 + }, + "input":{"shape":"StartReferenceImportJobRequest"}, + "output":{"shape":"StartReferenceImportJobResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Starts a reference import job.
", + "endpoint":{"hostPrefix":"control-storage-"} + }, + "StartRun":{ + "name":"StartRun", + "http":{ + "method":"POST", + "requestUri":"/run", + "responseCode":201 + }, + "input":{"shape":"StartRunRequest"}, + "output":{"shape":"StartRunResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The remaining parameters are copied from the previous run.
StartRun will not support re-run for a workflow that is shared with you.
The total number of runs in your account is subject to a quota per Region. To avoid needing to delete runs manually, you can set the retention mode to REMOVE. Runs with this setting are deleted automatically when the run quoata is exceeded.
By default, the run uses STATIC storage. For STATIC storage, set the storageCapacity field. You can set the storage type to DYNAMIC. You do not set storageCapacity, because HealthOmics dynamically scales the storage up or down as required. For more information about static and dynamic storage, see Running workflows in the AWS HealthOmics User Guide.
Starts a variant import job.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Tags a resource.
", + "endpoint":{"hostPrefix":"tags-"} + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Removes tags from a resource.
", + "endpoint":{"hostPrefix":"tags-"}, + "idempotent":true + }, + "UpdateAnnotationStore":{ + "name":"UpdateAnnotationStore", + "http":{ + "method":"POST", + "requestUri":"/annotationStore/{name}", + "responseCode":200 + }, + "input":{"shape":"UpdateAnnotationStoreRequest"}, + "output":{"shape":"UpdateAnnotationStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates an annotation store.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "UpdateAnnotationStoreVersion":{ + "name":"UpdateAnnotationStoreVersion", + "http":{ + "method":"POST", + "requestUri":"/annotationStore/{name}/version/{versionName}", + "responseCode":200 + }, + "input":{"shape":"UpdateAnnotationStoreVersionRequest"}, + "output":{"shape":"UpdateAnnotationStoreVersionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates the description of an annotation store version.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "UpdateRunGroup":{ + "name":"UpdateRunGroup", + "http":{ + "method":"POST", + "requestUri":"/runGroup/{id}", + "responseCode":202 + }, + "input":{"shape":"UpdateRunGroupRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Updates a run group.
", + "endpoint":{"hostPrefix":"workflows-"} + }, + "UpdateVariantStore":{ + "name":"UpdateVariantStore", + "http":{ + "method":"POST", + "requestUri":"/variantStore/{name}", + "responseCode":200 + }, + "input":{"shape":"UpdateVariantStoreRequest"}, + "output":{"shape":"UpdateVariantStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates a variant store.
", + "endpoint":{"hostPrefix":"analytics-"} + }, + "UpdateWorkflow":{ + "name":"UpdateWorkflow", + "http":{ + "method":"POST", + "requestUri":"/workflow/{id}", + "responseCode":202 + }, + "input":{"shape":"UpdateWorkflowRequest"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"Updates a workflow.
", + "endpoint":{"hostPrefix":"workflows-"} + }, + "UploadReadSetPart":{ + "name":"UploadReadSetPart", + "http":{ + "method":"PUT", + "requestUri":"/sequencestore/{sequenceStoreId}/upload/{uploadId}/part", + "responseCode":200 + }, + "input":{"shape":"UploadReadSetPartRequest"}, + "output":{"shape":"UploadReadSetPartResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"NotSupportedOperationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"This operation uploads a specific part of a read set. If you upload a new part using a previously used part number, the previously uploaded part will be overwritten.
", + "endpoint":{"hostPrefix":"storage-"}, + "unsignedPayload":true, + "authtype":"v4-unsigned-body" + } + }, + "shapes":{ + "AbortMultipartReadSetUploadRequest":{ + "type":"structure", + "required":[ + "sequenceStoreId", + "uploadId" + ], + "members":{ + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The sequence store ID for the store involved in the multipart upload.
", + "location":"uri", + "locationName":"sequenceStoreId" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"The ID for the multipart upload.
", + "location":"uri", + "locationName":"uploadId" + } + } + }, + "AbortMultipartReadSetUploadResponse":{ + "type":"structure", + "members":{ + } + }, + "Accelerators":{ + "type":"string", + "enum":["GPU"], + "max":64, + "min":1 + }, + "AcceptShareRequest":{ + "type":"structure", + "required":["shareId"], + "members":{ + "shareId":{ + "shape":"String", + "documentation":"The ID of the resource share.
", + "location":"uri", + "locationName":"shareId" + } + } + }, + "AcceptShareResponse":{ + "type":"structure", + "members":{ + "status":{ + "shape":"ShareStatus", + "documentation":"The status of the resource share.
" + } + } + }, + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "ActivateReadSetFilter":{ + "type":"structure", + "members":{ + "status":{ + "shape":"ReadSetActivationJobStatus", + "documentation":"The filter's status.
" + }, + "createdAfter":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's start date.
" + }, + "createdBefore":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's end date.
" + } + }, + "documentation":"A read set activation job filter.
" + }, + "ActivateReadSetJobItem":{ + "type":"structure", + "required":[ + "id", + "sequenceStoreId", + "status", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ActivationJobId", + "documentation":"The job's ID.
" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The job's sequence store ID.
" + }, + "status":{ + "shape":"ReadSetActivationJobStatus", + "documentation":"The job's status.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job was created.
" + }, + "completionTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job completed.
" + } + }, + "documentation":"A read set activation job.
" + }, + "ActivateReadSetJobList":{ + "type":"list", + "member":{"shape":"ActivateReadSetJobItem"} + }, + "ActivateReadSetSourceItem":{ + "type":"structure", + "required":[ + "readSetId", + "status" + ], + "members":{ + "readSetId":{ + "shape":"ReadSetId", + "documentation":"The source's read set ID.
" + }, + "status":{ + "shape":"ReadSetActivationJobItemStatus", + "documentation":"The source's status.
" + }, + "statusMessage":{ + "shape":"JobStatusMessage", + "documentation":"The source's status message.
" + } + }, + "documentation":"A source for a read set activation job.
" + }, + "ActivateReadSetSourceList":{ + "type":"list", + "member":{"shape":"ActivateReadSetSourceItem"} + }, + "ActivationJobId":{ + "type":"string", + "max":36, + "min":10, + "pattern":"[0-9]+" + }, + "AnnotationFieldMap":{ + "type":"map", + "key":{"shape":"AnnotationFieldMapKeyString"}, + "value":{"shape":"AnnotationFieldMapValueString"} + }, + "AnnotationFieldMapKeyString":{ + "type":"string", + "max":21, + "min":1 + }, + "AnnotationFieldMapValueString":{ + "type":"string", + "max":21, + "min":1 + }, + "AnnotationImportItemDetail":{ + "type":"structure", + "required":[ + "source", + "jobStatus" + ], + "members":{ + "source":{ + "shape":"S3Uri", + "documentation":"The source file's location in Amazon S3.
" + }, + "jobStatus":{ + "shape":"JobStatus", + "documentation":"The item's job status.
" + } + }, + "documentation":"Details about an imported annotation item.
" + }, + "AnnotationImportItemDetails":{ + "type":"list", + "member":{"shape":"AnnotationImportItemDetail"}, + "max":1, + "min":1 + }, + "AnnotationImportItemSource":{ + "type":"structure", + "required":["source"], + "members":{ + "source":{ + "shape":"S3Uri", + "documentation":"The source file's location in Amazon S3.
" + } + }, + "documentation":"A source for an annotation import job.
" + }, + "AnnotationImportItemSources":{ + "type":"list", + "member":{"shape":"AnnotationImportItemSource"}, + "min":1 + }, + "AnnotationImportJobItem":{ + "type":"structure", + "required":[ + "id", + "destinationName", + "versionName", + "roleArn", + "status", + "creationTime", + "updateTime" + ], + "members":{ + "id":{ + "shape":"String", + "documentation":"The job's ID.
" + }, + "destinationName":{ + "shape":"String", + "documentation":"The job's destination annotation store.
" + }, + "versionName":{ + "shape":"VersionName", + "documentation":"The name of the annotation store version.
" + }, + "roleArn":{ + "shape":"Arn", + "documentation":"The job's service role ARN.
" + }, + "status":{ + "shape":"JobStatus", + "documentation":"The job's status.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"When the job was created.
" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"When the job was updated.
" + }, + "completionTime":{ + "shape":"CompletionTime", + "documentation":"When the job completed.
" + }, + "runLeftNormalization":{ + "shape":"RunLeftNormalization", + "documentation":"The job's left normalization setting.
" + }, + "annotationFields":{ + "shape":"AnnotationFieldMap", + "documentation":"The annotation schema generated by the parsed annotation data.
" + } + }, + "documentation":"An annotation import job.
" + }, + "AnnotationImportJobItems":{ + "type":"list", + "member":{"shape":"AnnotationImportJobItem"} + }, + "AnnotationStoreItem":{ + "type":"structure", + "required":[ + "id", + "reference", + "status", + "storeArn", + "name", + "storeFormat", + "description", + "sseConfig", + "creationTime", + "updateTime", + "statusMessage", + "storeSizeBytes" + ], + "members":{ + "id":{ + "shape":"ResourceId", + "documentation":"The store's ID.
" + }, + "reference":{ + "shape":"ReferenceItem", + "documentation":"The store's genome reference.
" + }, + "status":{ + "shape":"StoreStatus", + "documentation":"The store's status.
" + }, + "storeArn":{ + "shape":"Arn", + "documentation":"The store's ARN.
" + }, + "name":{ + "shape":"String", + "documentation":"The store's name.
" + }, + "storeFormat":{ + "shape":"StoreFormat", + "documentation":"The store's file format.
" + }, + "description":{ + "shape":"Description", + "documentation":"The store's description.
" + }, + "sseConfig":{ + "shape":"SseConfig", + "documentation":"The store's server-side encryption (SSE) settings.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"The store's creation time.
" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"When the store was updated.
" + }, + "statusMessage":{ + "shape":"StatusMessage", + "documentation":"The store's status message.
" + }, + "storeSizeBytes":{ + "shape":"Long", + "documentation":"The store's size in bytes.
" + } + }, + "documentation":"An annotation store.
" + }, + "AnnotationStoreItems":{ + "type":"list", + "member":{"shape":"AnnotationStoreItem"} + }, + "AnnotationStoreVersionItem":{ + "type":"structure", + "required":[ + "storeId", + "id", + "status", + "versionArn", + "name", + "versionName", + "description", + "creationTime", + "updateTime", + "statusMessage", + "versionSizeBytes" + ], + "members":{ + "storeId":{ + "shape":"ResourceId", + "documentation":"The store ID for an annotation store version.
" + }, + "id":{ + "shape":"ResourceId", + "documentation":"The annotation store version ID.
" + }, + "status":{ + "shape":"VersionStatus", + "documentation":"The status of an annotation store version.
" + }, + "versionArn":{ + "shape":"Arn", + "documentation":"The Arn for an annotation store version.
" + }, + "name":{ + "shape":"StoreName", + "documentation":"A name given to an annotation store version to distinguish it from others.
" + }, + "versionName":{ + "shape":"VersionName", + "documentation":"The name of an annotation store version.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of an annotation store version.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"The time stamp for when an annotation store version was created.
" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"The time stamp for when an annotation store version was updated.
" + }, + "statusMessage":{ + "shape":"StatusMessage", + "documentation":"The status of an annotation store version.
" + }, + "versionSizeBytes":{ + "shape":"Long", + "documentation":"The size of an annotation store version in Bytes.
" + } + }, + "documentation":"Annotation store versions.
" + }, + "AnnotationStoreVersionItems":{ + "type":"list", + "member":{"shape":"AnnotationStoreVersionItem"} + }, + "AnnotationType":{ + "type":"string", + "enum":[ + "GENERIC", + "CHR_POS", + "CHR_POS_REF_ALT", + "CHR_START_END_ONE_BASE", + "CHR_START_END_REF_ALT_ONE_BASE", + "CHR_START_END_ZERO_BASE", + "CHR_START_END_REF_ALT_ZERO_BASE" + ] + }, + "Arn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)" + }, + "ArnList":{ + "type":"list", + "member":{"shape":"String"}, + "max":10, + "min":1 + }, + "BatchDeleteReadSetRequest":{ + "type":"structure", + "required":[ + "ids", + "sequenceStoreId" + ], + "members":{ + "ids":{ + "shape":"ReadSetIdList", + "documentation":"The read sets' IDs.
" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The read sets' sequence store ID.
", + "location":"uri", + "locationName":"sequenceStoreId" + } + } + }, + "BatchDeleteReadSetResponse":{ + "type":"structure", + "members":{ + "errors":{ + "shape":"ReadSetBatchErrorList", + "documentation":"Errors returned by individual delete operations.
" + } + } + }, + "Blob":{"type":"blob"}, + "Boolean":{ + "type":"boolean", + "box":true + }, + "CancelAnnotationImportRequest":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"ResourceId", + "documentation":"The job's ID.
", + "location":"uri", + "locationName":"jobId" + } + } + }, + "CancelAnnotationImportResponse":{ + "type":"structure", + "members":{ + } + }, + "CancelRunRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"RunId", + "documentation":"The run's ID.
", + "location":"uri", + "locationName":"id" + } + } + }, + "CancelVariantImportRequest":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"ResourceId", + "documentation":"The job's ID.
", + "location":"uri", + "locationName":"jobId" + } + } + }, + "CancelVariantImportResponse":{ + "type":"structure", + "members":{ + } + }, + "ClientToken":{ + "type":"string", + "max":127, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "CommentChar":{ + "type":"string", + "max":1, + "min":1 + }, + "CompleteMultipartReadSetUploadRequest":{ + "type":"structure", + "required":[ + "sequenceStoreId", + "uploadId", + "parts" + ], + "members":{ + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The sequence store ID for the store involved in the multipart upload.
", + "location":"uri", + "locationName":"sequenceStoreId" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"The ID for the multipart upload.
", + "location":"uri", + "locationName":"uploadId" + }, + "parts":{ + "shape":"CompleteReadSetUploadPartList", + "documentation":"The individual uploads or parts of a multipart upload.
" + } + } + }, + "CompleteMultipartReadSetUploadResponse":{ + "type":"structure", + "required":["readSetId"], + "members":{ + "readSetId":{ + "shape":"ReadSetId", + "documentation":"The read set ID created for an uploaded read set.
" + } + } + }, + "CompleteReadSetUploadPartList":{ + "type":"list", + "member":{"shape":"CompleteReadSetUploadPartListItem"} + }, + "CompleteReadSetUploadPartListItem":{ + "type":"structure", + "required":[ + "partNumber", + "partSource", + "checksum" + ], + "members":{ + "partNumber":{ + "shape":"CompleteReadSetUploadPartListItemPartNumberInteger", + "documentation":"A number identifying the part in a read set upload.
" + }, + "partSource":{ + "shape":"ReadSetPartSource", + "documentation":"The source file of the part being uploaded.
" + }, + "checksum":{ + "shape":"CompleteReadSetUploadPartListItemChecksumString", + "documentation":"A unique identifier used to confirm that parts are being added to the correct upload.
" + } + }, + "documentation":"Part of the response to the CompleteReadSetUpload API, including metadata.
" + }, + "CompleteReadSetUploadPartListItemChecksumString":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "CompleteReadSetUploadPartListItemPartNumberInteger":{ + "type":"integer", + "box":true, + "max":10000, + "min":1 + }, + "CompletionTime":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "ConflictException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request cannot be applied to the target resource in its current state.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateAnnotationStoreRequest":{ + "type":"structure", + "required":["storeFormat"], + "members":{ + "reference":{ + "shape":"ReferenceItem", + "documentation":"The genome reference for the store's annotations.
" + }, + "name":{ + "shape":"StoreName", + "documentation":"A name for the store.
" + }, + "description":{ + "shape":"Description", + "documentation":"A description for the store.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"Tags for the store.
" + }, + "versionName":{ + "shape":"VersionName", + "documentation":"The name given to an annotation store version to distinguish it from other versions.
" + }, + "sseConfig":{ + "shape":"SseConfig", + "documentation":"Server-side encryption (SSE) settings for the store.
" + }, + "storeFormat":{ + "shape":"StoreFormat", + "documentation":"The annotation file format of the store.
" + }, + "storeOptions":{ + "shape":"StoreOptions", + "documentation":"File parsing options for the annotation store.
" + } + } + }, + "CreateAnnotationStoreResponse":{ + "type":"structure", + "required":[ + "id", + "status", + "name", + "versionName", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ResourceId", + "documentation":"The store's ID.
" + }, + "reference":{ + "shape":"ReferenceItem", + "documentation":"The store's genome reference. Required for all stores except TSV format with generic annotations.
" + }, + "storeFormat":{ + "shape":"StoreFormat", + "documentation":"The annotation file format of the store.
" + }, + "storeOptions":{ + "shape":"StoreOptions", + "documentation":"The store's file parsing options.
" + }, + "status":{ + "shape":"StoreStatus", + "documentation":"The store's status.
" + }, + "name":{ + "shape":"String", + "documentation":"The store's name.
" + }, + "versionName":{ + "shape":"VersionName", + "documentation":"The name given to an annotation store version to distinguish it from other versions.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"When the store was created.
" + } + } + }, + "CreateAnnotationStoreVersionRequest":{ + "type":"structure", + "required":[ + "name", + "versionName" + ], + "members":{ + "name":{ + "shape":"StoreName", + "documentation":"The name of an annotation store version from which versions are being created.
", + "location":"uri", + "locationName":"name" + }, + "versionName":{ + "shape":"VersionName", + "documentation":"The name given to an annotation store version to distinguish it from other versions.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of an annotation store version.
" + }, + "versionOptions":{ + "shape":"VersionOptions", + "documentation":"The options for an annotation store version.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"Any tags added to annotation store version.
" + } + } + }, + "CreateAnnotationStoreVersionResponse":{ + "type":"structure", + "required":[ + "id", + "versionName", + "storeId", + "name", + "status", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ResourceId", + "documentation":"A generated ID for the annotation store
" + }, + "versionName":{ + "shape":"VersionName", + "documentation":"The name given to an annotation store version to distinguish it from other versions.
" + }, + "storeId":{ + "shape":"ResourceId", + "documentation":"The ID for the annotation store from which new versions are being created.
" + }, + "versionOptions":{ + "shape":"VersionOptions", + "documentation":"The options for an annotation store version.
" + }, + "name":{ + "shape":"StoreName", + "documentation":"The name given to an annotation store version to distinguish it from other versions.
" + }, + "status":{ + "shape":"VersionStatus", + "documentation":"The status of a annotation store version.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"The time stamp for the creation of an annotation store version.
" + } + } + }, + "CreateMultipartReadSetUploadRequest":{ + "type":"structure", + "required":[ + "sequenceStoreId", + "sourceFileType", + "subjectId", + "sampleId", + "name" + ], + "members":{ + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The sequence store ID for the store that is the destination of the multipart uploads.
", + "location":"uri", + "locationName":"sequenceStoreId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"An idempotency token that can be used to avoid triggering multiple multipart uploads.
" + }, + "sourceFileType":{ + "shape":"FileType", + "documentation":"The type of file being uploaded.
" + }, + "subjectId":{ + "shape":"SubjectId", + "documentation":"The source's subject ID.
" + }, + "sampleId":{ + "shape":"SampleId", + "documentation":"The source's sample ID.
" + }, + "generatedFrom":{ + "shape":"GeneratedFrom", + "documentation":"Where the source originated.
" + }, + "referenceArn":{ + "shape":"ReferenceArn", + "documentation":"The ARN of the reference.
" + }, + "name":{ + "shape":"ReadSetName", + "documentation":"The name of the read set.
" + }, + "description":{ + "shape":"ReadSetDescription", + "documentation":"The description of the read set.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"Any tags to add to the read set.
" + } + } + }, + "CreateMultipartReadSetUploadResponse":{ + "type":"structure", + "required":[ + "sequenceStoreId", + "uploadId", + "sourceFileType", + "subjectId", + "sampleId", + "referenceArn", + "creationTime" + ], + "members":{ + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The sequence store ID for the store that the read set will be created in.
" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"The ID for the initiated multipart upload.
" + }, + "sourceFileType":{ + "shape":"FileType", + "documentation":"The file type of the read set source.
" + }, + "subjectId":{ + "shape":"SubjectId", + "documentation":"The source's subject ID.
" + }, + "sampleId":{ + "shape":"SampleId", + "documentation":"The source's sample ID.
" + }, + "generatedFrom":{ + "shape":"GeneratedFrom", + "documentation":"The source of the read set.
" + }, + "referenceArn":{ + "shape":"ReferenceArn", + "documentation":"The read set source's reference ARN.
" + }, + "name":{ + "shape":"ReadSetName", + "documentation":"The name of the read set.
" + }, + "description":{ + "shape":"ReadSetDescription", + "documentation":"The description of the read set.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags to add to the read set.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The creation time of the multipart upload.
" + } + } + }, + "CreateReferenceStoreRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"ReferenceStoreName", + "documentation":"A name for the store.
" + }, + "description":{ + "shape":"ReferenceStoreDescription", + "documentation":"A description for the store.
" + }, + "sseConfig":{ + "shape":"SseConfig", + "documentation":"Server-side encryption (SSE) settings for the store.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"Tags for the store.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"To ensure that requests don't run multiple times, specify a unique token for each request.
" + } + } + }, + "CreateReferenceStoreResponse":{ + "type":"structure", + "required":[ + "id", + "arn", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ReferenceStoreId", + "documentation":"The store's ID.
" + }, + "arn":{ + "shape":"ReferenceStoreArn", + "documentation":"The store's ARN.
" + }, + "name":{ + "shape":"ReferenceStoreName", + "documentation":"The store's name.
" + }, + "description":{ + "shape":"ReferenceStoreDescription", + "documentation":"The store's description.
" + }, + "sseConfig":{ + "shape":"SseConfig", + "documentation":"The store's SSE settings.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the store was created.
" + } + } + }, + "CreateRunGroupRequest":{ + "type":"structure", + "required":["requestId"], + "members":{ + "name":{ + "shape":"RunGroupName", + "documentation":"A name for the group.
" + }, + "maxCpus":{ + "shape":"CreateRunGroupRequestMaxCpusInteger", + "documentation":"The maximum number of CPUs that can run concurrently across all active runs in the run group.
" + }, + "maxRuns":{ + "shape":"CreateRunGroupRequestMaxRunsInteger", + "documentation":"The maximum number of runs that can be running at the same time.
" + }, + "maxDuration":{ + "shape":"CreateRunGroupRequestMaxDurationInteger", + "documentation":"The maximum time for each run (in minutes). If a run exceeds the maximum run time, the run fails automatically.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"Tags for the group.
" + }, + "requestId":{ + "shape":"RunGroupRequestId", + "documentation":"To ensure that requests don't run multiple times, specify a unique ID for each request.
", + "idempotencyToken":true + }, + "maxGpus":{ + "shape":"CreateRunGroupRequestMaxGpusInteger", + "documentation":"The maximum number of GPUs that can run concurrently across all active runs in the run group.
" + } + } + }, + "CreateRunGroupRequestMaxCpusInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "CreateRunGroupRequestMaxDurationInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "CreateRunGroupRequestMaxGpusInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "CreateRunGroupRequestMaxRunsInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "CreateRunGroupResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"RunGroupArn", + "documentation":"The group's ARN.
" + }, + "id":{ + "shape":"RunGroupId", + "documentation":"The group's ID.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"Tags for the run group.
" + } + } + }, + "CreateSequenceStoreRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"SequenceStoreName", + "documentation":"A name for the store.
" + }, + "description":{ + "shape":"SequenceStoreDescription", + "documentation":"A description for the store.
" + }, + "sseConfig":{ + "shape":"SseConfig", + "documentation":"Server-side encryption (SSE) settings for the store.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"Tags for the store.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"To ensure that requests don't run multiple times, specify a unique token for each request.
" + }, + "fallbackLocation":{ + "shape":"S3Destination", + "documentation":"An S3 location that is used to store files that have failed a direct upload.
" + }, + "eTagAlgorithmFamily":{ + "shape":"ETagAlgorithmFamily", + "documentation":"The ETag algorithm family to use for ingested read sets.
" + } + } + }, + "CreateSequenceStoreResponse":{ + "type":"structure", + "required":[ + "id", + "arn", + "creationTime" + ], + "members":{ + "id":{ + "shape":"SequenceStoreId", + "documentation":"The store's ID.
" + }, + "arn":{ + "shape":"SequenceStoreArn", + "documentation":"The store's ARN.
" + }, + "name":{ + "shape":"SequenceStoreName", + "documentation":"The store's name.
" + }, + "description":{ + "shape":"SequenceStoreDescription", + "documentation":"The store's description.
" + }, + "sseConfig":{ + "shape":"SseConfig", + "documentation":"The store's SSE settings.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the store was created.
" + }, + "fallbackLocation":{ + "shape":"S3Destination", + "documentation":"An S3 location that is used to store files that have failed a direct upload.
" + }, + "eTagAlgorithmFamily":{ + "shape":"ETagAlgorithmFamily", + "documentation":"The algorithm family of the ETag.
" + } + } + }, + "CreateShareRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "principalSubscriber" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The ARN of the resource to be shared.
" + }, + "principalSubscriber":{ + "shape":"String", + "documentation":"The principal subscriber is the account being offered shared access to the resource.
" + }, + "shareName":{ + "shape":"ShareName", + "documentation":"A name that the owner defines for the share.
" + } + } + }, + "CreateShareResponse":{ + "type":"structure", + "members":{ + "shareId":{ + "shape":"String", + "documentation":"The ID that HealthOmics generates for the share.
" + }, + "status":{ + "shape":"ShareStatus", + "documentation":"The status of the share.
" + }, + "shareName":{ + "shape":"ShareName", + "documentation":"The name of the share.
" + } + } + }, + "CreateVariantStoreRequest":{ + "type":"structure", + "required":["reference"], + "members":{ + "reference":{ + "shape":"ReferenceItem", + "documentation":"The genome reference for the store's variants.
" + }, + "name":{ + "shape":"StoreName", + "documentation":"A name for the store.
" + }, + "description":{ + "shape":"Description", + "documentation":"A description for the store.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"Tags for the store.
" + }, + "sseConfig":{ + "shape":"SseConfig", + "documentation":"Server-side encryption (SSE) settings for the store.
" + } + } + }, + "CreateVariantStoreResponse":{ + "type":"structure", + "required":[ + "id", + "status", + "name", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ResourceId", + "documentation":"The store's ID.
" + }, + "reference":{ + "shape":"ReferenceItem", + "documentation":"The store's genome reference.
" + }, + "status":{ + "shape":"StoreStatus", + "documentation":"The store's status.
" + }, + "name":{ + "shape":"String", + "documentation":"The store's name.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"When the store was created.
" + } + } + }, + "CreateWorkflowRequest":{ + "type":"structure", + "required":["requestId"], + "members":{ + "name":{ + "shape":"WorkflowName", + "documentation":"A name for the workflow.
" + }, + "description":{ + "shape":"WorkflowDescription", + "documentation":"A description for the workflow.
" + }, + "engine":{ + "shape":"WorkflowEngine", + "documentation":"An engine for the workflow.
" + }, + "definitionZip":{ + "shape":"Blob", + "documentation":"A ZIP archive for the workflow.
" + }, + "definitionUri":{ + "shape":"WorkflowDefinition", + "documentation":"The URI of a definition for the workflow.
" + }, + "main":{ + "shape":"WorkflowMain", + "documentation":"The path of the main definition file for the workflow.
" + }, + "parameterTemplate":{ + "shape":"WorkflowParameterTemplate", + "documentation":"A parameter template for the workflow.
" + }, + "storageCapacity":{ + "shape":"CreateWorkflowRequestStorageCapacityInteger", + "documentation":"The default storage capacity for the workflow runs, in gibibytes.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"Tags for the workflow.
" + }, + "requestId":{ + "shape":"WorkflowRequestId", + "documentation":"To ensure that requests don't run multiple times, specify a unique ID for each request.
", + "idempotencyToken":true + }, + "accelerators":{ + "shape":"Accelerators", + "documentation":"The computational accelerator specified to run the workflow.
" + } + } + }, + "CreateWorkflowRequestStorageCapacityInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":0 + }, + "CreateWorkflowResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"WorkflowArn", + "documentation":"The workflow's ARN.
" + }, + "id":{ + "shape":"WorkflowId", + "documentation":"The workflow's ID.
" + }, + "status":{ + "shape":"WorkflowStatus", + "documentation":"The workflow's status.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The workflow's tags.
" + } + } + }, + "CreationJobId":{ + "type":"string", + "max":127, + "min":1, + "pattern":"[a-zA-Z0-9]+" + }, + "CreationTime":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "CreationType":{ + "type":"string", + "enum":[ + "IMPORT", + "UPLOAD" + ] + }, + "DeleteAnnotationStoreRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"The store's name.
", + "location":"uri", + "locationName":"name" + }, + "force":{ + "shape":"PrimitiveBoolean", + "documentation":"Whether to force deletion.
", + "location":"querystring", + "locationName":"force" + } + } + }, + "DeleteAnnotationStoreResponse":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"StoreStatus", + "documentation":"The store's status.
" + } + } + }, + "DeleteAnnotationStoreVersionsRequest":{ + "type":"structure", + "required":[ + "name", + "versions" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of the annotation store from which versions are being deleted.
", + "location":"uri", + "locationName":"name" + }, + "versions":{ + "shape":"VersionList", + "documentation":"The versions of an annotation store to be deleted.
" + }, + "force":{ + "shape":"PrimitiveBoolean", + "documentation":"Forces the deletion of an annotation store version when imports are in-progress..
", + "location":"querystring", + "locationName":"force" + } + } + }, + "DeleteAnnotationStoreVersionsResponse":{ + "type":"structure", + "members":{ + "errors":{ + "shape":"VersionDeleteErrorList", + "documentation":"Any errors that occur when attempting to delete an annotation store version.
" + } + } + }, + "DeleteReferenceRequest":{ + "type":"structure", + "required":[ + "id", + "referenceStoreId" + ], + "members":{ + "id":{ + "shape":"ReferenceId", + "documentation":"The reference's ID.
", + "location":"uri", + "locationName":"id" + }, + "referenceStoreId":{ + "shape":"ReferenceStoreId", + "documentation":"The reference's store ID.
", + "location":"uri", + "locationName":"referenceStoreId" + } + } + }, + "DeleteReferenceResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteReferenceStoreRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"ReferenceStoreId", + "documentation":"The store's ID.
", + "location":"uri", + "locationName":"id" + } + } + }, + "DeleteReferenceStoreResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteRunGroupRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"RunGroupId", + "documentation":"The run group's ID.
", + "location":"uri", + "locationName":"id" + } + } + }, + "DeleteRunRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"RunId", + "documentation":"The run's ID.
", + "location":"uri", + "locationName":"id" + } + } + }, + "DeleteSequenceStoreRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"SequenceStoreId", + "documentation":"The sequence store's ID.
", + "location":"uri", + "locationName":"id" + } + } + }, + "DeleteSequenceStoreResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteShareRequest":{ + "type":"structure", + "required":["shareId"], + "members":{ + "shareId":{ + "shape":"String", + "documentation":"The ID for the resource share to be deleted.
", + "location":"uri", + "locationName":"shareId" + } + } + }, + "DeleteShareResponse":{ + "type":"structure", + "members":{ + "status":{ + "shape":"ShareStatus", + "documentation":"The status of the share being deleted.
" + } + } + }, + "DeleteVariantStoreRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"The store's name.
", + "location":"uri", + "locationName":"name" + }, + "force":{ + "shape":"PrimitiveBoolean", + "documentation":"Whether to force deletion.
", + "location":"querystring", + "locationName":"force" + } + } + }, + "DeleteVariantStoreResponse":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"StoreStatus", + "documentation":"The store's status.
" + } + } + }, + "DeleteWorkflowRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"WorkflowId", + "documentation":"The workflow's ID.
", + "location":"uri", + "locationName":"id" + } + } + }, + "Description":{ + "type":"string", + "max":500, + "min":0 + }, + "ETag":{ + "type":"structure", + "members":{ + "algorithm":{ + "shape":"ETagAlgorithm", + "documentation":"The algorithm used to calculate the read set’s ETag(s).
" + }, + "source1":{ + "shape":"String", + "documentation":"The ETag hash calculated on Source1 of the read set.
" + }, + "source2":{ + "shape":"String", + "documentation":"The ETag hash calculated on Source2 of the read set.
" + } + }, + "documentation":"The entity tag (ETag) is a hash of the object representing its semantic content.
" + }, + "ETagAlgorithm":{ + "type":"string", + "enum":[ + "FASTQ_MD5up", + "BAM_MD5up", + "CRAM_MD5up", + "FASTQ_SHA256up", + "BAM_SHA256up", + "CRAM_SHA256up", + "FASTQ_SHA512up", + "BAM_SHA512up", + "CRAM_SHA512up" + ] + }, + "ETagAlgorithmFamily":{ + "type":"string", + "enum":[ + "MD5up", + "SHA256up", + "SHA512up" + ] + }, + "Encoding":{ + "type":"string", + "max":20, + "min":1 + }, + "EncryptionType":{ + "type":"string", + "enum":["KMS"] + }, + "EngineLogStream":{ + "type":"string", + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "EscapeChar":{ + "type":"string", + "max":1, + "min":1 + }, + "EscapeQuotes":{"type":"boolean"}, + "ExportJobId":{ + "type":"string", + "max":36, + "min":10, + "pattern":"[0-9]+" + }, + "ExportReadSet":{ + "type":"structure", + "required":["readSetId"], + "members":{ + "readSetId":{ + "shape":"ReadSetId", + "documentation":"The set's ID.
" + } + }, + "documentation":"A read set.
" + }, + "ExportReadSetDetail":{ + "type":"structure", + "required":[ + "id", + "status" + ], + "members":{ + "id":{ + "shape":"ReadSetId", + "documentation":"The set's ID.
" + }, + "status":{ + "shape":"ReadSetExportJobItemStatus", + "documentation":"The set's status.
" + }, + "statusMessage":{ + "shape":"JobStatusMessage", + "documentation":"The set's status message.
" + } + }, + "documentation":"Details about a read set.
" + }, + "ExportReadSetDetailList":{ + "type":"list", + "member":{"shape":"ExportReadSetDetail"} + }, + "ExportReadSetFilter":{ + "type":"structure", + "members":{ + "status":{ + "shape":"ReadSetExportJobStatus", + "documentation":"A status to filter on.
" + }, + "createdAfter":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's start date.
" + }, + "createdBefore":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's end date.
" + } + }, + "documentation":"An read set export job filter.
" + }, + "ExportReadSetJobDetail":{ + "type":"structure", + "required":[ + "id", + "sequenceStoreId", + "destination", + "status", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ExportJobId", + "documentation":"The job's ID.
" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The job's sequence store ID.
" + }, + "destination":{ + "shape":"S3Destination", + "documentation":"The job's destination in Amazon S3.
" + }, + "status":{ + "shape":"ReadSetExportJobStatus", + "documentation":"The job's status.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job was created.
" + }, + "completionTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job completed.
" + } + }, + "documentation":"Details about a read set export job.
" + }, + "ExportReadSetJobDetailList":{ + "type":"list", + "member":{"shape":"ExportReadSetJobDetail"} + }, + "FileInformation":{ + "type":"structure", + "members":{ + "totalParts":{ + "shape":"FileInformationTotalPartsInteger", + "documentation":"The file's total parts.
" + }, + "partSize":{ + "shape":"FileInformationPartSizeLong", + "documentation":"The file's part size.
" + }, + "contentLength":{ + "shape":"FileInformationContentLengthLong", + "documentation":"The file's content length.
" + }, + "s3Access":{ + "shape":"ReadSetS3Access", + "documentation":"The S3 URI metadata of a sequence store.
" + } + }, + "documentation":"Details about a file.
" + }, + "FileInformationContentLengthLong":{ + "type":"long", + "box":true, + "max":5497558138880, + "min":1 + }, + "FileInformationPartSizeLong":{ + "type":"long", + "box":true, + "max":5368709120, + "min":1 + }, + "FileInformationTotalPartsInteger":{ + "type":"integer", + "box":true, + "max":10000, + "min":1 + }, + "FileType":{ + "type":"string", + "enum":[ + "FASTQ", + "BAM", + "CRAM", + "UBAM" + ] + }, + "Filter":{ + "type":"structure", + "members":{ + "resourceArns":{ + "shape":"ArnList", + "documentation":"Filter based on the Amazon Resource Number (ARN) of the resource. You can specify up to 10 values.
" + }, + "status":{ + "shape":"StatusList", + "documentation":"Filter based on the resource status. You can specify up to 10 values.
" + }, + "type":{ + "shape":"TypeList", + "documentation":"The type of resources to be filtered. You can specify one or more of the resource types.
" + } + }, + "documentation":"Use filters to return a subset of resources. You can define filters for specific parameters, such as the resource status.
" + }, + "FormatOptions":{ + "type":"structure", + "members":{ + "tsvOptions":{ + "shape":"TsvOptions", + "documentation":"Options for a TSV file.
" + }, + "vcfOptions":{ + "shape":"VcfOptions", + "documentation":"Options for a VCF file.
" + } + }, + "documentation":"Formatting options for a file.
", + "union":true + }, + "FormatToHeader":{ + "type":"map", + "key":{"shape":"FormatToHeaderKey"}, + "value":{"shape":"FormatToHeaderValueString"} + }, + "FormatToHeaderKey":{ + "type":"string", + "enum":[ + "CHR", + "START", + "END", + "REF", + "ALT", + "POS" + ] + }, + "FormatToHeaderValueString":{ + "type":"string", + "max":1000, + "min":0 + }, + "GeneratedFrom":{ + "type":"string", + "max":127, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "GetAnnotationImportRequest":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"ResourceId", + "documentation":"The job's ID.
", + "location":"uri", + "locationName":"jobId" + } + } + }, + "GetAnnotationImportResponse":{ + "type":"structure", + "required":[ + "id", + "destinationName", + "versionName", + "roleArn", + "status", + "statusMessage", + "creationTime", + "updateTime", + "completionTime", + "items", + "runLeftNormalization", + "formatOptions" + ], + "members":{ + "id":{ + "shape":"ResourceId", + "documentation":"The job's ID.
" + }, + "destinationName":{ + "shape":"StoreName", + "documentation":"The job's destination annotation store.
" + }, + "versionName":{ + "shape":"VersionName", + "documentation":"The name of the annotation store version.
" + }, + "roleArn":{ + "shape":"Arn", + "documentation":"The job's service role ARN.
" + }, + "status":{ + "shape":"JobStatus", + "documentation":"The job's status.
" + }, + "statusMessage":{ + "shape":"JobStatusMsg", + "documentation":"The job's status message.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"When the job was created.
" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"When the job was updated.
" + }, + "completionTime":{ + "shape":"CompletionTime", + "documentation":"When the job completed.
" + }, + "items":{ + "shape":"AnnotationImportItemDetails", + "documentation":"The job's imported items.
" + }, + "runLeftNormalization":{ + "shape":"RunLeftNormalization", + "documentation":"The job's left normalization setting.
" + }, + "formatOptions":{"shape":"FormatOptions"}, + "annotationFields":{ + "shape":"AnnotationFieldMap", + "documentation":"The annotation schema generated by the parsed annotation data.
" + } + } + }, + "GetAnnotationStoreRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"The store's name.
", + "location":"uri", + "locationName":"name" + } + } + }, + "GetAnnotationStoreResponse":{ + "type":"structure", + "required":[ + "id", + "reference", + "status", + "storeArn", + "name", + "description", + "sseConfig", + "creationTime", + "updateTime", + "tags", + "statusMessage", + "storeSizeBytes", + "numVersions" + ], + "members":{ + "id":{ + "shape":"ResourceId", + "documentation":"The store's ID.
" + }, + "reference":{ + "shape":"ReferenceItem", + "documentation":"The store's genome reference.
" + }, + "status":{ + "shape":"StoreStatus", + "documentation":"The store's status.
" + }, + "storeArn":{ + "shape":"Arn", + "documentation":"The store's ARN.
" + }, + "name":{ + "shape":"String", + "documentation":"The store's name.
" + }, + "description":{ + "shape":"Description", + "documentation":"The store's description.
" + }, + "sseConfig":{ + "shape":"SseConfig", + "documentation":"The store's server-side encryption (SSE) settings.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"When the store was created.
" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"When the store was updated.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The store's tags.
" + }, + "storeOptions":{ + "shape":"StoreOptions", + "documentation":"The store's parsing options.
" + }, + "storeFormat":{ + "shape":"StoreFormat", + "documentation":"The store's annotation file format.
" + }, + "statusMessage":{ + "shape":"StatusMessage", + "documentation":"A status message.
" + }, + "storeSizeBytes":{ + "shape":"Long", + "documentation":"The store's size in bytes.
" + }, + "numVersions":{ + "shape":"Integer", + "documentation":"An integer indicating how many versions of an annotation store exist.
" + } + } + }, + "GetAnnotationStoreVersionRequest":{ + "type":"structure", + "required":[ + "name", + "versionName" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"The name given to an annotation store version to distinguish it from others.
", + "location":"uri", + "locationName":"name" + }, + "versionName":{ + "shape":"String", + "documentation":"The name given to an annotation store version to distinguish it from others.
", + "location":"uri", + "locationName":"versionName" + } + } + }, + "GetAnnotationStoreVersionResponse":{ + "type":"structure", + "required":[ + "storeId", + "id", + "status", + "versionArn", + "name", + "versionName", + "description", + "creationTime", + "updateTime", + "tags", + "statusMessage", + "versionSizeBytes" + ], + "members":{ + "storeId":{ + "shape":"ResourceId", + "documentation":"The store ID for annotation store version.
" + }, + "id":{ + "shape":"ResourceId", + "documentation":"The annotation store version ID.
" + }, + "status":{ + "shape":"VersionStatus", + "documentation":"The status of an annotation store version.
" + }, + "versionArn":{ + "shape":"Arn", + "documentation":"The Arn for the annotation store.
" + }, + "name":{ + "shape":"StoreName", + "documentation":"The name of the annotation store.
" + }, + "versionName":{ + "shape":"VersionName", + "documentation":"The name given to an annotation store version to distinguish it from others.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description for an annotation store version.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"The time stamp for when an annotation store version was created.
" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"The time stamp for when an annotation store version was updated.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"Any tags associated with an annotation store version.
" + }, + "versionOptions":{ + "shape":"VersionOptions", + "documentation":"The options for an annotation store version.
" + }, + "statusMessage":{ + "shape":"StatusMessage", + "documentation":"The status of an annotation store version.
" + }, + "versionSizeBytes":{ + "shape":"Long", + "documentation":"The size of the annotation store version in Bytes.
" + } + } + }, + "GetReadSetActivationJobRequest":{ + "type":"structure", + "required":[ + "id", + "sequenceStoreId" + ], + "members":{ + "id":{ + "shape":"ActivationJobId", + "documentation":"The job's ID.
", + "location":"uri", + "locationName":"id" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The job's sequence store ID.
", + "location":"uri", + "locationName":"sequenceStoreId" + } + } + }, + "GetReadSetActivationJobResponse":{ + "type":"structure", + "required":[ + "id", + "sequenceStoreId", + "status", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ActivationJobId", + "documentation":"The job's ID.
" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The job's sequence store ID.
" + }, + "status":{ + "shape":"ReadSetActivationJobStatus", + "documentation":"The job's status.
" + }, + "statusMessage":{ + "shape":"JobStatusMessage", + "documentation":"The job's status message.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job was created.
" + }, + "completionTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job completed.
" + }, + "sources":{ + "shape":"ActivateReadSetSourceList", + "documentation":"The job's source files.
" + } + } + }, + "GetReadSetExportJobRequest":{ + "type":"structure", + "required":[ + "sequenceStoreId", + "id" + ], + "members":{ + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The job's sequence store ID.
", + "location":"uri", + "locationName":"sequenceStoreId" + }, + "id":{ + "shape":"ExportJobId", + "documentation":"The job's ID.
", + "location":"uri", + "locationName":"id" + } + } + }, + "GetReadSetExportJobResponse":{ + "type":"structure", + "required":[ + "id", + "sequenceStoreId", + "destination", + "status", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ExportJobId", + "documentation":"The job's ID.
" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The job's sequence store ID.
" + }, + "destination":{ + "shape":"S3Destination", + "documentation":"The job's destination in Amazon S3.
" + }, + "status":{ + "shape":"ReadSetExportJobStatus", + "documentation":"The job's status.
" + }, + "statusMessage":{ + "shape":"JobStatusMessage", + "documentation":"The job's status message.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job was created.
" + }, + "completionTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job completed.
" + }, + "readSets":{ + "shape":"ExportReadSetDetailList", + "documentation":"The job's read sets.
" + } + } + }, + "GetReadSetImportJobRequest":{ + "type":"structure", + "required":[ + "id", + "sequenceStoreId" + ], + "members":{ + "id":{ + "shape":"ImportJobId", + "documentation":"The job's ID.
", + "location":"uri", + "locationName":"id" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The job's sequence store ID.
", + "location":"uri", + "locationName":"sequenceStoreId" + } + } + }, + "GetReadSetImportJobResponse":{ + "type":"structure", + "required":[ + "id", + "sequenceStoreId", + "roleArn", + "status", + "creationTime", + "sources" + ], + "members":{ + "id":{ + "shape":"ImportJobId", + "documentation":"The job's ID.
" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The job's sequence store ID.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The job's service role ARN.
" + }, + "status":{ + "shape":"ReadSetImportJobStatus", + "documentation":"The job's status.
" + }, + "statusMessage":{ + "shape":"JobStatusMessage", + "documentation":"The job's status message.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job was created.
" + }, + "completionTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job completed.
" + }, + "sources":{ + "shape":"ImportReadSetSourceList", + "documentation":"The job's source files.
" + } + } + }, + "GetReadSetMetadataRequest":{ + "type":"structure", + "required":[ + "id", + "sequenceStoreId" + ], + "members":{ + "id":{ + "shape":"ReadSetId", + "documentation":"The read set's ID.
", + "location":"uri", + "locationName":"id" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The read set's sequence store ID.
", + "location":"uri", + "locationName":"sequenceStoreId" + } + } + }, + "GetReadSetMetadataResponse":{ + "type":"structure", + "required":[ + "id", + "arn", + "sequenceStoreId", + "status", + "fileType", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ReadSetId", + "documentation":"The read set's ID.
" + }, + "arn":{ + "shape":"ReadSetArn", + "documentation":"The read set's ARN.
" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The read set's sequence store ID.
" + }, + "subjectId":{ + "shape":"SubjectId", + "documentation":"The read set's subject ID.
" + }, + "sampleId":{ + "shape":"SampleId", + "documentation":"The read set's sample ID.
" + }, + "status":{ + "shape":"ReadSetStatus", + "documentation":"The read set's status.
" + }, + "name":{ + "shape":"ReadSetName", + "documentation":"The read set's name.
" + }, + "description":{ + "shape":"ReadSetDescription", + "documentation":"The read set's description.
" + }, + "fileType":{ + "shape":"FileType", + "documentation":"The read set's file type.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the read set was created.
" + }, + "sequenceInformation":{ + "shape":"SequenceInformation", + "documentation":"The read set's sequence information.
" + }, + "referenceArn":{ + "shape":"ReferenceArn", + "documentation":"The read set's genome reference ARN.
" + }, + "files":{ + "shape":"ReadSetFiles", + "documentation":"The read set's files.
" + }, + "statusMessage":{ + "shape":"ReadSetStatusMessage", + "documentation":"The status message for a read set. It provides more detail as to why the read set has a status.
" + }, + "creationType":{ + "shape":"CreationType", + "documentation":"The creation type of the read set.
" + }, + "etag":{ + "shape":"ETag", + "documentation":"The entity tag (ETag) is a hash of the object meant to represent its semantic content.
" + }, + "creationJobId":{ + "shape":"CreationJobId", + "documentation":"The read set's creation job ID.
" + } + } + }, + "GetReadSetRequest":{ + "type":"structure", + "required":[ + "id", + "sequenceStoreId", + "partNumber" + ], + "members":{ + "id":{ + "shape":"ReadSetId", + "documentation":"The read set's ID.
", + "location":"uri", + "locationName":"id" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The read set's sequence store ID.
", + "location":"uri", + "locationName":"sequenceStoreId" + }, + "file":{ + "shape":"ReadSetFile", + "documentation":"The file to retrieve.
", + "location":"querystring", + "locationName":"file" + }, + "partNumber":{ + "shape":"GetReadSetRequestPartNumberInteger", + "documentation":"The part number to retrieve.
", + "location":"querystring", + "locationName":"partNumber" + } + } + }, + "GetReadSetRequestPartNumberInteger":{ + "type":"integer", + "box":true, + "max":10000, + "min":1 + }, + "GetReadSetResponse":{ + "type":"structure", + "members":{ + "payload":{ + "shape":"ReadSetStreamingBlob", + "documentation":"The read set file payload.
" + } + }, + "payload":"payload" + }, + "GetReferenceImportJobRequest":{ + "type":"structure", + "required":[ + "id", + "referenceStoreId" + ], + "members":{ + "id":{ + "shape":"ImportJobId", + "documentation":"The job's ID.
", + "location":"uri", + "locationName":"id" + }, + "referenceStoreId":{ + "shape":"ReferenceStoreId", + "documentation":"The job's reference store ID.
", + "location":"uri", + "locationName":"referenceStoreId" + } + } + }, + "GetReferenceImportJobResponse":{ + "type":"structure", + "required":[ + "id", + "referenceStoreId", + "roleArn", + "status", + "creationTime", + "sources" + ], + "members":{ + "id":{ + "shape":"ImportJobId", + "documentation":"The job's ID.
" + }, + "referenceStoreId":{ + "shape":"ReferenceStoreId", + "documentation":"The job's reference store ID.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The job's service role ARN.
" + }, + "status":{ + "shape":"ReferenceImportJobStatus", + "documentation":"The job's status.
" + }, + "statusMessage":{ + "shape":"JobStatusMessage", + "documentation":"The job's status message.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job was created.
" + }, + "completionTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job completed.
" + }, + "sources":{ + "shape":"ImportReferenceSourceList", + "documentation":"The job's source files.
" + } + } + }, + "GetReferenceMetadataRequest":{ + "type":"structure", + "required":[ + "id", + "referenceStoreId" + ], + "members":{ + "id":{ + "shape":"ReferenceId", + "documentation":"The reference's ID.
", + "location":"uri", + "locationName":"id" + }, + "referenceStoreId":{ + "shape":"ReferenceStoreId", + "documentation":"The reference's reference store ID.
", + "location":"uri", + "locationName":"referenceStoreId" + } + } + }, + "GetReferenceMetadataResponse":{ + "type":"structure", + "required":[ + "id", + "arn", + "referenceStoreId", + "md5", + "creationTime", + "updateTime" + ], + "members":{ + "id":{ + "shape":"ReferenceId", + "documentation":"The reference's ID.
" + }, + "arn":{ + "shape":"ReferenceArn", + "documentation":"The reference's ARN.
" + }, + "referenceStoreId":{ + "shape":"ReferenceStoreId", + "documentation":"The reference's reference store ID.
" + }, + "md5":{ + "shape":"Md5", + "documentation":"The reference's MD5 checksum.
" + }, + "status":{ + "shape":"ReferenceStatus", + "documentation":"The reference's status.
" + }, + "name":{ + "shape":"ReferenceName", + "documentation":"The reference's name.
" + }, + "description":{ + "shape":"ReferenceDescription", + "documentation":"The reference's description.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the reference was created.
" + }, + "updateTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the reference was updated.
" + }, + "files":{ + "shape":"ReferenceFiles", + "documentation":"The reference's files.
" + }, + "creationType":{ + "shape":"ReferenceCreationType", + "documentation":"The reference's creation type.
" + }, + "creationJobId":{ + "shape":"CreationJobId", + "documentation":"The reference's creation job ID.
" + } + } + }, + "GetReferenceRequest":{ + "type":"structure", + "required":[ + "id", + "referenceStoreId", + "partNumber" + ], + "members":{ + "id":{ + "shape":"ReferenceId", + "documentation":"The reference's ID.
", + "location":"uri", + "locationName":"id" + }, + "referenceStoreId":{ + "shape":"ReferenceStoreId", + "documentation":"The reference's store ID.
", + "location":"uri", + "locationName":"referenceStoreId" + }, + "range":{ + "shape":"Range", + "documentation":"The range to retrieve.
", + "location":"header", + "locationName":"Range" + }, + "partNumber":{ + "shape":"GetReferenceRequestPartNumberInteger", + "documentation":"The part number to retrieve.
", + "location":"querystring", + "locationName":"partNumber" + }, + "file":{ + "shape":"ReferenceFile", + "documentation":"The file to retrieve.
", + "location":"querystring", + "locationName":"file" + } + } + }, + "GetReferenceRequestPartNumberInteger":{ + "type":"integer", + "box":true, + "max":10000, + "min":1 + }, + "GetReferenceResponse":{ + "type":"structure", + "members":{ + "payload":{ + "shape":"ReferenceStreamingBlob", + "documentation":"The reference file payload.
" + } + }, + "payload":"payload" + }, + "GetReferenceStoreRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"ReferenceStoreId", + "documentation":"The store's ID.
", + "location":"uri", + "locationName":"id" + } + } + }, + "GetReferenceStoreResponse":{ + "type":"structure", + "required":[ + "id", + "arn", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ReferenceStoreId", + "documentation":"The store's ID.
" + }, + "arn":{ + "shape":"ReferenceStoreArn", + "documentation":"The store's ARN.
" + }, + "name":{ + "shape":"ReferenceStoreName", + "documentation":"The store's name.
" + }, + "description":{ + "shape":"ReferenceStoreDescription", + "documentation":"The store's description.
" + }, + "sseConfig":{ + "shape":"SseConfig", + "documentation":"The store's server-side encryption (SSE) settings.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the store was created.
" + } + } + }, + "GetRunGroupRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"RunGroupId", + "documentation":"The group's ID.
", + "location":"uri", + "locationName":"id" + } + } + }, + "GetRunGroupResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"RunGroupArn", + "documentation":"The group's ARN.
" + }, + "id":{ + "shape":"RunGroupId", + "documentation":"The group's ID.
" + }, + "name":{ + "shape":"RunGroupName", + "documentation":"The group's name.
" + }, + "maxCpus":{ + "shape":"GetRunGroupResponseMaxCpusInteger", + "documentation":"The group's maximum number of CPUs to use.
" + }, + "maxRuns":{ + "shape":"GetRunGroupResponseMaxRunsInteger", + "documentation":"The maximum number of concurrent runs for the group.
" + }, + "maxDuration":{ + "shape":"GetRunGroupResponseMaxDurationInteger", + "documentation":"The group's maximum run time in minutes.
" + }, + "creationTime":{ + "shape":"RunGroupTimestamp", + "documentation":"When the group was created.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The group's tags.
" + }, + "maxGpus":{ + "shape":"GetRunGroupResponseMaxGpusInteger", + "documentation":"The maximum GPUs that can be used by a run group.
" + } + } + }, + "GetRunGroupResponseMaxCpusInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "GetRunGroupResponseMaxDurationInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "GetRunGroupResponseMaxGpusInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "GetRunGroupResponseMaxRunsInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "GetRunRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"RunId", + "documentation":"The run's ID.
", + "location":"uri", + "locationName":"id" + }, + "export":{ + "shape":"RunExportList", + "documentation":"The run's export format.
", + "location":"querystring", + "locationName":"export" + } + } + }, + "GetRunResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"RunArn", + "documentation":"The run's ARN.
" + }, + "id":{ + "shape":"RunId", + "documentation":"The run's ID.
" + }, + "status":{ + "shape":"RunStatus", + "documentation":"The run's status.
" + }, + "workflowId":{ + "shape":"WorkflowId", + "documentation":"The run's workflow ID.
" + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"The run's workflow type.
" + }, + "runId":{ + "shape":"RunId", + "documentation":"The run's ID.
" + }, + "roleArn":{ + "shape":"RunRoleArn", + "documentation":"The run's service role ARN.
" + }, + "name":{ + "shape":"RunName", + "documentation":"The run's name.
" + }, + "runGroupId":{ + "shape":"RunGroupId", + "documentation":"The run's group ID.
" + }, + "priority":{ + "shape":"GetRunResponsePriorityInteger", + "documentation":"The run's priority.
" + }, + "definition":{ + "shape":"WorkflowDefinition", + "documentation":"The run's definition.
" + }, + "digest":{ + "shape":"WorkflowDigest", + "documentation":"The run's digest.
" + }, + "parameters":{ + "shape":"RunParameters", + "documentation":"The run's parameters.
" + }, + "storageCapacity":{ + "shape":"GetRunResponseStorageCapacityInteger", + "documentation":"The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.
" + }, + "outputUri":{ + "shape":"RunOutputUri", + "documentation":"The run's output URI.
" + }, + "logLevel":{ + "shape":"RunLogLevel", + "documentation":"The run's log level.
" + }, + "resourceDigests":{ + "shape":"RunResourceDigests", + "documentation":"The run's resource digests.
" + }, + "startedBy":{ + "shape":"RunStartedBy", + "documentation":"Who started the run.
" + }, + "creationTime":{ + "shape":"RunTimestamp", + "documentation":"When the run was created.
" + }, + "startTime":{ + "shape":"RunTimestamp", + "documentation":"When the run started.
" + }, + "stopTime":{ + "shape":"RunTimestamp", + "documentation":"The run's stop time.
" + }, + "statusMessage":{ + "shape":"RunStatusMessage", + "documentation":"The run's status message.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The run's tags.
" + }, + "accelerators":{ + "shape":"Accelerators", + "documentation":"The computational accelerator used to run the workflow.
" + }, + "retentionMode":{ + "shape":"RunRetentionMode", + "documentation":"The run's retention mode.
" + }, + "failureReason":{ + "shape":"RunFailureReason", + "documentation":"The reason a run has failed.
" + }, + "logLocation":{ + "shape":"RunLogLocation", + "documentation":"The location of the run log.
" + }, + "uuid":{ + "shape":"RunUuid", + "documentation":"The universally unique identifier for a run.
" + }, + "runOutputUri":{ + "shape":"RunOutputUri", + "documentation":"The destination for workflow outputs.
" + }, + "storageType":{ + "shape":"StorageType", + "documentation":"The run's storage type.
" + }, + "workflowOwnerId":{ + "shape":"WorkflowOwnerId", + "documentation":"The ID of the workflow owner.
" + } + } + }, + "GetRunResponsePriorityInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":0 + }, + "GetRunResponseStorageCapacityInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":0 + }, + "GetRunTaskRequest":{ + "type":"structure", + "required":[ + "id", + "taskId" + ], + "members":{ + "id":{ + "shape":"RunId", + "documentation":"The workflow run ID.
", + "location":"uri", + "locationName":"id" + }, + "taskId":{ + "shape":"TaskId", + "documentation":"The task's ID.
", + "location":"uri", + "locationName":"taskId" + } + } + }, + "GetRunTaskResponse":{ + "type":"structure", + "members":{ + "taskId":{ + "shape":"TaskId", + "documentation":"The task's ID.
" + }, + "status":{ + "shape":"TaskStatus", + "documentation":"The task's status.
" + }, + "name":{ + "shape":"TaskName", + "documentation":"The task's name.
" + }, + "cpus":{ + "shape":"GetRunTaskResponseCpusInteger", + "documentation":"The task's CPU usage.
" + }, + "memory":{ + "shape":"GetRunTaskResponseMemoryInteger", + "documentation":"The task's memory use in gigabytes.
" + }, + "creationTime":{ + "shape":"TaskTimestamp", + "documentation":"When the task was created.
" + }, + "startTime":{ + "shape":"TaskTimestamp", + "documentation":"The task's start time.
" + }, + "stopTime":{ + "shape":"TaskTimestamp", + "documentation":"The task's stop time.
" + }, + "statusMessage":{ + "shape":"TaskStatusMessage", + "documentation":"The task's status message.
" + }, + "logStream":{ + "shape":"TaskLogStream", + "documentation":"The task's log stream.
" + }, + "gpus":{ + "shape":"GetRunTaskResponseGpusInteger", + "documentation":"The number of Graphics Processing Units (GPU) specified in the task.
" + }, + "instanceType":{ + "shape":"TaskInstanceType", + "documentation":"The instance type for a task.
" + }, + "failureReason":{ + "shape":"TaskFailureReason", + "documentation":"The reason a task has failed.
" + } + } + }, + "GetRunTaskResponseCpusInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "GetRunTaskResponseGpusInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "GetRunTaskResponseMemoryInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "GetSequenceStoreRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"SequenceStoreId", + "documentation":"The store's ID.
", + "location":"uri", + "locationName":"id" + } + } + }, + "GetSequenceStoreResponse":{ + "type":"structure", + "required":[ + "id", + "arn", + "creationTime" + ], + "members":{ + "id":{ + "shape":"SequenceStoreId", + "documentation":"The store's ID.
" + }, + "arn":{ + "shape":"SequenceStoreArn", + "documentation":"The store's ARN.
" + }, + "name":{ + "shape":"SequenceStoreName", + "documentation":"The store's name.
" + }, + "description":{ + "shape":"SequenceStoreDescription", + "documentation":"The store's description.
" + }, + "sseConfig":{ + "shape":"SseConfig", + "documentation":"The store's server-side encryption (SSE) settings.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the store was created.
" + }, + "fallbackLocation":{ + "shape":"S3Destination", + "documentation":"An S3 location that is used to store files that have failed a direct upload.
" + }, + "s3Access":{ + "shape":"SequenceStoreS3Access", + "documentation":"The S3 metadata of a sequence store, including the ARN and S3 URI of the S3 bucket.
" + }, + "eTagAlgorithmFamily":{ + "shape":"ETagAlgorithmFamily", + "documentation":"The algorithm family of the ETag.
" + } + } + }, + "GetShareRequest":{ + "type":"structure", + "required":["shareId"], + "members":{ + "shareId":{ + "shape":"String", + "documentation":"The ID of the share.
", + "location":"uri", + "locationName":"shareId" + } + } + }, + "GetShareResponse":{ + "type":"structure", + "members":{ + "share":{ + "shape":"ShareDetails", + "documentation":"A resource share details object. The object includes the status, the resourceArn, and ownerId.
" + } + } + }, + "GetVariantImportRequest":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"ResourceId", + "documentation":"The job's ID.
", + "location":"uri", + "locationName":"jobId" + } + } + }, + "GetVariantImportResponse":{ + "type":"structure", + "required":[ + "id", + "destinationName", + "roleArn", + "status", + "statusMessage", + "creationTime", + "updateTime", + "items", + "runLeftNormalization" + ], + "members":{ + "id":{ + "shape":"ResourceId", + "documentation":"The job's ID.
" + }, + "destinationName":{ + "shape":"StoreName", + "documentation":"The job's destination variant store.
" + }, + "roleArn":{ + "shape":"Arn", + "documentation":"The job's service role ARN.
" + }, + "status":{ + "shape":"JobStatus", + "documentation":"The job's status.
" + }, + "statusMessage":{ + "shape":"JobStatusMsg", + "documentation":"The job's status message.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"When the job was created.
" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"When the job was updated.
" + }, + "completionTime":{ + "shape":"CompletionTime", + "documentation":"When the job completed.
" + }, + "items":{ + "shape":"VariantImportItemDetails", + "documentation":"The job's items.
" + }, + "runLeftNormalization":{ + "shape":"RunLeftNormalization", + "documentation":"The job's left normalization setting.
" + }, + "annotationFields":{ + "shape":"AnnotationFieldMap", + "documentation":"The annotation schema generated by the parsed annotation data.
" + } + } + }, + "GetVariantStoreRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"The store's name.
", + "location":"uri", + "locationName":"name" + } + } + }, + "GetVariantStoreResponse":{ + "type":"structure", + "required":[ + "id", + "reference", + "status", + "storeArn", + "name", + "description", + "sseConfig", + "creationTime", + "updateTime", + "tags", + "statusMessage", + "storeSizeBytes" + ], + "members":{ + "id":{ + "shape":"ResourceId", + "documentation":"The store's ID.
" + }, + "reference":{ + "shape":"ReferenceItem", + "documentation":"The store's genome reference.
" + }, + "status":{ + "shape":"StoreStatus", + "documentation":"The store's status.
" + }, + "storeArn":{ + "shape":"Arn", + "documentation":"The store's ARN.
" + }, + "name":{ + "shape":"String", + "documentation":"The store's name.
" + }, + "description":{ + "shape":"Description", + "documentation":"The store's description.
" + }, + "sseConfig":{ + "shape":"SseConfig", + "documentation":"The store's server-side encryption (SSE) settings.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"When the store was created.
" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"When the store was updated.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The store's tags.
" + }, + "statusMessage":{ + "shape":"StatusMessage", + "documentation":"The store's status message.
" + }, + "storeSizeBytes":{ + "shape":"Long", + "documentation":"The store's size in bytes.
" + } + } + }, + "GetWorkflowRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"WorkflowId", + "documentation":"The workflow's ID.
", + "location":"uri", + "locationName":"id" + }, + "type":{ + "shape":"WorkflowType", + "documentation":"The workflow's type.
", + "location":"querystring", + "locationName":"type" + }, + "export":{ + "shape":"WorkflowExportList", + "documentation":"The export format for the workflow.
", + "location":"querystring", + "locationName":"export" + }, + "workflowOwnerId":{ + "shape":"WorkflowOwnerId", + "documentation":"The ID of the workflow owner.
", + "location":"querystring", + "locationName":"workflowOwnerId" + } + } + }, + "GetWorkflowResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"WorkflowArn", + "documentation":"The workflow's ARN.
" + }, + "id":{ + "shape":"WorkflowId", + "documentation":"The workflow's ID.
" + }, + "status":{ + "shape":"WorkflowStatus", + "documentation":"The workflow's status.
" + }, + "type":{ + "shape":"WorkflowType", + "documentation":"The workflow's type.
" + }, + "name":{ + "shape":"WorkflowName", + "documentation":"The workflow's name.
" + }, + "description":{ + "shape":"WorkflowDescription", + "documentation":"The workflow's description.
" + }, + "engine":{ + "shape":"WorkflowEngine", + "documentation":"The workflow's engine.
" + }, + "definition":{ + "shape":"WorkflowDefinition", + "documentation":"The workflow's definition.
" + }, + "main":{ + "shape":"WorkflowMain", + "documentation":"The path of the main definition file for the workflow.
" + }, + "digest":{ + "shape":"WorkflowDigest", + "documentation":"The workflow's digest.
" + }, + "parameterTemplate":{ + "shape":"WorkflowParameterTemplate", + "documentation":"The workflow's parameter template.
" + }, + "storageCapacity":{ + "shape":"GetWorkflowResponseStorageCapacityInteger", + "documentation":"The workflow's default run storage capacity in gibibytes.
" + }, + "creationTime":{ + "shape":"WorkflowTimestamp", + "documentation":"When the workflow was created.
" + }, + "statusMessage":{ + "shape":"WorkflowStatusMessage", + "documentation":"The workflow's status message.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The workflow's tags.
" + }, + "metadata":{ + "shape":"WorkflowMetadata", + "documentation":"Gets metadata for workflow.
" + }, + "accelerators":{ + "shape":"Accelerators", + "documentation":"The computational accelerator specified to run the workflow.
" + } + } + }, + "GetWorkflowResponseStorageCapacityInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":0 + }, + "Header":{"type":"boolean"}, + "ImportJobId":{ + "type":"string", + "max":36, + "min":10, + "pattern":"[0-9]+" + }, + "ImportReadSetFilter":{ + "type":"structure", + "members":{ + "status":{ + "shape":"ReadSetImportJobStatus", + "documentation":"A status to filter on.
" + }, + "createdAfter":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's start date.
" + }, + "createdBefore":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's end date.
" + } + }, + "documentation":"A filter for import read set jobs.
" + }, + "ImportReadSetJobItem":{ + "type":"structure", + "required":[ + "id", + "sequenceStoreId", + "roleArn", + "status", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ImportJobId", + "documentation":"The job's ID.
" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The job's sequence store ID.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The job's service role ARN.
" + }, + "status":{ + "shape":"ReadSetImportJobStatus", + "documentation":"The job's status.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job was created.
" + }, + "completionTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job completed.
" + } + }, + "documentation":"An import read set job.
" + }, + "ImportReadSetJobList":{ + "type":"list", + "member":{"shape":"ImportReadSetJobItem"} + }, + "ImportReadSetSourceItem":{ + "type":"structure", + "required":[ + "sourceFiles", + "sourceFileType", + "status", + "subjectId", + "sampleId" + ], + "members":{ + "sourceFiles":{ + "shape":"SourceFiles", + "documentation":"The source files' location in Amazon S3.
" + }, + "sourceFileType":{ + "shape":"FileType", + "documentation":"The source's file type.
" + }, + "status":{ + "shape":"ReadSetImportJobItemStatus", + "documentation":"The source's status.
" + }, + "statusMessage":{ + "shape":"JobStatusMessage", + "documentation":"The source's status message.
" + }, + "subjectId":{ + "shape":"SubjectId", + "documentation":"The source's subject ID.
" + }, + "sampleId":{ + "shape":"SampleId", + "documentation":"The source's sample ID.
" + }, + "generatedFrom":{ + "shape":"GeneratedFrom", + "documentation":"Where the source originated.
" + }, + "referenceArn":{ + "shape":"ReferenceArn", + "documentation":"The source's genome reference ARN.
" + }, + "name":{ + "shape":"ReadSetName", + "documentation":"The source's name.
" + }, + "description":{ + "shape":"ReadSetDescription", + "documentation":"The source's description.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The source's tags.
" + }, + "readSetId":{ + "shape":"ReadSetId", + "documentation":"The source's read set ID.
" + } + }, + "documentation":"A source for an import read set job.
" + }, + "ImportReadSetSourceList":{ + "type":"list", + "member":{"shape":"ImportReadSetSourceItem"} + }, + "ImportReferenceFilter":{ + "type":"structure", + "members":{ + "status":{ + "shape":"ReferenceImportJobStatus", + "documentation":"A status to filter on.
" + }, + "createdAfter":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's start date.
" + }, + "createdBefore":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's end date.
" + } + }, + "documentation":"A filter for import references.
" + }, + "ImportReferenceJobItem":{ + "type":"structure", + "required":[ + "id", + "referenceStoreId", + "roleArn", + "status", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ImportJobId", + "documentation":"The job's ID.
" + }, + "referenceStoreId":{ + "shape":"ReferenceStoreId", + "documentation":"The job's reference store ID.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The job's service role ARN.
" + }, + "status":{ + "shape":"ReferenceImportJobStatus", + "documentation":"The job's status.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job was created.
" + }, + "completionTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job completed.
" + } + }, + "documentation":"An import reference job.
" + }, + "ImportReferenceJobList":{ + "type":"list", + "member":{"shape":"ImportReferenceJobItem"} + }, + "ImportReferenceSourceItem":{ + "type":"structure", + "required":["status"], + "members":{ + "sourceFile":{ + "shape":"S3Uri", + "documentation":"The source file's location in Amazon S3.
" + }, + "status":{ + "shape":"ReferenceImportJobItemStatus", + "documentation":"The source's status.
" + }, + "statusMessage":{ + "shape":"JobStatusMessage", + "documentation":"The source's status message.
" + }, + "name":{ + "shape":"ReferenceName", + "documentation":"The source's name.
" + }, + "description":{ + "shape":"ReferenceDescription", + "documentation":"The source's description.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The source's tags.
" + }, + "referenceId":{ + "shape":"ReferenceId", + "documentation":"The source's reference ID.
" + } + }, + "documentation":"An genome reference source.
" + }, + "ImportReferenceSourceList":{ + "type":"list", + "member":{"shape":"ImportReferenceSourceItem"} + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"An unexpected error occurred. Try the request again.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "JobStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "IN_PROGRESS", + "CANCELLED", + "COMPLETED", + "FAILED", + "COMPLETED_WITH_FAILURES" + ] + }, + "JobStatusMessage":{ + "type":"string", + "max":127, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "JobStatusMsg":{"type":"string"}, + "LineSep":{ + "type":"string", + "max":20, + "min":1 + }, + "ListAnnotationImportJobsFilter":{ + "type":"structure", + "members":{ + "status":{ + "shape":"JobStatus", + "documentation":"A status to filter on.
" + }, + "storeName":{ + "shape":"String", + "documentation":"A store name to filter on.
" + } + }, + "documentation":"A filter for annotation import jobs.
" + }, + "ListAnnotationImportJobsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListAnnotationImportJobsRequestMaxResultsInteger", + "documentation":"The maximum number of jobs to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + }, + "ids":{ + "shape":"ListAnnotationImportJobsRequestIdsList", + "documentation":"IDs of annotation import jobs to retrieve.
" + }, + "nextToken":{ + "shape":"ListAnnotationImportJobsRequestNextTokenString", + "documentation":"Specifies the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "filter":{ + "shape":"ListAnnotationImportJobsFilter", + "documentation":"A filter to apply to the list.
" + } + } + }, + "ListAnnotationImportJobsRequestIdsList":{ + "type":"list", + "member":{"shape":"ResourceIdentifier"}, + "max":20, + "min":1 + }, + "ListAnnotationImportJobsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListAnnotationImportJobsRequestNextTokenString":{ + "type":"string", + "max":10000, + "min":1 + }, + "ListAnnotationImportJobsResponse":{ + "type":"structure", + "members":{ + "annotationImportJobs":{ + "shape":"AnnotationImportJobItems", + "documentation":"A list of jobs.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"Specifies the pagination token from a previous request to retrieve the next page of results.
" + } + } + }, + "ListAnnotationStoreVersionsFilter":{ + "type":"structure", + "members":{ + "status":{ + "shape":"VersionStatus", + "documentation":"The status of an annotation store version.
" + } + }, + "documentation":"Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.
" + }, + "ListAnnotationStoreVersionsRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of an annotation store.
", + "location":"uri", + "locationName":"name" + }, + "maxResults":{ + "shape":"ListAnnotationStoreVersionsRequestMaxResultsInteger", + "documentation":"The maximum number of annotation store versions to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"ListAnnotationStoreVersionsRequestNextTokenString", + "documentation":"Specifies the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "filter":{ + "shape":"ListAnnotationStoreVersionsFilter", + "documentation":"A filter to apply to the list of annotation store versions.
" + } + } + }, + "ListAnnotationStoreVersionsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListAnnotationStoreVersionsRequestNextTokenString":{ + "type":"string", + "max":10000, + "min":1 + }, + "ListAnnotationStoreVersionsResponse":{ + "type":"structure", + "members":{ + "annotationStoreVersions":{ + "shape":"AnnotationStoreVersionItems", + "documentation":"Lists all versions of an annotation store.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"Specifies the pagination token from a previous request to retrieve the next page of results.
" + } + } + }, + "ListAnnotationStoresFilter":{ + "type":"structure", + "members":{ + "status":{ + "shape":"StoreStatus", + "documentation":"A status to filter on.
" + } + }, + "documentation":"A filter for annotation stores.
" + }, + "ListAnnotationStoresRequest":{ + "type":"structure", + "members":{ + "ids":{ + "shape":"ListAnnotationStoresRequestIdsList", + "documentation":"IDs of stores to list.
" + }, + "maxResults":{ + "shape":"ListAnnotationStoresRequestMaxResultsInteger", + "documentation":"The maximum number of stores to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"ListAnnotationStoresRequestNextTokenString", + "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "filter":{ + "shape":"ListAnnotationStoresFilter", + "documentation":"A filter to apply to the list.
" + } + } + }, + "ListAnnotationStoresRequestIdsList":{ + "type":"list", + "member":{"shape":"ResourceIdentifier"}, + "max":20, + "min":1 + }, + "ListAnnotationStoresRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListAnnotationStoresRequestNextTokenString":{ + "type":"string", + "max":10000, + "min":1 + }, + "ListAnnotationStoresResponse":{ + "type":"structure", + "members":{ + "annotationStores":{ + "shape":"AnnotationStoreItems", + "documentation":"A list of stores.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"A pagination token that's included if more results are available.
" + } + } + }, + "ListMultipartReadSetUploadsRequest":{ + "type":"structure", + "required":["sequenceStoreId"], + "members":{ + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The Sequence Store ID used for the multipart uploads.
", + "location":"uri", + "locationName":"sequenceStoreId" + }, + "maxResults":{ + "shape":"ListMultipartReadSetUploadsRequestMaxResultsInteger", + "documentation":"The maximum number of multipart uploads returned in a page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListMultipartReadSetUploadsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListMultipartReadSetUploadsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.
" + }, + "uploads":{ + "shape":"MultipartReadSetUploadList", + "documentation":"An array of multipart uploads.
" + } + } + }, + "ListReadSetActivationJobsRequest":{ + "type":"structure", + "required":["sequenceStoreId"], + "members":{ + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The read set's sequence store ID.
", + "location":"uri", + "locationName":"sequenceStoreId" + }, + "maxResults":{ + "shape":"ListReadSetActivationJobsRequestMaxResultsInteger", + "documentation":"The maximum number of read set activation jobs to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "filter":{ + "shape":"ActivateReadSetFilter", + "documentation":"A filter to apply to the list.
" + } + } + }, + "ListReadSetActivationJobsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListReadSetActivationJobsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token that's included if more results are available.
" + }, + "activationJobs":{ + "shape":"ActivateReadSetJobList", + "documentation":"A list of jobs.
" + } + } + }, + "ListReadSetExportJobsRequest":{ + "type":"structure", + "required":["sequenceStoreId"], + "members":{ + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The jobs' sequence store ID.
", + "location":"uri", + "locationName":"sequenceStoreId" + }, + "maxResults":{ + "shape":"ListReadSetExportJobsRequestMaxResultsInteger", + "documentation":"The maximum number of jobs to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "filter":{ + "shape":"ExportReadSetFilter", + "documentation":"A filter to apply to the list.
" + } + } + }, + "ListReadSetExportJobsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListReadSetExportJobsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token that's included if more results are available.
" + }, + "exportJobs":{ + "shape":"ExportReadSetJobDetailList", + "documentation":"A list of jobs.
" + } + } + }, + "ListReadSetImportJobsRequest":{ + "type":"structure", + "required":["sequenceStoreId"], + "members":{ + "maxResults":{ + "shape":"ListReadSetImportJobsRequestMaxResultsInteger", + "documentation":"The maximum number of jobs to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The jobs' sequence store ID.
", + "location":"uri", + "locationName":"sequenceStoreId" + }, + "filter":{ + "shape":"ImportReadSetFilter", + "documentation":"A filter to apply to the list.
" + } + } + }, + "ListReadSetImportJobsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListReadSetImportJobsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token that's included if more results are available.
" + }, + "importJobs":{ + "shape":"ImportReadSetJobList", + "documentation":"A list of jobs.
" + } + } + }, + "ListReadSetUploadPartsRequest":{ + "type":"structure", + "required":[ + "sequenceStoreId", + "uploadId", + "partSource" + ], + "members":{ + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The Sequence Store ID used for the multipart uploads.
", + "location":"uri", + "locationName":"sequenceStoreId" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"The ID for the initiated multipart upload.
", + "location":"uri", + "locationName":"uploadId" + }, + "partSource":{ + "shape":"ReadSetPartSource", + "documentation":"The source file for the upload part.
" + }, + "maxResults":{ + "shape":"ListReadSetUploadPartsRequestMaxResultsInteger", + "documentation":"The maximum number of read set upload parts returned in a page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "filter":{ + "shape":"ReadSetUploadPartListFilter", + "documentation":"Attributes used to filter for a specific subset of read set part uploads.
" + } + } + }, + "ListReadSetUploadPartsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListReadSetUploadPartsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"Next token returned in the response of a previous ListReadSetUploadParts call. Used to get the next page of results.
" + }, + "parts":{ + "shape":"ReadSetUploadPartList", + "documentation":"An array of upload parts.
" + } + } + }, + "ListReadSetsRequest":{ + "type":"structure", + "required":["sequenceStoreId"], + "members":{ + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The jobs' sequence store ID.
", + "location":"uri", + "locationName":"sequenceStoreId" + }, + "maxResults":{ + "shape":"ListReadSetsRequestMaxResultsInteger", + "documentation":"The maximum number of read sets to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "filter":{ + "shape":"ReadSetFilter", + "documentation":"A filter to apply to the list.
" + } + } + }, + "ListReadSetsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListReadSetsResponse":{ + "type":"structure", + "required":["readSets"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token that's included if more results are available.
" + }, + "readSets":{ + "shape":"ReadSetList", + "documentation":"A list of read sets.
" + } + } + }, + "ListReferenceImportJobsRequest":{ + "type":"structure", + "required":["referenceStoreId"], + "members":{ + "maxResults":{ + "shape":"ListReferenceImportJobsRequestMaxResultsInteger", + "documentation":"The maximum number of jobs to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "referenceStoreId":{ + "shape":"ReferenceStoreId", + "documentation":"The job's reference store ID.
", + "location":"uri", + "locationName":"referenceStoreId" + }, + "filter":{ + "shape":"ImportReferenceFilter", + "documentation":"A filter to apply to the list.
" + } + } + }, + "ListReferenceImportJobsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListReferenceImportJobsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token that's included if more results are available.
" + }, + "importJobs":{ + "shape":"ImportReferenceJobList", + "documentation":"A lis of jobs.
" + } + } + }, + "ListReferenceStoresRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListReferenceStoresRequestMaxResultsInteger", + "documentation":"The maximum number of stores to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "filter":{ + "shape":"ReferenceStoreFilter", + "documentation":"A filter to apply to the list.
" + } + } + }, + "ListReferenceStoresRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListReferenceStoresResponse":{ + "type":"structure", + "required":["referenceStores"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token that's included if more results are available.
" + }, + "referenceStores":{ + "shape":"ReferenceStoreDetailList", + "documentation":"A list of reference stores.
" + } + } + }, + "ListReferencesRequest":{ + "type":"structure", + "required":["referenceStoreId"], + "members":{ + "referenceStoreId":{ + "shape":"ReferenceStoreId", + "documentation":"The references' reference store ID.
", + "location":"uri", + "locationName":"referenceStoreId" + }, + "maxResults":{ + "shape":"ListReferencesRequestMaxResultsInteger", + "documentation":"The maximum number of references to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "filter":{ + "shape":"ReferenceFilter", + "documentation":"A filter to apply to the list.
" + } + } + }, + "ListReferencesRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListReferencesResponse":{ + "type":"structure", + "required":["references"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token that's included if more results are available.
" + }, + "references":{ + "shape":"ReferenceList", + "documentation":"A list of references.
" + } + } + }, + "ListRunGroupsRequest":{ + "type":"structure", + "members":{ + "name":{ + "shape":"RunGroupName", + "documentation":"The run groups' name.
", + "location":"querystring", + "locationName":"name" + }, + "startingToken":{ + "shape":"RunGroupListToken", + "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"startingToken" + }, + "maxResults":{ + "shape":"ListRunGroupsRequestMaxResultsInteger", + "documentation":"The maximum number of run groups to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListRunGroupsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListRunGroupsResponse":{ + "type":"structure", + "members":{ + "items":{ + "shape":"RunGroupList", + "documentation":"A list of groups.
" + }, + "nextToken":{ + "shape":"RunGroupListToken", + "documentation":"A pagination token that's included if more results are available.
" + } + } + }, + "ListRunTasksRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"RunId", + "documentation":"The run's ID.
", + "location":"uri", + "locationName":"id" + }, + "status":{ + "shape":"TaskStatus", + "documentation":"Filter the list by status.
", + "location":"querystring", + "locationName":"status" + }, + "startingToken":{ + "shape":"TaskListToken", + "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"startingToken" + }, + "maxResults":{ + "shape":"ListRunTasksRequestMaxResultsInteger", + "documentation":"The maximum number of run tasks to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListRunTasksRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListRunTasksResponse":{ + "type":"structure", + "members":{ + "items":{ + "shape":"TaskList", + "documentation":"A list of tasks.
" + }, + "nextToken":{ + "shape":"TaskListToken", + "documentation":"A pagination token that's included if more results are available.
" + } + } + }, + "ListRunsRequest":{ + "type":"structure", + "members":{ + "name":{ + "shape":"RunName", + "documentation":"Filter the list by run name.
", + "location":"querystring", + "locationName":"name" + }, + "runGroupId":{ + "shape":"RunGroupId", + "documentation":"Filter the list by run group ID.
", + "location":"querystring", + "locationName":"runGroupId" + }, + "startingToken":{ + "shape":"RunListToken", + "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"startingToken" + }, + "maxResults":{ + "shape":"ListRunsRequestMaxResultsInteger", + "documentation":"The maximum number of runs to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + }, + "status":{ + "shape":"RunStatus", + "documentation":"The status of a run.
", + "location":"querystring", + "locationName":"status" + } + } + }, + "ListRunsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListRunsResponse":{ + "type":"structure", + "members":{ + "items":{ + "shape":"RunList", + "documentation":"A list of runs.
" + }, + "nextToken":{ + "shape":"RunListToken", + "documentation":"A pagination token that's included if more results are available.
" + } + } + }, + "ListSequenceStoresRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListSequenceStoresRequestMaxResultsInteger", + "documentation":"The maximum number of stores to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "filter":{ + "shape":"SequenceStoreFilter", + "documentation":"A filter to apply to the list.
" + } + } + }, + "ListSequenceStoresRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListSequenceStoresResponse":{ + "type":"structure", + "required":["sequenceStores"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token that's included if more results are available.
" + }, + "sequenceStores":{ + "shape":"SequenceStoreDetailList", + "documentation":"A list of sequence stores.
" + } + } + }, + "ListSharesRequest":{ + "type":"structure", + "required":["resourceOwner"], + "members":{ + "resourceOwner":{ + "shape":"ResourceOwner", + "documentation":"The account that owns the resource shares.
" + }, + "filter":{ + "shape":"Filter", + "documentation":"Attributes that you use to filter for a specific subset of resource shares.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"The maximum number of shares to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListSharesResponse":{ + "type":"structure", + "required":["shares"], + "members":{ + "shares":{ + "shape":"ShareDetailsList", + "documentation":"The shares available and their metadata details.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"Next token returned in the response of a previous ListSharesResponse call. Used to get the next page of results.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"TagArn", + "documentation":"The resource's ARN.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"A list of tags.
" + } + } + }, + "ListVariantImportJobsFilter":{ + "type":"structure", + "members":{ + "status":{ + "shape":"JobStatus", + "documentation":"A status to filter on.
" + }, + "storeName":{ + "shape":"String", + "documentation":"A store name to filter on.
" + } + }, + "documentation":"A filter for variant import jobs.
" + }, + "ListVariantImportJobsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListVariantImportJobsRequestMaxResultsInteger", + "documentation":"The maximum number of import jobs to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + }, + "ids":{ + "shape":"ListVariantImportJobsRequestIdsList", + "documentation":"A list of job IDs.
" + }, + "nextToken":{ + "shape":"ListVariantImportJobsRequestNextTokenString", + "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "filter":{ + "shape":"ListVariantImportJobsFilter", + "documentation":"A filter to apply to the list.
" + } + } + }, + "ListVariantImportJobsRequestIdsList":{ + "type":"list", + "member":{"shape":"ResourceIdentifier"}, + "max":20, + "min":1 + }, + "ListVariantImportJobsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListVariantImportJobsRequestNextTokenString":{ + "type":"string", + "max":10000, + "min":1 + }, + "ListVariantImportJobsResponse":{ + "type":"structure", + "members":{ + "variantImportJobs":{ + "shape":"VariantImportJobItems", + "documentation":"A list of jobs.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"A pagination token that's included if more results are available.
" + } + } + }, + "ListVariantStoresFilter":{ + "type":"structure", + "members":{ + "status":{ + "shape":"StoreStatus", + "documentation":"A status to filter on.
" + } + }, + "documentation":"A filter for variant stores.
" + }, + "ListVariantStoresRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListVariantStoresRequestMaxResultsInteger", + "documentation":"The maximum number of stores to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + }, + "ids":{ + "shape":"ListVariantStoresRequestIdsList", + "documentation":"A list of store IDs.
" + }, + "nextToken":{ + "shape":"ListVariantStoresRequestNextTokenString", + "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "filter":{ + "shape":"ListVariantStoresFilter", + "documentation":"A filter to apply to the list.
" + } + } + }, + "ListVariantStoresRequestIdsList":{ + "type":"list", + "member":{"shape":"ResourceIdentifier"}, + "max":20, + "min":1 + }, + "ListVariantStoresRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListVariantStoresRequestNextTokenString":{ + "type":"string", + "max":10000, + "min":1 + }, + "ListVariantStoresResponse":{ + "type":"structure", + "members":{ + "variantStores":{ + "shape":"VariantStoreItems", + "documentation":"A list of variant stores.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"A pagination token that's included if more results are available.
" + } + } + }, + "ListWorkflowsRequest":{ + "type":"structure", + "members":{ + "type":{ + "shape":"WorkflowType", + "documentation":"Filter the list by workflow type.
", + "location":"querystring", + "locationName":"type" + }, + "name":{ + "shape":"WorkflowName", + "documentation":"Filter the list by workflow name.
", + "location":"querystring", + "locationName":"name" + }, + "startingToken":{ + "shape":"WorkflowListToken", + "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", + "location":"querystring", + "locationName":"startingToken" + }, + "maxResults":{ + "shape":"ListWorkflowsRequestMaxResultsInteger", + "documentation":"The maximum number of workflows to return in one page of results.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListWorkflowsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListWorkflowsResponse":{ + "type":"structure", + "members":{ + "items":{ + "shape":"WorkflowList", + "documentation":"A list of workflow items.
" + }, + "nextToken":{ + "shape":"WorkflowListToken", + "documentation":"A pagination token that's included if more results are available.
" + } + } + }, + "Long":{ + "type":"long", + "box":true + }, + "Md5":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\p{L}||\\p{N}]+" + }, + "MultipartReadSetUploadList":{ + "type":"list", + "member":{"shape":"MultipartReadSetUploadListItem"} + }, + "MultipartReadSetUploadListItem":{ + "type":"structure", + "required":[ + "sequenceStoreId", + "uploadId", + "sourceFileType", + "subjectId", + "sampleId", + "generatedFrom", + "referenceArn", + "creationTime" + ], + "members":{ + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The sequence store ID used for the multipart upload.
" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"The ID for the initiated multipart upload.
" + }, + "sourceFileType":{ + "shape":"FileType", + "documentation":"The type of file the read set originated from.
" + }, + "subjectId":{ + "shape":"SubjectId", + "documentation":"The read set source's subject ID.
" + }, + "sampleId":{ + "shape":"SampleId", + "documentation":"The read set source's sample ID.
" + }, + "generatedFrom":{ + "shape":"GeneratedFrom", + "documentation":"The source of an uploaded part.
" + }, + "referenceArn":{ + "shape":"ReferenceArn", + "documentation":"The source's reference ARN.
" + }, + "name":{ + "shape":"ReadSetName", + "documentation":"The name of a read set.
" + }, + "description":{ + "shape":"ReadSetDescription", + "documentation":"The description of a read set.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"Any tags you wish to add to a read set.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time stamp for when a direct upload was created.
" + } + }, + "documentation":"Part of the response to ListMultipartReadSetUploads, excluding completed and aborted multipart uploads.
" + }, + "NextToken":{ + "type":"string", + "max":6144, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "NotSupportedOperationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The operation is not supported by Amazon Omics, or the API does not exist.
", + "error":{ + "httpStatusCode":405, + "senderFault":true + }, + "exception":true + }, + "PrimitiveBoolean":{"type":"boolean"}, + "Quote":{ + "type":"string", + "max":1, + "min":1 + }, + "QuoteAll":{"type":"boolean"}, + "Range":{ + "type":"string", + "max":127, + "min":1, + "pattern":"[\\p{N}||\\p{P}]+" + }, + "RangeNotSatisfiableException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The ranges specified in the request are not valid.
", + "error":{ + "httpStatusCode":416, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":false} + }, + "ReadOptions":{ + "type":"structure", + "members":{ + "sep":{ + "shape":"Separator", + "documentation":"The file's field separator.
" + }, + "encoding":{ + "shape":"Encoding", + "documentation":"The file's encoding.
" + }, + "quote":{ + "shape":"Quote", + "documentation":"The file's quote character.
" + }, + "quoteAll":{ + "shape":"QuoteAll", + "documentation":"Whether all values need to be quoted, or just those that contain quotes.
" + }, + "escape":{ + "shape":"EscapeChar", + "documentation":"A character for escaping quotes in the file.
" + }, + "escapeQuotes":{ + "shape":"EscapeQuotes", + "documentation":"Whether quotes need to be escaped in the file.
" + }, + "comment":{ + "shape":"CommentChar", + "documentation":"The file's comment character.
" + }, + "header":{ + "shape":"Header", + "documentation":"Whether the file has a header row.
" + }, + "lineSep":{ + "shape":"LineSep", + "documentation":"A line separator for the file.
" + } + }, + "documentation":"Read options for an annotation import job.
" + }, + "ReadSetActivationJobItemStatus":{ + "type":"string", + "enum":[ + "NOT_STARTED", + "IN_PROGRESS", + "FINISHED", + "FAILED" + ] + }, + "ReadSetActivationJobStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "IN_PROGRESS", + "CANCELLING", + "CANCELLED", + "FAILED", + "COMPLETED", + "COMPLETED_WITH_FAILURES" + ] + }, + "ReadSetArn":{ + "type":"string", + "max":127, + "min":1, + "pattern":"arn:.+" + }, + "ReadSetBatchError":{ + "type":"structure", + "required":[ + "id", + "code", + "message" + ], + "members":{ + "id":{ + "shape":"ReadSetId", + "documentation":"The error's ID.
" + }, + "code":{ + "shape":"String", + "documentation":"The error's code.
" + }, + "message":{ + "shape":"String", + "documentation":"The error's message.
" + } + }, + "documentation":"An error from a batch read set operation.
" + }, + "ReadSetBatchErrorList":{ + "type":"list", + "member":{"shape":"ReadSetBatchError"} + }, + "ReadSetDescription":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "ReadSetExportJobItemStatus":{ + "type":"string", + "enum":[ + "NOT_STARTED", + "IN_PROGRESS", + "FINISHED", + "FAILED" + ] + }, + "ReadSetExportJobStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "IN_PROGRESS", + "CANCELLING", + "CANCELLED", + "FAILED", + "COMPLETED", + "COMPLETED_WITH_FAILURES" + ] + }, + "ReadSetFile":{ + "type":"string", + "enum":[ + "SOURCE1", + "SOURCE2", + "INDEX" + ] + }, + "ReadSetFiles":{ + "type":"structure", + "members":{ + "source1":{ + "shape":"FileInformation", + "documentation":"The location of the first file in Amazon S3.
" + }, + "source2":{ + "shape":"FileInformation", + "documentation":"The location of the second file in Amazon S3.
" + }, + "index":{ + "shape":"FileInformation", + "documentation":"The files' index.
" + } + }, + "documentation":"Files in a read set.
" + }, + "ReadSetFilter":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ReadSetName", + "documentation":"A name to filter on.
" + }, + "status":{ + "shape":"ReadSetStatus", + "documentation":"A status to filter on.
" + }, + "referenceArn":{ + "shape":"ReferenceArnFilter", + "documentation":"A genome reference ARN to filter on.
" + }, + "createdAfter":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's start date.
" + }, + "createdBefore":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's end date.
" + }, + "sampleId":{ + "shape":"SampleId", + "documentation":"The read set source's sample ID.
" + }, + "subjectId":{ + "shape":"SubjectId", + "documentation":"The read set source's subject ID.
" + }, + "generatedFrom":{ + "shape":"GeneratedFrom", + "documentation":"Where the source originated.
" + }, + "creationType":{ + "shape":"CreationType", + "documentation":"The creation type of the read set.
" + } + }, + "documentation":"A filter for read sets.
" + }, + "ReadSetId":{ + "type":"string", + "max":36, + "min":10, + "pattern":"[0-9]+" + }, + "ReadSetIdList":{ + "type":"list", + "member":{"shape":"ReadSetId"}, + "max":100, + "min":1 + }, + "ReadSetImportJobItemStatus":{ + "type":"string", + "enum":[ + "NOT_STARTED", + "IN_PROGRESS", + "FINISHED", + "FAILED" + ] + }, + "ReadSetImportJobStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "IN_PROGRESS", + "CANCELLING", + "CANCELLED", + "FAILED", + "COMPLETED", + "COMPLETED_WITH_FAILURES" + ] + }, + "ReadSetList":{ + "type":"list", + "member":{"shape":"ReadSetListItem"} + }, + "ReadSetListItem":{ + "type":"structure", + "required":[ + "id", + "arn", + "sequenceStoreId", + "status", + "fileType", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ReadSetId", + "documentation":"The read set's ID.
" + }, + "arn":{ + "shape":"ReadSetArn", + "documentation":"The read set's ARN.
" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The read set's sequence store ID.
" + }, + "subjectId":{ + "shape":"SubjectId", + "documentation":"The read set's subject ID.
" + }, + "sampleId":{ + "shape":"SampleId", + "documentation":"The read set's sample ID.
" + }, + "status":{ + "shape":"ReadSetStatus", + "documentation":"The read set's status.
" + }, + "name":{ + "shape":"ReadSetName", + "documentation":"The read set's name.
" + }, + "description":{ + "shape":"ReadSetDescription", + "documentation":"The read set's description.
" + }, + "referenceArn":{ + "shape":"ReferenceArn", + "documentation":"The read set's genome reference ARN.
" + }, + "fileType":{ + "shape":"FileType", + "documentation":"The read set's file type.
" + }, + "sequenceInformation":{"shape":"SequenceInformation"}, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the read set was created.
" + }, + "statusMessage":{ + "shape":"ReadSetStatusMessage", + "documentation":"The status for a read set. It provides more detail as to why the read set has a status.
" + }, + "creationType":{ + "shape":"CreationType", + "documentation":"The creation type of the read set.
" + }, + "etag":{ + "shape":"ETag", + "documentation":"The entity tag (ETag) is a hash of the object representing its semantic content.
" + } + }, + "documentation":"A read set.
" + }, + "ReadSetName":{ + "type":"string", + "max":127, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "ReadSetPartSource":{ + "type":"string", + "enum":[ + "SOURCE1", + "SOURCE2" + ] + }, + "ReadSetPartStreamingBlob":{ + "type":"blob", + "requiresLength":true, + "streaming":true + }, + "ReadSetS3Access":{ + "type":"structure", + "members":{ + "s3Uri":{ + "shape":"S3Uri", + "documentation":"The S3 URI for each read set file.
" + } + }, + "documentation":"The S3 URI for each read set file.
" + }, + "ReadSetStatus":{ + "type":"string", + "enum":[ + "ARCHIVED", + "ACTIVATING", + "ACTIVE", + "DELETING", + "DELETED", + "PROCESSING_UPLOAD", + "UPLOAD_FAILED" + ] + }, + "ReadSetStatusMessage":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "ReadSetStreamingBlob":{ + "type":"blob", + "streaming":true + }, + "ReadSetUploadPartList":{ + "type":"list", + "member":{"shape":"ReadSetUploadPartListItem"} + }, + "ReadSetUploadPartListFilter":{ + "type":"structure", + "members":{ + "createdAfter":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"Filters for read set uploads after a specified time.
" + }, + "createdBefore":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"Filters for read set part uploads before a specified time.
" + } + }, + "documentation":"Filter settings that select for read set upload parts of interest.
" + }, + "ReadSetUploadPartListItem":{ + "type":"structure", + "required":[ + "partNumber", + "partSize", + "partSource", + "checksum" + ], + "members":{ + "partNumber":{ + "shape":"ReadSetUploadPartListItemPartNumberInteger", + "documentation":"The number identifying the part in an upload.
" + }, + "partSize":{ + "shape":"ReadSetUploadPartListItemPartSizeLong", + "documentation":"The size of the the part in an upload.
" + }, + "partSource":{ + "shape":"ReadSetPartSource", + "documentation":"The origin of the part being direct uploaded.
" + }, + "checksum":{ + "shape":"String", + "documentation":"A unique identifier used to confirm that parts are being added to the correct upload.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time stamp for when a direct upload was created.
" + }, + "lastUpdatedTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time stamp for the most recent update to an uploaded part.
" + } + }, + "documentation":"The metadata of a single part of a file that was added to a multipart upload. A list of these parts is returned in the response to the ListReadSetUploadParts API.
" + }, + "ReadSetUploadPartListItemPartNumberInteger":{ + "type":"integer", + "box":true, + "max":10000, + "min":1 + }, + "ReadSetUploadPartListItemPartSizeLong":{ + "type":"long", + "box":true, + "max":5368709120, + "min":1 + }, + "ReferenceArn":{ + "type":"string", + "max":127, + "min":1, + "pattern":"arn:.+" + }, + "ReferenceArnFilter":{ + "type":"string", + "max":127, + "min":0, + "pattern":"$|^arn:.+" + }, + "ReferenceCreationType":{ + "type":"string", + "enum":["IMPORT"] + }, + "ReferenceDescription":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "ReferenceFile":{ + "type":"string", + "enum":[ + "SOURCE", + "INDEX" + ] + }, + "ReferenceFiles":{ + "type":"structure", + "members":{ + "source":{ + "shape":"FileInformation", + "documentation":"The source file's location in Amazon S3.
" + }, + "index":{ + "shape":"FileInformation", + "documentation":"The files' index.
" + } + }, + "documentation":"A set of genome reference files.
" + }, + "ReferenceFilter":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ReferenceName", + "documentation":"A name to filter on.
" + }, + "md5":{ + "shape":"Md5", + "documentation":"An MD5 checksum to filter on.
" + }, + "createdAfter":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's start date.
" + }, + "createdBefore":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's end date.
" + } + }, + "documentation":"A filter for references.
" + }, + "ReferenceId":{ + "type":"string", + "max":36, + "min":10, + "pattern":"[0-9]+" + }, + "ReferenceImportJobItemStatus":{ + "type":"string", + "enum":[ + "NOT_STARTED", + "IN_PROGRESS", + "FINISHED", + "FAILED" + ] + }, + "ReferenceImportJobStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "IN_PROGRESS", + "CANCELLING", + "CANCELLED", + "FAILED", + "COMPLETED", + "COMPLETED_WITH_FAILURES" + ] + }, + "ReferenceItem":{ + "type":"structure", + "members":{ + "referenceArn":{ + "shape":"ReferenceArn", + "documentation":"The reference's ARN.
" + } + }, + "documentation":"A genome reference.
", + "union":true + }, + "ReferenceList":{ + "type":"list", + "member":{"shape":"ReferenceListItem"} + }, + "ReferenceListItem":{ + "type":"structure", + "required":[ + "id", + "arn", + "referenceStoreId", + "md5", + "creationTime", + "updateTime" + ], + "members":{ + "id":{ + "shape":"ReferenceId", + "documentation":"The reference's ID.
" + }, + "arn":{ + "shape":"ReferenceArn", + "documentation":"The reference's ARN.
" + }, + "referenceStoreId":{ + "shape":"ReferenceStoreId", + "documentation":"The reference's store ID.
" + }, + "md5":{ + "shape":"Md5", + "documentation":"The reference's MD5 checksum.
" + }, + "status":{ + "shape":"ReferenceStatus", + "documentation":"The reference's status.
" + }, + "name":{ + "shape":"ReferenceName", + "documentation":"The reference's name.
" + }, + "description":{ + "shape":"ReferenceDescription", + "documentation":"The reference's description.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the reference was created.
" + }, + "updateTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the reference was updated.
" + } + }, + "documentation":"A genome reference.
" + }, + "ReferenceName":{ + "type":"string", + "max":255, + "min":3, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "ReferenceStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "DELETING", + "DELETED" + ] + }, + "ReferenceStoreArn":{ + "type":"string", + "max":127, + "min":1, + "pattern":"arn:.+" + }, + "ReferenceStoreDescription":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "ReferenceStoreDetail":{ + "type":"structure", + "required":[ + "arn", + "id", + "creationTime" + ], + "members":{ + "arn":{ + "shape":"ReferenceStoreArn", + "documentation":"The store's ARN.
" + }, + "id":{ + "shape":"ReferenceStoreId", + "documentation":"The store's ID.
" + }, + "name":{ + "shape":"ReferenceStoreName", + "documentation":"The store's name.
" + }, + "description":{ + "shape":"ReferenceStoreDescription", + "documentation":"The store's description.
" + }, + "sseConfig":{ + "shape":"SseConfig", + "documentation":"The store's server-side encryption (SSE) settings.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the store was created.
" + } + }, + "documentation":"Details about a reference store.
" + }, + "ReferenceStoreDetailList":{ + "type":"list", + "member":{"shape":"ReferenceStoreDetail"} + }, + "ReferenceStoreFilter":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ReferenceStoreName", + "documentation":"The name to filter on.
" + }, + "createdAfter":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's start date.
" + }, + "createdBefore":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's end date.
" + } + }, + "documentation":"A filter for reference stores.
" + }, + "ReferenceStoreId":{ + "type":"string", + "max":36, + "min":10, + "pattern":"[0-9]+" + }, + "ReferenceStoreName":{ + "type":"string", + "max":127, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "ReferenceStreamingBlob":{ + "type":"blob", + "streaming":true + }, + "RequestTimeoutException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request timed out.
", + "error":{ + "httpStatusCode":408, + "senderFault":true + }, + "exception":true + }, + "ResourceId":{ + "type":"string", + "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" + }, + "ResourceIdentifier":{ + "type":"string", + "max":50, + "min":1 + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The target resource was not found in the current Region.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceOwner":{ + "type":"string", + "enum":[ + "SELF", + "OTHER" + ] + }, + "RoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:.*" + }, + "RunArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:.+" + }, + "RunExport":{ + "type":"string", + "enum":["DEFINITION"], + "max":64, + "min":1 + }, + "RunExportList":{ + "type":"list", + "member":{"shape":"RunExport"}, + "max":32, + "min":0 + }, + "RunFailureReason":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "RunGroupArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:.+" + }, + "RunGroupId":{ + "type":"string", + "max":18, + "min":1, + "pattern":"[0-9]+" + }, + "RunGroupList":{ + "type":"list", + "member":{"shape":"RunGroupListItem"} + }, + "RunGroupListItem":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"RunGroupArn", + "documentation":"The group's ARN.
" + }, + "id":{ + "shape":"RunGroupId", + "documentation":"The group's ID.
" + }, + "name":{ + "shape":"RunGroupName", + "documentation":"The group's name.
" + }, + "maxCpus":{ + "shape":"RunGroupListItemMaxCpusInteger", + "documentation":"The group's maximum CPU count setting.
" + }, + "maxRuns":{ + "shape":"RunGroupListItemMaxRunsInteger", + "documentation":"The group's maximum concurrent run setting.
" + }, + "maxDuration":{ + "shape":"RunGroupListItemMaxDurationInteger", + "documentation":"The group's maximum duration setting in minutes.
" + }, + "creationTime":{ + "shape":"RunGroupTimestamp", + "documentation":"When the group was created.
" + }, + "maxGpus":{ + "shape":"RunGroupListItemMaxGpusInteger", + "documentation":"The maximum GPUs that can be used by a run group.
" + } + }, + "documentation":"A run group.
" + }, + "RunGroupListItemMaxCpusInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "RunGroupListItemMaxDurationInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "RunGroupListItemMaxGpusInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "RunGroupListItemMaxRunsInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "RunGroupListToken":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "RunGroupName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "RunGroupRequestId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "RunGroupTimestamp":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "RunId":{ + "type":"string", + "max":18, + "min":1, + "pattern":"[0-9]+" + }, + "RunLeftNormalization":{"type":"boolean"}, + "RunList":{ + "type":"list", + "member":{"shape":"RunListItem"} + }, + "RunListItem":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"RunArn", + "documentation":"The run's ARN.
" + }, + "id":{ + "shape":"RunId", + "documentation":"The run's ID.
" + }, + "status":{ + "shape":"RunStatus", + "documentation":"The run's status.
" + }, + "workflowId":{ + "shape":"WorkflowId", + "documentation":"The run's workflow ID.
" + }, + "name":{ + "shape":"RunName", + "documentation":"The run's name.
" + }, + "priority":{ + "shape":"RunListItemPriorityInteger", + "documentation":"The run's priority.
" + }, + "storageCapacity":{ + "shape":"RunListItemStorageCapacityInteger", + "documentation":"The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.
" + }, + "creationTime":{ + "shape":"RunTimestamp", + "documentation":"When the run was created.
" + }, + "startTime":{ + "shape":"RunTimestamp", + "documentation":"When the run started.
" + }, + "stopTime":{ + "shape":"RunTimestamp", + "documentation":"When the run stopped.
" + }, + "storageType":{ + "shape":"StorageType", + "documentation":"The run's storage type.
" + } + }, + "documentation":"A workflow run.
" + }, + "RunListItemPriorityInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":0 + }, + "RunListItemStorageCapacityInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":0 + }, + "RunListToken":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "RunLogLevel":{ + "type":"string", + "enum":[ + "OFF", + "FATAL", + "ERROR", + "ALL" + ], + "max":64, + "min":1 + }, + "RunLogLocation":{ + "type":"structure", + "members":{ + "engineLogStream":{ + "shape":"EngineLogStream", + "documentation":"The log stream ARN for the engine log.
" + }, + "runLogStream":{ + "shape":"RunLogStream", + "documentation":"The log stream ARN for the run log.
" + } + }, + "documentation":"The URI for the run log.
" + }, + "RunLogStream":{ + "type":"string", + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "RunName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "RunOutputUri":{ + "type":"string", + "max":750, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "RunParameters":{ + "type":"structure", + "members":{ + }, + "document":true + }, + "RunRequestId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "RunResourceDigest":{ + "type":"string", + "max":64, + "min":0, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "RunResourceDigestKey":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "RunResourceDigests":{ + "type":"map", + "key":{"shape":"RunResourceDigestKey"}, + "value":{"shape":"RunResourceDigest"} + }, + "RunRetentionMode":{ + "type":"string", + "enum":[ + "RETAIN", + "REMOVE" + ], + "max":64, + "min":1 + }, + "RunRoleArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:.+" + }, + "RunStartedBy":{ + "type":"string", + "max":128, + "min":1 + }, + "RunStatus":{ + "type":"string", + "enum":[ + "PENDING", + "STARTING", + "RUNNING", + "STOPPING", + "COMPLETED", + "DELETED", + "CANCELLED", + "FAILED" + ], + "max":64, + "min":1 + }, + "RunStatusMessage":{ + "type":"string", + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "RunTimestamp":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "RunUuid":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "S3AccessPointArn":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*" + }, + "S3Destination":{ + "type":"string", + "pattern":"s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?" + }, + "S3Uri":{ + "type":"string", + "pattern":"s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})" + }, + "SampleId":{ + "type":"string", + "max":127, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "SchemaItem":{ + "type":"map", + "key":{"shape":"SchemaItemKeyString"}, + "value":{"shape":"SchemaValueType"}, + "max":1, + "min":1 + }, + "SchemaItemKeyString":{ + "type":"string", + "pattern":"[a-z0-9_]{1,255}" + }, + "SchemaValueType":{ + "type":"string", + "enum":[ + "LONG", + "INT", + "STRING", + "FLOAT", + "DOUBLE", + "BOOLEAN" + ] + }, + "Separator":{ + "type":"string", + "max":20, + "min":1 + }, + "SequenceInformation":{ + "type":"structure", + "members":{ + "totalReadCount":{ + "shape":"Long", + "documentation":"The sequence's total read count.
" + }, + "totalBaseCount":{ + "shape":"Long", + "documentation":"The sequence's total base count.
" + }, + "generatedFrom":{ + "shape":"GeneratedFrom", + "documentation":"Where the sequence originated.
" + }, + "alignment":{ + "shape":"String", + "documentation":"The sequence's alignment setting.
" + } + }, + "documentation":"Details about a sequence.
" + }, + "SequenceStoreArn":{ + "type":"string", + "max":127, + "min":1, + "pattern":"arn:.+" + }, + "SequenceStoreDescription":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "SequenceStoreDetail":{ + "type":"structure", + "required":[ + "arn", + "id", + "creationTime" + ], + "members":{ + "arn":{ + "shape":"SequenceStoreArn", + "documentation":"The store's ARN.
" + }, + "id":{ + "shape":"SequenceStoreId", + "documentation":"The store's ID.
" + }, + "name":{ + "shape":"SequenceStoreName", + "documentation":"The store's name.
" + }, + "description":{ + "shape":"SequenceStoreDescription", + "documentation":"The store's description.
" + }, + "sseConfig":{ + "shape":"SseConfig", + "documentation":"The store's server-side encryption (SSE) settings.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the store was created.
" + }, + "fallbackLocation":{ + "shape":"S3Destination", + "documentation":"An S3 location that is used to store files that have failed a direct upload.
" + }, + "eTagAlgorithmFamily":{ + "shape":"ETagAlgorithmFamily", + "documentation":"The algorithm family of the ETag.
" + } + }, + "documentation":"Details about a sequence store.
" + }, + "SequenceStoreDetailList":{ + "type":"list", + "member":{"shape":"SequenceStoreDetail"} + }, + "SequenceStoreFilter":{ + "type":"structure", + "members":{ + "name":{ + "shape":"SequenceStoreName", + "documentation":"A name to filter on.
" + }, + "createdAfter":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's start date.
" + }, + "createdBefore":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The filter's end date.
" + } + }, + "documentation":"A filter for a sequence store.
" + }, + "SequenceStoreId":{ + "type":"string", + "max":36, + "min":10, + "pattern":"[0-9]+" + }, + "SequenceStoreName":{ + "type":"string", + "max":127, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "SequenceStoreS3Access":{ + "type":"structure", + "members":{ + "s3Uri":{ + "shape":"S3Uri", + "documentation":"The S3 URI of the sequence store.
" + }, + "s3AccessPointArn":{ + "shape":"S3AccessPointArn", + "documentation":"This is ARN of the access point associated with the S3 bucket storing read sets.
" + } + }, + "documentation":"The S3 access metadata of the sequence store.
" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request exceeds a service quota.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "ShareDetails":{ + "type":"structure", + "members":{ + "shareId":{ + "shape":"String", + "documentation":"The ID of the resource share.
" + }, + "resourceArn":{ + "shape":"String", + "documentation":"The Arn of the shared resource.
" + }, + "resourceId":{ + "shape":"String", + "documentation":"The ID of the shared resource.
" + }, + "principalSubscriber":{ + "shape":"String", + "documentation":"The principal subscriber is the account that is sharing the resource.
" + }, + "ownerId":{ + "shape":"String", + "documentation":"The account ID for the data owner. The owner creates the resource share.
" + }, + "status":{ + "shape":"ShareStatus", + "documentation":"The status of the share.
" + }, + "statusMessage":{ + "shape":"StatusMessage", + "documentation":"The status message for a resource share. It provides additional details about the share status.
" + }, + "shareName":{ + "shape":"ShareName", + "documentation":"The name of the resource share.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"The timestamp of when the resource share was created.
" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"The timestamp of the resource share update.
" + } + }, + "documentation":"The details of a resource share.
" + }, + "ShareDetailsList":{ + "type":"list", + "member":{"shape":"ShareDetails"} + }, + "ShareName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "ShareResourceType":{ + "type":"string", + "enum":[ + "VARIANT_STORE", + "ANNOTATION_STORE", + "WORKFLOW" + ] + }, + "ShareStatus":{ + "type":"string", + "enum":[ + "PENDING", + "ACTIVATING", + "ACTIVE", + "DELETING", + "DELETED", + "FAILED" + ] + }, + "SourceFiles":{ + "type":"structure", + "required":["source1"], + "members":{ + "source1":{ + "shape":"S3Uri", + "documentation":"The location of the first file in Amazon S3.
" + }, + "source2":{ + "shape":"S3Uri", + "documentation":"The location of the second file in Amazon S3.
" + } + }, + "documentation":"Source files for a sequence.
" + }, + "SseConfig":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"EncryptionType", + "documentation":"The encryption type.
" + }, + "keyArn":{ + "shape":"SseConfigKeyArnString", + "documentation":"An encryption key ARN.
" + } + }, + "documentation":"Server-side encryption (SSE) settings for a store.
" + }, + "SseConfigKeyArnString":{ + "type":"string", + "max":2048, + "min":20, + "pattern":".*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*" + }, + "StartAnnotationImportRequest":{ + "type":"structure", + "required":[ + "destinationName", + "roleArn", + "items" + ], + "members":{ + "destinationName":{ + "shape":"StoreName", + "documentation":"A destination annotation store for the job.
" + }, + "roleArn":{ + "shape":"Arn", + "documentation":"A service role for the job.
" + }, + "items":{ + "shape":"AnnotationImportItemSources", + "documentation":"Items to import.
" + }, + "versionName":{ + "shape":"VersionName", + "documentation":"The name of the annotation store version.
" + }, + "formatOptions":{ + "shape":"FormatOptions", + "documentation":"Formatting options for the annotation file.
" + }, + "runLeftNormalization":{ + "shape":"RunLeftNormalization", + "documentation":"The job's left normalization setting.
" + }, + "annotationFields":{ + "shape":"AnnotationFieldMap", + "documentation":"The annotation schema generated by the parsed annotation data.
" + } + } + }, + "StartAnnotationImportResponse":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"ResourceId", + "documentation":"The job's ID.
" + } + } + }, + "StartReadSetActivationJobRequest":{ + "type":"structure", + "required":[ + "sequenceStoreId", + "sources" + ], + "members":{ + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The read set's sequence store ID.
", + "location":"uri", + "locationName":"sequenceStoreId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"To ensure that jobs don't run multiple times, specify a unique token for each job.
" + }, + "sources":{ + "shape":"StartReadSetActivationJobRequestSourcesList", + "documentation":"The job's source files.
" + } + } + }, + "StartReadSetActivationJobRequestSourcesList":{ + "type":"list", + "member":{"shape":"StartReadSetActivationJobSourceItem"}, + "max":20, + "min":1 + }, + "StartReadSetActivationJobResponse":{ + "type":"structure", + "required":[ + "id", + "sequenceStoreId", + "status", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ActivationJobId", + "documentation":"The job's ID.
" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The read set's sequence store ID.
" + }, + "status":{ + "shape":"ReadSetActivationJobStatus", + "documentation":"The job's status.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job was created.
" + } + } + }, + "StartReadSetActivationJobSourceItem":{ + "type":"structure", + "required":["readSetId"], + "members":{ + "readSetId":{ + "shape":"ReadSetId", + "documentation":"The source's read set ID.
" + } + }, + "documentation":"A source for a read set activation job.
" + }, + "StartReadSetExportJobRequest":{ + "type":"structure", + "required":[ + "sequenceStoreId", + "destination", + "roleArn", + "sources" + ], + "members":{ + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The read set's sequence store ID.
", + "location":"uri", + "locationName":"sequenceStoreId" + }, + "destination":{ + "shape":"S3Destination", + "documentation":"A location for exported files in Amazon S3.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"A service role for the job.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"To ensure that jobs don't run multiple times, specify a unique token for each job.
" + }, + "sources":{ + "shape":"StartReadSetExportJobRequestSourcesList", + "documentation":"The job's source files.
" + } + } + }, + "StartReadSetExportJobRequestSourcesList":{ + "type":"list", + "member":{"shape":"ExportReadSet"}, + "max":100, + "min":1 + }, + "StartReadSetExportJobResponse":{ + "type":"structure", + "required":[ + "id", + "sequenceStoreId", + "destination", + "status", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ExportJobId", + "documentation":"The job's ID.
" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The read set's sequence store ID.
" + }, + "destination":{ + "shape":"S3Destination", + "documentation":"The job's output location.
" + }, + "status":{ + "shape":"ReadSetExportJobStatus", + "documentation":"The job's status.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job was created.
" + } + } + }, + "StartReadSetImportJobRequest":{ + "type":"structure", + "required":[ + "sequenceStoreId", + "roleArn", + "sources" + ], + "members":{ + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The read set's sequence store ID.
", + "location":"uri", + "locationName":"sequenceStoreId" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"A service role for the job.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"To ensure that jobs don't run multiple times, specify a unique token for each job.
" + }, + "sources":{ + "shape":"StartReadSetImportJobRequestSourcesList", + "documentation":"The job's source files.
" + } + } + }, + "StartReadSetImportJobRequestSourcesList":{ + "type":"list", + "member":{"shape":"StartReadSetImportJobSourceItem"}, + "max":100, + "min":1 + }, + "StartReadSetImportJobResponse":{ + "type":"structure", + "required":[ + "id", + "sequenceStoreId", + "roleArn", + "status", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ImportJobId", + "documentation":"The job's ID.
" + }, + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The read set's sequence store ID.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The job's service role ARN.
" + }, + "status":{ + "shape":"ReadSetImportJobStatus", + "documentation":"The job's status.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job was created.
" + } + } + }, + "StartReadSetImportJobSourceItem":{ + "type":"structure", + "required":[ + "sourceFiles", + "sourceFileType", + "subjectId", + "sampleId" + ], + "members":{ + "sourceFiles":{ + "shape":"SourceFiles", + "documentation":"The source files' location in Amazon S3.
" + }, + "sourceFileType":{ + "shape":"FileType", + "documentation":"The source's file type.
" + }, + "subjectId":{ + "shape":"SubjectId", + "documentation":"The source's subject ID.
" + }, + "sampleId":{ + "shape":"SampleId", + "documentation":"The source's sample ID.
" + }, + "generatedFrom":{ + "shape":"GeneratedFrom", + "documentation":"Where the source originated.
" + }, + "referenceArn":{ + "shape":"ReferenceArn", + "documentation":"The source's reference ARN.
" + }, + "name":{ + "shape":"ReadSetName", + "documentation":"The source's name.
" + }, + "description":{ + "shape":"ReadSetDescription", + "documentation":"The source's description.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The source's tags.
" + } + }, + "documentation":"A source for a read set import job.
" + }, + "StartReferenceImportJobRequest":{ + "type":"structure", + "required":[ + "referenceStoreId", + "roleArn", + "sources" + ], + "members":{ + "referenceStoreId":{ + "shape":"ReferenceStoreId", + "documentation":"The job's reference store ID.
", + "location":"uri", + "locationName":"referenceStoreId" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"A service role for the job.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"To ensure that jobs don't run multiple times, specify a unique token for each job.
" + }, + "sources":{ + "shape":"StartReferenceImportJobRequestSourcesList", + "documentation":"The job's source files.
" + } + } + }, + "StartReferenceImportJobRequestSourcesList":{ + "type":"list", + "member":{"shape":"StartReferenceImportJobSourceItem"}, + "max":100, + "min":1 + }, + "StartReferenceImportJobResponse":{ + "type":"structure", + "required":[ + "id", + "referenceStoreId", + "roleArn", + "status", + "creationTime" + ], + "members":{ + "id":{ + "shape":"ImportJobId", + "documentation":"The job's ID.
" + }, + "referenceStoreId":{ + "shape":"ReferenceStoreId", + "documentation":"The job's reference store ID.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The job's service role ARN.
" + }, + "status":{ + "shape":"ReferenceImportJobStatus", + "documentation":"The job's status.
" + }, + "creationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the job was created.
" + } + } + }, + "StartReferenceImportJobSourceItem":{ + "type":"structure", + "required":[ + "sourceFile", + "name" + ], + "members":{ + "sourceFile":{ + "shape":"S3Uri", + "documentation":"The source file's location in Amazon S3.
" + }, + "name":{ + "shape":"ReferenceName", + "documentation":"The source's name.
" + }, + "description":{ + "shape":"ReferenceDescription", + "documentation":"The source's description.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The source's tags.
" + } + }, + "documentation":"A source for a reference import job.
" + }, + "StartRunRequest":{ + "type":"structure", + "required":[ + "roleArn", + "requestId" + ], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"The run's workflow ID.
" + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"The run's workflow type.
" + }, + "runId":{ + "shape":"RunId", + "documentation":"The ID of a run to duplicate.
" + }, + "roleArn":{ + "shape":"RunRoleArn", + "documentation":"A service role for the run.
" + }, + "name":{ + "shape":"RunName", + "documentation":"A name for the run.
" + }, + "runGroupId":{ + "shape":"RunGroupId", + "documentation":"The run's group ID.
" + }, + "priority":{ + "shape":"StartRunRequestPriorityInteger", + "documentation":"A priority for the run.
" + }, + "parameters":{ + "shape":"RunParameters", + "documentation":"Parameters for the run.
" + }, + "storageCapacity":{ + "shape":"StartRunRequestStorageCapacityInteger", + "documentation":"A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic (the system ignores any value that you enter).
" + }, + "outputUri":{ + "shape":"RunOutputUri", + "documentation":"An output URI for the run.
" + }, + "logLevel":{ + "shape":"RunLogLevel", + "documentation":"A log level for the run.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"Tags for the run.
" + }, + "requestId":{ + "shape":"RunRequestId", + "documentation":"To ensure that requests don't run multiple times, specify a unique ID for each request.
", + "idempotencyToken":true + }, + "retentionMode":{ + "shape":"RunRetentionMode", + "documentation":"The retention mode for the run.
" + }, + "storageType":{ + "shape":"StorageType", + "documentation":"The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.
" + }, + "workflowOwnerId":{ + "shape":"WorkflowOwnerId", + "documentation":"The ID of the workflow owner.
" + } + } + }, + "StartRunRequestPriorityInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":0 + }, + "StartRunRequestStorageCapacityInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":0 + }, + "StartRunResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"RunArn", + "documentation":"The run's ARN.
" + }, + "id":{ + "shape":"RunId", + "documentation":"The run's ID.
" + }, + "status":{ + "shape":"RunStatus", + "documentation":"The run's status.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The run's tags.
" + }, + "uuid":{ + "shape":"RunUuid", + "documentation":"The universally unique identifier for a run.
" + }, + "runOutputUri":{ + "shape":"RunOutputUri", + "documentation":"The destination for workflow outputs.
" + } + } + }, + "StartVariantImportRequest":{ + "type":"structure", + "required":[ + "destinationName", + "roleArn", + "items" + ], + "members":{ + "destinationName":{ + "shape":"StoreName", + "documentation":"The destination variant store for the job.
" + }, + "roleArn":{ + "shape":"Arn", + "documentation":"A service role for the job.
" + }, + "items":{ + "shape":"VariantImportItemSources", + "documentation":"Items to import.
" + }, + "runLeftNormalization":{ + "shape":"RunLeftNormalization", + "documentation":"The job's left normalization setting.
" + }, + "annotationFields":{ + "shape":"AnnotationFieldMap", + "documentation":"The annotation schema generated by the parsed annotation data.
" + } + } + }, + "StartVariantImportResponse":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"ResourceId", + "documentation":"The job's ID.
" + } + } + }, + "StatusList":{ + "type":"list", + "member":{"shape":"ShareStatus"}, + "max":10, + "min":1 + }, + "StatusMessage":{ + "type":"string", + "max":1000, + "min":0 + }, + "StorageType":{ + "type":"string", + "enum":[ + "STATIC", + "DYNAMIC" + ], + "max":64, + "min":1 + }, + "StoreFormat":{ + "type":"string", + "enum":[ + "GFF", + "TSV", + "VCF" + ] + }, + "StoreName":{ + "type":"string", + "max":255, + "min":3, + "pattern":"([a-z]){1}([a-z0-9_]){2,254}" + }, + "StoreOptions":{ + "type":"structure", + "members":{ + "tsvStoreOptions":{ + "shape":"TsvStoreOptions", + "documentation":"File settings for a TSV store.
" + } + }, + "documentation":"Settings for a store.
", + "union":true + }, + "StoreStatus":{ + "type":"string", + "enum":[ + "CREATING", + "UPDATING", + "DELETING", + "ACTIVE", + "FAILED" + ] + }, + "String":{"type":"string"}, + "SubjectId":{ + "type":"string", + "max":127, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "SyntheticTimestamp_date_time":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "TagArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:.+" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"TagArn", + "documentation":"The resource's ARN.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagResourceRequestTagsMap", + "documentation":"Tags for the resource.
" + } + } + }, + "TagResourceRequestTagsMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":0 + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TaskFailureReason":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "TaskId":{ + "type":"string", + "max":18, + "min":1, + "pattern":"[0-9]+" + }, + "TaskInstanceType":{ + "type":"string", + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "TaskList":{ + "type":"list", + "member":{"shape":"TaskListItem"} + }, + "TaskListItem":{ + "type":"structure", + "members":{ + "taskId":{ + "shape":"TaskId", + "documentation":"The task's ID.
" + }, + "status":{ + "shape":"TaskStatus", + "documentation":"The task's status.
" + }, + "name":{ + "shape":"TaskName", + "documentation":"The task's name.
" + }, + "cpus":{ + "shape":"TaskListItemCpusInteger", + "documentation":"The task's CPU count.
" + }, + "memory":{ + "shape":"TaskListItemMemoryInteger", + "documentation":"The task's memory use in gigabyes.
" + }, + "creationTime":{ + "shape":"TaskTimestamp", + "documentation":"When the task was created.
" + }, + "startTime":{ + "shape":"TaskTimestamp", + "documentation":"When the task started.
" + }, + "stopTime":{ + "shape":"TaskTimestamp", + "documentation":"When the task stopped.
" + }, + "gpus":{ + "shape":"TaskListItemGpusInteger", + "documentation":"The number of Graphics Processing Units (GPU) specified for the task.
" + }, + "instanceType":{ + "shape":"TaskInstanceType", + "documentation":"The instance type for a task.
" + } + }, + "documentation":"A workflow run task.
" + }, + "TaskListItemCpusInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "TaskListItemGpusInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "TaskListItemMemoryInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "TaskListToken":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "TaskLogStream":{ + "type":"string", + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "TaskName":{ + "type":"string", + "max":128, + "min":1 + }, + "TaskStatus":{ + "type":"string", + "enum":[ + "PENDING", + "STARTING", + "RUNNING", + "STOPPING", + "COMPLETED", + "CANCELLED", + "FAILED" + ], + "max":64, + "min":1 + }, + "TaskStatusMessage":{ + "type":"string", + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "TaskTimestamp":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":true} + }, + "TsvOptions":{ + "type":"structure", + "members":{ + "readOptions":{ + "shape":"ReadOptions", + "documentation":"The file's read options.
" + } + }, + "documentation":"Formatting options for a TSV file.
" + }, + "TsvStoreOptions":{ + "type":"structure", + "members":{ + "annotationType":{ + "shape":"AnnotationType", + "documentation":"The store's annotation type.
" + }, + "formatToHeader":{ + "shape":"FormatToHeader", + "documentation":"The store's header key to column name mapping.
" + }, + "schema":{ + "shape":"TsvStoreOptionsSchemaList", + "documentation":"The store's schema.
" + } + }, + "documentation":"File settings for a TSV store.
" + }, + "TsvStoreOptionsSchemaList":{ + "type":"list", + "member":{"shape":"SchemaItem"}, + "max":5000, + "min":1 + }, + "TsvVersionOptions":{ + "type":"structure", + "members":{ + "annotationType":{ + "shape":"AnnotationType", + "documentation":"The store version's annotation type.
" + }, + "formatToHeader":{ + "shape":"FormatToHeader", + "documentation":"The annotation store version's header key to column name mapping.
" + }, + "schema":{ + "shape":"TsvVersionOptionsSchemaList", + "documentation":"The TSV schema for an annotation store version.
" + } + }, + "documentation":"The options for a TSV file.
" + }, + "TsvVersionOptionsSchemaList":{ + "type":"list", + "member":{"shape":"SchemaItem"}, + "max":5000, + "min":1 + }, + "TypeList":{ + "type":"list", + "member":{"shape":"ShareResourceType"}, + "max":10, + "min":1 + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"TagArn", + "documentation":"The resource's ARN.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"Keys of tags to remove.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateAnnotationStoreRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"A name for the store.
", + "location":"uri", + "locationName":"name" + }, + "description":{ + "shape":"Description", + "documentation":"A description for the store.
" + } + } + }, + "UpdateAnnotationStoreResponse":{ + "type":"structure", + "required":[ + "id", + "reference", + "status", + "name", + "description", + "creationTime", + "updateTime" + ], + "members":{ + "id":{ + "shape":"ResourceId", + "documentation":"The store's ID.
" + }, + "reference":{ + "shape":"ReferenceItem", + "documentation":"The store's genome reference.
" + }, + "status":{ + "shape":"StoreStatus", + "documentation":"The store's status.
" + }, + "name":{ + "shape":"String", + "documentation":"The store's name.
" + }, + "description":{ + "shape":"Description", + "documentation":"The store's description.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"When the store was created.
" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"When the store was updated.
" + }, + "storeOptions":{ + "shape":"StoreOptions", + "documentation":"Parsing options for the store.
" + }, + "storeFormat":{ + "shape":"StoreFormat", + "documentation":"The annotation file format of the store.
" + } + } + }, + "UpdateAnnotationStoreVersionRequest":{ + "type":"structure", + "required":[ + "name", + "versionName" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of an annotation store.
", + "location":"uri", + "locationName":"name" + }, + "versionName":{ + "shape":"String", + "documentation":"The name of an annotation store version.
", + "location":"uri", + "locationName":"versionName" + }, + "description":{ + "shape":"Description", + "documentation":"The description of an annotation store.
" + } + } + }, + "UpdateAnnotationStoreVersionResponse":{ + "type":"structure", + "required":[ + "storeId", + "id", + "status", + "name", + "versionName", + "description", + "creationTime", + "updateTime" + ], + "members":{ + "storeId":{ + "shape":"ResourceId", + "documentation":"The annotation store ID.
" + }, + "id":{ + "shape":"ResourceId", + "documentation":"The annotation store version ID.
" + }, + "status":{ + "shape":"VersionStatus", + "documentation":"The status of an annotation store version.
" + }, + "name":{ + "shape":"StoreName", + "documentation":"The name of an annotation store.
" + }, + "versionName":{ + "shape":"VersionName", + "documentation":"The name of an annotation store version.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of an annotation store version.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"The time stamp for when an annotation store version was created.
" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"The time stamp for when an annotation store version was updated.
" + } + } + }, + "UpdateRunGroupRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"RunGroupId", + "documentation":"The group's ID.
", + "location":"uri", + "locationName":"id" + }, + "name":{ + "shape":"RunGroupName", + "documentation":"A name for the group.
" + }, + "maxCpus":{ + "shape":"UpdateRunGroupRequestMaxCpusInteger", + "documentation":"The maximum number of CPUs to use.
" + }, + "maxRuns":{ + "shape":"UpdateRunGroupRequestMaxRunsInteger", + "documentation":"The maximum number of concurrent runs for the group.
" + }, + "maxDuration":{ + "shape":"UpdateRunGroupRequestMaxDurationInteger", + "documentation":"A maximum run time for the group in minutes.
" + }, + "maxGpus":{ + "shape":"UpdateRunGroupRequestMaxGpusInteger", + "documentation":"The maximum GPUs that can be used by a run group.
" + } + } + }, + "UpdateRunGroupRequestMaxCpusInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "UpdateRunGroupRequestMaxDurationInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "UpdateRunGroupRequestMaxGpusInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "UpdateRunGroupRequestMaxRunsInteger":{ + "type":"integer", + "box":true, + "max":100000, + "min":1 + }, + "UpdateTime":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "UpdateVariantStoreRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"A name for the store.
", + "location":"uri", + "locationName":"name" + }, + "description":{ + "shape":"Description", + "documentation":"A description for the store.
" + } + } + }, + "UpdateVariantStoreResponse":{ + "type":"structure", + "required":[ + "id", + "reference", + "status", + "name", + "description", + "creationTime", + "updateTime" + ], + "members":{ + "id":{ + "shape":"ResourceId", + "documentation":"The store's ID.
" + }, + "reference":{ + "shape":"ReferenceItem", + "documentation":"The store's genome reference.
" + }, + "status":{ + "shape":"StoreStatus", + "documentation":"The store's status.
" + }, + "name":{ + "shape":"String", + "documentation":"The store's name.
" + }, + "description":{ + "shape":"Description", + "documentation":"The store's description.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"When the store was created.
" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"When the store was updated.
" + } + } + }, + "UpdateWorkflowRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"WorkflowId", + "documentation":"The workflow's ID.
", + "location":"uri", + "locationName":"id" + }, + "name":{ + "shape":"WorkflowName", + "documentation":"A name for the workflow.
" + }, + "description":{ + "shape":"WorkflowDescription", + "documentation":"A description for the workflow.
" + } + } + }, + "UploadId":{ + "type":"string", + "max":36, + "min":10, + "pattern":"[0-9]+" + }, + "UploadReadSetPartRequest":{ + "type":"structure", + "required":[ + "sequenceStoreId", + "uploadId", + "partSource", + "partNumber", + "payload" + ], + "members":{ + "sequenceStoreId":{ + "shape":"SequenceStoreId", + "documentation":"The Sequence Store ID used for the multipart upload.
", + "location":"uri", + "locationName":"sequenceStoreId" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"The ID for the initiated multipart upload.
", + "location":"uri", + "locationName":"uploadId" + }, + "partSource":{ + "shape":"ReadSetPartSource", + "documentation":"The source file for an upload part.
", + "location":"querystring", + "locationName":"partSource" + }, + "partNumber":{ + "shape":"UploadReadSetPartRequestPartNumberInteger", + "documentation":"The number of the part being uploaded.
", + "location":"querystring", + "locationName":"partNumber" + }, + "payload":{ + "shape":"ReadSetPartStreamingBlob", + "documentation":"The read set data to upload for a part.
" + } + }, + "payload":"payload" + }, + "UploadReadSetPartRequestPartNumberInteger":{ + "type":"integer", + "box":true, + "max":10000, + "min":1 + }, + "UploadReadSetPartResponse":{ + "type":"structure", + "required":["checksum"], + "members":{ + "checksum":{ + "shape":"String", + "documentation":"An identifier used to confirm that parts are being added to the intended upload.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The input fails to satisfy the constraints specified by an AWS service.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "VariantImportItemDetail":{ + "type":"structure", + "required":[ + "source", + "jobStatus" + ], + "members":{ + "source":{ + "shape":"S3Uri", + "documentation":"The source file's location in Amazon S3.
" + }, + "jobStatus":{ + "shape":"JobStatus", + "documentation":"The item's job status.
" + }, + "statusMessage":{ + "shape":"JobStatusMsg", + "documentation":"A message that provides additional context about a job
" + } + }, + "documentation":"Details about an imported variant item.
" + }, + "VariantImportItemDetails":{ + "type":"list", + "member":{"shape":"VariantImportItemDetail"}, + "min":1 + }, + "VariantImportItemSource":{ + "type":"structure", + "required":["source"], + "members":{ + "source":{ + "shape":"S3Uri", + "documentation":"The source file's location in Amazon S3.
" + } + }, + "documentation":"A imported variant item's source.
" + }, + "VariantImportItemSources":{ + "type":"list", + "member":{"shape":"VariantImportItemSource"}, + "min":1 + }, + "VariantImportJobItem":{ + "type":"structure", + "required":[ + "id", + "destinationName", + "roleArn", + "status", + "creationTime", + "updateTime" + ], + "members":{ + "id":{ + "shape":"String", + "documentation":"The job's ID.
" + }, + "destinationName":{ + "shape":"String", + "documentation":"The job's destination variant store.
" + }, + "roleArn":{ + "shape":"Arn", + "documentation":"The job's service role ARN.
" + }, + "status":{ + "shape":"JobStatus", + "documentation":"The job's status.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"When the job was created.
" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"When the job was updated.
" + }, + "completionTime":{ + "shape":"CompletionTime", + "documentation":"When the job completed.
" + }, + "runLeftNormalization":{ + "shape":"RunLeftNormalization", + "documentation":"The job's left normalization setting.
" + }, + "annotationFields":{ + "shape":"AnnotationFieldMap", + "documentation":"The annotation schema generated by the parsed annotation data.
" + } + }, + "documentation":"A variant import job.
" + }, + "VariantImportJobItems":{ + "type":"list", + "member":{"shape":"VariantImportJobItem"} + }, + "VariantStoreItem":{ + "type":"structure", + "required":[ + "id", + "reference", + "status", + "storeArn", + "name", + "description", + "sseConfig", + "creationTime", + "updateTime", + "statusMessage", + "storeSizeBytes" + ], + "members":{ + "id":{ + "shape":"ResourceId", + "documentation":"The store's ID.
" + }, + "reference":{ + "shape":"ReferenceItem", + "documentation":"The store's genome reference.
" + }, + "status":{ + "shape":"StoreStatus", + "documentation":"The store's status.
" + }, + "storeArn":{ + "shape":"Arn", + "documentation":"The store's ARN.
" + }, + "name":{ + "shape":"String", + "documentation":"The store's name.
" + }, + "description":{ + "shape":"Description", + "documentation":"The store's description.
" + }, + "sseConfig":{ + "shape":"SseConfig", + "documentation":"The store's server-side encryption (SSE) settings.
" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"When the store was created.
" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"When the store was updated.
" + }, + "statusMessage":{ + "shape":"StatusMessage", + "documentation":"The store's status message.
" + }, + "storeSizeBytes":{ + "shape":"Long", + "documentation":"The store's size in bytes.
" + } + }, + "documentation":"A variant store.
" + }, + "VariantStoreItems":{ + "type":"list", + "member":{"shape":"VariantStoreItem"} + }, + "VcfOptions":{ + "type":"structure", + "members":{ + "ignoreQualField":{ + "shape":"Boolean", + "documentation":"The file's ignore qual field setting.
" + }, + "ignoreFilterField":{ + "shape":"Boolean", + "documentation":"The file's ignore filter field setting.
" + } + }, + "documentation":"Formatting options for a VCF file.
" + }, + "VersionDeleteError":{ + "type":"structure", + "required":[ + "versionName", + "message" + ], + "members":{ + "versionName":{ + "shape":"VersionName", + "documentation":"The name given to an annotation store version.
" + }, + "message":{ + "shape":"String", + "documentation":"The message explaining the error in annotation store deletion.
" + } + }, + "documentation":"The error preventing deletion of the annotation store version.
" + }, + "VersionDeleteErrorList":{ + "type":"list", + "member":{"shape":"VersionDeleteError"} + }, + "VersionList":{ + "type":"list", + "member":{"shape":"VersionName"}, + "max":10, + "min":1 + }, + "VersionName":{ + "type":"string", + "max":255, + "min":3, + "pattern":"([a-z]){1}([a-z0-9_]){2,254}" + }, + "VersionOptions":{ + "type":"structure", + "members":{ + "tsvVersionOptions":{ + "shape":"TsvVersionOptions", + "documentation":"File settings for a version of a TSV store.
" + } + }, + "documentation":"The options for an annotation store version.
", + "union":true + }, + "VersionStatus":{ + "type":"string", + "enum":[ + "CREATING", + "UPDATING", + "DELETING", + "ACTIVE", + "FAILED" + ] + }, + "WorkflowArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"arn:.+" + }, + "WorkflowDefinition":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "WorkflowDescription":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "WorkflowDigest":{ + "type":"string", + "max":64, + "min":1 + }, + "WorkflowEngine":{ + "type":"string", + "enum":[ + "WDL", + "NEXTFLOW", + "CWL" + ], + "max":64, + "min":1 + }, + "WorkflowExport":{ + "type":"string", + "enum":["DEFINITION"], + "max":64, + "min":1 + }, + "WorkflowExportList":{ + "type":"list", + "member":{"shape":"WorkflowExport"}, + "max":32, + "min":0 + }, + "WorkflowId":{ + "type":"string", + "max":18, + "min":1, + "pattern":"[0-9]+" + }, + "WorkflowList":{ + "type":"list", + "member":{"shape":"WorkflowListItem"} + }, + "WorkflowListItem":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"WorkflowArn", + "documentation":"The workflow's ARN.
" + }, + "id":{ + "shape":"WorkflowId", + "documentation":"The workflow's ID.
" + }, + "name":{ + "shape":"WorkflowName", + "documentation":"The workflow's name.
" + }, + "status":{ + "shape":"WorkflowStatus", + "documentation":"The workflow's status.
" + }, + "type":{ + "shape":"WorkflowType", + "documentation":"The workflow's type.
" + }, + "digest":{ + "shape":"WorkflowDigest", + "documentation":"The workflow's digest.
" + }, + "creationTime":{ + "shape":"WorkflowTimestamp", + "documentation":"When the workflow was created.
" + }, + "metadata":{ + "shape":"WorkflowMetadata", + "documentation":"Any metadata available for workflow. The information listed may vary depending on the workflow, and there may also be no metadata to return.
" + } + }, + "documentation":"A workflow.
" + }, + "WorkflowListToken":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "WorkflowMain":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "WorkflowMetadata":{ + "type":"map", + "key":{"shape":"WorkflowMetadataKey"}, + "value":{"shape":"WorkflowMetadataValue"} + }, + "WorkflowMetadataKey":{ + "type":"string", + "max":128, + "min":1 + }, + "WorkflowMetadataValue":{ + "type":"string", + "max":256, + "min":0 + }, + "WorkflowName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "WorkflowOwnerId":{ + "type":"string", + "pattern":"[0-9]{12}" + }, + "WorkflowParameter":{ + "type":"structure", + "members":{ + "description":{ + "shape":"WorkflowParameterDescription", + "documentation":"The parameter's description.
" + }, + "optional":{ + "shape":"Boolean", + "documentation":"Whether the parameter is optional.
" + } + }, + "documentation":"A workflow parameter.
" + }, + "WorkflowParameterDescription":{ + "type":"string", + "max":256, + "min":0, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "WorkflowParameterName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "WorkflowParameterTemplate":{ + "type":"map", + "key":{"shape":"WorkflowParameterName"}, + "value":{"shape":"WorkflowParameter"}, + "max":1000, + "min":1 + }, + "WorkflowRequestId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "WorkflowStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "UPDATING", + "DELETED", + "FAILED", + "INACTIVE" + ], + "max":64, + "min":1 + }, + "WorkflowStatusMessage":{ + "type":"string", + "pattern":"[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+" + }, + "WorkflowTimestamp":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "WorkflowType":{ + "type":"string", + "enum":[ + "PRIVATE", + "READY2RUN" + ], + "max":64, + "min":1 + } + }, + "documentation":"This is the AWS HealthOmics API Reference. For an introduction to the service, see What is AWS HealthOmics? in the AWS HealthOmics User Guide.
" +} diff --git a/testbed/boto__botocore/botocore/data/omics/2022-11-28/waiters-2.json b/testbed/boto__botocore/botocore/data/omics/2022-11-28/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..9e82e101dcbd4cac7b5357ec69bdd3d4a8c5dd4b --- /dev/null +++ b/testbed/boto__botocore/botocore/data/omics/2022-11-28/waiters-2.json @@ -0,0 +1,546 @@ +{ + "version" : 2, + "waiters" : { + "AnnotationImportJobCreated" : { + "description" : "Wait until an annotation import is completed", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetAnnotationImportJob", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "SUBMITTED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "IN_PROGRESS" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "FAILED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "CANCELLED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "COMPLETED" + } ] + }, + "AnnotationStoreCreated" : { + "description" : "Wait until an annotation store is created", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetAnnotationStore", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "ACTIVE" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "CREATING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "UPDATING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "FAILED" + } ] + }, + "AnnotationStoreDeleted" : { + "description" : "Wait until an annotation store is deleted.", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetAnnotationStore", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "DELETED" + }, { + "matcher" : "error", + "state" : "success", + "expected" : "ResourceNotFoundException" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "DELETING" + } ] + }, + "AnnotationStoreVersionCreated" : { + "description" : "Wait until an annotation store version is created", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetAnnotationStoreVersion", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "ACTIVE" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "CREATING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "UPDATING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "FAILED" + } ] + }, + "AnnotationStoreVersionDeleted" : { + "description" : "Wait until an annotation store version is deleted.", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetAnnotationStoreVersion", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "DELETED" + }, { + "matcher" : "error", + "state" : "success", + "expected" : "ResourceNotFoundException" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "DELETING" + } ] + }, + "ReadSetActivationJobCompleted" : { + "description" : "Wait until a job is completed.", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetReadSetActivationJob", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "COMPLETED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "SUBMITTED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "IN_PROGRESS" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "CANCELLING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "CANCELLED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "FAILED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "COMPLETED_WITH_FAILURES" + } ] + }, + "ReadSetExportJobCompleted" : { + "description" : "Wait until a job is completed.", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetReadSetExportJob", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "COMPLETED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "SUBMITTED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "IN_PROGRESS" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "CANCELLING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "CANCELLED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "FAILED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "COMPLETED_WITH_FAILURES" + } ] + }, + "ReadSetImportJobCompleted" : { + "description" : "Wait until a job is completed.", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetReadSetImportJob", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "COMPLETED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "SUBMITTED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "IN_PROGRESS" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "CANCELLING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "CANCELLED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "FAILED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "COMPLETED_WITH_FAILURES" + } ] + }, + "ReferenceImportJobCompleted" : { + "description" : "Wait until a job is completed.", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetReferenceImportJob", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "COMPLETED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "SUBMITTED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "IN_PROGRESS" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "CANCELLING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "CANCELLED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "FAILED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "COMPLETED_WITH_FAILURES" + } ] + }, + "RunCompleted" : { + "description" : "Wait until a run is completed.", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetRun", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "COMPLETED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "PENDING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "STARTING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "RUNNING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "STOPPING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "FAILED" + } ] + }, + "RunRunning" : { + "description" : "Wait until a run is running.", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetRun", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "RUNNING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "PENDING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "STARTING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "FAILED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "CANCELLED" + } ] + }, + "TaskCompleted" : { + "description" : "Wait until a task is completed.", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetRunTask", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "COMPLETED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "PENDING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "STARTING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "RUNNING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "STOPPING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "FAILED" + } ] + }, + "TaskRunning" : { + "description" : "Wait until a task is running.", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetRunTask", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "RUNNING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "PENDING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "STARTING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "FAILED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "CANCELLED" + } ] + }, + "VariantImportJobCreated" : { + "description" : "Wait until variant import is completed", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetVariantImportJob", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "SUBMITTED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "IN_PROGRESS" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "FAILED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "CANCELLED" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "COMPLETED" + } ] + }, + "VariantStoreCreated" : { + "description" : "Wait until a variant store is created", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetVariantStore", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "ACTIVE" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "CREATING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "UPDATING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "FAILED" + } ] + }, + "VariantStoreDeleted" : { + "description" : "Wait until a variant store is deleted.", + "delay" : 30, + "maxAttempts" : 20, + "operation" : "GetVariantStore", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "DELETED" + }, { + "matcher" : "error", + "state" : "success", + "expected" : "ResourceNotFoundException" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "DELETING" + } ] + }, + "WorkflowActive" : { + "description" : "Wait until a workflow is active.", + "delay" : 3, + "maxAttempts" : 10, + "operation" : "GetWorkflow", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "ACTIVE" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "CREATING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "retry", + "expected" : "UPDATING" + }, { + "matcher" : "path", + "argument" : "status", + "state" : "failure", + "expected" : "FAILED" + } ] + } + } +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/opensearchserverless/2021-11-01/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/opensearchserverless/2021-11-01/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..2004d0d38ea2f817f5d347abd8816d8dab8af2a4 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/opensearchserverless/2021-11-01/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://aoss-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://aoss-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://aoss.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://aoss.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/opensearchserverless/2021-11-01/paginators-1.json b/testbed/boto__botocore/botocore/data/opensearchserverless/2021-11-01/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..ea142457a6a77d6e6a54942329f1199bc2f2a60c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/opensearchserverless/2021-11-01/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/testbed/boto__botocore/botocore/data/opensearchserverless/2021-11-01/service-2.json b/testbed/boto__botocore/botocore/data/opensearchserverless/2021-11-01/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..9d705d7c7bb1c90adb706cab43553d38f421b6cc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/opensearchserverless/2021-11-01/service-2.json @@ -0,0 +1,3023 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-11-01", + "endpointPrefix":"aoss", + "jsonVersion":"1.0", + "protocol":"json", + "protocols":["json"], + "serviceFullName":"OpenSearch Service Serverless", + "serviceId":"OpenSearchServerless", + "signatureVersion":"v4", + "signingName":"aoss", + "targetPrefix":"OpenSearchServerless", + "uid":"opensearchserverless-2021-11-01", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "BatchGetCollection":{ + "name":"BatchGetCollection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetCollectionRequest"}, + "output":{"shape":"BatchGetCollectionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
" + }, + "BatchGetEffectiveLifecyclePolicy":{ + "name":"BatchGetEffectiveLifecyclePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetEffectiveLifecyclePolicyRequest"}, + "output":{"shape":"BatchGetEffectiveLifecyclePolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.
" + }, + "BatchGetLifecyclePolicy":{ + "name":"BatchGetLifecyclePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetLifecyclePolicyRequest"}, + "output":{"shape":"BatchGetLifecyclePolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
" + }, + "BatchGetVpcEndpoint":{ + "name":"BatchGetVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetVpcEndpointRequest"}, + "output":{"shape":"BatchGetVpcEndpointResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
" + }, + "CreateAccessPolicy":{ + "name":"CreateAccessPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAccessPolicyRequest"}, + "output":{"shape":"CreateAccessPolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless.
", + "idempotent":true + }, + "CreateCollection":{ + "name":"CreateCollection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCollectionRequest"}, + "output":{"shape":"CreateCollectionResponse"}, + "errors":[ + {"shape":"OcuLimitExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
", + "idempotent":true + }, + "CreateLifecyclePolicy":{ + "name":"CreateLifecyclePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLifecyclePolicyRequest"}, + "output":{"shape":"CreateLifecyclePolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies.
", + "idempotent":true + }, + "CreateSecurityConfig":{ + "name":"CreateSecurityConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSecurityConfigRequest"}, + "output":{"shape":"CreateSecurityConfigResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
", + "idempotent":true + }, + "CreateSecurityPolicy":{ + "name":"CreateSecurityPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSecurityPolicyRequest"}, + "output":{"shape":"CreateSecurityPolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
", + "idempotent":true + }, + "CreateVpcEndpoint":{ + "name":"CreateVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcEndpointRequest"}, + "output":{"shape":"CreateVpcEndpointResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
", + "idempotent":true + }, + "DeleteAccessPolicy":{ + "name":"DeleteAccessPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAccessPolicyRequest"}, + "output":{"shape":"DeleteAccessPolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
", + "idempotent":true + }, + "DeleteCollection":{ + "name":"DeleteCollection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCollectionRequest"}, + "output":{"shape":"DeleteCollectionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
", + "idempotent":true + }, + "DeleteLifecyclePolicy":{ + "name":"DeleteLifecyclePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLifecyclePolicyRequest"}, + "output":{"shape":"DeleteLifecyclePolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.
", + "idempotent":true + }, + "DeleteSecurityConfig":{ + "name":"DeleteSecurityConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSecurityConfigRequest"}, + "output":{"shape":"DeleteSecurityConfigResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
", + "idempotent":true + }, + "DeleteSecurityPolicy":{ + "name":"DeleteSecurityPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSecurityPolicyRequest"}, + "output":{"shape":"DeleteSecurityPolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes an OpenSearch Serverless security policy.
", + "idempotent":true + }, + "DeleteVpcEndpoint":{ + "name":"DeleteVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcEndpointRequest"}, + "output":{"shape":"DeleteVpcEndpointResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
", + "idempotent":true + }, + "GetAccessPolicy":{ + "name":"GetAccessPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAccessPolicyRequest"}, + "output":{"shape":"GetAccessPolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
" + }, + "GetAccountSettings":{ + "name":"GetAccountSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAccountSettingsRequest"}, + "output":{"shape":"GetAccountSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns account-level settings related to OpenSearch Serverless.
" + }, + "GetPoliciesStats":{ + "name":"GetPoliciesStats", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPoliciesStatsRequest"}, + "output":{"shape":"GetPoliciesStatsResponse"}, + "errors":[ + {"shape":"InternalServerException"} + ], + "documentation":"Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
" + }, + "GetSecurityConfig":{ + "name":"GetSecurityConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSecurityConfigRequest"}, + "output":{"shape":"GetSecurityConfigResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.
" + }, + "GetSecurityPolicy":{ + "name":"GetSecurityPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSecurityPolicyRequest"}, + "output":{"shape":"GetSecurityPolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
" + }, + "ListAccessPolicies":{ + "name":"ListAccessPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAccessPoliciesRequest"}, + "output":{"shape":"ListAccessPoliciesResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns information about a list of OpenSearch Serverless access policies.
" + }, + "ListCollections":{ + "name":"ListCollections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCollectionsRequest"}, + "output":{"shape":"ListCollectionsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
Make sure to include an empty request body {} if you don't include any collection filters in the request.
Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
" + }, + "ListSecurityConfigs":{ + "name":"ListSecurityConfigs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSecurityConfigsRequest"}, + "output":{"shape":"ListSecurityConfigsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.
" + }, + "ListSecurityPolicies":{ + "name":"ListSecurityPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSecurityPoliciesRequest"}, + "output":{"shape":"ListSecurityPoliciesResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns information about configured OpenSearch Serverless security policies.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
" + }, + "ListVpcEndpoints":{ + "name":"ListVpcEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListVpcEndpointsRequest"}, + "output":{"shape":"ListVpcEndpointsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
" + }, + "UpdateAccessPolicy":{ + "name":"UpdateAccessPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAccessPolicyRequest"}, + "output":{"shape":"UpdateAccessPolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
", + "idempotent":true + }, + "UpdateAccountSettings":{ + "name":"UpdateAccountSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAccountSettingsRequest"}, + "output":{"shape":"UpdateAccountSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.
" + }, + "UpdateCollection":{ + "name":"UpdateCollection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateCollectionRequest"}, + "output":{"shape":"UpdateCollectionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates an OpenSearch Serverless collection.
", + "idempotent":true + }, + "UpdateLifecyclePolicy":{ + "name":"UpdateLifecyclePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateLifecyclePolicyRequest"}, + "output":{"shape":"UpdateLifecyclePolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.
", + "idempotent":true + }, + "UpdateSecurityConfig":{ + "name":"UpdateSecurityConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSecurityConfigRequest"}, + "output":{"shape":"UpdateSecurityConfigResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
", + "idempotent":true + }, + "UpdateSecurityPolicy":{ + "name":"UpdateSecurityPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSecurityPolicyRequest"}, + "output":{"shape":"UpdateSecurityPolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
", + "idempotent":true + }, + "UpdateVpcEndpoint":{ + "name":"UpdateVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateVpcEndpointRequest"}, + "output":{"shape":"UpdateVpcEndpointResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
", + "idempotent":true + } + }, + "shapes":{ + "AccessPolicyDetail":{ + "type":"structure", + "members":{ + "createdDate":{ + "shape":"Long", + "documentation":"The date the policy was created.
" + }, + "description":{ + "shape":"PolicyDescription", + "documentation":"The description of the policy.
" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"The timestamp of when the policy was last modified.
" + }, + "name":{ + "shape":"PolicyName", + "documentation":"The name of the policy.
" + }, + "policy":{ + "shape":"Document", + "documentation":"The JSON policy document without any whitespaces.
" + }, + "policyVersion":{ + "shape":"PolicyVersion", + "documentation":"The version of the policy.
" + }, + "type":{ + "shape":"AccessPolicyType", + "documentation":"The type of access policy.
" + } + }, + "documentation":"Details about an OpenSearch Serverless access policy.
" + }, + "AccessPolicyStats":{ + "type":"structure", + "members":{ + "DataPolicyCount":{ + "shape":"Long", + "documentation":"The number of data access policies in the current account.
" + } + }, + "documentation":"Statistics for an OpenSearch Serverless access policy.
" + }, + "AccessPolicySummaries":{ + "type":"list", + "member":{"shape":"AccessPolicySummary"} + }, + "AccessPolicySummary":{ + "type":"structure", + "members":{ + "createdDate":{ + "shape":"Long", + "documentation":"The Epoch time when the access policy was created.
" + }, + "description":{ + "shape":"PolicyDescription", + "documentation":"The description of the access policy.
" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"The date and time when the collection was last modified.
" + }, + "name":{ + "shape":"PolicyName", + "documentation":"The name of the access policy.
" + }, + "policyVersion":{ + "shape":"PolicyVersion", + "documentation":"The version of the policy.
" + }, + "type":{ + "shape":"AccessPolicyType", + "documentation":"The type of access policy. Currently, the only available type is data.
A summary of the data access policy.
" + }, + "AccessPolicyType":{ + "type":"string", + "enum":["data"] + }, + "AccountSettingsDetail":{ + "type":"structure", + "members":{ + "capacityLimits":{"shape":"CapacityLimits"} + }, + "documentation":"OpenSearch Serverless-related information for the current account.
" + }, + "Arn":{ + "type":"string", + "max":1011, + "min":1 + }, + "BatchGetCollectionRequest":{ + "type":"structure", + "members":{ + "ids":{ + "shape":"CollectionIds", + "documentation":"A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.
" + }, + "names":{ + "shape":"CollectionNames", + "documentation":"A list of collection names. You can't provide names and IDs in the same request.
" + } + } + }, + "BatchGetCollectionResponse":{ + "type":"structure", + "members":{ + "collectionDetails":{ + "shape":"CollectionDetails", + "documentation":"Details about each collection.
" + }, + "collectionErrorDetails":{ + "shape":"CollectionErrorDetails", + "documentation":"Error information for the request.
" + } + } + }, + "BatchGetEffectiveLifecyclePolicyRequest":{ + "type":"structure", + "required":["resourceIdentifiers"], + "members":{ + "resourceIdentifiers":{ + "shape":"LifecyclePolicyResourceIdentifiers", + "documentation":"The unique identifiers of policy types and resource names.
" + } + } + }, + "BatchGetEffectiveLifecyclePolicyResponse":{ + "type":"structure", + "members":{ + "effectiveLifecyclePolicyDetails":{ + "shape":"EffectiveLifecyclePolicyDetails", + "documentation":"A list of lifecycle policies applied to the OpenSearch Serverless indexes.
" + }, + "effectiveLifecyclePolicyErrorDetails":{ + "shape":"EffectiveLifecyclePolicyErrorDetails", + "documentation":"A list of resources for which retrieval failed.
" + } + } + }, + "BatchGetLifecyclePolicyRequest":{ + "type":"structure", + "required":["identifiers"], + "members":{ + "identifiers":{ + "shape":"LifecyclePolicyIdentifiers", + "documentation":"The unique identifiers of policy types and policy names.
" + } + } + }, + "BatchGetLifecyclePolicyResponse":{ + "type":"structure", + "members":{ + "lifecyclePolicyDetails":{ + "shape":"LifecyclePolicyDetails", + "documentation":"A list of lifecycle policies matched to the input policy name and policy type.
" + }, + "lifecyclePolicyErrorDetails":{ + "shape":"LifecyclePolicyErrorDetails", + "documentation":"A list of lifecycle policy names and policy types for which retrieval failed.
" + } + } + }, + "BatchGetVpcEndpointRequest":{ + "type":"structure", + "required":["ids"], + "members":{ + "ids":{ + "shape":"VpcEndpointIds", + "documentation":"A list of VPC endpoint identifiers.
" + } + } + }, + "BatchGetVpcEndpointResponse":{ + "type":"structure", + "members":{ + "vpcEndpointDetails":{ + "shape":"VpcEndpointDetails", + "documentation":"Details about the specified VPC endpoint.
" + }, + "vpcEndpointErrorDetails":{ + "shape":"VpcEndpointErrorDetails", + "documentation":"Error information for a failed request.
" + } + } + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "CapacityLimits":{ + "type":"structure", + "members":{ + "maxIndexingCapacityInOCU":{ + "shape":"IndexingCapacityValue", + "documentation":"The maximum indexing capacity for collections.
" + }, + "maxSearchCapacityInOCU":{ + "shape":"SearchCapacityValue", + "documentation":"The maximum search capacity for collections.
" + } + }, + "documentation":"The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.
" + }, + "ClientToken":{ + "type":"string", + "max":512, + "min":1 + }, + "CollectionDetail":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the collection.
" + }, + "collectionEndpoint":{ + "shape":"String", + "documentation":"Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
" + }, + "createdDate":{ + "shape":"Long", + "documentation":"The Epoch time when the collection was created.
" + }, + "dashboardEndpoint":{ + "shape":"String", + "documentation":"Collection-specific endpoint used to access OpenSearch Dashboards.
" + }, + "description":{ + "shape":"String", + "documentation":"A description of the collection.
" + }, + "failureCode":{ + "shape":"String", + "documentation":"A failure code associated with the request.
" + }, + "failureMessage":{ + "shape":"String", + "documentation":"A message associated with the failure code.
" + }, + "id":{ + "shape":"CollectionId", + "documentation":"A unique identifier for the collection.
" + }, + "kmsKeyArn":{ + "shape":"String", + "documentation":"The ARN of the Amazon Web Services KMS key used to encrypt the collection.
" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"The date and time when the collection was last modified.
" + }, + "name":{ + "shape":"CollectionName", + "documentation":"The name of the collection.
" + }, + "standbyReplicas":{ + "shape":"StandbyReplicas", + "documentation":"Details about an OpenSearch Serverless collection.
" + }, + "status":{ + "shape":"CollectionStatus", + "documentation":"The current status of the collection.
" + }, + "type":{ + "shape":"CollectionType", + "documentation":"The type of collection.
" + } + }, + "documentation":"Details about each OpenSearch Serverless collection, including the collection endpoint and the OpenSearch Dashboards endpoint.
" + }, + "CollectionDetails":{ + "type":"list", + "member":{"shape":"CollectionDetail"} + }, + "CollectionErrorDetail":{ + "type":"structure", + "members":{ + "errorCode":{ + "shape":"String", + "documentation":"The error code for the request. For example, NOT_FOUND.
A description of the error. For example, The specified Collection is not found.
If the request contains collection IDs, the response includes the IDs provided in the request.
" + }, + "name":{ + "shape":"CollectionName", + "documentation":"If the request contains collection names, the response includes the names provided in the request.
" + } + }, + "documentation":"Error information for an OpenSearch Serverless request.
" + }, + "CollectionErrorDetails":{ + "type":"list", + "member":{"shape":"CollectionErrorDetail"} + }, + "CollectionFilters":{ + "type":"structure", + "members":{ + "name":{ + "shape":"CollectionName", + "documentation":"The name of the collection.
" + }, + "status":{ + "shape":"CollectionStatus", + "documentation":"The current status of the collection.
" + } + }, + "documentation":"A list of filter keys that you can use for LIST, UPDATE, and DELETE requests to OpenSearch Serverless collections.
" + }, + "CollectionId":{ + "type":"string", + "max":40, + "min":3, + "pattern":"^[a-z0-9]{3,40}$" + }, + "CollectionIds":{ + "type":"list", + "member":{"shape":"CollectionId"}, + "max":100, + "min":1 + }, + "CollectionName":{ + "type":"string", + "max":32, + "min":3, + "pattern":"^[a-z][a-z0-9-]+$" + }, + "CollectionNames":{ + "type":"list", + "member":{"shape":"CollectionName"}, + "max":100, + "min":1 + }, + "CollectionStatus":{ + "type":"string", + "enum":[ + "CREATING", + "DELETING", + "ACTIVE", + "FAILED" + ] + }, + "CollectionSummaries":{ + "type":"list", + "member":{"shape":"CollectionSummary"} + }, + "CollectionSummary":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the collection.
" + }, + "id":{ + "shape":"CollectionId", + "documentation":"The unique identifier of the collection.
" + }, + "name":{ + "shape":"CollectionName", + "documentation":"The name of the collection.
" + }, + "status":{ + "shape":"CollectionStatus", + "documentation":"The current status of the collection.
" + } + }, + "documentation":"Details about each OpenSearch Serverless collection.
" + }, + "CollectionType":{ + "type":"string", + "enum":[ + "SEARCH", + "TIMESERIES", + "VECTORSEARCH" + ] + }, + "ConfigDescription":{ + "type":"string", + "max":1000, + "min":1 + }, + "ConfigName":{ + "type":"string", + "max":32, + "min":3, + "pattern":"^[a-z][a-z0-9-]+$" + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
", + "exception":true + }, + "CreateAccessPolicyRequest":{ + "type":"structure", + "required":[ + "name", + "policy", + "type" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "description":{ + "shape":"PolicyDescription", + "documentation":"A description of the policy. Typically used to store information about the permissions defined in the policy.
" + }, + "name":{ + "shape":"PolicyName", + "documentation":"The name of the policy.
" + }, + "policy":{ + "shape":"PolicyDocument", + "documentation":"The JSON policy document to use as the content for the policy.
" + }, + "type":{ + "shape":"AccessPolicyType", + "documentation":"The type of policy.
" + } + } + }, + "CreateAccessPolicyResponse":{ + "type":"structure", + "members":{ + "accessPolicyDetail":{ + "shape":"AccessPolicyDetail", + "documentation":"Details about the created access policy.
" + } + } + }, + "CreateCollectionDetail":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the collection.
" + }, + "createdDate":{ + "shape":"Long", + "documentation":"The Epoch time when the collection was created.
" + }, + "description":{ + "shape":"String", + "documentation":"A description of the collection.
" + }, + "id":{ + "shape":"CollectionId", + "documentation":"The unique identifier of the collection.
" + }, + "kmsKeyArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.
" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"The date and time when the collection was last modified.
" + }, + "name":{ + "shape":"CollectionName", + "documentation":"The name of the collection.
" + }, + "standbyReplicas":{ + "shape":"StandbyReplicas", + "documentation":"Creates details about an OpenSearch Serverless collection.
" + }, + "status":{ + "shape":"CollectionStatus", + "documentation":"The current status of the collection.
" + }, + "type":{ + "shape":"CollectionType", + "documentation":"The type of collection.
" + } + }, + "documentation":"Details about the created OpenSearch Serverless collection.
" + }, + "CreateCollectionRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "description":{ + "shape":"CreateCollectionRequestDescriptionString", + "documentation":"Description of the collection.
" + }, + "name":{ + "shape":"CollectionName", + "documentation":"Name of the collection.
" + }, + "standbyReplicas":{ + "shape":"StandbyReplicas", + "documentation":"Indicates whether standby replicas should be used for a collection.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
" + }, + "type":{ + "shape":"CollectionType", + "documentation":"The type of collection.
" + } + } + }, + "CreateCollectionRequestDescriptionString":{ + "type":"string", + "max":1000, + "min":0 + }, + "CreateCollectionResponse":{ + "type":"structure", + "members":{ + "createCollectionDetail":{ + "shape":"CreateCollectionDetail", + "documentation":"Details about the collection.
" + } + } + }, + "CreateLifecyclePolicyRequest":{ + "type":"structure", + "required":[ + "name", + "policy", + "type" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "description":{ + "shape":"PolicyDescription", + "documentation":"A description of the lifecycle policy.
" + }, + "name":{ + "shape":"PolicyName", + "documentation":"The name of the lifecycle policy.
" + }, + "policy":{ + "shape":"PolicyDocument", + "documentation":"The JSON policy document to use as the content for the lifecycle policy.
" + }, + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"The type of lifecycle policy.
" + } + } + }, + "CreateLifecyclePolicyResponse":{ + "type":"structure", + "members":{ + "lifecyclePolicyDetail":{ + "shape":"LifecyclePolicyDetail", + "documentation":"Details about the created lifecycle policy.
" + } + } + }, + "CreateSecurityConfigRequest":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "description":{ + "shape":"ConfigDescription", + "documentation":"A description of the security configuration.
" + }, + "name":{ + "shape":"ConfigName", + "documentation":"The name of the security configuration.
" + }, + "samlOptions":{ + "shape":"SamlConfigOptions", + "documentation":"Describes SAML options in in the form of a key-value map. This field is required if you specify saml for the type parameter.
The type of security configuration.
" + } + } + }, + "CreateSecurityConfigResponse":{ + "type":"structure", + "members":{ + "securityConfigDetail":{ + "shape":"SecurityConfigDetail", + "documentation":"Details about the created security configuration.
" + } + } + }, + "CreateSecurityPolicyRequest":{ + "type":"structure", + "required":[ + "name", + "policy", + "type" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "description":{ + "shape":"PolicyDescription", + "documentation":"A description of the policy. Typically used to store information about the permissions defined in the policy.
" + }, + "name":{ + "shape":"PolicyName", + "documentation":"The name of the policy.
" + }, + "policy":{ + "shape":"PolicyDocument", + "documentation":"The JSON policy document to use as the content for the new policy.
" + }, + "type":{ + "shape":"SecurityPolicyType", + "documentation":"The type of security policy.
" + } + } + }, + "CreateSecurityPolicyResponse":{ + "type":"structure", + "members":{ + "securityPolicyDetail":{ + "shape":"SecurityPolicyDetail", + "documentation":"Details about the created security policy.
" + } + } + }, + "CreateVpcEndpointDetail":{ + "type":"structure", + "members":{ + "id":{ + "shape":"VpcEndpointId", + "documentation":"The unique identifier of the endpoint.
" + }, + "name":{ + "shape":"VpcEndpointName", + "documentation":"The name of the endpoint.
" + }, + "status":{ + "shape":"VpcEndpointStatus", + "documentation":"The current status in the endpoint creation process.
" + } + }, + "documentation":"Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
" + }, + "CreateVpcEndpointRequest":{ + "type":"structure", + "required":[ + "name", + "subnetIds", + "vpcId" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "name":{ + "shape":"VpcEndpointName", + "documentation":"The name of the interface endpoint.
" + }, + "securityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
" + }, + "subnetIds":{ + "shape":"SubnetIds", + "documentation":"The ID of one or more subnets from which you'll access OpenSearch Serverless.
" + }, + "vpcId":{ + "shape":"VpcId", + "documentation":"The ID of the VPC from which you'll access OpenSearch Serverless.
" + } + } + }, + "CreateVpcEndpointResponse":{ + "type":"structure", + "members":{ + "createVpcEndpointDetail":{ + "shape":"CreateVpcEndpointDetail", + "documentation":"Details about the created interface VPC endpoint.
" + } + } + }, + "DeleteAccessPolicyRequest":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "name":{ + "shape":"PolicyName", + "documentation":"The name of the policy to delete.
" + }, + "type":{ + "shape":"AccessPolicyType", + "documentation":"The type of policy.
" + } + } + }, + "DeleteAccessPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteCollectionDetail":{ + "type":"structure", + "members":{ + "id":{ + "shape":"CollectionId", + "documentation":"The unique identifier of the collection.
" + }, + "name":{ + "shape":"CollectionName", + "documentation":"The name of the collection.
" + }, + "status":{ + "shape":"CollectionStatus", + "documentation":"The current status of the collection.
" + } + }, + "documentation":"Details about a deleted OpenSearch Serverless collection.
" + }, + "DeleteCollectionRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "id":{ + "shape":"CollectionId", + "documentation":"The unique identifier of the collection. For example, 1iu5usc406kd. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.
Details of the deleted collection.
" + } + } + }, + "DeleteLifecyclePolicyRequest":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "name":{ + "shape":"PolicyName", + "documentation":"The name of the policy to delete.
" + }, + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"The type of lifecycle policy.
" + } + } + }, + "DeleteLifecyclePolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteSecurityConfigRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "id":{ + "shape":"SecurityConfigId", + "documentation":"The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.
Unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "name":{ + "shape":"PolicyName", + "documentation":"The name of the policy to delete.
" + }, + "type":{ + "shape":"SecurityPolicyType", + "documentation":"The type of policy.
" + } + } + }, + "DeleteSecurityPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteVpcEndpointDetail":{ + "type":"structure", + "members":{ + "id":{ + "shape":"VpcEndpointId", + "documentation":"The unique identifier of the endpoint.
" + }, + "name":{ + "shape":"VpcEndpointName", + "documentation":"The name of the endpoint.
" + }, + "status":{ + "shape":"VpcEndpointStatus", + "documentation":"The current status of the endpoint deletion process.
" + } + }, + "documentation":"Deletion details for an OpenSearch Serverless-managed interface endpoint.
" + }, + "DeleteVpcEndpointRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "id":{ + "shape":"VpcEndpointId", + "documentation":"The VPC endpoint identifier.
" + } + } + }, + "DeleteVpcEndpointResponse":{ + "type":"structure", + "members":{ + "deleteVpcEndpointDetail":{ + "shape":"DeleteVpcEndpointDetail", + "documentation":"Details about the deleted endpoint.
" + } + } + }, + "Document":{ + "type":"structure", + "members":{ + }, + "document":true + }, + "EffectiveLifecyclePolicyDetail":{ + "type":"structure", + "members":{ + "noMinRetentionPeriod":{ + "shape":"Boolean", + "documentation":"The minimum number of index retention days set. That is an optional param that will return as true if the minimum number of days or hours is not set to a index resource.
The name of the lifecycle policy.
" + }, + "resource":{ + "shape":"Resource", + "documentation":"The name of the OpenSearch Serverless index resource.
" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"The type of OpenSearch Serverless resource. Currently, the only supported resource is index.
The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.
" + }, + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"The type of lifecycle policy.
" + } + }, + "documentation":"Error information for an OpenSearch Serverless request.
" + }, + "EffectiveLifecyclePolicyDetails":{ + "type":"list", + "member":{"shape":"EffectiveLifecyclePolicyDetail"} + }, + "EffectiveLifecyclePolicyErrorDetail":{ + "type":"structure", + "members":{ + "errorCode":{ + "shape":"String", + "documentation":"The error code for the request.
" + }, + "errorMessage":{ + "shape":"String", + "documentation":"A description of the error. For example, The specified Index resource is not found.
The name of OpenSearch Serverless index resource.
" + }, + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"The type of lifecycle policy.
" + } + }, + "documentation":"Error information for an OpenSearch Serverless request.
" + }, + "EffectiveLifecyclePolicyErrorDetails":{ + "type":"list", + "member":{"shape":"EffectiveLifecyclePolicyErrorDetail"} + }, + "GetAccessPolicyRequest":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "name":{ + "shape":"PolicyName", + "documentation":"The name of the access policy.
" + }, + "type":{ + "shape":"AccessPolicyType", + "documentation":"Tye type of policy. Currently, the only supported value is data.
Details about the requested access policy.
" + } + } + }, + "GetAccountSettingsRequest":{ + "type":"structure", + "members":{ + } + }, + "GetAccountSettingsResponse":{ + "type":"structure", + "members":{ + "accountSettingsDetail":{ + "shape":"AccountSettingsDetail", + "documentation":"OpenSearch Serverless-related details for the current account.
" + } + } + }, + "GetPoliciesStatsRequest":{ + "type":"structure", + "members":{ + } + }, + "GetPoliciesStatsResponse":{ + "type":"structure", + "members":{ + "AccessPolicyStats":{ + "shape":"AccessPolicyStats", + "documentation":"Information about the data access policies in your account.
" + }, + "LifecyclePolicyStats":{ + "shape":"LifecyclePolicyStats", + "documentation":"Information about the lifecycle policies in your account.
" + }, + "SecurityConfigStats":{ + "shape":"SecurityConfigStats", + "documentation":"Information about the security configurations in your account.
" + }, + "SecurityPolicyStats":{ + "shape":"SecurityPolicyStats", + "documentation":"Information about the security policies in your account.
" + }, + "TotalPolicyCount":{ + "shape":"Long", + "documentation":"The total number of OpenSearch Serverless security policies and configurations in your account.
" + } + } + }, + "GetSecurityConfigRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"SecurityConfigId", + "documentation":"The unique identifier of the security configuration.
" + } + } + }, + "GetSecurityConfigResponse":{ + "type":"structure", + "members":{ + "securityConfigDetail":{ + "shape":"SecurityConfigDetail", + "documentation":"Details of the requested security configuration.
" + } + } + }, + "GetSecurityPolicyRequest":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "name":{ + "shape":"PolicyName", + "documentation":"The name of the security policy.
" + }, + "type":{ + "shape":"SecurityPolicyType", + "documentation":"The type of security policy.
" + } + } + }, + "GetSecurityPolicyResponse":{ + "type":"structure", + "members":{ + "securityPolicyDetail":{ + "shape":"SecurityPolicyDetail", + "documentation":"Details about the requested security policy.
" + } + } + }, + "IndexingCapacityValue":{ + "type":"integer", + "box":true, + "min":2 + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Thrown when an error internal to the service occurs while processing a request.
", + "exception":true, + "fault":true + }, + "LifecyclePolicyDetail":{ + "type":"structure", + "members":{ + "createdDate":{ + "shape":"Long", + "documentation":"The date the lifecycle policy was created.
" + }, + "description":{ + "shape":"PolicyDescription", + "documentation":"The description of the lifecycle policy.
" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"The timestamp of when the lifecycle policy was last modified.
" + }, + "name":{ + "shape":"PolicyName", + "documentation":"The name of the lifecycle policy.
" + }, + "policy":{ + "shape":"Document", + "documentation":"The JSON policy document without any whitespaces.
" + }, + "policyVersion":{ + "shape":"PolicyVersion", + "documentation":"The version of the lifecycle policy.
" + }, + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"The type of lifecycle policy.
" + } + }, + "documentation":"Details about an OpenSearch Serverless lifecycle policy.
" + }, + "LifecyclePolicyDetails":{ + "type":"list", + "member":{"shape":"LifecyclePolicyDetail"} + }, + "LifecyclePolicyErrorDetail":{ + "type":"structure", + "members":{ + "errorCode":{ + "shape":"String", + "documentation":"The error code for the request. For example, NOT_FOUND.
A description of the error. For example, The specified Lifecycle Policy is not found.
The name of the lifecycle policy.
" + }, + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"The type of lifecycle policy.
" + } + }, + "documentation":"Error information for an OpenSearch Serverless request.
" + }, + "LifecyclePolicyErrorDetails":{ + "type":"list", + "member":{"shape":"LifecyclePolicyErrorDetail"} + }, + "LifecyclePolicyIdentifier":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "name":{ + "shape":"PolicyName", + "documentation":"The name of the lifecycle policy.
" + }, + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"The type of lifecycle policy.
" + } + }, + "documentation":"The unique identifiers of policy types and policy names.
" + }, + "LifecyclePolicyIdentifiers":{ + "type":"list", + "member":{"shape":"LifecyclePolicyIdentifier"}, + "max":40, + "min":1 + }, + "LifecyclePolicyResourceIdentifier":{ + "type":"structure", + "required":[ + "resource", + "type" + ], + "members":{ + "resource":{ + "shape":"ResourceName", + "documentation":"The name of the OpenSearch Serverless ilndex resource.
" + }, + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"The type of lifecycle policy.
" + } + }, + "documentation":"The unique identifiers of policy types and resource names.
" + }, + "LifecyclePolicyResourceIdentifiers":{ + "type":"list", + "member":{"shape":"LifecyclePolicyResourceIdentifier"}, + "max":100, + "min":1 + }, + "LifecyclePolicyStats":{ + "type":"structure", + "members":{ + "RetentionPolicyCount":{ + "shape":"Long", + "documentation":"The number of retention lifecycle policies in the current account.
" + } + }, + "documentation":"Statistics for an OpenSearch Serverless lifecycle policy.
" + }, + "LifecyclePolicySummaries":{ + "type":"list", + "member":{"shape":"LifecyclePolicySummary"} + }, + "LifecyclePolicySummary":{ + "type":"structure", + "members":{ + "createdDate":{ + "shape":"Long", + "documentation":"The Epoch time when the lifecycle policy was created.
" + }, + "description":{ + "shape":"PolicyDescription", + "documentation":"The description of the lifecycle policy.
" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"The date and time when the lifecycle policy was last modified.
" + }, + "name":{ + "shape":"PolicyName", + "documentation":"The name of the lifecycle policy.
" + }, + "policyVersion":{ + "shape":"PolicyVersion", + "documentation":"The version of the lifecycle policy.
" + }, + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"The type of lifecycle policy.
" + } + }, + "documentation":"A summary of the lifecycle policy.
" + }, + "LifecyclePolicyType":{ + "type":"string", + "enum":["retention"] + }, + "LifecycleResource":{"type":"string"}, + "ListAccessPoliciesRequest":{ + "type":"structure", + "required":["type"], + "members":{ + "maxResults":{ + "shape":"ListAccessPoliciesRequestMaxResultsInteger", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.
If your initial ListAccessPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListAccessPolicies operations, which returns results in the next page.
Resource filters (can be collections or indexes) that policies can apply to.
" + }, + "type":{ + "shape":"AccessPolicyType", + "documentation":"The type of access policy.
" + } + } + }, + "ListAccessPoliciesRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListAccessPoliciesRequestResourceList":{ + "type":"list", + "member":{"shape":"Resource"}, + "max":1000, + "min":1 + }, + "ListAccessPoliciesResponse":{ + "type":"structure", + "members":{ + "accessPolicySummaries":{ + "shape":"AccessPolicySummaries", + "documentation":"Details about the requested access policies.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
A list of filter names and values that you can use for requests.
" + }, + "maxResults":{ + "shape":"ListCollectionsRequestMaxResultsInteger", + "documentation":"The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.
If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.
Details about each collection.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
An optional parameter that specifies the maximum number of results to return. You can use use nextToken to get the next page of results. The default is 10.
If your initial ListLifecyclePolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListLifecyclePolicies operations, which returns results in the next page.
Resource filters that policies can apply to. Currently, the only supported resource type is index.
The type of lifecycle policy.
" + } + } + }, + "ListLifecyclePoliciesRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListLifecyclePoliciesRequestResourcesList":{ + "type":"list", + "member":{"shape":"LifecycleResource"}, + "max":1000, + "min":1 + }, + "ListLifecyclePoliciesResponse":{ + "type":"structure", + "members":{ + "lifecyclePolicySummaries":{ + "shape":"LifecyclePolicySummaries", + "documentation":"Details about the requested lifecycle policies.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.
If your initial ListSecurityConfigs operation returns a nextToken, you can include the returned nextToken in subsequent ListSecurityConfigs operations, which returns results in the next page.
The type of security configuration.
" + } + } + }, + "ListSecurityConfigsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListSecurityConfigsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Details about the security configurations in your account.
" + } + } + }, + "ListSecurityPoliciesRequest":{ + "type":"structure", + "required":["type"], + "members":{ + "maxResults":{ + "shape":"ListSecurityPoliciesRequestMaxResultsInteger", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.
If your initial ListSecurityPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListSecurityPolicies operations, which returns results in the next page.
Resource filters (can be collection or indexes) that policies can apply to.
" + }, + "type":{ + "shape":"SecurityPolicyType", + "documentation":"The type of policy.
" + } + } + }, + "ListSecurityPoliciesRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListSecurityPoliciesRequestResourceList":{ + "type":"list", + "member":{"shape":"Resource"}, + "max":1000, + "min":1 + }, + "ListSecurityPoliciesResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Details about the security policies in your account.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.
The tags associated with the resource.
" + } + } + }, + "ListVpcEndpointsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListVpcEndpointsRequestMaxResultsInteger", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.
If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.
Filter the results according to the current status of the VPC endpoint. Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and FAILED.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Details about each VPC endpoint, including the name and current status.
" + } + } + }, + "Long":{ + "type":"long", + "box":true + }, + "OcuLimitExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"String", + "documentation":"Description of the error.
" + } + }, + "documentation":"Thrown when the collection you're attempting to create results in a number of search or indexing OCUs that exceeds the account limit.
", + "exception":true + }, + "PolicyDescription":{ + "type":"string", + "max":1000, + "min":0 + }, + "PolicyDocument":{ + "type":"string", + "max":20480, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+" + }, + "PolicyName":{ + "type":"string", + "max":32, + "min":3, + "pattern":"^[a-z][a-z0-9-]+$" + }, + "PolicyVersion":{ + "type":"string", + "max":36, + "min":20, + "pattern":"^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$" + }, + "Resource":{"type":"string"}, + "ResourceName":{ + "type":"string", + "pattern":"^index/[a-z][a-z0-9-]{3,32}/([a-z;0-9&$%][+.~=\\-_a-z;0-9&$%]*)$" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Thrown when accessing or deleting a resource that does not exist.
", + "exception":true + }, + "ResourceType":{ + "type":"string", + "enum":["index"] + }, + "SamlConfigOptions":{ + "type":"structure", + "required":["metadata"], + "members":{ + "groupAttribute":{ + "shape":"samlGroupAttribute", + "documentation":"The group attribute for this SAML integration.
" + }, + "metadata":{ + "shape":"samlMetadata", + "documentation":"The XML IdP metadata file generated from your identity provider.
" + }, + "sessionTimeout":{ + "shape":"SamlConfigOptionsSessionTimeoutInteger", + "documentation":"The session timeout, in minutes. Default is 60 minutes (12 hours).
" + }, + "userAttribute":{ + "shape":"samlUserAttribute", + "documentation":"A user attribute for this SAML integration.
" + } + }, + "documentation":"Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.
" + }, + "SamlConfigOptionsSessionTimeoutInteger":{ + "type":"integer", + "box":true, + "max":720, + "min":5 + }, + "SearchCapacityValue":{ + "type":"integer", + "box":true, + "min":2 + }, + "SecurityConfigDetail":{ + "type":"structure", + "members":{ + "configVersion":{ + "shape":"PolicyVersion", + "documentation":"The version of the security configuration.
" + }, + "createdDate":{ + "shape":"Long", + "documentation":"The date the configuration was created.
" + }, + "description":{ + "shape":"ConfigDescription", + "documentation":"The description of the security configuration.
" + }, + "id":{ + "shape":"SecurityConfigId", + "documentation":"The unique identifier of the security configuration.
" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"The timestamp of when the configuration was last modified.
" + }, + "samlOptions":{ + "shape":"SamlConfigOptions", + "documentation":"SAML options for the security configuration in the form of a key-value map.
" + }, + "type":{ + "shape":"SecurityConfigType", + "documentation":"The type of security configuration.
" + } + }, + "documentation":"Details about a security configuration for OpenSearch Serverless.
" + }, + "SecurityConfigId":{ + "type":"string", + "max":100, + "min":1 + }, + "SecurityConfigStats":{ + "type":"structure", + "members":{ + "SamlConfigCount":{ + "shape":"Long", + "documentation":"The number of security configurations in the current account.
" + } + }, + "documentation":"Statistics for an OpenSearch Serverless security configuration.
" + }, + "SecurityConfigSummaries":{ + "type":"list", + "member":{"shape":"SecurityConfigSummary"} + }, + "SecurityConfigSummary":{ + "type":"structure", + "members":{ + "configVersion":{ + "shape":"PolicyVersion", + "documentation":"The version of the security configuration.
" + }, + "createdDate":{ + "shape":"Long", + "documentation":"The Epoch time when the security configuration was created.
" + }, + "description":{ + "shape":"ConfigDescription", + "documentation":"The description of the security configuration.
" + }, + "id":{ + "shape":"SecurityConfigId", + "documentation":"The unique identifier of the security configuration.
" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"The timestamp of when the configuration was last modified.
" + }, + "type":{ + "shape":"SecurityConfigType", + "documentation":"The type of security configuration.
" + } + }, + "documentation":"A summary of a security configuration for OpenSearch Serverless.
" + }, + "SecurityConfigType":{ + "type":"string", + "enum":["saml"] + }, + "SecurityGroupId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[\\w+\\-]+$" + }, + "SecurityGroupIds":{ + "type":"list", + "member":{"shape":"SecurityGroupId"}, + "max":5, + "min":1 + }, + "SecurityPolicyDetail":{ + "type":"structure", + "members":{ + "createdDate":{ + "shape":"Long", + "documentation":"The date the policy was created.
" + }, + "description":{ + "shape":"PolicyDescription", + "documentation":"The description of the security policy.
" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"The timestamp of when the policy was last modified.
" + }, + "name":{ + "shape":"PolicyName", + "documentation":"The name of the policy.
" + }, + "policy":{ + "shape":"Document", + "documentation":"The JSON policy document without any whitespaces.
" + }, + "policyVersion":{ + "shape":"PolicyVersion", + "documentation":"The version of the policy.
" + }, + "type":{ + "shape":"SecurityPolicyType", + "documentation":"The type of security policy.
" + } + }, + "documentation":"Details about an OpenSearch Serverless security policy.
" + }, + "SecurityPolicyStats":{ + "type":"structure", + "members":{ + "EncryptionPolicyCount":{ + "shape":"Long", + "documentation":"The number of encryption policies in the current account.
" + }, + "NetworkPolicyCount":{ + "shape":"Long", + "documentation":"The number of network policies in the current account.
" + } + }, + "documentation":"Statistics for an OpenSearch Serverless security policy.
" + }, + "SecurityPolicySummaries":{ + "type":"list", + "member":{"shape":"SecurityPolicySummary"} + }, + "SecurityPolicySummary":{ + "type":"structure", + "members":{ + "createdDate":{ + "shape":"Long", + "documentation":"The date the policy was created.
" + }, + "description":{ + "shape":"PolicyDescription", + "documentation":"The description of the security policy.
" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"The timestamp of when the policy was last modified.
" + }, + "name":{ + "shape":"PolicyName", + "documentation":"The name of the policy.
" + }, + "policyVersion":{ + "shape":"PolicyVersion", + "documentation":"The version of the policy.
" + }, + "type":{ + "shape":"SecurityPolicyType", + "documentation":"The type of security policy.
" + } + }, + "documentation":"A summary of a security policy for OpenSearch Serverless.
" + }, + "SecurityPolicyType":{ + "type":"string", + "enum":[ + "encryption", + "network" + ] + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "message", + "serviceCode" + ], + "members":{ + "message":{ + "shape":"String", + "documentation":"Description of the error.
" + }, + "quotaCode":{ + "shape":"String", + "documentation":"Service Quotas requirement to identify originating quota.
" + }, + "resourceId":{ + "shape":"String", + "documentation":"Identifier of the resource affected.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"Type of the resource affected.
" + }, + "serviceCode":{ + "shape":"String", + "documentation":"Service Quotas requirement to identify originating service.
" + } + }, + "documentation":"Thrown when you attempt to create more resources than the service allows based on service quotas.
", + "exception":true + }, + "StandbyReplicas":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "String":{"type":"string"}, + "SubnetId":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^subnet-([0-9a-f]{8}|[0-9a-f]{17})$" + }, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"}, + "max":6, + "min":1 + }, + "Tag":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"The key to use in the tag.
" + }, + "value":{ + "shape":"TagValue", + "documentation":"The value of the tag.
" + } + }, + "documentation":"A map of key-value pairs associated to an OpenSearch Serverless resource.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.
A list of tags (key-value pairs) to add to the resource. All tag keys in the request must be unique.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":0 + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource to remove tags from. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.
The tag or set of tags to remove from the resource. All tag keys in the request must be unique.
" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateAccessPolicyRequest":{ + "type":"structure", + "required":[ + "name", + "policyVersion", + "type" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "description":{ + "shape":"PolicyDescription", + "documentation":"A description of the policy. Typically used to store information about the permissions defined in the policy.
" + }, + "name":{ + "shape":"PolicyName", + "documentation":"The name of the policy.
" + }, + "policy":{ + "shape":"PolicyDocument", + "documentation":"The JSON policy document to use as the content for the policy.
" + }, + "policyVersion":{ + "shape":"PolicyVersion", + "documentation":"The version of the policy being updated.
" + }, + "type":{ + "shape":"AccessPolicyType", + "documentation":"The type of policy.
" + } + } + }, + "UpdateAccessPolicyResponse":{ + "type":"structure", + "members":{ + "accessPolicyDetail":{ + "shape":"AccessPolicyDetail", + "documentation":"Details about the updated access policy.
" + } + } + }, + "UpdateAccountSettingsRequest":{ + "type":"structure", + "members":{ + "capacityLimits":{"shape":"CapacityLimits"} + } + }, + "UpdateAccountSettingsResponse":{ + "type":"structure", + "members":{ + "accountSettingsDetail":{ + "shape":"AccountSettingsDetail", + "documentation":"OpenSearch Serverless-related settings for the current Amazon Web Services account.
" + } + } + }, + "UpdateCollectionDetail":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the collection.
" + }, + "createdDate":{ + "shape":"Long", + "documentation":"The date and time when the collection was created.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the collection.
" + }, + "id":{ + "shape":"CollectionId", + "documentation":"The unique identifier of the collection.
" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"The date and time when the collection was last modified.
" + }, + "name":{ + "shape":"CollectionName", + "documentation":"The name of the collection.
" + }, + "status":{ + "shape":"CollectionStatus", + "documentation":"The current status of the collection.
" + }, + "type":{ + "shape":"CollectionType", + "documentation":"The collection type.
" + } + }, + "documentation":"Details about an updated OpenSearch Serverless collection.
" + }, + "UpdateCollectionRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "description":{ + "shape":"UpdateCollectionRequestDescriptionString", + "documentation":"A description of the collection.
" + }, + "id":{ + "shape":"CollectionId", + "documentation":"The unique identifier of the collection.
" + } + } + }, + "UpdateCollectionRequestDescriptionString":{ + "type":"string", + "max":1000, + "min":0 + }, + "UpdateCollectionResponse":{ + "type":"structure", + "members":{ + "updateCollectionDetail":{ + "shape":"UpdateCollectionDetail", + "documentation":"Details about the updated collection.
" + } + } + }, + "UpdateLifecyclePolicyRequest":{ + "type":"structure", + "required":[ + "name", + "policyVersion", + "type" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "description":{ + "shape":"PolicyDescription", + "documentation":"A description of the lifecycle policy.
" + }, + "name":{ + "shape":"PolicyName", + "documentation":"The name of the policy.
" + }, + "policy":{ + "shape":"PolicyDocument", + "documentation":"The JSON policy document to use as the content for the lifecycle policy.
" + }, + "policyVersion":{ + "shape":"PolicyVersion", + "documentation":"The version of the policy being updated.
" + }, + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"The type of lifecycle policy.
" + } + } + }, + "UpdateLifecyclePolicyResponse":{ + "type":"structure", + "members":{ + "lifecyclePolicyDetail":{ + "shape":"LifecyclePolicyDetail", + "documentation":"Details about the updated lifecycle policy.
" + } + } + }, + "UpdateSecurityConfigRequest":{ + "type":"structure", + "required":[ + "configVersion", + "id" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "configVersion":{ + "shape":"PolicyVersion", + "documentation":"The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command.
A description of the security configuration.
" + }, + "id":{ + "shape":"SecurityConfigId", + "documentation":"The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.
SAML options in in the form of a key-value map.
" + } + } + }, + "UpdateSecurityConfigResponse":{ + "type":"structure", + "members":{ + "securityConfigDetail":{ + "shape":"SecurityConfigDetail", + "documentation":"Details about the updated security configuration.
" + } + } + }, + "UpdateSecurityPolicyRequest":{ + "type":"structure", + "required":[ + "name", + "policyVersion", + "type" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "description":{ + "shape":"PolicyDescription", + "documentation":"A description of the policy. Typically used to store information about the permissions defined in the policy.
" + }, + "name":{ + "shape":"PolicyName", + "documentation":"The name of the policy.
" + }, + "policy":{ + "shape":"PolicyDocument", + "documentation":"The JSON policy document to use as the content for the new policy.
" + }, + "policyVersion":{ + "shape":"PolicyVersion", + "documentation":"The version of the policy being updated.
" + }, + "type":{ + "shape":"SecurityPolicyType", + "documentation":"The type of access policy.
" + } + } + }, + "UpdateSecurityPolicyResponse":{ + "type":"structure", + "members":{ + "securityPolicyDetail":{ + "shape":"SecurityPolicyDetail", + "documentation":"Details about the updated security policy.
" + } + } + }, + "UpdateVpcEndpointDetail":{ + "type":"structure", + "members":{ + "id":{ + "shape":"VpcEndpointId", + "documentation":"The unique identifier of the endpoint.
" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"The timestamp of when the endpoint was last modified.
" + }, + "name":{ + "shape":"VpcEndpointName", + "documentation":"The name of the endpoint.
" + }, + "securityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
" + }, + "status":{ + "shape":"VpcEndpointStatus", + "documentation":"The current status of the endpoint update process.
" + }, + "subnetIds":{ + "shape":"SubnetIds", + "documentation":"The ID of the subnets from which you access OpenSearch Serverless.
" + } + }, + "documentation":"Update details for an OpenSearch Serverless-managed interface endpoint.
" + }, + "UpdateVpcEndpointRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "addSecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"The unique identifiers of the security groups to add to the endpoint. Security groups define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
" + }, + "addSubnetIds":{ + "shape":"SubnetIds", + "documentation":"The ID of one or more subnets to add to the endpoint.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier to ensure idempotency of the request.
", + "idempotencyToken":true + }, + "id":{ + "shape":"VpcEndpointId", + "documentation":"The unique identifier of the interface endpoint to update.
" + }, + "removeSecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"The unique identifiers of the security groups to remove from the endpoint.
" + }, + "removeSubnetIds":{ + "shape":"SubnetIds", + "documentation":"The unique identifiers of the subnets to remove from the endpoint.
" + } + } + }, + "UpdateVpcEndpointResponse":{ + "type":"structure", + "members":{ + "UpdateVpcEndpointDetail":{ + "shape":"UpdateVpcEndpointDetail", + "documentation":"Details about the updated VPC endpoint.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Thrown when the HTTP request contains invalid input or is missing required input.
", + "exception":true + }, + "VpcEndpointDetail":{ + "type":"structure", + "members":{ + "createdDate":{ + "shape":"Long", + "documentation":"The date the endpoint was created.
" + }, + "failureCode":{ + "shape":"String", + "documentation":"A failure code associated with the request.
" + }, + "failureMessage":{ + "shape":"String", + "documentation":"A message associated with the failure code.
" + }, + "id":{ + "shape":"VpcEndpointId", + "documentation":"The unique identifier of the endpoint.
" + }, + "name":{ + "shape":"VpcEndpointName", + "documentation":"The name of the endpoint.
" + }, + "securityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
" + }, + "status":{ + "shape":"VpcEndpointStatus", + "documentation":"The current status of the endpoint.
" + }, + "subnetIds":{ + "shape":"SubnetIds", + "documentation":"The ID of the subnets from which you access OpenSearch Serverless.
" + }, + "vpcId":{ + "shape":"VpcId", + "documentation":"The ID of the VPC from which you access OpenSearch Serverless.
" + } + }, + "documentation":"Details about an OpenSearch Serverless-managed interface endpoint.
" + }, + "VpcEndpointDetails":{ + "type":"list", + "member":{"shape":"VpcEndpointDetail"} + }, + "VpcEndpointErrorDetail":{ + "type":"structure", + "members":{ + "errorCode":{ + "shape":"String", + "documentation":"The error code for the failed request.
" + }, + "errorMessage":{ + "shape":"String", + "documentation":"An error message describing the reason for the failure.
" + }, + "id":{ + "shape":"VpcEndpointId", + "documentation":"The unique identifier of the VPC endpoint.
" + } + }, + "documentation":"Error information for a failed BatchGetVpcEndpoint request.
The current status of the endpoint.
" + } + }, + "documentation":"Filter the results of a ListVpcEndpoints request.
The unique identifier of the endpoint.
" + }, + "name":{ + "shape":"VpcEndpointName", + "documentation":"The name of the endpoint.
" + }, + "status":{ + "shape":"VpcEndpointStatus", + "documentation":"The current status of the endpoint.
" + } + }, + "documentation":"The VPC endpoint object.
" + }, + "VpcId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^vpc-[0-9a-z]*$" + }, + "samlGroupAttribute":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "samlMetadata":{ + "type":"string", + "max":51200, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+" + }, + "samlUserAttribute":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[\\w+=,.@-]+" + } + }, + "documentation":"Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies.
OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying infrastructure and data management.
To learn more about OpenSearch Serverless, see What is Amazon OpenSearch Serverless?
" +} diff --git a/testbed/boto__botocore/botocore/data/osis/2022-01-01/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/osis/2022-01-01/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..fa618146c73b0ab613cae72941165a8c9aa48333 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/osis/2022-01-01/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://osis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://osis-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://osis.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://osis.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/osis/2022-01-01/paginators-1.json b/testbed/boto__botocore/botocore/data/osis/2022-01-01/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..ea142457a6a77d6e6a54942329f1199bc2f2a60c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/osis/2022-01-01/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/testbed/boto__botocore/botocore/data/osis/2022-01-01/service-2.json b/testbed/boto__botocore/botocore/data/osis/2022-01-01/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..aa6244273dd4fea78666a2ffdb982856e56ccab3 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/osis/2022-01-01/service-2.json @@ -0,0 +1,1261 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-01-01", + "endpointPrefix":"osis", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"Amazon OpenSearch Ingestion", + "serviceId":"OSIS", + "signatureVersion":"v4", + "uid":"osis-2022-01-01", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "CreatePipeline":{ + "name":"CreatePipeline", + "http":{ + "method":"POST", + "requestUri":"/2022-01-01/osis/createPipeline" + }, + "input":{"shape":"CreatePipelineRequest"}, + "output":{"shape":"CreatePipelineResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
" + }, + "DeletePipeline":{ + "name":"DeletePipeline", + "http":{ + "method":"DELETE", + "requestUri":"/2022-01-01/osis/deletePipeline/{PipelineName}" + }, + "input":{"shape":"DeletePipelineRequest"}, + "output":{"shape":"DeletePipelineResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.
" + }, + "GetPipeline":{ + "name":"GetPipeline", + "http":{ + "method":"GET", + "requestUri":"/2022-01-01/osis/getPipeline/{PipelineName}" + }, + "input":{"shape":"GetPipelineRequest"}, + "output":{"shape":"GetPipelineResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves information about an OpenSearch Ingestion pipeline.
" + }, + "GetPipelineBlueprint":{ + "name":"GetPipelineBlueprint", + "http":{ + "method":"GET", + "requestUri":"/2022-01-01/osis/getPipelineBlueprint/{BlueprintName}" + }, + "input":{"shape":"GetPipelineBlueprintRequest"}, + "output":{"shape":"GetPipelineBlueprintResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request. For more information, see Using blueprints to create a pipeline.
Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created.
For more information, see Tracking the status of pipeline creation.
" + }, + "ListPipelineBlueprints":{ + "name":"ListPipelineBlueprints", + "http":{ + "method":"POST", + "requestUri":"/2022-01-01/osis/listPipelineBlueprints" + }, + "input":{"shape":"ListPipelineBlueprintsRequest"}, + "output":{"shape":"ListPipelineBlueprintsResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidPaginationTokenException"} + ], + "documentation":"Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.
" + }, + "ListPipelines":{ + "name":"ListPipelines", + "http":{ + "method":"GET", + "requestUri":"/2022-01-01/osis/listPipelines" + }, + "input":{"shape":"ListPipelinesRequest"}, + "output":{"shape":"ListPipelinesResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidPaginationTokenException"} + ], + "documentation":"Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/2022-01-01/osis/listTagsForResource/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
" + }, + "StartPipeline":{ + "name":"StartPipeline", + "http":{ + "method":"PUT", + "requestUri":"/2022-01-01/osis/startPipeline/{PipelineName}" + }, + "input":{"shape":"StartPipelineRequest"}, + "output":{"shape":"StartPipelineResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
" + }, + "StopPipeline":{ + "name":"StopPipeline", + "http":{ + "method":"PUT", + "requestUri":"/2022-01-01/osis/stopPipeline/{PipelineName}" + }, + "input":{"shape":"StopPipelineRequest"}, + "output":{"shape":"StopPipelineResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/2022-01-01/osis/tagResource/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/2022-01-01/osis/untagResource/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
" + }, + "UpdatePipeline":{ + "name":"UpdatePipeline", + "http":{ + "method":"PUT", + "requestUri":"/2022-01-01/osis/updatePipeline/{PipelineName}" + }, + "input":{"shape":"UpdatePipelineRequest"}, + "output":{"shape":"UpdatePipelineResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.
" + }, + "ValidatePipeline":{ + "name":"ValidatePipeline", + "http":{ + "method":"POST", + "requestUri":"/2022-01-01/osis/validatePipeline" + }, + "input":{"shape":"ValidatePipelineRequest"}, + "output":{"shape":"ValidatePipelineResponse"}, + "errors":[ + {"shape":"DisabledOperationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalException"}, + {"shape":"ValidationException"} + ], + "documentation":"Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + }, + "documentation":"You don't have permissions to access the resource.
", + "error":{"httpStatusCode":403}, + "exception":true + }, + "BlueprintFormat":{ + "type":"string", + "pattern":"(YAML|JSON)" + }, + "Boolean":{"type":"boolean"}, + "BufferOptions":{ + "type":"structure", + "required":["PersistentBufferEnabled"], + "members":{ + "PersistentBufferEnabled":{ + "shape":"Boolean", + "documentation":"Whether persistent buffering should be enabled.
" + } + }, + "documentation":"Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions. For more information, see Persistent buffering.
The name of the stage.
" + }, + "Status":{ + "shape":"ChangeProgressStageStatuses", + "documentation":"The current status of the stage that the change is in.
" + }, + "Description":{ + "shape":"String", + "documentation":"A description of the stage.
" + }, + "LastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"The most recent updated timestamp of the stage.
" + } + }, + "documentation":"Progress details for a specific stage of a pipeline configuration change.
" + }, + "ChangeProgressStageList":{ + "type":"list", + "member":{"shape":"ChangeProgressStage"} + }, + "ChangeProgressStageStatuses":{ + "type":"string", + "enum":[ + "PENDING", + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + }, + "ChangeProgressStatus":{ + "type":"structure", + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"The time at which the configuration change is made on the pipeline.
" + }, + "Status":{ + "shape":"ChangeProgressStatuses", + "documentation":"The overall status of the pipeline configuration change.
" + }, + "TotalNumberOfStages":{ + "shape":"Integer", + "documentation":"The total number of stages required for the pipeline configuration change.
" + }, + "ChangeProgressStages":{ + "shape":"ChangeProgressStageList", + "documentation":"Information about the stages that the pipeline is going through to perform the configuration change.
" + } + }, + "documentation":"The progress details of a pipeline configuration change.
" + }, + "ChangeProgressStatusList":{ + "type":"list", + "member":{"shape":"ChangeProgressStatus"} + }, + "ChangeProgressStatuses":{ + "type":"string", + "enum":[ + "PENDING", + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + }, + "CidrBlock":{ + "type":"string", + "pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(3[0-2]|[12]?[0-9])$" + }, + "CloudWatchLogDestination":{ + "type":"structure", + "required":["LogGroup"], + "members":{ + "LogGroup":{ + "shape":"LogGroup", + "documentation":"The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/vendedlogs/OpenSearchService/pipelines.
The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch.
" + }, + "ConflictException":{ + "type":"structure", + "members":{ + }, + "documentation":"The client attempted to remove a resource that is currently in use.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CreatePipelineRequest":{ + "type":"structure", + "required":[ + "PipelineName", + "MinUnits", + "MaxUnits", + "PipelineConfigurationBody" + ], + "members":{ + "PipelineName":{ + "shape":"PipelineName", + "documentation":"The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.
" + }, + "MinUnits":{ + "shape":"PipelineUnits", + "documentation":"The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
" + }, + "MaxUnits":{ + "shape":"PipelineUnits", + "documentation":"The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
" + }, + "PipelineConfigurationBody":{ + "shape":"PipelineConfigurationBody", + "documentation":"The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \\n.
Key-value pairs to configure log publishing.
" + }, + "VpcOptions":{ + "shape":"VpcOptions", + "documentation":"Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.
" + }, + "BufferOptions":{ + "shape":"BufferOptions", + "documentation":"Key-value pairs to configure persistent buffering for the pipeline.
" + }, + "EncryptionAtRestOptions":{ + "shape":"EncryptionAtRestOptions", + "documentation":"Key-value pairs to configure encryption for data that is written to a persistent buffer.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"List of tags to add to the pipeline upon creation.
" + } + } + }, + "CreatePipelineResponse":{ + "type":"structure", + "members":{ + "Pipeline":{ + "shape":"Pipeline", + "documentation":"Container for information about the created pipeline.
" + } + } + }, + "DeletePipelineRequest":{ + "type":"structure", + "required":["PipelineName"], + "members":{ + "PipelineName":{ + "shape":"PipelineName", + "documentation":"The name of the pipeline to delete.
", + "location":"uri", + "locationName":"PipelineName" + } + } + }, + "DeletePipelineResponse":{ + "type":"structure", + "members":{ + } + }, + "DisabledOperationException":{ + "type":"structure", + "members":{ + }, + "documentation":"Exception is thrown when an operation has been disabled.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "EncryptionAtRestOptions":{ + "type":"structure", + "required":["KmsKeyArn"], + "members":{ + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key.
" + } + }, + "documentation":"Options to control how OpenSearch encrypts buffer data.
" + }, + "GetPipelineBlueprintRequest":{ + "type":"structure", + "required":["BlueprintName"], + "members":{ + "BlueprintName":{ + "shape":"String", + "documentation":"The name of the blueprint to retrieve.
", + "location":"uri", + "locationName":"BlueprintName" + }, + "Format":{ + "shape":"BlueprintFormat", + "documentation":"The format format of the blueprint to retrieve.
", + "location":"querystring", + "locationName":"format" + } + } + }, + "GetPipelineBlueprintResponse":{ + "type":"structure", + "members":{ + "Blueprint":{ + "shape":"PipelineBlueprint", + "documentation":"The requested blueprint in YAML format.
" + }, + "Format":{ + "shape":"String", + "documentation":"The format of the blueprint.
" + } + } + }, + "GetPipelineChangeProgressRequest":{ + "type":"structure", + "required":["PipelineName"], + "members":{ + "PipelineName":{ + "shape":"PipelineName", + "documentation":"The name of the pipeline.
", + "location":"uri", + "locationName":"PipelineName" + } + } + }, + "GetPipelineChangeProgressResponse":{ + "type":"structure", + "members":{ + "ChangeProgressStatuses":{ + "shape":"ChangeProgressStatusList", + "documentation":"The current status of the change happening on the pipeline.
" + } + } + }, + "GetPipelineRequest":{ + "type":"structure", + "required":["PipelineName"], + "members":{ + "PipelineName":{ + "shape":"PipelineName", + "documentation":"The name of the pipeline.
", + "location":"uri", + "locationName":"PipelineName" + } + } + }, + "GetPipelineResponse":{ + "type":"structure", + "members":{ + "Pipeline":{ + "shape":"Pipeline", + "documentation":"Detailed information about the requested pipeline.
" + } + } + }, + "IngestEndpointUrlsList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Integer":{"type":"integer"}, + "InternalException":{ + "type":"structure", + "members":{ + }, + "documentation":"The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
", + "error":{"httpStatusCode":500}, + "exception":true + }, + "InvalidPaginationTokenException":{ + "type":"structure", + "members":{ + }, + "documentation":"An invalid pagination token provided in the request.
", + "error":{"httpStatusCode":400}, + "exception":true + }, + "KmsKeyArn":{ + "type":"string", + "max":2048, + "min":7 + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"You attempted to create more than the allowed number of tags.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ListPipelineBlueprintsRequest":{ + "type":"structure", + "members":{ + } + }, + "ListPipelineBlueprintsResponse":{ + "type":"structure", + "members":{ + "Blueprints":{ + "shape":"PipelineBlueprintsSummaryList", + "documentation":"A list of available blueprints for Data Prepper.
" + } + } + }, + "ListPipelinesRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
If your initial ListPipelines operation returns a nextToken, you can include the returned nextToken in subsequent ListPipelines operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
A list of all existing Data Prepper pipelines.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"PipelineArn", + "documentation":"The Amazon Resource Name (ARN) of the pipeline to retrieve tags for.
", + "location":"querystring", + "locationName":"arn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"A list of tags associated with the given pipeline.
" + } + } + }, + "LogGroup":{ + "type":"string", + "max":512, + "min":1, + "pattern":"\\/aws\\/vendedlogs\\/[\\.\\-_/#A-Za-z0-9]+" + }, + "LogPublishingOptions":{ + "type":"structure", + "members":{ + "IsLoggingEnabled":{ + "shape":"Boolean", + "documentation":"Whether logs should be published.
" + }, + "CloudWatchLogDestination":{ + "shape":"CloudWatchLogDestination", + "documentation":"The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true.
Container for the values required to configure logging for the pipeline. If you don't specify these values, OpenSearch Ingestion will not publish logs from your application to CloudWatch Logs.
" + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "NextToken":{ + "type":"string", + "max":3000, + "min":0, + "pattern":"^([\\s\\S]*)$" + }, + "Pipeline":{ + "type":"structure", + "members":{ + "PipelineName":{ + "shape":"String", + "documentation":"The name of the pipeline.
" + }, + "PipelineArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the pipeline.
" + }, + "MinUnits":{ + "shape":"Integer", + "documentation":"The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
" + }, + "MaxUnits":{ + "shape":"Integer", + "documentation":"The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
" + }, + "Status":{ + "shape":"PipelineStatus", + "documentation":"The current status of the pipeline.
" + }, + "StatusReason":{ + "shape":"PipelineStatusReason", + "documentation":"The reason for the current status of the pipeline.
" + }, + "PipelineConfigurationBody":{ + "shape":"String", + "documentation":"The Data Prepper pipeline configuration in YAML format.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time when the pipeline was created.
" + }, + "LastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time when the pipeline was last updated.
" + }, + "IngestEndpointUrls":{ + "shape":"IngestEndpointUrlsList", + "documentation":"The ingestion endpoints for the pipeline, which you can send data to.
" + }, + "LogPublishingOptions":{ + "shape":"LogPublishingOptions", + "documentation":"Key-value pairs that represent log publishing settings.
" + }, + "VpcEndpoints":{ + "shape":"VpcEndpointsList", + "documentation":"The VPC interface endpoints that have access to the pipeline.
" + }, + "BufferOptions":{"shape":"BufferOptions"}, + "EncryptionAtRestOptions":{"shape":"EncryptionAtRestOptions"}, + "VpcEndpointService":{ + "shape":"String", + "documentation":"The VPC endpoint service name for the pipeline.
" + }, + "ServiceVpcEndpoints":{ + "shape":"ServiceVpcEndpointsList", + "documentation":"A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
" + }, + "Destinations":{ + "shape":"PipelineDestinationList", + "documentation":"Destinations to which the pipeline writes data.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A list of tags associated with the given pipeline.
" + } + }, + "documentation":"Information about an existing OpenSearch Ingestion pipeline.
" + }, + "PipelineArn":{ + "type":"string", + "max":76, + "min":46, + "pattern":"^arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):osis:.+:pipeline\\/.+$" + }, + "PipelineBlueprint":{ + "type":"structure", + "members":{ + "BlueprintName":{ + "shape":"String", + "documentation":"The name of the blueprint.
" + }, + "PipelineConfigurationBody":{ + "shape":"String", + "documentation":"The YAML configuration of the blueprint.
" + }, + "DisplayName":{ + "shape":"String", + "documentation":"The display name of the blueprint.
" + }, + "DisplayDescription":{ + "shape":"String", + "documentation":"A description of the blueprint.
" + }, + "Service":{ + "shape":"String", + "documentation":"The name of the service that the blueprint is associated with.
" + }, + "UseCase":{ + "shape":"String", + "documentation":"The use case that the blueprint relates to.
" + } + }, + "documentation":"Container for information about an OpenSearch Ingestion blueprint.
" + }, + "PipelineBlueprintSummary":{ + "type":"structure", + "members":{ + "BlueprintName":{ + "shape":"String", + "documentation":"The name of the blueprint.
" + }, + "DisplayName":{ + "shape":"String", + "documentation":"The display name of the blueprint.
" + }, + "DisplayDescription":{ + "shape":"String", + "documentation":"A description of the blueprint.
" + }, + "Service":{ + "shape":"String", + "documentation":"The name of the service that the blueprint is associated with.
" + }, + "UseCase":{ + "shape":"String", + "documentation":"The use case that the blueprint relates to.
" + } + }, + "documentation":"A summary of an OpenSearch Ingestion blueprint.
" + }, + "PipelineBlueprintsSummaryList":{ + "type":"list", + "member":{"shape":"PipelineBlueprintSummary"} + }, + "PipelineConfigurationBody":{ + "type":"string", + "max":24000, + "min":1 + }, + "PipelineDestination":{ + "type":"structure", + "members":{ + "ServiceName":{ + "shape":"String", + "documentation":"The name of the service receiving data from the pipeline.
" + }, + "Endpoint":{ + "shape":"String", + "documentation":"The endpoint receiving data from the pipeline.
" + } + }, + "documentation":"An object representing the destination of a pipeline.
" + }, + "PipelineDestinationList":{ + "type":"list", + "member":{"shape":"PipelineDestination"} + }, + "PipelineName":{ + "type":"string", + "max":28, + "min":3, + "pattern":"[a-z][a-z0-9\\-]+" + }, + "PipelineStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "UPDATING", + "DELETING", + "CREATE_FAILED", + "UPDATE_FAILED", + "STARTING", + "START_FAILED", + "STOPPING", + "STOPPED" + ] + }, + "PipelineStatusReason":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"A description of why a pipeline has a certain status.
" + } + }, + "documentation":"Information about a pipeline's current status.
" + }, + "PipelineSummary":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"PipelineStatus", + "documentation":"The current status of the pipeline.
" + }, + "StatusReason":{"shape":"PipelineStatusReason"}, + "PipelineName":{ + "shape":"PipelineName", + "documentation":"The name of the pipeline.
" + }, + "PipelineArn":{ + "shape":"PipelineArn", + "documentation":"The Amazon Resource Name (ARN) of the pipeline.
" + }, + "MinUnits":{ + "shape":"PipelineUnits", + "documentation":"The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
" + }, + "MaxUnits":{ + "shape":"PipelineUnits", + "documentation":"The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time when the pipeline was created.
" + }, + "LastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time when the pipeline was last updated.
" + }, + "Destinations":{ + "shape":"PipelineDestinationList", + "documentation":"A list of destinations to which the pipeline writes data.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A list of tags associated with the given pipeline.
" + } + }, + "documentation":"Summary information for an OpenSearch Ingestion pipeline.
" + }, + "PipelineSummaryList":{ + "type":"list", + "member":{"shape":"PipelineSummary"} + }, + "PipelineUnits":{ + "type":"integer", + "min":1 + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"You attempted to create a resource that already exists.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"You attempted to access or delete a resource that does not exist.
", + "error":{"httpStatusCode":404}, + "exception":true + }, + "SecurityGroupId":{ + "type":"string", + "max":20, + "min":11, + "pattern":"sg-\\w{8}(\\w{9})?" + }, + "SecurityGroupIds":{ + "type":"list", + "member":{"shape":"SecurityGroupId"}, + "max":12, + "min":1 + }, + "ServiceVpcEndpoint":{ + "type":"structure", + "members":{ + "ServiceName":{ + "shape":"VpcEndpointServiceName", + "documentation":"The name of the service for which a VPC endpoint was created.
" + }, + "VpcEndpointId":{ + "shape":"String", + "documentation":"The unique identifier of the VPC endpoint that was created.
" + } + }, + "documentation":"A container for information about VPC endpoints that were created to other services
" + }, + "ServiceVpcEndpointsList":{ + "type":"list", + "member":{"shape":"ServiceVpcEndpoint"} + }, + "StartPipelineRequest":{ + "type":"structure", + "required":["PipelineName"], + "members":{ + "PipelineName":{ + "shape":"PipelineName", + "documentation":"The name of the pipeline to start.
", + "location":"uri", + "locationName":"PipelineName" + } + } + }, + "StartPipelineResponse":{ + "type":"structure", + "members":{ + "Pipeline":{"shape":"Pipeline"} + } + }, + "StopPipelineRequest":{ + "type":"structure", + "required":["PipelineName"], + "members":{ + "PipelineName":{ + "shape":"PipelineName", + "documentation":"The name of the pipeline to stop.
", + "location":"uri", + "locationName":"PipelineName" + } + } + }, + "StopPipelineResponse":{ + "type":"structure", + "members":{ + "Pipeline":{"shape":"Pipeline"} + } + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "SubnetId":{ + "type":"string", + "max":24, + "min":15, + "pattern":"subnet-\\w{8}(\\w{9})?" + }, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"}, + "max":12, + "min":1 + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"The tag key. Tag keys must be unique for the pipeline to which they are attached.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
A tag (key-value pair) for an OpenSearch Ingestion pipeline.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":".*" + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "Arn", + "Tags" + ], + "members":{ + "Arn":{ + "shape":"PipelineArn", + "documentation":"The Amazon Resource Name (ARN) of the pipeline to tag.
", + "location":"querystring", + "locationName":"arn" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The list of key-value tags to add to the pipeline.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":".*" + }, + "Timestamp":{"type":"timestamp"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "Arn", + "TagKeys" + ], + "members":{ + "Arn":{ + "shape":"PipelineArn", + "documentation":"The Amazon Resource Name (ARN) of the pipeline to remove tags from.
", + "location":"querystring", + "locationName":"arn" + }, + "TagKeys":{ + "shape":"StringList", + "documentation":"The tag keys to remove.
" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdatePipelineRequest":{ + "type":"structure", + "required":["PipelineName"], + "members":{ + "PipelineName":{ + "shape":"PipelineName", + "documentation":"The name of the pipeline to update.
", + "location":"uri", + "locationName":"PipelineName" + }, + "MinUnits":{ + "shape":"PipelineUnits", + "documentation":"The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
" + }, + "MaxUnits":{ + "shape":"PipelineUnits", + "documentation":"The maximum pipeline capacity, in Ingestion Compute Units (ICUs)
" + }, + "PipelineConfigurationBody":{ + "shape":"PipelineConfigurationBody", + "documentation":"The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \\n.
Key-value pairs to configure log publishing.
" + }, + "BufferOptions":{ + "shape":"BufferOptions", + "documentation":"Key-value pairs to configure persistent buffering for the pipeline.
" + }, + "EncryptionAtRestOptions":{ + "shape":"EncryptionAtRestOptions", + "documentation":"Key-value pairs to configure encryption for data that is written to a persistent buffer.
" + } + } + }, + "UpdatePipelineResponse":{ + "type":"structure", + "members":{ + "Pipeline":{ + "shape":"Pipeline", + "documentation":"Container for information about the updated pipeline.
" + } + } + }, + "ValidatePipelineRequest":{ + "type":"structure", + "required":["PipelineConfigurationBody"], + "members":{ + "PipelineConfigurationBody":{ + "shape":"PipelineConfigurationBody", + "documentation":"The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \\n.
A boolean indicating whether or not the pipeline configuration is valid.
" + }, + "Errors":{ + "shape":"ValidationMessageList", + "documentation":"A list of errors if the configuration is invalid.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + }, + "documentation":"An exception for missing or invalid input fields.
", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ValidationMessage":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"The validation message.
" + } + }, + "documentation":"A validation message associated with a ValidatePipeline request in OpenSearch Ingestion.
Whether a VPC is attached to the pipeline.
" + }, + "CidrBlock":{ + "shape":"CidrBlock", + "documentation":"The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
" + } + }, + "documentation":"Options for attaching a VPC to pipeline.
" + }, + "VpcEndpoint":{ + "type":"structure", + "members":{ + "VpcEndpointId":{ + "shape":"String", + "documentation":"The unique identifier of the endpoint.
" + }, + "VpcId":{ + "shape":"String", + "documentation":"The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC.
" + }, + "VpcOptions":{ + "shape":"VpcOptions", + "documentation":"Information about the VPC, including associated subnets and security groups.
" + } + }, + "documentation":"An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines.
" + }, + "VpcEndpointManagement":{ + "type":"string", + "enum":[ + "CUSTOMER", + "SERVICE" + ] + }, + "VpcEndpointServiceName":{ + "type":"string", + "enum":["OPENSEARCH_SERVERLESS"] + }, + "VpcEndpointsList":{ + "type":"list", + "member":{"shape":"VpcEndpoint"} + }, + "VpcOptions":{ + "type":"structure", + "required":["SubnetIds"], + "members":{ + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"A list of subnet IDs associated with the VPC endpoint.
" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"A list of security groups associated with the VPC endpoint.
" + }, + "VpcAttachmentOptions":{ + "shape":"VpcAttachmentOptions", + "documentation":"Options for attaching a VPC to a pipeline.
" + }, + "VpcEndpointManagement":{ + "shape":"VpcEndpointManagement", + "documentation":"Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.
" + } + }, + "documentation":"Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.
" + } + }, + "documentation":"Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines. OpenSearch Ingestion is a fully managed data collector that delivers real-time log and trace data to OpenSearch Service domains. For more information, see Getting data into your cluster using OpenSearch Ingestion.
" +} diff --git a/testbed/boto__botocore/botocore/data/payment-cryptography-data/2022-02-03/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/payment-cryptography-data/2022-02-03/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..6b5a79cbf7e2f8c6490df1bfb944fc591595acbc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/payment-cryptography-data/2022-02-03/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://dataplane.payment-cryptography-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://dataplane.payment-cryptography-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://dataplane.payment-cryptography.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://dataplane.payment-cryptography.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/payment-cryptography-data/2022-02-03/paginators-1.json b/testbed/boto__botocore/botocore/data/payment-cryptography-data/2022-02-03/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..ea142457a6a77d6e6a54942329f1199bc2f2a60c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/payment-cryptography-data/2022-02-03/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/testbed/boto__botocore/botocore/data/payment-cryptography-data/2022-02-03/service-2.json b/testbed/boto__botocore/botocore/data/payment-cryptography-data/2022-02-03/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..38b9b967e5e080e7148a0b4408f49c77c99db712 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/payment-cryptography-data/2022-02-03/service-2.json @@ -0,0 +1,2287 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-02-03", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"dataplane.payment-cryptography", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"Payment Cryptography Data Plane", + "serviceId":"Payment Cryptography Data", + "signatureVersion":"v4", + "signingName":"payment-cryptography", + "uid":"payment-cryptography-data-2022-02-03" + }, + "operations":{ + "DecryptData":{ + "name":"DecryptData", + "http":{ + "method":"POST", + "requestUri":"/keys/{KeyIdentifier}/decrypt", + "responseCode":200 + }, + "input":{"shape":"DecryptDataInput"}, + "output":{"shape":"DecryptDataOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see Decrypt data in the Amazon Web Services Payment Cryptography User Guide.
You can use an encryption key generated within Amazon Web Services Payment Cryptography, or you can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Decrypt. In asymmetric decryption, Amazon Web Services Payment Cryptography decrypts the ciphertext using the private component of the asymmetric encryption key pair. For data encryption outside of Amazon Web Services Payment Cryptography, you can export the public component of the asymmetric key pair by calling GetPublicCertificate.
For symmetric and DUKPT decryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For EMV decryption, Amazon Web Services Payment Cryptography supports TDES algorithms. For asymmetric decryption, Amazon Web Services Payment Cryptography supports RSA.
When you use TDES or TDES DUKPT, the ciphertext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the ciphertext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "EncryptData":{ + "name":"EncryptData", + "http":{ + "method":"POST", + "requestUri":"/keys/{KeyIdentifier}/encrypt", + "responseCode":200 + }, + "input":{"shape":"EncryptDataInput"}, + "output":{"shape":"EncryptDataOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Encrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.
You can generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey. You can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Encrypt. In asymmetric encryption, plaintext is encrypted using public component. You can import the public component of an asymmetric key pair created outside Amazon Web Services Payment Cryptography by calling ImportKey.
For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For EMV encryption, Amazon Web Services Payment Cryptography supports TDES algorithms.For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA.
When you use TDES or TDES DUKPT, the plaintext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the plaintext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.
To encrypt using DUKPT, you must already have a BDK (Base Derivation Key) key in your account with KeyModesOfUse set to DeriveKey, or you can generate a new DUKPT key by calling CreateKey. To encrypt using EMV, you must already have an IMK (Issuer Master Key) key in your account with KeyModesOfUse set to DeriveKey.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "GenerateCardValidationData":{ + "name":"GenerateCardValidationData", + "http":{ + "method":"POST", + "requestUri":"/cardvalidationdata/generate", + "responseCode":200 + }, + "input":{"shape":"GenerateCardValidationDataInput"}, + "output":{"shape":"GenerateCardValidationDataOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Generates card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC). For more information, see Generate card data in the Amazon Web Services Payment Cryptography User Guide.
This operation generates a CVV or CSC value that is printed on a payment credit or debit card during card production. The CVV or CSC, PAN (Primary Account Number) and expiration date of the card are required to check its validity during transaction processing. To begin this operation, a CVK (Card Verification Key) encryption key is required. You can use CreateKey or ImportKey to establish a CVK within Amazon Web Services Payment Cryptography. The KeyModesOfUse should be set to Generate and Verify for a CVK encryption key.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "GenerateMac":{ + "name":"GenerateMac", + "http":{ + "method":"POST", + "requestUri":"/mac/generate", + "responseCode":200 + }, + "input":{"shape":"GenerateMacInput"}, + "output":{"shape":"GenerateMacOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography.
You can use this operation to authenticate card-related data by using known data values to generate MAC for data validation between the sending and receiving parties. This operation uses message data, a secret encryption key and MAC algorithm to generate a unique MAC value for transmission. The receiving party of the MAC must use the same message data, secret encryption key and MAC algorithm to reproduce another MAC value for comparision.
You can use this operation to generate a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. The MAC generation encryption key must have valid values for KeyUsage such as TR31_M7_HMAC_KEY for HMAC generation, and they key must have KeyModesOfUse set to Generate and Verify.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "GeneratePinData":{ + "name":"GeneratePinData", + "http":{ + "method":"POST", + "requestUri":"/pindata/generate", + "responseCode":200 + }, + "input":{"shape":"GeneratePinDataInput"}, + "output":{"shape":"GeneratePinDataOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Generates pin-related data such as PIN, PIN Verification Value (PVV), PIN Block, and PIN Offset during new card issuance or reissuance. For more information, see Generate PIN data in the Amazon Web Services Payment Cryptography User Guide.
PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation generates PIN, PVV, or PIN Offset and then encrypts it using Pin Encryption Key (PEK) to create an EncryptedPinBlock for transmission from Amazon Web Services Payment Cryptography. This operation uses a separate Pin Verification Key (PVK) for VISA PVV generation.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "ReEncryptData":{ + "name":"ReEncryptData", + "http":{ + "method":"POST", + "requestUri":"/keys/{IncomingKeyIdentifier}/reencrypt", + "responseCode":200 + }, + "input":{"shape":"ReEncryptDataInput"}, + "output":{"shape":"ReEncryptDataOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Re-encrypt ciphertext using DUKPT or Symmetric data encryption keys.
You can either generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey or import your own encryption key by calling ImportKey. The KeyArn for use with this operation must be in a compatible key state with KeyModesOfUse set to Encrypt.
For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. To encrypt using DUKPT, a DUKPT key must already exist within your account with KeyModesOfUse set to DeriveKey or a new DUKPT can be generated by calling CreateKey.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "TranslatePinData":{ + "name":"TranslatePinData", + "http":{ + "method":"POST", + "requestUri":"/pindata/translate", + "responseCode":200 + }, + "input":{"shape":"TranslatePinDataInput"}, + "output":{"shape":"TranslatePinDataOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more information, see Translate PIN data in the Amazon Web Services Payment Cryptography User Guide.
PIN block translation involves changing the encrytion of PIN block from one encryption key to another encryption key and changing PIN block format from one to another without PIN block data leaving Amazon Web Services Payment Cryptography. The encryption key transformation can be from PEK (Pin Encryption Key) to BDK (Base Derivation Key) for DUKPT or from BDK for DUKPT to PEK. Amazon Web Services Payment Cryptography supports TDES and AES key derivation type for DUKPT translations.
The allowed combinations of PIN block format translations are guided by PCI. It is important to note that not all encrypted PIN block formats (example, format 1) require PAN (Primary Account Number) as input. And as such, PIN block format that requires PAN (example, formats 0,3,4) cannot be translated to a format (format 1) that does not require a PAN for generation.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Amazon Web Services Payment Cryptography currently supports ISO PIN block 4 translation for PIN block built using legacy PAN length. That is, PAN is the right most 12 digits excluding the check digits.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "VerifyAuthRequestCryptogram":{ + "name":"VerifyAuthRequestCryptogram", + "http":{ + "method":"POST", + "requestUri":"/cryptogram/verify", + "responseCode":200 + }, + "input":{"shape":"VerifyAuthRequestCryptogramInput"}, + "output":{"shape":"VerifyAuthRequestCryptogramOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"VerificationFailedException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Verifies Authorization Request Cryptogram (ARQC) for a EMV chip payment card authorization. For more information, see Verify auth request cryptogram in the Amazon Web Services Payment Cryptography User Guide.
ARQC generation is done outside of Amazon Web Services Payment Cryptography and is typically generated on a point of sale terminal for an EMV chip card to obtain payment authorization during transaction time. For ARQC verification, you must first import the ARQC generated outside of Amazon Web Services Payment Cryptography by calling ImportKey. This operation uses the imported ARQC and an major encryption key (DUKPT) created by calling CreateKey to either provide a boolean ARQC verification result or provide an APRC (Authorization Response Cryptogram) response using Method 1 or Method 2. The ARPC_METHOD_1 uses AuthResponseCode to generate ARPC and ARPC_METHOD_2 uses CardStatusUpdate to generate ARPC.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "VerifyCardValidationData":{ + "name":"VerifyCardValidationData", + "http":{ + "method":"POST", + "requestUri":"/cardvalidationdata/verify", + "responseCode":200 + }, + "input":{"shape":"VerifyCardValidationDataInput"}, + "output":{"shape":"VerifyCardValidationDataOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"VerificationFailedException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Verifies card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2) and Card Security Codes (CSC). For more information, see Verify card data in the Amazon Web Services Payment Cryptography User Guide.
This operation validates the CVV or CSC codes that is printed on a payment credit or debit card during card payment transaction. The input values are typically provided as part of an inbound transaction to an issuer or supporting platform partner. Amazon Web Services Payment Cryptography uses CVV or CSC, PAN (Primary Account Number) and expiration date of the card to check its validity during transaction processing. In this operation, the CVK (Card Verification Key) encryption key for use with card data verification is same as the one in used for GenerateCardValidationData.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "VerifyMac":{ + "name":"VerifyMac", + "http":{ + "method":"POST", + "requestUri":"/mac/verify", + "responseCode":200 + }, + "input":{"shape":"VerifyMacInput"}, + "output":{"shape":"VerifyMacOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"VerificationFailedException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Verifies a Message Authentication Code (MAC).
You can use this operation to verify MAC for message data authentication such as . In this operation, you must use the same message data, secret encryption key and MAC algorithm that was used to generate MAC. You can use this operation to verify a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "VerifyPinData":{ + "name":"VerifyPinData", + "http":{ + "method":"POST", + "requestUri":"/pindata/verify", + "responseCode":200 + }, + "input":{"shape":"VerifyPinDataInput"}, + "output":{"shape":"VerifyPinDataOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"VerificationFailedException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624. For more information, see Verify PIN data in the Amazon Web Services Payment Cryptography User Guide.
This operation verifies PIN data for user payment card. A card holder PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation uses PIN Verification Key (PVK) for PIN or PIN Offset generation and then encrypts it using PIN Encryption Key (PEK) to create an EncryptedPinBlock for transmission from Amazon Web Services Payment Cryptography.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AmexCardSecurityCodeVersion1":{ + "type":"structure", + "required":["CardExpiryDate"], + "members":{ + "CardExpiryDate":{ + "shape":"CardExpiryDateType", + "documentation":"The expiry date of a payment card.
" + } + }, + "documentation":"Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.
" + }, + "AmexCardSecurityCodeVersion2":{ + "type":"structure", + "required":[ + "CardExpiryDate", + "ServiceCode" + ], + "members":{ + "CardExpiryDate":{ + "shape":"CardExpiryDateType", + "documentation":"The expiry date of a payment card.
" + }, + "ServiceCode":{ + "shape":"ServiceCodeType", + "documentation":"The service code of the AMEX payment card. This is different from the Card Security Code (CSC).
" + } + }, + "documentation":"Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.
" + }, + "ApplicationCryptogramType":{ + "type":"string", + "max":16, + "min":16, + "pattern":"[0-9a-fA-F]+", + "sensitive":true + }, + "AsymmetricEncryptionAttributes":{ + "type":"structure", + "members":{ + "PaddingType":{ + "shape":"PaddingType", + "documentation":"The padding to be included with the data.
" + } + }, + "documentation":"Parameters for plaintext encryption using asymmetric keys.
" + }, + "AuthRequestCryptogramType":{ + "type":"string", + "max":16, + "min":16, + "pattern":"[0-9a-fA-F]+", + "sensitive":true + }, + "AuthResponseValueType":{ + "type":"string", + "max":16, + "min":1, + "pattern":"[0-9a-fA-F]+", + "sensitive":true + }, + "CardExpiryDateType":{ + "type":"string", + "max":4, + "min":4, + "pattern":"[0-9]+", + "sensitive":true + }, + "CardGenerationAttributes":{ + "type":"structure", + "members":{ + "AmexCardSecurityCodeVersion1":{"shape":"AmexCardSecurityCodeVersion1"}, + "AmexCardSecurityCodeVersion2":{ + "shape":"AmexCardSecurityCodeVersion2", + "documentation":"Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.
" + }, + "CardVerificationValue1":{ + "shape":"CardVerificationValue1", + "documentation":"Card data parameters that are required to generate Card Verification Value (CVV) for the payment card.
" + }, + "CardVerificationValue2":{ + "shape":"CardVerificationValue2", + "documentation":"Card data parameters that are required to generate Card Verification Value (CVV2) for the payment card.
" + }, + "CardHolderVerificationValue":{ + "shape":"CardHolderVerificationValue", + "documentation":"Card data parameters that are required to generate a cardholder verification value for the payment card.
" + }, + "DynamicCardVerificationCode":{ + "shape":"DynamicCardVerificationCode", + "documentation":"Card data parameters that are required to generate CDynamic Card Verification Code (dCVC) for the payment card.
" + }, + "DynamicCardVerificationValue":{ + "shape":"DynamicCardVerificationValue", + "documentation":"Card data parameters that are required to generate CDynamic Card Verification Value (dCVV) for the payment card.
" + } + }, + "documentation":"Card data parameters that are required to generate Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC).
", + "union":true + }, + "CardHolderVerificationValue":{ + "type":"structure", + "required":[ + "UnpredictableNumber", + "PanSequenceNumber", + "ApplicationTransactionCounter" + ], + "members":{ + "UnpredictableNumber":{ + "shape":"HexLengthBetween2And8", + "documentation":"A random number generated by the issuer.
" + }, + "PanSequenceNumber":{ + "shape":"NumberLengthEquals2", + "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" + }, + "ApplicationTransactionCounter":{ + "shape":"HexLengthBetween2And4", + "documentation":"The transaction counter value that comes from a point of sale terminal.
" + } + }, + "documentation":"Card data parameters that are required to generate a cardholder verification value for the payment card.
" + }, + "CardVerificationAttributes":{ + "type":"structure", + "members":{ + "AmexCardSecurityCodeVersion1":{"shape":"AmexCardSecurityCodeVersion1"}, + "AmexCardSecurityCodeVersion2":{ + "shape":"AmexCardSecurityCodeVersion2", + "documentation":"Card data parameters that are required to verify a Card Security Code (CSC2) for an AMEX payment card.
" + }, + "CardVerificationValue1":{ + "shape":"CardVerificationValue1", + "documentation":"Card data parameters that are required to verify Card Verification Value (CVV) for the payment card.
" + }, + "CardVerificationValue2":{ + "shape":"CardVerificationValue2", + "documentation":"Card data parameters that are required to verify Card Verification Value (CVV2) for the payment card.
" + }, + "CardHolderVerificationValue":{ + "shape":"CardHolderVerificationValue", + "documentation":"Card data parameters that are required to verify a cardholder verification value for the payment card.
" + }, + "DynamicCardVerificationCode":{ + "shape":"DynamicCardVerificationCode", + "documentation":"Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.
" + }, + "DynamicCardVerificationValue":{ + "shape":"DynamicCardVerificationValue", + "documentation":"Card data parameters that are required to verify CDynamic Card Verification Value (dCVV) for the payment card.
" + }, + "DiscoverDynamicCardVerificationCode":{ + "shape":"DiscoverDynamicCardVerificationCode", + "documentation":"Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.
" + } + }, + "documentation":"Card data parameters that are requried to verify Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC).
", + "union":true + }, + "CardVerificationValue1":{ + "type":"structure", + "required":[ + "CardExpiryDate", + "ServiceCode" + ], + "members":{ + "CardExpiryDate":{ + "shape":"CardExpiryDateType", + "documentation":"The expiry date of a payment card.
" + }, + "ServiceCode":{ + "shape":"ServiceCodeType", + "documentation":"The service code of the payment card. This is different from Card Security Code (CSC).
" + } + }, + "documentation":"Card data parameters that are required to verify CVV (Card Verification Value) for the payment card.
" + }, + "CardVerificationValue2":{ + "type":"structure", + "required":["CardExpiryDate"], + "members":{ + "CardExpiryDate":{ + "shape":"CardExpiryDateType", + "documentation":"The expiry date of a payment card.
" + } + }, + "documentation":"Card data parameters that are required to verify Card Verification Value (CVV2) for the payment card.
" + }, + "CipherTextType":{ + "type":"string", + "max":4096, + "min":16, + "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", + "sensitive":true + }, + "CryptogramAuthResponse":{ + "type":"structure", + "members":{ + "ArpcMethod1":{ + "shape":"CryptogramVerificationArpcMethod1", + "documentation":"Parameters that are required for ARPC response generation using method1 after ARQC verification is successful.
" + }, + "ArpcMethod2":{ + "shape":"CryptogramVerificationArpcMethod2", + "documentation":"Parameters that are required for ARPC response generation using method2 after ARQC verification is successful.
" + } + }, + "documentation":"Parameters that are required for Authorization Response Cryptogram (ARPC) generation after Authorization Request Cryptogram (ARQC) verification is successful.
", + "union":true + }, + "CryptogramVerificationArpcMethod1":{ + "type":"structure", + "required":["AuthResponseCode"], + "members":{ + "AuthResponseCode":{ + "shape":"HexLengthEquals4", + "documentation":"The auth code used to calculate APRC after ARQC verification is successful. This is the same auth code used for ARQC generation outside of Amazon Web Services Payment Cryptography.
" + } + }, + "documentation":"Parameters that are required for ARPC response generation using method1 after ARQC verification is successful.
" + }, + "CryptogramVerificationArpcMethod2":{ + "type":"structure", + "required":["CardStatusUpdate"], + "members":{ + "CardStatusUpdate":{ + "shape":"HexLengthEquals8", + "documentation":"The data indicating whether the issuer approves or declines an online transaction using an EMV chip card.
" + }, + "ProprietaryAuthenticationData":{ + "shape":"ProprietaryAuthenticationDataType", + "documentation":"The proprietary authentication data used by issuer for communication during online transaction using an EMV chip card.
" + } + }, + "documentation":"Parameters that are required for ARPC response generation using method2 after ARQC verification is successful.
" + }, + "DecimalizationTableType":{ + "type":"string", + "max":16, + "min":16, + "pattern":"[0-9]+", + "sensitive":true + }, + "DecryptDataInput":{ + "type":"structure", + "required":[ + "KeyIdentifier", + "CipherText", + "DecryptionAttributes" + ], + "members":{ + "KeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.
When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.
", + "location":"uri", + "locationName":"KeyIdentifier" + }, + "CipherText":{ + "shape":"CipherTextType", + "documentation":"The ciphertext to decrypt.
" + }, + "DecryptionAttributes":{ + "shape":"EncryptionDecryptionAttributes", + "documentation":"The encryption key type and attributes for ciphertext decryption.
" + }, + "WrappedKey":{ + "shape":"WrappedKey", + "documentation":"The WrappedKeyBlock containing the encryption key for ciphertext decryption.
" + } + } + }, + "DecryptDataOutput":{ + "type":"structure", + "required":[ + "KeyArn", + "KeyCheckValue", + "PlainText" + ], + "members":{ + "KeyArn":{ + "shape":"KeyArn", + "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + }, + "PlainText":{ + "shape":"PlainTextOutputType", + "documentation":"The decrypted plaintext data in hexBinary format.
" + } + } + }, + "DiscoverDynamicCardVerificationCode":{ + "type":"structure", + "required":[ + "CardExpiryDate", + "UnpredictableNumber", + "ApplicationTransactionCounter" + ], + "members":{ + "CardExpiryDate":{ + "shape":"CardExpiryDateType", + "documentation":"The expiry date of a payment card.
" + }, + "UnpredictableNumber":{ + "shape":"HexLengthBetween2And8", + "documentation":"A random number that is generated by the issuer.
" + }, + "ApplicationTransactionCounter":{ + "shape":"HexLengthBetween2And4", + "documentation":"The transaction counter value that comes from the terminal.
" + } + }, + "documentation":"Parameters that are required to generate or verify dCVC (Dynamic Card Verification Code).
" + }, + "DukptAttributes":{ + "type":"structure", + "required":[ + "KeySerialNumber", + "DukptDerivationType" + ], + "members":{ + "KeySerialNumber":{ + "shape":"HexLengthBetween10And24", + "documentation":"The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
" + }, + "DukptDerivationType":{ + "shape":"DukptDerivationType", + "documentation":"The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.
Parameters that are used for Derived Unique Key Per Transaction (DUKPT) derivation algorithm.
" + }, + "DukptDerivationAttributes":{ + "type":"structure", + "required":["KeySerialNumber"], + "members":{ + "KeySerialNumber":{ + "shape":"HexLengthBetween10And24", + "documentation":"The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
" + }, + "DukptKeyDerivationType":{ + "shape":"DukptDerivationType", + "documentation":"The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY
The type of use of DUKPT, which can be for incoming data decryption, outgoing data encryption, or both.
" + } + }, + "documentation":"Parameters required for encryption or decryption of data using DUKPT.
" + }, + "DukptDerivationType":{ + "type":"string", + "enum":[ + "TDES_2KEY", + "TDES_3KEY", + "AES_128", + "AES_192", + "AES_256" + ] + }, + "DukptEncryptionAttributes":{ + "type":"structure", + "required":["KeySerialNumber"], + "members":{ + "KeySerialNumber":{ + "shape":"HexLengthBetween10And24", + "documentation":"The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
" + }, + "Mode":{ + "shape":"DukptEncryptionMode", + "documentation":"The block cipher method to use for encryption.
The default is CBC.
" + }, + "DukptKeyDerivationType":{ + "shape":"DukptDerivationType", + "documentation":"The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY
The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
" + }, + "InitializationVector":{ + "shape":"InitializationVectorType", + "documentation":"An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
" + } + }, + "documentation":"Parameters that are required to encrypt plaintext data using DUKPT.
" + }, + "DukptEncryptionMode":{ + "type":"string", + "enum":[ + "ECB", + "CBC" + ] + }, + "DukptKeyVariant":{ + "type":"string", + "enum":[ + "BIDIRECTIONAL", + "REQUEST", + "RESPONSE" + ] + }, + "DynamicCardVerificationCode":{ + "type":"structure", + "required":[ + "UnpredictableNumber", + "PanSequenceNumber", + "ApplicationTransactionCounter", + "TrackData" + ], + "members":{ + "UnpredictableNumber":{ + "shape":"HexLengthBetween2And8", + "documentation":"A random number generated by the issuer.
" + }, + "PanSequenceNumber":{ + "shape":"NumberLengthEquals2", + "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" + }, + "ApplicationTransactionCounter":{ + "shape":"HexLengthBetween2And4", + "documentation":"The transaction counter value that comes from the terminal.
" + }, + "TrackData":{ + "shape":"TrackDataType", + "documentation":"The data on the two tracks of magnetic cards used for financial transactions. This includes the cardholder name, PAN, expiration date, bank ID (BIN) and several other numbers the issuing bank uses to validate the data received.
" + } + }, + "documentation":"Parameters that are required to generate or verify Dynamic Card Verification Value (dCVV).
" + }, + "DynamicCardVerificationValue":{ + "type":"structure", + "required":[ + "PanSequenceNumber", + "CardExpiryDate", + "ServiceCode", + "ApplicationTransactionCounter" + ], + "members":{ + "PanSequenceNumber":{ + "shape":"NumberLengthEquals2", + "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" + }, + "CardExpiryDate":{ + "shape":"CardExpiryDateType", + "documentation":"The expiry date of a payment card.
" + }, + "ServiceCode":{ + "shape":"ServiceCodeType", + "documentation":"The service code of the payment card. This is different from Card Security Code (CSC).
" + }, + "ApplicationTransactionCounter":{ + "shape":"HexLengthBetween2And4", + "documentation":"The transaction counter value that comes from the terminal.
" + } + }, + "documentation":"Parameters that are required to generate or verify Dynamic Card Verification Value (dCVV).
" + }, + "EmvEncryptionAttributes":{ + "type":"structure", + "required":[ + "MajorKeyDerivationMode", + "PrimaryAccountNumber", + "PanSequenceNumber", + "SessionDerivationData" + ], + "members":{ + "MajorKeyDerivationMode":{ + "shape":"EmvMajorKeyDerivationMode", + "documentation":"The EMV derivation mode to use for ICC master key derivation as per EMV version 4.3 book 2.
" + }, + "PrimaryAccountNumber":{ + "shape":"PrimaryAccountNumberType", + "documentation":"The Primary Account Number (PAN), a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" + }, + "PanSequenceNumber":{ + "shape":"NumberLengthEquals2", + "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" + }, + "SessionDerivationData":{ + "shape":"SessionDerivationDataType", + "documentation":"The derivation value used to derive the ICC session key. It is typically the application transaction counter value padded with zeros or previous ARQC value padded with zeros as per EMV version 4.3 book 2.
" + }, + "Mode":{ + "shape":"EmvEncryptionMode", + "documentation":"The block cipher method to use for encryption.
" + }, + "InitializationVector":{ + "shape":"InitializationVectorType", + "documentation":"An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
" + } + }, + "documentation":"Parameters for plaintext encryption using EMV keys.
" + }, + "EmvEncryptionMode":{ + "type":"string", + "enum":[ + "ECB", + "CBC" + ] + }, + "EmvMajorKeyDerivationMode":{ + "type":"string", + "enum":[ + "EMV_OPTION_A", + "EMV_OPTION_B" + ] + }, + "EncryptDataInput":{ + "type":"structure", + "required":[ + "KeyIdentifier", + "PlainText", + "EncryptionAttributes" + ], + "members":{ + "KeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.
", + "location":"uri", + "locationName":"KeyIdentifier" + }, + "PlainText":{ + "shape":"PlainTextType", + "documentation":"The plaintext to be encrypted.
For encryption using asymmetric keys, plaintext data length is constrained by encryption key strength that you define in KeyAlgorithm and padding type that you define in AsymmetricEncryptionAttributes. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.
The encryption key type and attributes for plaintext encryption.
" + }, + "WrappedKey":{ + "shape":"WrappedKey", + "documentation":"The WrappedKeyBlock containing the encryption key for plaintext encryption.
" + } + } + }, + "EncryptDataOutput":{ + "type":"structure", + "required":[ + "KeyArn", + "CipherText" + ], + "members":{ + "KeyArn":{ + "shape":"KeyArn", + "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + }, + "CipherText":{ + "shape":"CipherTextType", + "documentation":"The encrypted ciphertext.
" + } + } + }, + "EncryptedPinBlockType":{ + "type":"string", + "max":32, + "min":16, + "pattern":"[0-9a-fA-F]+", + "sensitive":true + }, + "EncryptionDecryptionAttributes":{ + "type":"structure", + "members":{ + "Symmetric":{ + "shape":"SymmetricEncryptionAttributes", + "documentation":"Parameters that are required to perform encryption and decryption using symmetric keys.
" + }, + "Asymmetric":{"shape":"AsymmetricEncryptionAttributes"}, + "Dukpt":{"shape":"DukptEncryptionAttributes"}, + "Emv":{ + "shape":"EmvEncryptionAttributes", + "documentation":"Parameters for plaintext encryption using EMV keys.
" + } + }, + "documentation":"Parameters that are required to perform encryption and decryption operations.
", + "union":true + }, + "EncryptionMode":{ + "type":"string", + "enum":[ + "ECB", + "CBC", + "CFB", + "CFB1", + "CFB8", + "CFB64", + "CFB128", + "OFB" + ] + }, + "GenerateCardValidationDataInput":{ + "type":"structure", + "required":[ + "KeyIdentifier", + "PrimaryAccountNumber", + "GenerationAttributes" + ], + "members":{ + "KeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate card data.
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
" + }, + "GenerationAttributes":{ + "shape":"CardGenerationAttributes", + "documentation":"The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography.
" + }, + "ValidationDataLength":{ + "shape":"IntegerRangeBetween3And5Type", + "documentation":"The length of the CVV or CSC to be generated. The default value is 3.
" + } + } + }, + "GenerateCardValidationDataOutput":{ + "type":"structure", + "required":[ + "KeyArn", + "KeyCheckValue", + "ValidationData" + ], + "members":{ + "KeyArn":{ + "shape":"KeyArn", + "documentation":"The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate CVV or CSC.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + }, + "ValidationData":{ + "shape":"ValidationDataType", + "documentation":"The CVV or CSC value that Amazon Web Services Payment Cryptography generates for the card.
" + } + } + }, + "GenerateMacInput":{ + "type":"structure", + "required":[ + "KeyIdentifier", + "MessageData", + "GenerationAttributes" + ], + "members":{ + "KeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the MAC generation encryption key.
The data for which a MAC is under generation. This value must be hexBinary.
" + }, + "GenerationAttributes":{ + "shape":"MacAttributes", + "documentation":"The attributes and data values to use for MAC generation within Amazon Web Services Payment Cryptography.
" + }, + "MacLength":{ + "shape":"IntegerRangeBetween4And16", + "documentation":"The length of a MAC under generation.
" + } + } + }, + "GenerateMacOutput":{ + "type":"structure", + "required":[ + "KeyArn", + "KeyCheckValue", + "Mac" + ], + "members":{ + "KeyArn":{ + "shape":"KeyArn", + "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for MAC generation.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + }, + "Mac":{ + "shape":"MacOutputType", + "documentation":"The MAC cryptogram generated within Amazon Web Services Payment Cryptography.
" + } + } + }, + "GeneratePinDataInput":{ + "type":"structure", + "required":[ + "GenerationKeyIdentifier", + "EncryptionKeyIdentifier", + "GenerationAttributes", + "PrimaryAccountNumber", + "PinBlockFormat" + ], + "members":{ + "GenerationKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block.
The attributes and values to use for PIN, PVV, or PIN Offset generation.
" + }, + "PinDataLength":{ + "shape":"IntegerRangeBetween4And12", + "documentation":"The length of PIN under generation.
" + }, + "PrimaryAccountNumber":{ + "shape":"PrimaryAccountNumberType", + "documentation":"The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
" + }, + "PinBlockFormat":{ + "shape":"PinBlockFormatForPinData", + "documentation":"The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.
The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.
The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.
The keyARN of the pin data generation key that Amazon Web Services Payment Cryptography uses for PIN, PVV or PIN Offset generation.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + }, + "EncryptionKeyArn":{ + "shape":"KeyArn", + "documentation":"The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + }, + "EncryptedPinBlock":{ + "shape":"EncryptedPinBlockType", + "documentation":"The PIN block encrypted under PEK from Amazon Web Services Payment Cryptography. The encrypted PIN block is a composite of PAN (Primary Account Number) and PIN (Personal Identification Number), generated in accordance with ISO 9564 standard.
" + }, + "PinData":{ + "shape":"PinData", + "documentation":"The attributes and values Amazon Web Services Payment Cryptography uses for pin data generation.
" + } + } + }, + "HexEvenLengthBetween16And32":{ + "type":"string", + "max":32, + "min":16, + "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", + "sensitive":true + }, + "HexLengthBetween10And24":{ + "type":"string", + "max":24, + "min":10, + "pattern":"[0-9a-fA-F]+" + }, + "HexLengthBetween2And4":{ + "type":"string", + "max":4, + "min":2, + "pattern":"[0-9a-fA-F]+" + }, + "HexLengthBetween2And8":{ + "type":"string", + "max":8, + "min":2, + "pattern":"[0-9a-fA-F]+" + }, + "HexLengthEquals1":{ + "type":"string", + "max":1, + "min":1, + "pattern":"[0-9A-F]+" + }, + "HexLengthEquals4":{ + "type":"string", + "max":4, + "min":4, + "pattern":"[0-9a-fA-F]+" + }, + "HexLengthEquals8":{ + "type":"string", + "max":8, + "min":8, + "pattern":"[0-9a-fA-F]+" + }, + "Ibm3624NaturalPin":{ + "type":"structure", + "required":[ + "DecimalizationTable", + "PinValidationDataPadCharacter", + "PinValidationData" + ], + "members":{ + "DecimalizationTable":{ + "shape":"DecimalizationTableType", + "documentation":"The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
" + }, + "PinValidationDataPadCharacter":{ + "shape":"HexLengthEquals1", + "documentation":"The padding character for validation data.
" + }, + "PinValidationData":{ + "shape":"PinValidationDataType", + "documentation":"The unique data for cardholder identification.
" + } + }, + "documentation":"Parameters that are required to generate or verify Ibm3624 natural PIN.
" + }, + "Ibm3624PinFromOffset":{ + "type":"structure", + "required":[ + "DecimalizationTable", + "PinValidationDataPadCharacter", + "PinValidationData", + "PinOffset" + ], + "members":{ + "DecimalizationTable":{ + "shape":"DecimalizationTableType", + "documentation":"The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
" + }, + "PinValidationDataPadCharacter":{ + "shape":"HexLengthEquals1", + "documentation":"The padding character for validation data.
" + }, + "PinValidationData":{ + "shape":"PinValidationDataType", + "documentation":"The unique data for cardholder identification.
" + }, + "PinOffset":{ + "shape":"PinOffsetType", + "documentation":"The PIN offset value.
" + } + }, + "documentation":"Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.
" + }, + "Ibm3624PinOffset":{ + "type":"structure", + "required":[ + "EncryptedPinBlock", + "DecimalizationTable", + "PinValidationDataPadCharacter", + "PinValidationData" + ], + "members":{ + "EncryptedPinBlock":{ + "shape":"EncryptedPinBlockType", + "documentation":"The encrypted PIN block data. According to ISO 9564 standard, a PIN Block is an encoded representation of a payment card Personal Account Number (PAN) and the cardholder Personal Identification Number (PIN).
" + }, + "DecimalizationTable":{ + "shape":"DecimalizationTableType", + "documentation":"The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
" + }, + "PinValidationDataPadCharacter":{ + "shape":"HexLengthEquals1", + "documentation":"The padding character for validation data.
" + }, + "PinValidationData":{ + "shape":"PinValidationDataType", + "documentation":"The unique data for cardholder identification.
" + } + }, + "documentation":"Pparameters that are required to generate or verify Ibm3624 PIN offset PIN.
" + }, + "Ibm3624PinVerification":{ + "type":"structure", + "required":[ + "DecimalizationTable", + "PinValidationDataPadCharacter", + "PinValidationData", + "PinOffset" + ], + "members":{ + "DecimalizationTable":{ + "shape":"DecimalizationTableType", + "documentation":"The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
" + }, + "PinValidationDataPadCharacter":{ + "shape":"HexLengthEquals1", + "documentation":"The padding character for validation data.
" + }, + "PinValidationData":{ + "shape":"PinValidationDataType", + "documentation":"The unique data for cardholder identification.
" + }, + "PinOffset":{ + "shape":"PinOffsetType", + "documentation":"The PIN offset value.
" + } + }, + "documentation":"Parameters that are required to generate or verify Ibm3624 PIN verification PIN.
" + }, + "Ibm3624RandomPin":{ + "type":"structure", + "required":[ + "DecimalizationTable", + "PinValidationDataPadCharacter", + "PinValidationData" + ], + "members":{ + "DecimalizationTable":{ + "shape":"DecimalizationTableType", + "documentation":"The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
" + }, + "PinValidationDataPadCharacter":{ + "shape":"HexLengthEquals1", + "documentation":"The padding character for validation data.
" + }, + "PinValidationData":{ + "shape":"PinValidationDataType", + "documentation":"The unique data for cardholder identification.
" + } + }, + "documentation":"Parameters that are required to generate or verify Ibm3624 random PIN.
" + }, + "InitializationVectorType":{ + "type":"string", + "max":32, + "min":16, + "pattern":"(?:[0-9a-fA-F]{16}|[0-9a-fA-F]{32})", + "sensitive":true + }, + "IntegerRangeBetween0And6":{ + "type":"integer", + "box":true, + "max":6, + "min":0 + }, + "IntegerRangeBetween3And5Type":{ + "type":"integer", + "box":true, + "max":5, + "min":3 + }, + "IntegerRangeBetween4And12":{ + "type":"integer", + "box":true, + "max":12, + "min":4 + }, + "IntegerRangeBetween4And16":{ + "type":"integer", + "box":true, + "max":16, + "min":4 + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request processing has failed because of an unknown error, exception, or failure.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "KeyArn":{ + "type":"string", + "max":150, + "min":70, + "pattern":"arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}" + }, + "KeyArnOrKeyAliasType":{ + "type":"string", + "max":322, + "min":7, + "pattern":"arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+" + }, + "KeyCheckValue":{ + "type":"string", + "max":16, + "min":4, + "pattern":"[0-9a-fA-F]+" + }, + "KeyCheckValueAlgorithm":{ + "type":"string", + "enum":[ + "CMAC", + "ANSI_X9_24" + ] + }, + "MacAlgorithm":{ + "type":"string", + "enum":[ + "ISO9797_ALGORITHM1", + "ISO9797_ALGORITHM3", + "CMAC", + "HMAC_SHA224", + "HMAC_SHA256", + "HMAC_SHA384", + "HMAC_SHA512" + ] + }, + "MacAlgorithmDukpt":{ + "type":"structure", + "required":[ + "KeySerialNumber", + "DukptKeyVariant" + ], + "members":{ + "KeySerialNumber":{ + "shape":"HexLengthBetween10And24", + "documentation":"The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
" + }, + "DukptKeyVariant":{ + "shape":"DukptKeyVariant", + "documentation":"The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
" + }, + "DukptDerivationType":{ + "shape":"DukptDerivationType", + "documentation":"The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.
Parameters required for DUKPT MAC generation and verification.
" + }, + "MacAlgorithmEmv":{ + "type":"structure", + "required":[ + "MajorKeyDerivationMode", + "PrimaryAccountNumber", + "PanSequenceNumber", + "SessionKeyDerivationMode", + "SessionKeyDerivationValue" + ], + "members":{ + "MajorKeyDerivationMode":{ + "shape":"MajorKeyDerivationMode", + "documentation":"The method to use when deriving the master key for EMV MAC generation or verification.
" + }, + "PrimaryAccountNumber":{ + "shape":"PrimaryAccountNumberType", + "documentation":"The Primary Account Number (PAN), a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" + }, + "PanSequenceNumber":{ + "shape":"NumberLengthEquals2", + "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" + }, + "SessionKeyDerivationMode":{ + "shape":"SessionKeyDerivationMode", + "documentation":"The method of deriving a session key for EMV MAC generation or verification.
" + }, + "SessionKeyDerivationValue":{ + "shape":"SessionKeyDerivationValue", + "documentation":"Parameters that are required to generate session key for EMV generation and verification.
" + } + }, + "documentation":"Parameters that are required for EMV MAC generation and verification.
" + }, + "MacAttributes":{ + "type":"structure", + "members":{ + "Algorithm":{ + "shape":"MacAlgorithm", + "documentation":"The encryption algorithm for MAC generation or verification.
" + }, + "EmvMac":{ + "shape":"MacAlgorithmEmv", + "documentation":"Parameters that are required for MAC generation or verification using EMV MAC algorithm.
" + }, + "DukptIso9797Algorithm1":{ + "shape":"MacAlgorithmDukpt", + "documentation":"Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.
" + }, + "DukptIso9797Algorithm3":{ + "shape":"MacAlgorithmDukpt", + "documentation":"Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm3.
" + }, + "DukptCmac":{ + "shape":"MacAlgorithmDukpt", + "documentation":"Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
" + } + }, + "documentation":"Parameters that are required for DUKPT, HMAC, or EMV MAC generation or verification.
", + "union":true + }, + "MacOutputType":{ + "type":"string", + "max":128, + "min":4, + "pattern":"[0-9a-fA-F]+", + "sensitive":true + }, + "MacType":{ + "type":"string", + "max":128, + "min":4, + "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", + "sensitive":true + }, + "MajorKeyDerivationMode":{ + "type":"string", + "enum":[ + "EMV_OPTION_A", + "EMV_OPTION_B" + ] + }, + "MessageDataType":{ + "type":"string", + "max":4096, + "min":2, + "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", + "sensitive":true + }, + "NumberLengthEquals2":{ + "type":"string", + "max":2, + "min":2, + "pattern":"[0-9]+" + }, + "PaddingType":{ + "type":"string", + "enum":[ + "PKCS1", + "OAEP_SHA1", + "OAEP_SHA256", + "OAEP_SHA512" + ] + }, + "PinBlockFormatForPinData":{ + "type":"string", + "enum":[ + "ISO_FORMAT_0", + "ISO_FORMAT_3" + ] + }, + "PinData":{ + "type":"structure", + "members":{ + "PinOffset":{ + "shape":"PinOffsetType", + "documentation":"The PIN offset value.
" + }, + "VerificationValue":{ + "shape":"VerificationValueType", + "documentation":"The unique data to identify a cardholder. In most cases, this is the same as cardholder's Primary Account Number (PAN). If a value is not provided, it defaults to PAN.
" + } + }, + "documentation":"Parameters that are required to generate, translate, or verify PIN data.
", + "union":true + }, + "PinGenerationAttributes":{ + "type":"structure", + "members":{ + "VisaPin":{ + "shape":"VisaPin", + "documentation":"Parameters that are required to generate or verify Visa PIN.
" + }, + "VisaPinVerificationValue":{ + "shape":"VisaPinVerificationValue", + "documentation":"Parameters that are required to generate or verify Visa PIN Verification Value (PVV).
" + }, + "Ibm3624PinOffset":{ + "shape":"Ibm3624PinOffset", + "documentation":"Parameters that are required to generate or verify Ibm3624 PIN offset PIN.
" + }, + "Ibm3624NaturalPin":{ + "shape":"Ibm3624NaturalPin", + "documentation":"Parameters that are required to generate or verify Ibm3624 natural PIN.
" + }, + "Ibm3624RandomPin":{ + "shape":"Ibm3624RandomPin", + "documentation":"Parameters that are required to generate or verify Ibm3624 random PIN.
" + }, + "Ibm3624PinFromOffset":{ + "shape":"Ibm3624PinFromOffset", + "documentation":"Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.
" + } + }, + "documentation":"Parameters that are required for PIN data generation.
", + "union":true + }, + "PinOffsetType":{ + "type":"string", + "max":12, + "min":4, + "pattern":"[0-9]+", + "sensitive":true + }, + "PinValidationDataType":{ + "type":"string", + "max":16, + "min":4, + "pattern":"[0-9]+", + "sensitive":true + }, + "PinVerificationAttributes":{ + "type":"structure", + "members":{ + "VisaPin":{ + "shape":"VisaPinVerification", + "documentation":"Parameters that are required to generate or verify Visa PIN.
" + }, + "Ibm3624Pin":{ + "shape":"Ibm3624PinVerification", + "documentation":"Parameters that are required to generate or verify Ibm3624 PIN.
" + } + }, + "documentation":"Parameters that are required for PIN data verification.
", + "union":true + }, + "PlainTextOutputType":{ + "type":"string", + "max":4096, + "min":16, + "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", + "sensitive":true + }, + "PlainTextType":{ + "type":"string", + "max":4064, + "min":16, + "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", + "sensitive":true + }, + "PrimaryAccountNumberType":{ + "type":"string", + "max":19, + "min":12, + "pattern":"[0-9]+", + "sensitive":true + }, + "ProprietaryAuthenticationDataType":{ + "type":"string", + "max":16, + "min":1, + "pattern":"[0-9a-fA-F]+", + "sensitive":true + }, + "ReEncryptDataInput":{ + "type":"structure", + "required":[ + "IncomingKeyIdentifier", + "OutgoingKeyIdentifier", + "CipherText", + "IncomingEncryptionAttributes", + "OutgoingEncryptionAttributes" + ], + "members":{ + "IncomingKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the encryption key of incoming ciphertext data.
When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.
", + "location":"uri", + "locationName":"IncomingKeyIdentifier" + }, + "OutgoingKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
Ciphertext to be encrypted. The minimum allowed length is 16 bytes and maximum allowed length is 4096 bytes.
" + }, + "IncomingEncryptionAttributes":{ + "shape":"ReEncryptionAttributes", + "documentation":"The attributes and values for incoming ciphertext.
" + }, + "OutgoingEncryptionAttributes":{ + "shape":"ReEncryptionAttributes", + "documentation":"The attributes and values for outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
" + }, + "IncomingWrappedKey":{ + "shape":"WrappedKey", + "documentation":"The WrappedKeyBlock containing the encryption key of incoming ciphertext data.
" + }, + "OutgoingWrappedKey":{ + "shape":"WrappedKey", + "documentation":"The WrappedKeyBlock containing the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
" + } + } + }, + "ReEncryptDataOutput":{ + "type":"structure", + "required":[ + "KeyArn", + "KeyCheckValue", + "CipherText" + ], + "members":{ + "KeyArn":{ + "shape":"KeyArn", + "documentation":"The keyARN (Amazon Resource Name) of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
" + }, + "KeyCheckValue":{ + "shape":"KeyCheckValue", + "documentation":"The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + }, + "CipherText":{ + "shape":"CipherTextType", + "documentation":"The encrypted ciphertext.
" + } + } + }, + "ReEncryptionAttributes":{ + "type":"structure", + "members":{ + "Symmetric":{ + "shape":"SymmetricEncryptionAttributes", + "documentation":"Parameters that are required to encrypt data using symmetric keys.
" + }, + "Dukpt":{"shape":"DukptEncryptionAttributes"} + }, + "documentation":"Parameters that are required to perform reencryption operation.
", + "union":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"The resource that is missing.
" + } + }, + "documentation":"The request was denied due to an invalid resource error.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ServiceCodeType":{ + "type":"string", + "max":3, + "min":3, + "pattern":"[0-9]+", + "sensitive":true + }, + "SessionDerivationDataType":{ + "type":"string", + "max":16, + "min":16, + "pattern":"[0-9a-fA-F]+", + "sensitive":true + }, + "SessionKeyAmex":{ + "type":"structure", + "required":[ + "PrimaryAccountNumber", + "PanSequenceNumber" + ], + "members":{ + "PrimaryAccountNumber":{ + "shape":"PrimaryAccountNumberType", + "documentation":"The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" + }, + "PanSequenceNumber":{ + "shape":"NumberLengthEquals2", + "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" + } + }, + "documentation":"Parameters to derive session key for an Amex payment card.
" + }, + "SessionKeyDerivation":{ + "type":"structure", + "members":{ + "EmvCommon":{ + "shape":"SessionKeyEmvCommon", + "documentation":"Parameters to derive session key for an Emv common payment card for ARQC verification.
" + }, + "Mastercard":{ + "shape":"SessionKeyMastercard", + "documentation":"Parameters to derive session key for a Mastercard payment card for ARQC verification.
" + }, + "Emv2000":{ + "shape":"SessionKeyEmv2000", + "documentation":"Parameters to derive session key for an Emv2000 payment card for ARQC verification.
" + }, + "Amex":{ + "shape":"SessionKeyAmex", + "documentation":"Parameters to derive session key for an Amex payment card for ARQC verification.
" + }, + "Visa":{ + "shape":"SessionKeyVisa", + "documentation":"Parameters to derive session key for a Visa payment cardfor ARQC verification.
" + } + }, + "documentation":"Parameters to derive a session key for Authorization Response Cryptogram (ARQC) verification.
", + "union":true + }, + "SessionKeyDerivationMode":{ + "type":"string", + "enum":[ + "EMV_COMMON_SESSION_KEY", + "EMV2000", + "AMEX", + "MASTERCARD_SESSION_KEY", + "VISA" + ] + }, + "SessionKeyDerivationValue":{ + "type":"structure", + "members":{ + "ApplicationCryptogram":{ + "shape":"ApplicationCryptogramType", + "documentation":"The cryptogram provided by the terminal during transaction processing.
" + }, + "ApplicationTransactionCounter":{ + "shape":"HexLengthBetween2And4", + "documentation":"The transaction counter that is provided by the terminal during transaction processing.
" + } + }, + "documentation":"Parameters to derive session key value using a MAC EMV algorithm.
", + "union":true + }, + "SessionKeyEmv2000":{ + "type":"structure", + "required":[ + "PrimaryAccountNumber", + "PanSequenceNumber", + "ApplicationTransactionCounter" + ], + "members":{ + "PrimaryAccountNumber":{ + "shape":"PrimaryAccountNumberType", + "documentation":"The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" + }, + "PanSequenceNumber":{ + "shape":"NumberLengthEquals2", + "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" + }, + "ApplicationTransactionCounter":{ + "shape":"HexLengthBetween2And4", + "documentation":"The transaction counter that is provided by the terminal during transaction processing.
" + } + }, + "documentation":"Parameters to derive session key for an Emv2000 payment card for ARQC verification.
" + }, + "SessionKeyEmvCommon":{ + "type":"structure", + "required":[ + "PrimaryAccountNumber", + "PanSequenceNumber", + "ApplicationTransactionCounter" + ], + "members":{ + "PrimaryAccountNumber":{ + "shape":"PrimaryAccountNumberType", + "documentation":"The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" + }, + "PanSequenceNumber":{ + "shape":"NumberLengthEquals2", + "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" + }, + "ApplicationTransactionCounter":{ + "shape":"HexLengthBetween2And4", + "documentation":"The transaction counter that is provided by the terminal during transaction processing.
" + } + }, + "documentation":"Parameters to derive session key for an Emv common payment card for ARQC verification.
" + }, + "SessionKeyMastercard":{ + "type":"structure", + "required":[ + "PrimaryAccountNumber", + "PanSequenceNumber", + "ApplicationTransactionCounter", + "UnpredictableNumber" + ], + "members":{ + "PrimaryAccountNumber":{ + "shape":"PrimaryAccountNumberType", + "documentation":"The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" + }, + "PanSequenceNumber":{ + "shape":"NumberLengthEquals2", + "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" + }, + "ApplicationTransactionCounter":{ + "shape":"HexLengthBetween2And4", + "documentation":"The transaction counter that is provided by the terminal during transaction processing.
" + }, + "UnpredictableNumber":{ + "shape":"HexLengthBetween2And8", + "documentation":"A random number generated by the issuer.
" + } + }, + "documentation":"Parameters to derive session key for Mastercard payment card for ARQC verification.
" + }, + "SessionKeyVisa":{ + "type":"structure", + "required":[ + "PrimaryAccountNumber", + "PanSequenceNumber" + ], + "members":{ + "PrimaryAccountNumber":{ + "shape":"PrimaryAccountNumberType", + "documentation":"The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" + }, + "PanSequenceNumber":{ + "shape":"NumberLengthEquals2", + "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" + } + }, + "documentation":"Parameters to derive session key for Visa payment card for ARQC verification.
" + }, + "String":{"type":"string"}, + "SymmetricEncryptionAttributes":{ + "type":"structure", + "required":["Mode"], + "members":{ + "Mode":{ + "shape":"EncryptionMode", + "documentation":"The block cipher method to use for encryption.
" + }, + "InitializationVector":{ + "shape":"InitializationVectorType", + "documentation":"An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
" + }, + "PaddingType":{ + "shape":"PaddingType", + "documentation":"The padding to be included with the data.
" + } + }, + "documentation":"Parameters requried to encrypt plaintext data using symmetric keys.
" + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "Tr31WrappedKeyBlock":{ + "type":"string", + "max":9984, + "min":56, + "pattern":"[0-9A-Z]+", + "sensitive":true + }, + "TrackDataType":{ + "type":"string", + "max":160, + "min":2, + "pattern":"[0-9a-fA-F]+", + "sensitive":true + }, + "TransactionDataType":{ + "type":"string", + "max":1024, + "min":2, + "pattern":"[0-9a-fA-F]+", + "sensitive":true + }, + "TranslatePinDataInput":{ + "type":"structure", + "required":[ + "IncomingKeyIdentifier", + "OutgoingKeyIdentifier", + "IncomingTranslationAttributes", + "OutgoingTranslationAttributes", + "EncryptedPinBlock" + ], + "members":{ + "IncomingKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the encryption key under which incoming PIN block data is encrypted. This key type can be PEK or BDK.
When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key for PIN block. Otherwise, it is the key identifier used to perform the operation.
" + }, + "OutgoingKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the encryption key for encrypting outgoing PIN block data. This key type can be PEK or BDK.
The format of the incoming PIN block data for translation within Amazon Web Services Payment Cryptography.
" + }, + "OutgoingTranslationAttributes":{ + "shape":"TranslationIsoFormats", + "documentation":"The format of the outgoing PIN block data after translation by Amazon Web Services Payment Cryptography.
" + }, + "EncryptedPinBlock":{ + "shape":"HexEvenLengthBetween16And32", + "documentation":"The encrypted PIN block data that Amazon Web Services Payment Cryptography translates.
" + }, + "IncomingDukptAttributes":{ + "shape":"DukptDerivationAttributes", + "documentation":"The attributes and values to use for incoming DUKPT encryption key for PIN block translation.
" + }, + "OutgoingDukptAttributes":{ + "shape":"DukptDerivationAttributes", + "documentation":"The attributes and values to use for outgoing DUKPT encryption key after PIN block translation.
" + }, + "IncomingWrappedKey":{ + "shape":"WrappedKey", + "documentation":"The WrappedKeyBlock containing the encryption key under which incoming PIN block data is encrypted.
" + }, + "OutgoingWrappedKey":{ + "shape":"WrappedKey", + "documentation":"The WrappedKeyBlock containing the encryption key for encrypting outgoing PIN block data.
" + } + } + }, + "TranslatePinDataOutput":{ + "type":"structure", + "required":[ + "PinBlock", + "KeyArn", + "KeyCheckValue" + ], + "members":{ + "PinBlock":{ + "shape":"EncryptedPinBlockType", + "documentation":"The outgoing encrypted PIN block data after translation.
" + }, + "KeyArn":{ + "shape":"KeyArn", + "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to encrypt outgoing PIN block data after translation.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + } + } + }, + "TranslationIsoFormats":{ + "type":"structure", + "members":{ + "IsoFormat0":{ + "shape":"TranslationPinDataIsoFormat034", + "documentation":"Parameters that are required for ISO9564 PIN format 0 tranlation.
" + }, + "IsoFormat1":{ + "shape":"TranslationPinDataIsoFormat1", + "documentation":"Parameters that are required for ISO9564 PIN format 1 tranlation.
" + }, + "IsoFormat3":{ + "shape":"TranslationPinDataIsoFormat034", + "documentation":"Parameters that are required for ISO9564 PIN format 3 tranlation.
" + }, + "IsoFormat4":{ + "shape":"TranslationPinDataIsoFormat034", + "documentation":"Parameters that are required for ISO9564 PIN format 4 tranlation.
" + } + }, + "documentation":"Parameters that are required for translation between ISO9564 PIN block formats 0,1,3,4.
", + "union":true + }, + "TranslationPinDataIsoFormat034":{ + "type":"structure", + "required":["PrimaryAccountNumber"], + "members":{ + "PrimaryAccountNumber":{ + "shape":"PrimaryAccountNumberType", + "documentation":"The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" + } + }, + "documentation":"Parameters that are required for tranlation between ISO9564 PIN format 0,3,4 tranlation.
" + }, + "TranslationPinDataIsoFormat1":{ + "type":"structure", + "members":{ + }, + "documentation":"Parameters that are required for ISO9564 PIN format 1 tranlation.
" + }, + "ValidationDataType":{ + "type":"string", + "max":5, + "min":3, + "pattern":"[0-9]+", + "sensitive":true + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "fieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"The request was denied due to an invalid request error.
" + } + }, + "documentation":"The request was denied due to an invalid request error.
", + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "path", + "message" + ], + "members":{ + "path":{ + "shape":"String", + "documentation":"The request was denied due to an invalid request error.
" + }, + "message":{ + "shape":"String", + "documentation":"The request was denied due to an invalid request error.
" + } + }, + "documentation":"The request was denied due to an invalid request error.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "VerificationFailedException":{ + "type":"structure", + "required":[ + "Reason", + "Message" + ], + "members":{ + "Reason":{ + "shape":"VerificationFailedReason", + "documentation":"The reason for the exception.
" + }, + "Message":{"shape":"String"} + }, + "documentation":"This request failed verification.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "VerificationFailedReason":{ + "type":"string", + "enum":[ + "INVALID_MAC", + "INVALID_PIN", + "INVALID_VALIDATION_DATA", + "INVALID_AUTH_REQUEST_CRYPTOGRAM" + ] + }, + "VerificationValueType":{ + "type":"string", + "max":12, + "min":4, + "pattern":"[0-9]+", + "sensitive":true + }, + "VerifyAuthRequestCryptogramInput":{ + "type":"structure", + "required":[ + "KeyIdentifier", + "TransactionData", + "AuthRequestCryptogram", + "MajorKeyDerivationMode", + "SessionKeyDerivationAttributes" + ], + "members":{ + "KeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.
The transaction data that Amazon Web Services Payment Cryptography uses for ARQC verification. The same transaction is used for ARQC generation outside of Amazon Web Services Payment Cryptography.
" + }, + "AuthRequestCryptogram":{ + "shape":"AuthRequestCryptogramType", + "documentation":"The auth request cryptogram imported into Amazon Web Services Payment Cryptography for ARQC verification using a major encryption key and transaction data.
" + }, + "MajorKeyDerivationMode":{ + "shape":"MajorKeyDerivationMode", + "documentation":"The method to use when deriving the major encryption key for ARQC verification within Amazon Web Services Payment Cryptography. The same key derivation mode was used for ARQC generation outside of Amazon Web Services Payment Cryptography.
" + }, + "SessionKeyDerivationAttributes":{ + "shape":"SessionKeyDerivation", + "documentation":"The attributes and values to use for deriving a session key for ARQC verification within Amazon Web Services Payment Cryptography. The same attributes were used for ARQC generation outside of Amazon Web Services Payment Cryptography.
" + }, + "AuthResponseAttributes":{ + "shape":"CryptogramAuthResponse", + "documentation":"The attributes and values for auth request cryptogram verification. These parameters are required in case using ARPC Method 1 or Method 2 for ARQC verification.
" + } + } + }, + "VerifyAuthRequestCryptogramOutput":{ + "type":"structure", + "required":[ + "KeyArn", + "KeyCheckValue" + ], + "members":{ + "KeyArn":{ + "shape":"KeyArn", + "documentation":"The keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + }, + "AuthResponseValue":{ + "shape":"AuthResponseValueType", + "documentation":"The result for ARQC verification or ARPC generation within Amazon Web Services Payment Cryptography.
" + } + } + }, + "VerifyCardValidationDataInput":{ + "type":"structure", + "required":[ + "KeyIdentifier", + "PrimaryAccountNumber", + "VerificationAttributes", + "ValidationData" + ], + "members":{ + "KeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify card data.
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
" + }, + "VerificationAttributes":{ + "shape":"CardVerificationAttributes", + "documentation":"The algorithm to use for verification of card data within Amazon Web Services Payment Cryptography.
" + }, + "ValidationData":{ + "shape":"ValidationDataType", + "documentation":"The CVV or CSC value for use for card data verification within Amazon Web Services Payment Cryptography.
" + } + } + }, + "VerifyCardValidationDataOutput":{ + "type":"structure", + "required":[ + "KeyArn", + "KeyCheckValue" + ], + "members":{ + "KeyArn":{ + "shape":"KeyArn", + "documentation":"The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify CVV or CSC.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + } + } + }, + "VerifyMacInput":{ + "type":"structure", + "required":[ + "KeyIdentifier", + "MessageData", + "Mac", + "VerificationAttributes" + ], + "members":{ + "KeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to verify MAC data.
The data on for which MAC is under verification. This value must be hexBinary.
" + }, + "Mac":{ + "shape":"MacType", + "documentation":"The MAC being verified.
" + }, + "VerificationAttributes":{ + "shape":"MacAttributes", + "documentation":"The attributes and data values to use for MAC verification within Amazon Web Services Payment Cryptography.
" + }, + "MacLength":{ + "shape":"IntegerRangeBetween4And16", + "documentation":"The length of the MAC.
" + } + } + }, + "VerifyMacOutput":{ + "type":"structure", + "required":[ + "KeyArn", + "KeyCheckValue" + ], + "members":{ + "KeyArn":{ + "shape":"KeyArn", + "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for MAC verification.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + } + } + }, + "VerifyPinDataInput":{ + "type":"structure", + "required":[ + "VerificationKeyIdentifier", + "EncryptionKeyIdentifier", + "VerificationAttributes", + "EncryptedPinBlock", + "PrimaryAccountNumber", + "PinBlockFormat" + ], + "members":{ + "VerificationKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the PIN verification key.
The keyARN of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.
The attributes and values for PIN data verification.
" + }, + "EncryptedPinBlock":{ + "shape":"EncryptedPinBlockType", + "documentation":"The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.
" + }, + "PrimaryAccountNumber":{ + "shape":"PrimaryAccountNumberType", + "documentation":"The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
" + }, + "PinBlockFormat":{ + "shape":"PinBlockFormatForPinData", + "documentation":"The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.
The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.
The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.
The length of PIN being verified.
" + }, + "DukptAttributes":{ + "shape":"DukptAttributes", + "documentation":"The attributes and values for the DUKPT encrypted PIN block data.
" + } + } + }, + "VerifyPinDataOutput":{ + "type":"structure", + "required":[ + "VerificationKeyArn", + "VerificationKeyCheckValue", + "EncryptionKeyArn", + "EncryptionKeyCheckValue" + ], + "members":{ + "VerificationKeyArn":{ + "shape":"KeyArn", + "documentation":"The keyARN of the PIN encryption key that Amazon Web Services Payment Cryptography uses for PIN or PIN Offset verification.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + }, + "EncryptionKeyArn":{ + "shape":"KeyArn", + "documentation":"The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + } + } + }, + "VisaPin":{ + "type":"structure", + "required":["PinVerificationKeyIndex"], + "members":{ + "PinVerificationKeyIndex":{ + "shape":"IntegerRangeBetween0And6", + "documentation":"The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
" + } + }, + "documentation":"Parameters that are required to generate or verify Visa PIN.
" + }, + "VisaPinVerification":{ + "type":"structure", + "required":[ + "PinVerificationKeyIndex", + "VerificationValue" + ], + "members":{ + "PinVerificationKeyIndex":{ + "shape":"IntegerRangeBetween0And6", + "documentation":"The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
" + }, + "VerificationValue":{ + "shape":"VerificationValueType", + "documentation":"Parameters that are required to generate or verify Visa PVV (PIN Verification Value).
" + } + }, + "documentation":"Parameters that are required to generate or verify Visa PIN.
" + }, + "VisaPinVerificationValue":{ + "type":"structure", + "required":[ + "EncryptedPinBlock", + "PinVerificationKeyIndex" + ], + "members":{ + "EncryptedPinBlock":{ + "shape":"EncryptedPinBlockType", + "documentation":"The encrypted PIN block data to verify.
" + }, + "PinVerificationKeyIndex":{ + "shape":"IntegerRangeBetween0And6", + "documentation":"The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
" + } + }, + "documentation":"Parameters that are required to generate or verify Visa PVV (PIN Verification Value).
" + }, + "WrappedKey":{ + "type":"structure", + "required":["WrappedKeyMaterial"], + "members":{ + "WrappedKeyMaterial":{ + "shape":"WrappedKeyMaterial", + "documentation":"Parameter information of a WrappedKeyBlock for encryption key exchange.
" + }, + "KeyCheckValueAlgorithm":{ + "shape":"KeyCheckValueAlgorithm", + "documentation":"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.
" + } + }, + "documentation":"Parameter information of a WrappedKeyBlock for encryption key exchange.
" + }, + "WrappedKeyMaterial":{ + "type":"structure", + "members":{ + "Tr31KeyBlock":{ + "shape":"Tr31WrappedKeyBlock", + "documentation":"The TR-31 wrapped key block.
" + } + }, + "documentation":"Parameter information of a WrappedKeyBlock for encryption key exchange.
", + "union":true + } + }, + "documentation":"You use the Amazon Web Services Payment Cryptography Data Plane to manage how encryption keys are used for payment-related transaction processing and associated cryptographic operations. You can encrypt, decrypt, generate, verify, and translate payment-related cryptographic operations in Amazon Web Services Payment Cryptography. For more information, see Data operations in the Amazon Web Services Payment Cryptography User Guide.
To manage your encryption keys, you use the Amazon Web Services Payment Cryptography Control Plane. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys.
" +} diff --git a/testbed/boto__botocore/botocore/data/payment-cryptography-data/2022-02-03/waiters-2.json b/testbed/boto__botocore/botocore/data/payment-cryptography-data/2022-02-03/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..13f60ee66be6a3d75208653e2bd7b563561adacc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/payment-cryptography-data/2022-02-03/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/testbed/boto__botocore/botocore/data/payment-cryptography/2021-09-14/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/payment-cryptography/2021-09-14/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..26afb5d773837620dd9553c4f30dede1755b0da6 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/payment-cryptography/2021-09-14/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlplane.payment-cryptography.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlplane.payment-cryptography.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/payment-cryptography/2021-09-14/paginators-1.json b/testbed/boto__botocore/botocore/data/payment-cryptography/2021-09-14/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..02af499b6530a04956593cc47f962ae160de33d2 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/payment-cryptography/2021-09-14/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListAliases": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Aliases" + }, + "ListKeys": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Keys" + }, + "ListTagsForResource": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Tags" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/payment-cryptography/2021-09-14/service-2.json b/testbed/boto__botocore/botocore/data/payment-cryptography/2021-09-14/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..fa667a29b9a30473dfe6d113b4d65ab24274f4b5 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/payment-cryptography/2021-09-14/service-2.json @@ -0,0 +1,1823 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-09-14", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"controlplane.payment-cryptography", + "jsonVersion":"1.0", + "protocol":"json", + "protocols":["json"], + "serviceFullName":"Payment Cryptography Control Plane", + "serviceId":"Payment Cryptography", + "signatureVersion":"v4", + "signingName":"payment-cryptography", + "targetPrefix":"PaymentCryptographyControlPlane", + "uid":"payment-cryptography-2021-09-14" + }, + "operations":{ + "CreateAlias":{ + "name":"CreateAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAliasInput"}, + "output":{"shape":"CreateAliasOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData.
You can associate the alias with any key in the same Amazon Web Services Region. Each alias is associated with only one key at a time, but a key can have multiple aliases. You can't create an alias without a key. The alias must be unique in the account and Amazon Web Services Region, but you can create another alias with the same name in a different Amazon Web Services Region.
To change the key that's associated with the alias, call UpdateAlias. To delete the alias, call DeleteAlias. These operations don't affect the underlying key. To get the alias that you created, call ListAliases.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
", + "idempotent":true + }, + "CreateKey":{ + "name":"CreateKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateKeyInput"}, + "output":{"shape":"CreateKeyOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region. You use keys for cryptographic functions such as encryption and decryption.
In addition to the key material used in cryptographic operations, an Amazon Web Services Payment Cryptography key includes metadata such as the key ARN, key usage, key origin, creation date, description, and key state.
When you create a key, you specify both immutable and mutable data about the key. The immutable data contains key attributes that define the scope and cryptographic operations that you can perform using the key, for example key class (example: SYMMETRIC_KEY), key algorithm (example: TDES_2KEY), key usage (example: TR31_P0_PIN_ENCRYPTION_KEY) and key modes of use (example: Encrypt). For information about valid combinations of key attributes, see Understanding key attributes in the Amazon Web Services Payment Cryptography User Guide. The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation.
Amazon Web Services Payment Cryptography binds key attributes to keys using key blocks when you store or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "DeleteAlias":{ + "name":"DeleteAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAliasInput"}, + "output":{"shape":"DeleteAliasOutput"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes the alias, but doesn't affect the underlying key.
Each key can have multiple aliases. To get the aliases of all keys, use the UpdateAlias operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
", + "idempotent":true + }, + "DeleteKey":{ + "name":"DeleteKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteKeyInput"}, + "output":{"shape":"DeleteKeyOutput"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes the key material and metadata associated with Amazon Web Services Payment Cryptography key.
Key deletion is irreversible. After a key is deleted, you can't perform cryptographic operations using the key. For example, you can't decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call this operation, Amazon Web Services Payment Cryptography disables the specified key but doesn't delete it until after a waiting period set using DeleteKeyInDays. The default waiting period is 7 days. During the waiting period, the KeyState is DELETE_PENDING. After the key is deleted, the KeyState is DELETE_COMPLETE.
You should delete a key only when you are sure that you don't need to use it anymore and no other parties are utilizing this key. If you aren't sure, consider deactivating it instead by calling StopKeyUsage.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
", + "idempotent":true + }, + "ExportKey":{ + "name":"ExportKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExportKeyInput"}, + "output":{"shape":"ExportKeyOutput"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Exports a key from Amazon Web Services Payment Cryptography.
Amazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ExportKey you can export symmetric keys using either symmetric and asymmetric key exchange mechanisms. Using this operation, you can share your Amazon Web Services Payment Cryptography generated keys with other service partners to perform cryptographic operations outside of Amazon Web Services Payment Cryptography
For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm and RSA wrap and unwrap key exchange mechanism. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK). After which you can export working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.
The TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.
You can also use ExportKey functionality to generate and export an IPEK (Initial Pin Encryption Key) from Amazon Web Services Payment Cryptography using either TR-31 or TR-34 export key exchange. IPEK is generated from BDK (Base Derivation Key) and ExportDukptInitialKey attribute KSN (KeySerialNumber). The generated IPEK does not persist within Amazon Web Services Payment Cryptography and has to be re-generated each time during export.
For key exchange using TR-31 or TR-34 key blocks, you can also export optional blocks within the key block header which contain additional attribute information about the key. The KeyVersion within KeyBlockHeaders indicates the version of the key within the key block. Furthermore, KeyExportability within KeyBlockHeaders can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.
The OptionalBlocks contain the additional data related to the key. For information on data type that can be included within optional blocks, refer to ASC X9.143-2022.
Data included in key block headers is signed but transmitted in clear text. Sensitive or confidential information should not be included in optional blocks. Refer to ASC X9.143-2022 standard for information on allowed data type.
To export initial keys (KEK) or IPEK using TR-34
Using this operation, you can export initial key using TR-34 asymmetric key exchange. You can only export KEK generated within Amazon Web Services Payment Cryptography. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Device (KRD). During key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export and KRD is the user receiving the key.
To initiate TR-34 key export, the KRD must obtain an export token by calling GetParametersForExport. This operation also generates a key pair for the purpose of key export, signs the key and returns back the signing public key certificate (also known as KDH signing certificate) and root certificate chain. The KDH uses the private key to sign the the export payload and the signing public key certificate is provided to KRD to verify the signature. The KRD can import the root certificate into its Hardware Security Module (HSM), as required. The export token and the associated KDH signing certificate expires after 7 days.
Next the KRD generates a key pair for the the purpose of encrypting the KDH key and provides the public key cerificate (also known as KRD wrapping certificate) back to KDH. The KRD will also import the root cerificate chain into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey. The KDH, Amazon Web Services Payment Cryptography, will use the KRD wrapping cerificate to encrypt (wrap) the key under export and signs it with signing private key to generate a TR-34 WrappedKeyBlock. For more information on TR-34 key export, see section Exporting symmetric keys in the Amazon Web Services Payment Cryptography User Guide.
Set the following parameters:
ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.
ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.
KeyMaterial: Use Tr34KeyBlock parameters.
CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed the KRD wrapping key certificate.
ExportToken: Obtained from KDH by calling GetParametersForImport.
WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KRD wrapping key Amazon Web Services Payment Cryptography uses for encryption of the TR-34 export payload. This certificate must be signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography.
When this operation is successful, Amazon Web Services Payment Cryptography returns the KEK or IPEK as a TR-34 WrappedKeyBlock.
To export initial keys (KEK) or IPEK using RSA Wrap and Unwrap
Using this operation, you can export initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate export, generate an asymmetric key pair on the receiving HSM and obtain the public key certificate in PEM format (base64 encoded) for the purpose of wrapping and the root certifiate chain. Import the root certificate into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey.
Next call ExportKey and set the following parameters:
CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed wrapping key certificate.
KeyMaterial: Set to KeyCryptogram.
WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) obtained by the receiving HSM and signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography. The receiving HSM uses its private key component to unwrap the WrappedKeyCryptogram.
When this operation is successful, Amazon Web Services Payment Cryptography returns the WrappedKeyCryptogram.
To export working keys or IPEK using TR-31
Using this operation, you can export working keys or IPEK using TR-31 symmetric key exchange. In TR-31, you must use an initial key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use CreateKey or ImportKey.
Set the following parameters:
ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.
ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.
KeyMaterial: Use Tr31KeyBlock parameters.
When this operation is successful, Amazon Web Services Payment Cryptography returns the working key or IPEK as a TR-31 WrappedKeyBlock.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "GetAlias":{ + "name":"GetAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAliasInput"}, + "output":{"shape":"GetAliasOutput"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets the Amazon Web Services Payment Cryptography key associated with the alias.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "GetKey":{ + "name":"GetKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetKeyInput"}, + "output":{"shape":"GetKeyOutput"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "GetParametersForExport":{ + "name":"GetParametersForExport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetParametersForExportInput"}, + "output":{"shape":"GetParametersForExportOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.
The signing key certificate signs the wrapped key under export within the TR-34 key payload. The export token and signing key certificate must be in place and operational before calling ExportKey. The export token expires in 7 days. You can use the same export token to export multiple keys from your service account.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "GetParametersForImport":{ + "name":"GetParametersForImport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetParametersForImportInput"}, + "output":{"shape":"GetParametersForImportOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram import into Amazon Web Services Payment Cryptography.
The wrapping key certificate wraps the key under import. The import token and wrapping key certificate must be in place and operational before calling ImportKey. The import token expires in 7 days. You can use the same import token to import multiple keys into your service account.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "GetPublicKeyCertificate":{ + "name":"GetPublicKeyCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPublicKeyCertificateInput"}, + "output":{"shape":"GetPublicKeyCertificateOutput"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography.
Unlike the private key of an asymmetric key, which never leaves Amazon Web Services Payment Cryptography unencrypted, callers with GetPublicKeyCertificate permission can download the public key certificate of the asymmetric key. You can share the public key certificate to allow others to encrypt messages and verify signatures outside of Amazon Web Services Payment Cryptography
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
" + }, + "ImportKey":{ + "name":"ImportKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportKeyInput"}, + "output":{"shape":"ImportKeyOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.
Amazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ImportKey you can import symmetric keys using either symmetric and asymmetric key exchange mechanisms.
For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm and RSA wrap and unwrap key exchange mechanisms. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK) or Zone Master Key (ZMK). After which you can import working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.
The TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.
You can also import a root public key certificate, used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.
To import a public root key certificate
You can also import a root public key certificate, used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.
To import a public root key certificate
Using this operation, you can import the public component (in PEM cerificate format) of your private root key. You can use the imported public root key certificate for digital signatures, for example signing wrapping key or signing key in TR-34, within your Amazon Web Services Payment Cryptography account.
Set the following parameters:
KeyMaterial: RootCertificatePublicKey
KeyClass: PUBLIC_KEY
KeyModesOfUse: Verify
KeyUsage: TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE
PublicKeyCertificate: The public key certificate in PEM format (base64 encoded) of the private root key under import.
To import a trusted public key certificate
The root public key certificate must be in place and operational before you import a trusted public key certificate. Set the following parameters:
KeyMaterial: TrustedCertificatePublicKey
CertificateAuthorityPublicKeyIdentifier: KeyArn of the RootCertificatePublicKey.
KeyModesOfUse and KeyUsage: Corresponding to the cryptographic operations such as wrap, sign, or encrypt that you will allow the trusted public key certificate to perform.
PublicKeyCertificate: The trusted public key certificate in PEM format (base64 encoded) under import.
To import initial keys (KEK or ZMK or similar) using TR-34
Using this operation, you can import initial key using TR-34 asymmetric key exchange. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Device (KRD). During the key import process, KDH is the user who initiates the key import and KRD is Amazon Web Services Payment Cryptography who receives the key.
To initiate TR-34 key import, the KDH must obtain an import token by calling GetParametersForImport. This operation generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate (also known as KRD wrapping certificate) and the root certificate chain. The KDH must trust and install the KRD wrapping certificate on its HSM and use it to encrypt (wrap) the KDH key during TR-34 WrappedKeyBlock generation. The import token and associated KRD wrapping certificate expires after 7 days.
Next the KDH generates a key pair for the purpose of signing the encrypted KDH key and provides the public certificate of the signing key to Amazon Web Services Payment Cryptography. The KDH will also need to import the root certificate chain of the KDH signing certificate by calling ImportKey for RootCertificatePublicKey. For more information on TR-34 key import, see section Importing symmetric keys in the Amazon Web Services Payment Cryptography User Guide.
Set the following parameters:
KeyMaterial: Use Tr34KeyBlock parameters.
CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed the KDH signing key certificate.
ImportToken: Obtained from KRD by calling GetParametersForImport.
WrappedKeyBlock: The TR-34 wrapped key material from KDH. It contains the KDH key under import, wrapped with KRD wrapping certificate and signed by KDH signing private key. This TR-34 key block is typically generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.
SigningKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KDH signing key generated under the root certificate (CertificateAuthorityPublicKeyIdentifier) imported in Amazon Web Services Payment Cryptography.
To import initial keys (KEK or ZMK or similar) using RSA Wrap and Unwrap
Using this operation, you can import initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate import, call GetParametersForImport with KeyMaterial set to KEY_CRYPTOGRAM to generate an import token. This operation also generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate in PEM format (base64 encoded) and its root certificate chain. The import token and associated KRD wrapping certificate expires after 7 days.
You must trust and install the wrapping certificate and its certificate chain on the sending HSM and use it to wrap the key under export for WrappedKeyCryptogram generation. Next call ImportKey with KeyMaterial set to KEY_CRYPTOGRAM and provide the ImportToken and KeyAttributes for the key under import.
To import working keys using TR-31
Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange norm to import working keys. A KEK must be established within Amazon Web Services Payment Cryptography by using TR-34 key import or by using CreateKey. To initiate a TR-31 key import, set the following parameters:
KeyMaterial: Use Tr31KeyBlock parameters.
WrappedKeyBlock: The TR-31 wrapped key material. It contains the key under import, encrypted using KEK. The TR-31 key block is typically generated by a HSM outside of Amazon Web Services Payment Cryptography.
WrappingKeyIdentifier: The KeyArn of the KEK that Amazon Web Services Payment Cryptography uses to decrypt or unwrap the key under import.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "ListAliases":{ + "name":"ListAliases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAliasesInput"}, + "output":{"shape":"ListAliasesOutput"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of aliases. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.
This is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value. Use this value in a subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "ListKeys":{ + "name":"ListKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListKeysInput"}, + "output":{"shape":"ListKeysOutput"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys.
This is a paginated operation, which means that each response might contain only a subset of all the keys. When the response contains only a subset of keys, it includes a NextToken value. Use this value in a subsequent ListKeys request to get more keys. When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists the tags for an Amazon Web Services resource.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTagsForResource request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "RestoreKey":{ + "name":"RestoreKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreKeyInput"}, + "output":{"shape":"RestoreKeyOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Cancels a scheduled key deletion during the waiting period. Use this operation to restore a Key that is scheduled for deletion.
During the waiting period, the KeyState is DELETE_PENDING and deletePendingTimestamp contains the date and time after which the Key will be deleted. After Key is restored, the KeyState is CREATE_COMPLETE, and the value for deletePendingTimestamp is removed.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "StartKeyUsage":{ + "name":"StartKeyUsage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartKeyUsageInput"}, + "output":{"shape":"StartKeyUsageOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "StopKeyUsage":{ + "name":"StopKeyUsage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopKeyUsageInput"}, + "output":{"shape":"StopKeyUsageOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.
You can use this operation instead of DeleteKey to deactivate a key. You can enable the key in the future by calling StartKeyUsage.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Adds or edits tags on an Amazon Web Services Payment Cryptography key.
Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can also add tags to an Amazon Web Services Payment Cryptography key when you create it with CreateKey.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes a tag from an Amazon Web Services Payment Cryptography key.
Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + }, + "UpdateAlias":{ + "name":"UpdateAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAliasInput"}, + "output":{"shape":"UpdateAliasOutput"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Associates an existing Amazon Web Services Payment Cryptography alias with a different key. Each alias is associated with only one Amazon Web Services Payment Cryptography key at a time, although a key can have multiple aliases. The alias and the Amazon Web Services Payment Cryptography key must be in the same Amazon Web Services account and Amazon Web Services Region
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"You do not have sufficient access to perform this action.
", + "exception":true + }, + "Alias":{ + "type":"structure", + "required":["AliasName"], + "members":{ + "AliasName":{ + "shape":"AliasName", + "documentation":"A friendly name that you can use to refer to a key. The value must begin with alias/.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
The KeyARN of the key associated with the alias.
Contains information about an alias.
" + }, + "AliasName":{ + "type":"string", + "max":256, + "min":7, + "pattern":"alias/[a-zA-Z0-9/_-]+" + }, + "Aliases":{ + "type":"list", + "member":{"shape":"Alias"} + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "CertificateType":{ + "type":"string", + "max":32768, + "min":1, + "pattern":"[^\\[;\\]<>]+", + "sensitive":true + }, + "ConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"This request can cause an inconsistent state for the resource.
", + "exception":true + }, + "CreateAliasInput":{ + "type":"structure", + "required":["AliasName"], + "members":{ + "AliasName":{ + "shape":"AliasName", + "documentation":"A friendly name that you can use to refer to a key. An alias must begin with alias/ followed by a name, for example alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-).
Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
The KeyARN of the key to associate with the alias.
The alias for the key.
" + } + } + }, + "CreateKeyInput":{ + "type":"structure", + "required":[ + "KeyAttributes", + "Exportable" + ], + "members":{ + "KeyAttributes":{ + "shape":"KeyAttributes", + "documentation":"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":{ + "shape":"KeyCheckValueAlgorithm", + "documentation":"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.
" + }, + "Exportable":{ + "shape":"Boolean", + "documentation":"Specifies whether the key is exportable from the service.
" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key is not enabled, then it is created but not activated. The default value is enabled.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.
Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.
Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
The key material that contains all the key attributes.
" + } + } + }, + "DeleteAliasInput":{ + "type":"structure", + "required":["AliasName"], + "members":{ + "AliasName":{ + "shape":"AliasName", + "documentation":"A friendly name that you can use to refer Amazon Web Services Payment Cryptography key. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.
The KeyARN of the key that is scheduled for deletion.
The waiting period for key deletion. The default value is seven days.
" + } + } + }, + "DeleteKeyInputDeleteKeyInDaysInteger":{ + "type":"integer", + "box":true, + "max":180, + "min":3 + }, + "DeleteKeyOutput":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"Key", + "documentation":"The KeyARN of the key that is scheduled for deletion.
Parameter information for IPEK export.
" + }, + "KeyCheckValueAlgorithm":{ + "shape":"KeyCheckValueAlgorithm", + "documentation":"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.
" + } + }, + "documentation":"The attributes for IPEK generation during export.
" + }, + "ExportDukptInitialKey":{ + "type":"structure", + "required":["KeySerialNumber"], + "members":{ + "KeySerialNumber":{ + "shape":"HexLength20Or24", + "documentation":"The KSN for IPEK generation using DUKPT.
KSN must be padded before sending to Amazon Web Services Payment Cryptography. KSN hex length should be 20 for a TDES_2KEY key or 24 for an AES key.
" + } + }, + "documentation":"Parameter information for IPEK generation during export.
" + }, + "ExportKeyCryptogram":{ + "type":"structure", + "required":[ + "CertificateAuthorityPublicKeyIdentifier", + "WrappingKeyCertificate" + ], + "members":{ + "CertificateAuthorityPublicKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The KeyARN of the certificate chain that signs the wrapping key certificate during RSA wrap and unwrap key export.
The wrapping key certificate in PEM format (base64 encoded). Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.
" + }, + "WrappingSpec":{ + "shape":"WrappingKeySpec", + "documentation":"The wrapping spec for the key under export.
" + } + }, + "documentation":"Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method.
" + }, + "ExportKeyInput":{ + "type":"structure", + "required":[ + "KeyMaterial", + "ExportKeyIdentifier" + ], + "members":{ + "KeyMaterial":{ + "shape":"ExportKeyMaterial", + "documentation":"The key block format type, for example, TR-34 or TR-31, to use during key material export.
" + }, + "ExportKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The KeyARN of the key under export from Amazon Web Services Payment Cryptography.
The attributes for IPEK generation during export.
" + } + } + }, + "ExportKeyMaterial":{ + "type":"structure", + "members":{ + "Tr31KeyBlock":{ + "shape":"ExportTr31KeyBlock", + "documentation":"Parameter information for key material export using symmetric TR-31 key exchange method.
" + }, + "Tr34KeyBlock":{ + "shape":"ExportTr34KeyBlock", + "documentation":"Parameter information for key material export using the asymmetric TR-34 key exchange method.
" + }, + "KeyCryptogram":{ + "shape":"ExportKeyCryptogram", + "documentation":"Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method
" + } + }, + "documentation":"Parameter information for key material export from Amazon Web Services Payment Cryptography using TR-31 or TR-34 or RSA wrap and unwrap key exchange method.
", + "union":true + }, + "ExportKeyOutput":{ + "type":"structure", + "members":{ + "WrappedKey":{ + "shape":"WrappedKey", + "documentation":"The key material under export as a TR-34 WrappedKeyBlock or a TR-31 WrappedKeyBlock. or a RSA WrappedKeyCryptogram.
" + } + } + }, + "ExportTokenId":{ + "type":"string", + "pattern":"export-token-[0-9a-zA-Z]{16,64}" + }, + "ExportTr31KeyBlock":{ + "type":"structure", + "required":["WrappingKeyIdentifier"], + "members":{ + "WrappingKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The KeyARN of the the wrapping key. This key encrypts or wraps the key under export for TR-31 key block generation.
Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
" + } + }, + "documentation":"Parameter information for key material export using symmetric TR-31 key exchange method.
" + }, + "ExportTr34KeyBlock":{ + "type":"structure", + "required":[ + "CertificateAuthorityPublicKeyIdentifier", + "WrappingKeyCertificate", + "ExportToken", + "KeyBlockFormat" + ], + "members":{ + "CertificateAuthorityPublicKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The KeyARN of the certificate chain that signs the wrapping key certificate during TR-34 key export.
The KeyARN of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.
The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 7 days. You can use the same export token to export multiple keys from the same service account.
" + }, + "KeyBlockFormat":{ + "shape":"Tr34KeyBlockFormat", + "documentation":"The format of key block that Amazon Web Services Payment Cryptography will use during key export.
" + }, + "RandomNonce":{ + "shape":"EvenHexLengthBetween16And32", + "documentation":"A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.
" + }, + "KeyBlockHeaders":{ + "shape":"KeyBlockHeaders", + "documentation":"Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
" + } + }, + "documentation":"Parameter information for key material export using the asymmetric TR-34 key exchange method.
" + }, + "GetAliasInput":{ + "type":"structure", + "required":["AliasName"], + "members":{ + "AliasName":{ + "shape":"AliasName", + "documentation":"The alias of the Amazon Web Services Payment Cryptography key.
" + } + } + }, + "GetAliasOutput":{ + "type":"structure", + "required":["Alias"], + "members":{ + "Alias":{ + "shape":"Alias", + "documentation":"The alias of the Amazon Web Services Payment Cryptography key.
" + } + } + }, + "GetKeyInput":{ + "type":"structure", + "required":["KeyIdentifier"], + "members":{ + "KeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The KeyARN of the Amazon Web Services Payment Cryptography key.
The key material, including the immutable and mutable data for the key.
" + } + } + }, + "GetParametersForExportInput":{ + "type":"structure", + "required":[ + "KeyMaterialType", + "SigningKeyAlgorithm" + ], + "members":{ + "KeyMaterialType":{ + "shape":"KeyMaterialType", + "documentation":"The key block format type (for example, TR-34 or TR-31) to use during key material export. Export token is only required for a TR-34 key export, TR34_KEY_BLOCK. Export token is not required for TR-31 key export.
The signing key algorithm to generate a signing key certificate. This certificate signs the wrapped key under export within the TR-34 key block. RSA_2048 is the only signing key algorithm allowed.
The signing key certificate in PEM format (base64 encoded) of the public key for signature within the TR-34 key block. The certificate expires after 7 days.
" + }, + "SigningKeyCertificateChain":{ + "shape":"CertificateType", + "documentation":"The root certificate authority (CA) that signed the signing key certificate in PEM format (base64 encoded).
" + }, + "SigningKeyAlgorithm":{ + "shape":"KeyAlgorithm", + "documentation":"The algorithm of the signing key certificate for use in TR-34 key block generation. RSA_2048 is the only signing key algorithm allowed.
The export token to initiate key export from Amazon Web Services Payment Cryptography. The export token expires after 7 days. You can use the same export token to export multiple keys from the same service account.
" + }, + "ParametersValidUntilTimestamp":{ + "shape":"Timestamp", + "documentation":"The validity period of the export token.
" + } + } + }, + "GetParametersForImportInput":{ + "type":"structure", + "required":[ + "KeyMaterialType", + "WrappingKeyAlgorithm" + ], + "members":{ + "KeyMaterialType":{ + "shape":"KeyMaterialType", + "documentation":"The method to use for key material import. Import token is only required for TR-34 WrappedKeyBlock (TR34_KEY_BLOCK) and RSA WrappedKeyCryptogram (KEY_CRYPTOGRAM).
Import token is not required for TR-31, root public key cerificate or trusted public key certificate.
" + }, + "WrappingKeyAlgorithm":{ + "shape":"KeyAlgorithm", + "documentation":"The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import.
At this time, RSA_2048 is the allowed algorithm for TR-34 WrappedKeyBlock import. Additionally, RSA_2048, RSA_3072, RSA_4096 are the allowed algorithms for RSA WrappedKeyCryptogram import.
The wrapping key certificate in PEM format (base64 encoded) of the wrapping key for use within the TR-34 key block. The certificate expires in 7 days.
" + }, + "WrappingKeyCertificateChain":{ + "shape":"CertificateType", + "documentation":"The Amazon Web Services Payment Cryptography root certificate authority (CA) that signed the wrapping key certificate in PEM format (base64 encoded).
" + }, + "WrappingKeyAlgorithm":{ + "shape":"KeyAlgorithm", + "documentation":"The algorithm of the wrapping key for use within TR-34 WrappedKeyBlock or RSA WrappedKeyCryptogram.
" + }, + "ImportToken":{ + "shape":"ImportTokenId", + "documentation":"The import token to initiate key import into Amazon Web Services Payment Cryptography. The import token expires after 7 days. You can use the same import token to import multiple keys to the same service account.
" + }, + "ParametersValidUntilTimestamp":{ + "shape":"Timestamp", + "documentation":"The validity period of the import token.
" + } + } + }, + "GetPublicKeyCertificateInput":{ + "type":"structure", + "required":["KeyIdentifier"], + "members":{ + "KeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The KeyARN of the asymmetric key pair.
The public key component of the asymmetric key pair in a certificate PEM format (base64 encoded). It is signed by the root certificate authority (CA). The certificate expires in 90 days.
" + }, + "KeyCertificateChain":{ + "shape":"CertificateType", + "documentation":"The root certificate authority (CA) that signed the public key certificate in PEM format (base64 encoded) of the asymmetric key pair.
" + } + } + }, + "HexLength20Or24":{ + "type":"string", + "max":24, + "min":20, + "pattern":"[0-9A-F]{20}$|^[0-9A-F]{24}" + }, + "ImportKeyCryptogram":{ + "type":"structure", + "required":[ + "KeyAttributes", + "Exportable", + "WrappedKeyCryptogram", + "ImportToken" + ], + "members":{ + "KeyAttributes":{"shape":"KeyAttributes"}, + "Exportable":{ + "shape":"Boolean", + "documentation":"Specifies whether the key is exportable from the service.
" + }, + "WrappedKeyCryptogram":{ + "shape":"WrappedKeyCryptogram", + "documentation":"The RSA wrapped key cryptogram under import.
" + }, + "ImportToken":{ + "shape":"ImportTokenId", + "documentation":"The import token that initiates key import using the asymmetric RSA wrap and unwrap key exchange method into AWS Payment Cryptography. It expires after 7 days. You can use the same import token to import multiple keys to the same service account.
" + }, + "WrappingSpec":{ + "shape":"WrappingKeySpec", + "documentation":"The wrapping spec for the wrapped key cryptogram.
" + } + }, + "documentation":"Parameter information for key material import using asymmetric RSA wrap and unwrap key exchange method.
" + }, + "ImportKeyInput":{ + "type":"structure", + "required":["KeyMaterial"], + "members":{ + "KeyMaterial":{ + "shape":"ImportKeyMaterial", + "documentation":"The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.
" + }, + "KeyCheckValueAlgorithm":{ + "shape":"KeyCheckValueAlgorithm", + "documentation":"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.
" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"Specifies whether import key is enabled.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is imported. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.
Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.
Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
Parameter information for root public key certificate import.
" + }, + "TrustedCertificatePublicKey":{ + "shape":"TrustedCertificatePublicKey", + "documentation":"Parameter information for trusted public key certificate import.
" + }, + "Tr31KeyBlock":{ + "shape":"ImportTr31KeyBlock", + "documentation":"Parameter information for key material import using symmetric TR-31 key exchange method.
" + }, + "Tr34KeyBlock":{ + "shape":"ImportTr34KeyBlock", + "documentation":"Parameter information for key material import using the asymmetric TR-34 key exchange method.
" + }, + "KeyCryptogram":{ + "shape":"ImportKeyCryptogram", + "documentation":"Parameter information for key material import using asymmetric RSA wrap and unwrap key exchange method.
" + } + }, + "documentation":"Parameter information for key material import into Amazon Web Services Payment Cryptography using TR-31 or TR-34 or RSA wrap and unwrap key exchange method.
", + "union":true + }, + "ImportKeyOutput":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"Key", + "documentation":"The KeyARN of the key material imported within Amazon Web Services Payment Cryptography.
The KeyARN of the key that will decrypt or unwrap a TR-31 key block during import.
The TR-31 wrapped key block to import.
" + } + }, + "documentation":"Parameter information for key material import using symmetric TR-31 key exchange method.
" + }, + "ImportTr34KeyBlock":{ + "type":"structure", + "required":[ + "CertificateAuthorityPublicKeyIdentifier", + "SigningKeyCertificate", + "ImportToken", + "WrappedKeyBlock", + "KeyBlockFormat" + ], + "members":{ + "CertificateAuthorityPublicKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The KeyARN of the certificate chain that signs the signing key certificate during TR-34 key import.
The public key component in PEM certificate format of the private key that signs the KDH TR-34 WrappedKeyBlock.
" + }, + "ImportToken":{ + "shape":"ImportTokenId", + "documentation":"The import token that initiates key import using the asymmetric TR-34 key exchange method into Amazon Web Services Payment Cryptography. It expires after 7 days. You can use the same import token to import multiple keys to the same service account.
" + }, + "WrappedKeyBlock":{ + "shape":"Tr34WrappedKeyBlock", + "documentation":"The TR-34 wrapped key block to import.
" + }, + "KeyBlockFormat":{ + "shape":"Tr34KeyBlockFormat", + "documentation":"The key block format to use during key import. The only value allowed is X9_TR34_2012.
A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.
" + } + }, + "documentation":"Parameter information for key material import using the asymmetric TR-34 key exchange method.
" + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request processing has failed because of an unknown error, exception, or failure.
", + "exception":true, + "fault":true + }, + "Key":{ + "type":"structure", + "required":[ + "KeyArn", + "KeyAttributes", + "KeyCheckValue", + "KeyCheckValueAlgorithm", + "Enabled", + "Exportable", + "KeyState", + "KeyOrigin", + "CreateTimestamp" + ], + "members":{ + "KeyArn":{ + "shape":"KeyArn", + "documentation":"The Amazon Resource Name (ARN) of the key.
" + }, + "KeyAttributes":{ + "shape":"KeyAttributes", + "documentation":"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.
" + }, + "KeyCheckValue":{ + "shape":"KeyCheckValue", + "documentation":"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":{ + "shape":"KeyCheckValueAlgorithm", + "documentation":"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.
" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"Specifies whether the key is enabled.
" + }, + "Exportable":{ + "shape":"Boolean", + "documentation":"Specifies whether the key is exportable. This data is immutable after the key is created.
" + }, + "KeyState":{ + "shape":"KeyState", + "documentation":"The state of key that is being created or deleted.
" + }, + "KeyOrigin":{ + "shape":"KeyOrigin", + "documentation":"The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.
The date and time when the key was created.
" + }, + "UsageStartTimestamp":{ + "shape":"Timestamp", + "documentation":"The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.
" + }, + "UsageStopTimestamp":{ + "shape":"Timestamp", + "documentation":"The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.
" + }, + "DeletePendingTimestamp":{ + "shape":"Timestamp", + "documentation":"The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.
The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.
Metadata about an Amazon Web Services Payment Cryptography key.
" + }, + "KeyAlgorithm":{ + "type":"string", + "enum":[ + "TDES_2KEY", + "TDES_3KEY", + "AES_128", + "AES_192", + "AES_256", + "RSA_2048", + "RSA_3072", + "RSA_4096" + ] + }, + "KeyArn":{ + "type":"string", + "max":150, + "min":70, + "pattern":"arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}" + }, + "KeyArnOrKeyAliasType":{ + "type":"string", + "max":322, + "min":7, + "pattern":"arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+" + }, + "KeyAttributes":{ + "type":"structure", + "required":[ + "KeyUsage", + "KeyClass", + "KeyAlgorithm", + "KeyModesOfUse" + ], + "members":{ + "KeyUsage":{ + "shape":"KeyUsage", + "documentation":"The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.
" + }, + "KeyClass":{ + "shape":"KeyClass", + "documentation":"The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
" + }, + "KeyAlgorithm":{ + "shape":"KeyAlgorithm", + "documentation":"The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
The list of cryptographic operations that you can perform using the key.
" + } + }, + "documentation":"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.
" + }, + "KeyBlockHeaders":{ + "type":"structure", + "members":{ + "KeyModesOfUse":{"shape":"KeyModesOfUse"}, + "KeyExportability":{ + "shape":"KeyExportability", + "documentation":"Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.
When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.
Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.
" + }, + "OptionalBlocks":{ + "shape":"OptionalBlocks", + "documentation":"Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks.
Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.
" + } + }, + "documentation":"Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
" + }, + "KeyCheckValue":{ + "type":"string", + "max":16, + "min":4, + "pattern":"[0-9a-fA-F]+" + }, + "KeyCheckValueAlgorithm":{ + "type":"string", + "enum":[ + "CMAC", + "ANSI_X9_24" + ] + }, + "KeyClass":{ + "type":"string", + "enum":[ + "SYMMETRIC_KEY", + "ASYMMETRIC_KEY_PAIR", + "PRIVATE_KEY", + "PUBLIC_KEY" + ] + }, + "KeyExportability":{ + "type":"string", + "enum":[ + "EXPORTABLE", + "NON_EXPORTABLE", + "SENSITIVE" + ] + }, + "KeyMaterial":{ + "type":"string", + "max":16384, + "min":48, + "sensitive":true + }, + "KeyMaterialType":{ + "type":"string", + "enum":[ + "TR34_KEY_BLOCK", + "TR31_KEY_BLOCK", + "ROOT_PUBLIC_KEY_CERTIFICATE", + "TRUSTED_PUBLIC_KEY_CERTIFICATE", + "KEY_CRYPTOGRAM" + ] + }, + "KeyModesOfUse":{ + "type":"structure", + "members":{ + "Encrypt":{ + "shape":"PrimitiveBoolean", + "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
" + }, + "Decrypt":{ + "shape":"PrimitiveBoolean", + "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
" + }, + "Wrap":{ + "shape":"PrimitiveBoolean", + "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
" + }, + "Unwrap":{ + "shape":"PrimitiveBoolean", + "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
" + }, + "Generate":{ + "shape":"PrimitiveBoolean", + "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
" + }, + "Sign":{ + "shape":"PrimitiveBoolean", + "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.
" + }, + "Verify":{ + "shape":"PrimitiveBoolean", + "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
" + }, + "DeriveKey":{ + "shape":"PrimitiveBoolean", + "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
" + }, + "NoRestrictions":{ + "shape":"PrimitiveBoolean", + "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.
The list of cryptographic operations that you can perform using the key. The modes of use are defined in section A.5.3 of the TR-31 spec.
" + }, + "KeyOrigin":{ + "type":"string", + "documentation":"Defines the source of a key
", + "enum":[ + "EXTERNAL", + "AWS_PAYMENT_CRYPTOGRAPHY" + ] + }, + "KeyState":{ + "type":"string", + "documentation":"Defines the state of a key
", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_COMPLETE", + "DELETE_PENDING", + "DELETE_COMPLETE" + ] + }, + "KeySummary":{ + "type":"structure", + "required":[ + "KeyArn", + "KeyState", + "KeyAttributes", + "KeyCheckValue", + "Exportable", + "Enabled" + ], + "members":{ + "KeyArn":{ + "shape":"KeyArn", + "documentation":"The Amazon Resource Name (ARN) of the key.
" + }, + "KeyState":{ + "shape":"KeyState", + "documentation":"The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
" + }, + "KeyAttributes":{ + "shape":"KeyAttributes", + "documentation":"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.
" + }, + "KeyCheckValue":{ + "shape":"KeyCheckValue", + "documentation":"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.
" + }, + "Exportable":{ + "shape":"Boolean", + "documentation":"Specifies whether the key is exportable. This data is immutable after the key is created.
" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"Specifies whether the key is enabled.
" + } + }, + "documentation":"Metadata about an Amazon Web Services Payment Cryptography key.
" + }, + "KeySummaryList":{ + "type":"list", + "member":{"shape":"KeySummary"} + }, + "KeyUsage":{ + "type":"string", + "enum":[ + "TR31_B0_BASE_DERIVATION_KEY", + "TR31_C0_CARD_VERIFICATION_KEY", + "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", + "TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION", + "TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS", + "TR31_E1_EMV_MKEY_CONFIDENTIALITY", + "TR31_E2_EMV_MKEY_INTEGRITY", + "TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS", + "TR31_E5_EMV_MKEY_CARD_PERSONALIZATION", + "TR31_E6_EMV_MKEY_OTHER", + "TR31_K0_KEY_ENCRYPTION_KEY", + "TR31_K1_KEY_BLOCK_PROTECTION_KEY", + "TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT", + "TR31_M3_ISO_9797_3_MAC_KEY", + "TR31_M1_ISO_9797_1_MAC_KEY", + "TR31_M6_ISO_9797_5_CMAC_KEY", + "TR31_M7_HMAC_KEY", + "TR31_P0_PIN_ENCRYPTION_KEY", + "TR31_P1_PIN_GENERATION_KEY", + "TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE", + "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", + "TR31_V2_VISA_PIN_VERIFICATION_KEY", + "TR31_K2_TR34_ASYMMETRIC_KEY" + ] + }, + "KeyVersion":{ + "type":"string", + "max":2, + "min":2, + "pattern":"[0-9A-Z]{2}+" + }, + "ListAliasesInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
" + } + } + }, + "ListAliasesOutput":{ + "type":"structure", + "required":["Aliases"], + "members":{ + "Aliases":{ + "shape":"Aliases", + "documentation":"The list of aliases. Each alias describes the KeyArn contained within.
The token for the next set of results, or an empty or null value if there are no more results.
" + } + } + }, + "ListKeysInput":{ + "type":"structure", + "members":{ + "KeyState":{ + "shape":"KeyState", + "documentation":"The key state of the keys you want to list.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
" + } + } + }, + "ListKeysOutput":{ + "type":"structure", + "required":["Keys"], + "members":{ + "Keys":{ + "shape":"KeySummaryList", + "documentation":"The list of keys created within the caller's Amazon Web Services account and Amazon Web Services Region.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results, or an empty or null value if there are no more results.
" + } + } + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"The KeyARN of the key whose tags you are getting.
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"The list of tags associated with a ResourceArn. Each tag will list the key-value pair contained within that tag.
The token for the next set of results, or an empty or null value if there are no more results.
" + } + } + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "NextToken":{ + "type":"string", + "max":8192, + "min":1 + }, + "OptionalBlockId":{ + "type":"string", + "max":2, + "min":2, + "pattern":"[0-9A-Z]{2}+", + "sensitive":true + }, + "OptionalBlockValue":{ + "type":"string", + "max":108, + "min":1, + "pattern":"[0-9A-Z]+", + "sensitive":true + }, + "OptionalBlocks":{ + "type":"map", + "key":{"shape":"OptionalBlockId"}, + "value":{"shape":"OptionalBlockValue"} + }, + "PrimitiveBoolean":{"type":"boolean"}, + "ResourceArn":{ + "type":"string", + "max":150, + "min":70, + "pattern":"arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"The string for the exception.
" + } + }, + "documentation":"The request was denied due to an invalid resource error.
", + "exception":true + }, + "RestoreKeyInput":{ + "type":"structure", + "required":["KeyIdentifier"], + "members":{ + "KeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The KeyARN of the key to be restored within Amazon Web Services Payment Cryptography.
The key material of the restored key. The KeyState will change to CREATE_COMPLETE and value for DeletePendingTimestamp gets removed.
The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the root public key is imported.
" + }, + "PublicKeyCertificate":{ + "shape":"CertificateType", + "documentation":"Parameter information for root public key certificate import.
" + } + }, + "documentation":"Parameter information for root public key certificate import.
" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"This request would cause a service quota to be exceeded.
", + "exception":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The service cannot complete the request.
", + "exception":true, + "fault":true + }, + "StartKeyUsageInput":{ + "type":"structure", + "required":["KeyIdentifier"], + "members":{ + "KeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The KeyArn of the key.
The KeyARN of the Amazon Web Services Payment Cryptography key activated for use.
The KeyArn of the key.
The KeyARN of the key.
The key of the tag.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The value of the tag.
" + } + }, + "documentation":"A structure that contains information about a tag.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"The KeyARN of the key whose tags are being updated.
One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the new one.
Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
To use this parameter, you must have TagResource permission in an IAM policy.
Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
The request was denied due to request throttling.
", + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "Tr31WrappedKeyBlock":{ + "type":"string", + "max":9984, + "min":56, + "pattern":"[0-9A-Z]+", + "sensitive":true + }, + "Tr34KeyBlockFormat":{ + "type":"string", + "enum":["X9_TR34_2012"] + }, + "Tr34WrappedKeyBlock":{ + "type":"string", + "max":4096, + "min":2, + "pattern":"[0-9A-F]+" + }, + "TrustedCertificatePublicKey":{ + "type":"structure", + "required":[ + "KeyAttributes", + "PublicKeyCertificate", + "CertificateAuthorityPublicKeyIdentifier" + ], + "members":{ + "KeyAttributes":{ + "shape":"KeyAttributes", + "documentation":"The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after a trusted public key is imported.
" + }, + "PublicKeyCertificate":{ + "shape":"CertificateType", + "documentation":"Parameter information for trusted public key certificate import.
" + }, + "CertificateAuthorityPublicKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The KeyARN of the root public key certificate or certificate chain that signs the trusted public key certificate import.
Parameter information for trusted public key certificate import.
" + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"The KeyARN of the key whose tags are being removed.
One or more tag keys. Don't include the tag values.
If the Amazon Web Services Payment Cryptography key doesn't have the specified tag key, Amazon Web Services Payment Cryptography doesn't throw an exception or return a response. To confirm that the operation succeeded, use the ListTagsForResource operation.
" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateAliasInput":{ + "type":"structure", + "required":["AliasName"], + "members":{ + "AliasName":{ + "shape":"AliasName", + "documentation":"The alias whose associated key is changing.
" + }, + "KeyArn":{ + "shape":"KeyArn", + "documentation":"The KeyARN for the key that you are updating or removing from the alias.
The alias name.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request was denied due to an invalid request error.
", + "exception":true + }, + "WrappedKey":{ + "type":"structure", + "required":[ + "WrappingKeyArn", + "WrappedKeyMaterialFormat", + "KeyMaterial" + ], + "members":{ + "WrappingKeyArn":{ + "shape":"KeyArn", + "documentation":"The KeyARN of the wrapped key.
The key block format of a wrapped key.
" + }, + "KeyMaterial":{ + "shape":"KeyMaterial", + "documentation":"Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.
" + }, + "KeyCheckValue":{ + "shape":"KeyCheckValue", + "documentation":"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":{ + "shape":"KeyCheckValueAlgorithm", + "documentation":"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.
" + } + }, + "documentation":"Parameter information for generating a WrappedKeyBlock for key exchange.
" + }, + "WrappedKeyCryptogram":{ + "type":"string", + "max":4096, + "min":16, + "pattern":"[0-9A-F]+" + }, + "WrappedKeyMaterialFormat":{ + "type":"string", + "enum":[ + "KEY_CRYPTOGRAM", + "TR31_KEY_BLOCK", + "TR34_KEY_BLOCK" + ] + }, + "WrappingKeySpec":{ + "type":"string", + "enum":[ + "RSA_OAEP_SHA_256", + "RSA_OAEP_SHA_512" + ] + } + }, + "documentation":"Amazon Web Services Payment Cryptography Control Plane APIs manage encryption keys for use during payment-related cryptographic operations. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys. For more information, see Identity and access management in the Amazon Web Services Payment Cryptography User Guide.
To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the Amazon Web Services Payment Cryptography Data Plane. You can perform actions like encrypt, decrypt, generate, and verify payment-related data.
All Amazon Web Services Payment Cryptography API calls must be signed and transmitted using Transport Layer Security (TLS). We recommend you always use the latest supported TLS version for logging API requests.
Amazon Web Services Payment Cryptography supports CloudTrail for control plane operations, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket you specify. By using the information collected by CloudTrail, you can determine what requests were made to Amazon Web Services Payment Cryptography, who made the request, when it was made, and so on. If you don't configure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the CloudTrail User Guide.
" +} diff --git a/testbed/boto__botocore/botocore/data/payment-cryptography/2021-09-14/waiters-2.json b/testbed/boto__botocore/botocore/data/payment-cryptography/2021-09-14/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..13f60ee66be6a3d75208653e2bd7b563561adacc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/payment-cryptography/2021-09-14/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/testbed/boto__botocore/botocore/data/pca-connector-scep/2018-05-10/paginators-1.json b/testbed/boto__botocore/botocore/data/pca-connector-scep/2018-05-10/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..7a913db52966d55b39c3e52f21e977001131647e --- /dev/null +++ b/testbed/boto__botocore/botocore/data/pca-connector-scep/2018-05-10/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListChallengeMetadata": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Challenges" + }, + "ListConnectors": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Connectors" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..a04c048b07c50fa8561b1bca411de5b9608de536 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://sms-voice-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://sms-voice-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://sms-voice.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sms-voice.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/examples-1.json b/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/examples-1.json new file mode 100644 index 0000000000000000000000000000000000000000..0ea7e3b0bbe917eb027880396ac01509becd1fa0 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/paginators-1.json b/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..a149c8899c5912f4a5b4b3b85fac3e807fd50410 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/paginators-1.json @@ -0,0 +1,130 @@ +{ + "pagination": { + "DescribeAccountAttributes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "AccountAttributes" + }, + "DescribeAccountLimits": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "AccountLimits" + }, + "DescribeConfigurationSets": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ConfigurationSets" + }, + "DescribeKeywords": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Keywords" + }, + "DescribeOptOutLists": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "OptOutLists" + }, + "DescribeOptedOutNumbers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "OptedOutNumbers" + }, + "DescribePhoneNumbers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "PhoneNumbers" + }, + "DescribePools": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Pools" + }, + "DescribeSenderIds": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SenderIds" + }, + "DescribeSpendLimits": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SpendLimits" + }, + "ListPoolOriginationIdentities": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "OriginationIdentities" + }, + "DescribeRegistrationAttachments": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RegistrationAttachments" + }, + "DescribeRegistrationFieldDefinitions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RegistrationFieldDefinitions" + }, + "DescribeRegistrationFieldValues": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RegistrationFieldValues" + }, + "DescribeRegistrationSectionDefinitions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RegistrationSectionDefinitions" + }, + "DescribeRegistrationTypeDefinitions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RegistrationTypeDefinitions" + }, + "DescribeRegistrationVersions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RegistrationVersions" + }, + "DescribeRegistrations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Registrations" + }, + "DescribeVerifiedDestinationNumbers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "VerifiedDestinationNumbers" + }, + "ListRegistrationAssociations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RegistrationAssociations" + }, + "DescribeProtectConfigurations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ProtectConfigurations" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/paginators-1.sdk-extras.json b/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/paginators-1.sdk-extras.json new file mode 100644 index 0000000000000000000000000000000000000000..7db1e530153bab8fe2ac695b8542a60ddaa1ac54 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/paginators-1.sdk-extras.json @@ -0,0 +1,55 @@ +{ + "version": 1.0, + "merge": { + "pagination": { + "DescribeKeywords": { + "non_aggregate_keys": [ + "OriginationIdentity", + "OriginationIdentityArn" + ] + }, + "DescribeRegistrationFieldDefinitions": { + "non_aggregate_keys": [ + "RegistrationType" + ] + }, + "DescribeRegistrationFieldValues": { + "non_aggregate_keys": [ + "RegistrationId", + "RegistrationArn", + "VersionNumber" + ] + }, + "DescribeRegistrationSectionDefinitions": { + "non_aggregate_keys": [ + "RegistrationType" + ] + }, + "DescribeRegistrationVersions": { + "non_aggregate_keys": [ + "RegistrationId", + "RegistrationArn" + ] + }, + "DescribeOptedOutNumbers": { + "non_aggregate_keys": [ + "OptOutListArn", + "OptOutListName" + ] + }, + "ListPoolOriginationIdentities": { + "non_aggregate_keys": [ + "PoolArn", + "PoolId" + ] + }, + "ListRegistrationAssociations": { + "non_aggregate_keys": [ + "RegistrationId", + "RegistrationArn", + "RegistrationType" + ] + } + } + } +} diff --git a/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/service-2.json b/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..963e671bd324ef98d42e2b649330e3bd98041ae4 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/service-2.json @@ -0,0 +1,8100 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-03-31", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"sms-voice", + "jsonVersion":"1.0", + "protocol":"json", + "protocols":["json"], + "serviceFullName":"Amazon Pinpoint SMS Voice V2", + "serviceId":"Pinpoint SMS Voice V2", + "signatureVersion":"v4", + "signingName":"sms-voice", + "targetPrefix":"PinpointSMSVoiceV2", + "uid":"pinpoint-sms-voice-v2-2022-03-31" + }, + "operations":{ + "AssociateOriginationIdentity":{ + "name":"AssociateOriginationIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateOriginationIdentityRequest"}, + "output":{"shape":"AssociateOriginationIdentityResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Associates the specified origination identity with a pool.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
If the origination identity configuration doesn't match the pool's configuration, an error is returned.
" + }, + "AssociateProtectConfiguration":{ + "name":"AssociateProtectConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateProtectConfigurationRequest"}, + "output":{"shape":"AssociateProtectConfigurationResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.
" + }, + "CreateConfigurationSet":{ + "name":"CreateConfigurationSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateConfigurationSetRequest"}, + "output":{"shape":"CreateConfigurationSetResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
A configuration set is a set of rules that you apply to the SMS and voice messages that you send.
When you send a message, you can optionally specify a single configuration set.
" + }, + "CreateEventDestination":{ + "name":"CreateEventDestination", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEventDestinationRequest"}, + "output":{"shape":"CreateEventDestinationResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Firehose destination.
" + }, + "CreateOptOutList":{ + "name":"CreateOptOutList", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateOptOutListRequest"}, + "output":{"shape":"CreateOptOutListResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a new opt-out list.
If the opt-out list name already exists, an error is returned.
An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the AWS End User Messaging SMS User Guide.
" + }, + "CreatePool":{ + "name":"CreatePool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePoolRequest"}, + "output":{"shape":"CreatePoolResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
" + }, + "CreateProtectConfiguration":{ + "name":"CreateProtectConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateProtectConfigurationRequest"}, + "output":{"shape":"CreateProtectConfigurationResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.
Creates a new registration based on the RegistrationType field.
" + }, + "CreateRegistrationAssociation":{ + "name":"CreateRegistrationAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRegistrationAssociationRequest"}, + "output":{"shape":"CreateRegistrationAssociationResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Associate the registration with an origination identity such as a phone number or sender ID.
" + }, + "CreateRegistrationAttachment":{ + "name":"CreateRegistrationAttachment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRegistrationAttachmentRequest"}, + "output":{"shape":"CreateRegistrationAttachmentResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.
" + }, + "CreateRegistrationVersion":{ + "name":"CreateRegistrationVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRegistrationVersionRequest"}, + "output":{"shape":"CreateRegistrationVersionResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
" + }, + "CreateVerifiedDestinationNumber":{ + "name":"CreateVerifiedDestinationNumber", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVerifiedDestinationNumberRequest"}, + "output":{"shape":"CreateVerifiedDestinationNumberResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.
" + }, + "DeleteAccountDefaultProtectConfiguration":{ + "name":"DeleteAccountDefaultProtectConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAccountDefaultProtectConfigurationRequest"}, + "output":{"shape":"DeleteAccountDefaultProtectConfigurationResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Removes the current account default protect configuration.
" + }, + "DeleteConfigurationSet":{ + "name":"DeleteConfigurationSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConfigurationSetRequest"}, + "output":{"shape":"DeleteConfigurationSetResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes an existing configuration set.
A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.
" + }, + "DeleteDefaultMessageType":{ + "name":"DeleteDefaultMessageType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDefaultMessageTypeRequest"}, + "output":{"shape":"DeleteDefaultMessageTypeResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes an existing default message type on a configuration set.
A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
" + }, + "DeleteDefaultSenderId":{ + "name":"DeleteDefaultSenderId", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDefaultSenderIdRequest"}, + "output":{"shape":"DeleteDefaultSenderIdResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes an existing default sender ID on a configuration set.
A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.
" + }, + "DeleteEventDestination":{ + "name":"DeleteEventDestination", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEventDestinationRequest"}, + "output":{"shape":"DeleteEventDestinationResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes an existing event destination.
An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
" + }, + "DeleteKeyword":{ + "name":"DeleteKeyword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteKeywordRequest"}, + "output":{"shape":"DeleteKeywordResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes an existing keyword from an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
Keywords \"HELP\" and \"STOP\" can't be deleted or modified.
" + }, + "DeleteMediaMessageSpendLimitOverride":{ + "name":"DeleteMediaMessageSpendLimitOverride", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMediaMessageSpendLimitOverrideRequest"}, + "output":{"shape":"DeleteMediaMessageSpendLimitOverrideResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes an account-level monthly spending limit override for sending multimedia messages (MMS). Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Quotas for Server Migration Service in the Server Migration Service User Guide.
Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.
If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned.
" + }, + "DeleteOptedOutNumber":{ + "name":"DeleteOptedOutNumber", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteOptedOutNumberRequest"}, + "output":{"shape":"DeleteOptedOutNumberResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes an existing opted out destination phone number from the specified opt-out list.
Each destination phone number can only be deleted once every 30 days.
If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.
" + }, + "DeletePool":{ + "name":"DeletePool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePoolRequest"}, + "output":{"shape":"DeletePoolResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.
If the pool status isn't active or if deletion protection is enabled, an error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
" + }, + "DeleteProtectConfiguration":{ + "name":"DeleteProtectConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteProtectConfigurationRequest"}, + "output":{"shape":"DeleteProtectConfigurationResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Permanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.
" + }, + "DeleteRegistration":{ + "name":"DeleteRegistration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRegistrationRequest"}, + "output":{"shape":"DeleteRegistrationResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Permanently delete an existing registration from your account.
" + }, + "DeleteRegistrationAttachment":{ + "name":"DeleteRegistrationAttachment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRegistrationAttachmentRequest"}, + "output":{"shape":"DeleteRegistrationAttachmentResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Permanently delete the specified registration attachment.
" + }, + "DeleteRegistrationFieldValue":{ + "name":"DeleteRegistrationFieldValue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRegistrationFieldValueRequest"}, + "output":{"shape":"DeleteRegistrationFieldValueResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Delete the value in a registration form field.
" + }, + "DeleteResourcePolicy":{ + "name":"DeleteResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResourcePolicyRequest"}, + "output":{"shape":"DeleteResourcePolicyResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.
" + }, + "DeleteTextMessageSpendLimitOverride":{ + "name":"DeleteTextMessageSpendLimitOverride", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTextMessageSpendLimitOverrideRequest"}, + "output":{"shape":"DeleteTextMessageSpendLimitOverrideResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Quotas in the AWS End User Messaging SMS User Guide.
Delete a verified destination phone number.
" + }, + "DeleteVoiceMessageSpendLimitOverride":{ + "name":"DeleteVoiceMessageSpendLimitOverride", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVoiceMessageSpendLimitOverrideRequest"}, + "output":{"shape":"DeleteVoiceMessageSpendLimitOverrideResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Quotas in the AWS End User Messaging SMS User Guide.
Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
New accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
" + }, + "DescribeAccountLimits":{ + "name":"DescribeAccountLimits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountLimitsRequest"}, + "output":{"shape":"DescribeAccountLimitsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Describes the current AWS End User Messaging SMS and Voice SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Quotas in the AWS End User Messaging SMS User Guide.
" + }, + "DescribeConfigurationSets":{ + "name":"DescribeConfigurationSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConfigurationSetsRequest"}, + "output":{"shape":"DescribeConfigurationSetsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
" + }, + "DescribeKeywords":{ + "name":"DescribeKeywords", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeKeywordsRequest"}, + "output":{"shape":"DescribeKeywordsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Describes the specified keywords or all keywords on your origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
" + }, + "DescribeOptOutLists":{ + "name":"DescribeOptOutLists", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOptOutListsRequest"}, + "output":{"shape":"DescribeOptOutListsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Describes the specified opt-out list or all opt-out lists in your account.
If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.
If you specify an opt-out list name that isn't valid, an error is returned.
" + }, + "DescribeOptedOutNumbers":{ + "name":"DescribeOptedOutNumbers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOptedOutNumbersRequest"}, + "output":{"shape":"DescribeOptedOutNumbersResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.
If you specify an opted out number that isn't valid, an error is returned.
" + }, + "DescribePhoneNumbers":{ + "name":"DescribePhoneNumbers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePhoneNumbersRequest"}, + "output":{"shape":"DescribePhoneNumbersResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Describes the specified origination phone number, or all the phone numbers in your account.
If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.
If you specify a phone number ID that isn't valid, an error is returned.
" + }, + "DescribePools":{ + "name":"DescribePools", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePoolsRequest"}, + "output":{"shape":"DescribePoolsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves the specified pools or all pools associated with your Amazon Web Services account.
If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.
If you specify a pool ID that isn't valid, an error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
" + }, + "DescribeProtectConfigurations":{ + "name":"DescribeProtectConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProtectConfigurationsRequest"}, + "output":{"shape":"DescribeProtectConfigurationsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.
" + }, + "DescribeRegistrationAttachments":{ + "name":"DescribeRegistrationAttachments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegistrationAttachmentsRequest"}, + "output":{"shape":"DescribeRegistrationAttachmentsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
" + }, + "DescribeRegistrationFieldDefinitions":{ + "name":"DescribeRegistrationFieldDefinitions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegistrationFieldDefinitionsRequest"}, + "output":{"shape":"DescribeRegistrationFieldDefinitionsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
" + }, + "DescribeRegistrationFieldValues":{ + "name":"DescribeRegistrationFieldValues", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegistrationFieldValuesRequest"}, + "output":{"shape":"DescribeRegistrationFieldValuesResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves the specified registration field values.
" + }, + "DescribeRegistrationSectionDefinitions":{ + "name":"DescribeRegistrationSectionDefinitions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegistrationSectionDefinitionsRequest"}, + "output":{"shape":"DescribeRegistrationSectionDefinitionsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
" + }, + "DescribeRegistrationTypeDefinitions":{ + "name":"DescribeRegistrationTypeDefinitions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegistrationTypeDefinitionsRequest"}, + "output":{"shape":"DescribeRegistrationTypeDefinitionsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
" + }, + "DescribeRegistrationVersions":{ + "name":"DescribeRegistrationVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegistrationVersionsRequest"}, + "output":{"shape":"DescribeRegistrationVersionsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves the specified registration version.
" + }, + "DescribeRegistrations":{ + "name":"DescribeRegistrations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegistrationsRequest"}, + "output":{"shape":"DescribeRegistrationsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves the specified registrations.
" + }, + "DescribeSenderIds":{ + "name":"DescribeSenderIds", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSenderIdsRequest"}, + "output":{"shape":"DescribeSenderIdsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.
f you specify a sender ID that isn't valid, an error is returned.
" + }, + "DescribeSpendLimits":{ + "name":"DescribeSpendLimits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpendLimitsRequest"}, + "output":{"shape":"DescribeSpendLimitsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Describes the current monthly spend limits for sending voice and text messages.
When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS, MMS, or Voice spending quota in the AWS End User Messaging SMS User Guide.
" + }, + "DescribeVerifiedDestinationNumbers":{ + "name":"DescribeVerifiedDestinationNumbers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVerifiedDestinationNumbersRequest"}, + "output":{"shape":"DescribeVerifiedDestinationNumbersResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves the specified verified destiona numbers.
" + }, + "DisassociateOriginationIdentity":{ + "name":"DisassociateOriginationIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateOriginationIdentityRequest"}, + "output":{"shape":"DisassociateOriginationIdentityResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Removes the specified origination identity from an existing pool.
If the origination identity isn't associated with the specified pool, an error is returned.
" + }, + "DisassociateProtectConfiguration":{ + "name":"DisassociateProtectConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateProtectConfigurationRequest"}, + "output":{"shape":"DisassociateProtectConfigurationResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Disassociate a protect configuration from a configuration set.
" + }, + "DiscardRegistrationVersion":{ + "name":"DiscardRegistrationVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DiscardRegistrationVersionRequest"}, + "output":{"shape":"DiscardRegistrationVersionResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Discard the current version of the registration.
" + }, + "GetProtectConfigurationCountryRuleSet":{ + "name":"GetProtectConfigurationCountryRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetProtectConfigurationCountryRuleSetRequest"}, + "output":{"shape":"GetProtectConfigurationCountryRuleSetResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
" + }, + "GetResourcePolicy":{ + "name":"GetResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResourcePolicyRequest"}, + "output":{"shape":"GetResourcePolicyResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves the JSON text of the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.
" + }, + "ListPoolOriginationIdentities":{ + "name":"ListPoolOriginationIdentities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPoolOriginationIdentitiesRequest"}, + "output":{"shape":"ListPoolOriginationIdentitiesResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists all associated origination identities in your pool.
If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
" + }, + "ListRegistrationAssociations":{ + "name":"ListRegistrationAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRegistrationAssociationsRequest"}, + "output":{"shape":"ListRegistrationAssociationsResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retreive all of the origination identies that are associated with a registration.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"List all tags associated with a resource.
" + }, + "PutKeyword":{ + "name":"PutKeyword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutKeywordRequest"}, + "output":{"shape":"PutKeywordResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates or updates a keyword configuration on an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
" + }, + "PutOptedOutNumber":{ + "name":"PutOptedOutNumber", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutOptedOutNumberRequest"}, + "output":{"shape":"PutOptedOutNumberResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates an opted out destination phone number in the opt-out list.
If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an error is returned.
" + }, + "PutRegistrationFieldValue":{ + "name":"PutRegistrationFieldValue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRegistrationFieldValueRequest"}, + "output":{"shape":"PutRegistrationFieldValueResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates or updates a field value for a registration.
" + }, + "PutResourcePolicy":{ + "name":"PutResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutResourcePolicyRequest"}, + "output":{"shape":"PutResourcePolicyResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Attaches a resource-based policy to a AWS End User Messaging SMS and Voice resource(phone number, sender Id, phone poll, or opt-out list) that is used for sharing the resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For more information about resource-based policies, see Working with shared resources in the AWS End User Messaging SMS User Guide.
" + }, + "ReleasePhoneNumber":{ + "name":"ReleasePhoneNumber", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReleasePhoneNumberRequest"}, + "output":{"shape":"ReleasePhoneNumberResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.
If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.
" + }, + "ReleaseSenderId":{ + "name":"ReleaseSenderId", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReleaseSenderIdRequest"}, + "output":{"shape":"ReleaseSenderIdResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Releases an existing sender ID in your account.
" + }, + "RequestPhoneNumber":{ + "name":"RequestPhoneNumber", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestPhoneNumberRequest"}, + "output":{"shape":"RequestPhoneNumberResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Request an origination phone number for use in your account. For more information on phone number request see Request a phone number in the AWS End User Messaging SMS User Guide.
" + }, + "RequestSenderId":{ + "name":"RequestSenderId", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestSenderIdRequest"}, + "output":{"shape":"RequestSenderIdResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Request a new sender ID that doesn't require registration.
" + }, + "SendDestinationNumberVerificationCode":{ + "name":"SendDestinationNumberVerificationCode", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendDestinationNumberVerificationCodeRequest"}, + "output":{"shape":"SendDestinationNumberVerificationCodeResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
" + }, + "SendMediaMessage":{ + "name":"SendMediaMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendMediaMessageRequest"}, + "output":{"shape":"SendMediaMessageResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a new multimedia message (MMS) and sends it to a recipient's phone number.
" + }, + "SendTextMessage":{ + "name":"SendTextMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendTextMessageRequest"}, + "output":{"shape":"SendTextMessageResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a new text message and sends it to a recipient's phone number. SendTextMessage only sends an SMS message to one recipient each time it is invoked.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information about MPS, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide.
" + }, + "SendVoiceMessage":{ + "name":"SendVoiceMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendVoiceMessageRequest"}, + "output":{"shape":"SendVoiceMessageResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Allows you to send a request that sends a voice message. This operation uses Amazon Polly to convert a text script into a voice message.
" + }, + "SetAccountDefaultProtectConfiguration":{ + "name":"SetAccountDefaultProtectConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetAccountDefaultProtectConfigurationRequest"}, + "output":{"shape":"SetAccountDefaultProtectConfigurationResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Set a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.
" + }, + "SetDefaultMessageType":{ + "name":"SetDefaultMessageType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetDefaultMessageTypeRequest"}, + "output":{"shape":"SetDefaultMessageTypeResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Sets the default message type on a configuration set.
Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
" + }, + "SetDefaultSenderId":{ + "name":"SetDefaultSenderId", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetDefaultSenderIdRequest"}, + "output":{"shape":"SetDefaultSenderIdResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Sets default sender ID on a configuration set.
When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.
" + }, + "SetMediaMessageSpendLimitOverride":{ + "name":"SetMediaMessageSpendLimitOverride", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetMediaMessageSpendLimitOverrideRequest"}, + "output":{"shape":"SetMediaMessageSpendLimitOverrideResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Sets an account level monthly spend limit override for sending MMS messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Submit the specified registration for review and approval.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tags in the AWS End User Messaging SMS User Guide.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Removes the association of the specified tags from a resource. For more information on tags see Tags in the AWS End User Messaging SMS User Guide.
" + }, + "UpdateEventDestination":{ + "name":"UpdateEventDestination", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateEventDestinationRequest"}, + "output":{"shape":"UpdateEventDestinationResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Firehose. You can also enable or disable the event destination.
You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Firehose, and Amazon SNS.
" + }, + "UpdatePhoneNumber":{ + "name":"UpdatePhoneNumber", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdatePhoneNumberRequest"}, + "output":{"shape":"UpdatePhoneNumberResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
If the origination phone number is associated with a pool, an error is returned.
" + }, + "UpdatePool":{ + "name":"UpdatePool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdatePoolRequest"}, + "output":{"shape":"UpdatePoolResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
Update the setting for an existing protect configuration.
" + }, + "UpdateProtectConfigurationCountryRuleSet":{ + "name":"UpdateProtectConfigurationCountryRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateProtectConfigurationCountryRuleSetRequest"}, + "output":{"shape":"UpdateProtectConfigurationCountryRuleSetResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Update a country rule set to ALLOW or BLOCK messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.
Updates the configuration of an existing sender ID.
" + }, + "VerifyDestinationNumber":{ + "name":"VerifyDestinationNumber", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"VerifyDestinationNumberRequest"}, + "output":{"shape":"VerifyDestinationNumberResult"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "Reason":{ + "shape":"AccessDeniedExceptionReason", + "documentation":"The reason for the exception.
" + } + }, + "documentation":"The request was denied because you don't have sufficient permissions to access the resource.
", + "exception":true + }, + "AccessDeniedExceptionReason":{ + "type":"string", + "enum":[ + "INSUFFICIENT_ACCOUNT_REPUTATION", + "ACCOUNT_DISABLED" + ] + }, + "AccountAttribute":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"AccountAttributeName", + "documentation":"The name of the account attribute.
" + }, + "Value":{ + "shape":"String", + "documentation":"The value associated with the account attribute name.
" + } + }, + "documentation":"Displays the attributes associated with a single Amazon Web Services account.
" + }, + "AccountAttributeList":{ + "type":"list", + "member":{"shape":"AccountAttribute"} + }, + "AccountAttributeName":{ + "type":"string", + "enum":[ + "ACCOUNT_TIER", + "DEFAULT_PROTECT_CONFIGURATION_ID" + ] + }, + "AccountLimit":{ + "type":"structure", + "required":[ + "Name", + "Used", + "Max" + ], + "members":{ + "Name":{ + "shape":"AccountLimitName", + "documentation":"The name of the attribute to apply the account limit to.
" + }, + "Used":{ + "shape":"PrimitiveLong", + "documentation":"The current amount that has been spent, in US dollars.
" + }, + "Max":{ + "shape":"PrimitiveLong", + "documentation":"The Amazon Web Services set limit for that resource type, in US dollars.
" + } + }, + "documentation":"The current resource quotas associated with an Amazon Web Services account.
" + }, + "AccountLimitList":{ + "type":"list", + "member":{"shape":"AccountLimit"} + }, + "AccountLimitName":{ + "type":"string", + "enum":[ + "PHONE_NUMBERS", + "POOLS", + "CONFIGURATION_SETS", + "OPT_OUT_LISTS", + "SENDER_IDS", + "REGISTRATIONS", + "REGISTRATION_ATTACHMENTS", + "VERIFIED_DESTINATION_NUMBERS" + ] + }, + "AmazonResourceName":{ + "type":"string", + "max":256, + "min":20, + "pattern":"arn:[A-Za-z0-9_:/-]+" + }, + "AssociateOriginationIdentityRequest":{ + "type":"structure", + "required":[ + "PoolId", + "OriginationIdentity", + "IsoCountryCode" + ], + "members":{ + "PoolId":{ + "shape":"PoolIdOrArn", + "documentation":"The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken":true + } + } + }, + "AssociateOriginationIdentityResult":{ + "type":"structure", + "members":{ + "PoolArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.
" + }, + "PoolId":{ + "shape":"String", + "documentation":"The PoolId of the pool that is now associated with the origination identity.
" + }, + "OriginationIdentityArn":{ + "shape":"String", + "documentation":"The PhoneNumberArn or SenderIdArn of the origination identity.
" + }, + "OriginationIdentity":{ + "shape":"String", + "documentation":"The PhoneNumberId or SenderId of the origination identity.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + } + } + }, + "AssociateProtectConfigurationRequest":{ + "type":"structure", + "required":[ + "ProtectConfigurationId", + "ConfigurationSetName" + ], + "members":{ + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationIdOrArn", + "documentation":"The unique identifier for the protect configuration.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetNameOrArn", + "documentation":"The name of the ConfigurationSet.
" + } + } + }, + "AssociateProtectConfigurationResult":{ + "type":"structure", + "required":[ + "ConfigurationSetArn", + "ConfigurationSetName", + "ProtectConfigurationArn", + "ProtectConfigurationId" + ], + "members":{ + "ConfigurationSetArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the configuration set.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"The name of the ConfigurationSet.
" + }, + "ProtectConfigurationArn":{ + "shape":"ProtectConfigurationArn", + "documentation":"The Amazon Resource Name (ARN) of the protect configuration.
" + }, + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationId", + "documentation":"The unique identifier for the protect configuration.
" + } + } + }, + "AttachmentBody":{ + "type":"blob", + "max":1572864, + "min":1 + }, + "AttachmentStatus":{ + "type":"string", + "enum":[ + "UPLOAD_IN_PROGRESS", + "UPLOAD_COMPLETE", + "UPLOAD_FAILED", + "DELETED" + ] + }, + "AttachmentUploadErrorReason":{ + "type":"string", + "enum":["INTERNAL_ERROR"] + }, + "AttachmentUrl":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"\\S+" + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ClientToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[!-~]+" + }, + "CloudWatchLogsDestination":{ + "type":"structure", + "required":[ + "IamRoleArn", + "LogGroupArn" + ], + "members":{ + "IamRoleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.
" + }, + "LogGroupArn":{ + "shape":"LogGroupArn", + "documentation":"The name of the Amazon CloudWatch log group that you want to record events in.
" + } + }, + "documentation":"Contains the destination configuration to use when publishing message sending events.
" + }, + "ConfigurationSetFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"ConfigurationSetFilterName", + "documentation":"The name of the attribute to filter on.
" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"An array values to filter for.
" + } + }, + "documentation":"The information for configuration sets that meet a specified criteria.
" + }, + "ConfigurationSetFilterList":{ + "type":"list", + "member":{"shape":"ConfigurationSetFilter"}, + "max":20, + "min":0 + }, + "ConfigurationSetFilterName":{ + "type":"string", + "enum":[ + "event-destination-name", + "matching-event-types", + "default-message-type", + "default-sender-id", + "protect-configuration-id" + ] + }, + "ConfigurationSetInformation":{ + "type":"structure", + "required":[ + "ConfigurationSetArn", + "ConfigurationSetName", + "EventDestinations", + "CreatedTimestamp" + ], + "members":{ + "ConfigurationSetArn":{ + "shape":"String", + "documentation":"The Resource Name (ARN) of the ConfigurationSet.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"The name of the ConfigurationSet.
" + }, + "EventDestinations":{ + "shape":"EventDestinationList", + "documentation":"An array of EventDestination objects that describe any events to log and where to log them.
" + }, + "DefaultMessageType":{ + "shape":"MessageType", + "documentation":"The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "DefaultSenderId":{ + "shape":"SenderId", + "documentation":"The default sender ID used by the ConfigurationSet.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the ConfigurationSet was created, in UNIX epoch time format.
" + }, + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationIdOrArn", + "documentation":"The unique identifier for the protect configuration.
" + } + }, + "documentation":"Information related to a given configuration set in your Amazon Web Services account.
" + }, + "ConfigurationSetInformationList":{ + "type":"list", + "member":{"shape":"ConfigurationSetInformation"} + }, + "ConfigurationSetName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z0-9_-]+" + }, + "ConfigurationSetNameList":{ + "type":"list", + "member":{"shape":"ConfigurationSetNameOrArn"}, + "max":5, + "min":0 + }, + "ConfigurationSetNameOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/-]+" + }, + "ConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "Reason":{ + "shape":"ConflictExceptionReason", + "documentation":"The reason for the exception.
" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"The type of resource that caused the exception.
" + }, + "ResourceId":{ + "shape":"String", + "documentation":"The unique identifier of the request.
" + } + }, + "documentation":"Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
", + "exception":true + }, + "ConflictExceptionReason":{ + "type":"string", + "enum":[ + "CREATE_REGISTRATION_VERSION_NOT_ALLOWED", + "DELETION_PROTECTION_ENABLED", + "DESTINATION_PHONE_NUMBER_NOT_VERIFIED", + "DESTINATION_PHONE_NUMBER_OPTED_OUT", + "DISASSOCIATE_REGISTRATION_NOT_ALLOWED", + "DISCARD_REGISTRATION_VERSION_NOT_ALLOWED", + "EDIT_REGISTRATION_FIELD_VALUES_NOT_ALLOWED", + "EVENT_DESTINATION_MISMATCH", + "KEYWORD_MISMATCH", + "LAST_PHONE_NUMBER", + "NUMBER_CAPABILITIES_MISMATCH", + "MESSAGE_TYPE_MISMATCH", + "NO_ORIGINATION_IDENTITIES_FOUND", + "OPT_OUT_LIST_MISMATCH", + "PHONE_NUMBER_ASSOCIATED_TO_POOL", + "PHONE_NUMBER_ASSOCIATED_TO_REGISTRATION", + "PHONE_NUMBER_NOT_ASSOCIATED_TO_POOL", + "PHONE_NUMBER_NOT_IN_REGISTRATION_REGION", + "REGISTRATION_ALREADY_SUBMITTED", + "REGISTRATION_NOT_COMPLETE", + "SENDER_ID_ASSOCIATED_TO_POOL", + "RESOURCE_ALREADY_EXISTS", + "RESOURCE_DELETION_NOT_ALLOWED", + "RESOURCE_MODIFICATION_NOT_ALLOWED", + "RESOURCE_NOT_ACTIVE", + "RESOURCE_NOT_EMPTY", + "SELF_MANAGED_OPT_OUTS_MISMATCH", + "SUBMIT_REGISTRATION_VERSION_NOT_ALLOWED", + "TWO_WAY_CONFIG_MISMATCH", + "VERIFICATION_CODE_EXPIRED", + "VERIFICATION_ALREADY_COMPLETE", + "PROTECT_CONFIGURATION_IS_ACCOUNT_DEFAULT", + "PROTECT_CONFIGURATION_ASSOCIATED_WITH_CONFIGURATION_SET", + "PROTECT_CONFIGURATION_NOT_ASSOCIATED_WITH_CONFIGURATION_SET", + "DESTINATION_COUNTRY_BLOCKED_BY_PROTECT_CONFIGURATION" + ] + }, + "ContextKey":{ + "type":"string", + "max":100, + "min":1, + "pattern":"\\S+" + }, + "ContextMap":{ + "type":"map", + "key":{"shape":"ContextKey"}, + "value":{"shape":"ContextValue"}, + "max":5, + "min":0 + }, + "ContextValue":{ + "type":"string", + "max":800, + "min":1, + "pattern":"(?!\\s)^[\\s\\S]+(?The name to use for the new configuration set." + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of key and value pair tags that's associated with the new configuration set.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken":true + } + } + }, + "CreateConfigurationSetResult":{ + "type":"structure", + "members":{ + "ConfigurationSetArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the newly created configuration set.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"The name of the new configuration set.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of key and value pair tags that's associated with the configuration set.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the configuration set was created, in UNIX epoch time format.
" + } + } + }, + "CreateEventDestinationRequest":{ + "type":"structure", + "required":[ + "ConfigurationSetName", + "EventDestinationName", + "MatchingEventTypes" + ], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetNameOrArn", + "documentation":"Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
" + }, + "EventDestinationName":{ + "shape":"EventDestinationName", + "documentation":"The name that identifies the event destination.
" + }, + "MatchingEventTypes":{ + "shape":"EventTypeList", + "documentation":"An array of event types that determine which events to log. If \"ALL\" is used, then AWS End User Messaging SMS and Voice logs every event type.
The TEXT_SENT event type is not supported.
An object that contains information about an event destination for logging to Amazon CloudWatch Logs.
" + }, + "KinesisFirehoseDestination":{ + "shape":"KinesisFirehoseDestination", + "documentation":"An object that contains information about an event destination for logging to Amazon Data Firehose.
" + }, + "SnsDestination":{ + "shape":"SnsDestination", + "documentation":"An object that contains information about an event destination for logging to Amazon SNS.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken":true + } + } + }, + "CreateEventDestinationResult":{ + "type":"structure", + "members":{ + "ConfigurationSetArn":{ + "shape":"String", + "documentation":"The ARN of the configuration set.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"The name of the configuration set.
" + }, + "EventDestination":{ + "shape":"EventDestination", + "documentation":"The details of the destination where events are logged.
" + } + } + }, + "CreateOptOutListRequest":{ + "type":"structure", + "required":["OptOutListName"], + "members":{ + "OptOutListName":{ + "shape":"OptOutListName", + "documentation":"The name of the new OptOutList.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of tags (key and value pairs) to associate with the new OptOutList.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken":true + } + } + }, + "CreateOptOutListResult":{ + "type":"structure", + "members":{ + "OptOutListArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the OptOutList.
" + }, + "OptOutListName":{ + "shape":"OptOutListName", + "documentation":"The name of the new OptOutList.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of tags (key and value pairs) associated with the new OptOutList.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the pool was created, in UNIX epoch time format.
" + } + } + }, + "CreatePoolRequest":{ + "type":"structure", + "required":[ + "OriginationIdentity", + "IsoCountryCode", + "MessageType" + ], + "members":{ + "OriginationIdentity":{ + "shape":"PhoneOrSenderIdOrArn", + "documentation":"The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
" + }, + "MessageType":{ + "shape":"MessageType", + "documentation":"The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. After the pool is created the MessageType can't be changed.
" + }, + "DeletionProtectionEnabled":{ + "shape":"Boolean", + "documentation":"By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of tags (key and value pairs) associated with the pool.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken":true + } + } + }, + "CreatePoolResult":{ + "type":"structure", + "members":{ + "PoolArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the pool.
" + }, + "PoolId":{ + "shape":"String", + "documentation":"The unique identifier for the pool.
" + }, + "Status":{ + "shape":"PoolStatus", + "documentation":"The current status of the pool.
CREATING: The pool is currently being created and isn't yet available for use.
ACTIVE: The pool is active and available for use.
DELETING: The pool is being deleted.
The type of message for the pool to use.
" + }, + "TwoWayEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" + }, + "TwoWayChannelArn":{ + "shape":"TwoWayChannelArn", + "documentation":"The Amazon Resource Name (ARN) of the two way channel.
" + }, + "TwoWayChannelRole":{ + "shape":"IamRoleArn", + "documentation":"An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, + "SelfManagedOptOutsEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" + }, + "OptOutListName":{ + "shape":"OptOutListName", + "documentation":"The name of the OptOutList associated with the pool.
" + }, + "SharedRoutesEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.
" + }, + "DeletionProtectionEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"When set to true deletion protection is enabled. By default this is set to false.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of tags (key and value pairs) associated with the pool.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the pool was created, in UNIX epoch time format.
" + } + } + }, + "CreateProtectConfigurationRequest":{ + "type":"structure", + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken":true + }, + "DeletionProtectionEnabled":{ + "shape":"Boolean", + "documentation":"When set to true deletion protection is enabled. By default this is set to false.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of key and value pair tags that are associated with the resource.
" + } + } + }, + "CreateProtectConfigurationResult":{ + "type":"structure", + "required":[ + "ProtectConfigurationArn", + "ProtectConfigurationId", + "CreatedTimestamp", + "AccountDefault", + "DeletionProtectionEnabled" + ], + "members":{ + "ProtectConfigurationArn":{ + "shape":"ProtectConfigurationArn", + "documentation":"The Amazon Resource Name (ARN) of the protect configuration.
" + }, + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationId", + "documentation":"The unique identifier for the protect configuration.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the protect configuration was created, in UNIX epoch time format.
" + }, + "AccountDefault":{ + "shape":"PrimitiveBoolean", + "documentation":"This is true if the protect configuration is set as your account default protect configuration.
" + }, + "DeletionProtectionEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"When set to true deletion protection is enabled. By default this is set to false.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of key and value pair tags that are associated with the resource.
" + } + } + }, + "CreateRegistrationAssociationRequest":{ + "type":"structure", + "required":[ + "RegistrationId", + "ResourceId" + ], + "members":{ + "RegistrationId":{ + "shape":"RegistrationIdOrArn", + "documentation":"The unique identifier for the registration.
" + }, + "ResourceId":{ + "shape":"ResourceIdOrArn", + "documentation":"The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
" + } + } + }, + "CreateRegistrationAssociationResult":{ + "type":"structure", + "required":[ + "RegistrationArn", + "RegistrationId", + "RegistrationType", + "ResourceArn", + "ResourceId", + "ResourceType" + ], + "members":{ + "RegistrationArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "RegistrationType":{ + "shape":"RegistrationType", + "documentation":"The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "ResourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
" + }, + "ResourceId":{ + "shape":"String", + "documentation":"The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
" + }, + "ResourceType":{ + "shape":"String", + "documentation":"The registration type or origination identity type.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "PhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The phone number associated with the registration in E.164 format.
" + } + } + }, + "CreateRegistrationAttachmentRequest":{ + "type":"structure", + "members":{ + "AttachmentBody":{ + "shape":"AttachmentBody", + "documentation":"The registration file to upload. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG.
" + }, + "AttachmentUrl":{ + "shape":"AttachmentUrl", + "documentation":"A URL to the required registration file. For example, you can provide the S3 object URL.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of tags (key and value pairs) to associate with the registration attachment.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken":true + } + } + }, + "CreateRegistrationAttachmentResult":{ + "type":"structure", + "required":[ + "RegistrationAttachmentArn", + "RegistrationAttachmentId", + "AttachmentStatus", + "CreatedTimestamp" + ], + "members":{ + "RegistrationAttachmentArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the registration attachment.
" + }, + "RegistrationAttachmentId":{ + "shape":"String", + "documentation":"The unique identifier for the registration attachment.
" + }, + "AttachmentStatus":{ + "shape":"AttachmentStatus", + "documentation":"The status of the registration attachment.
UPLOAD_IN_PROGRESS The attachment is being uploaded.
UPLOAD_COMPLETE The attachment has been uploaded.
UPLOAD_FAILED The attachment failed to uploaded.
DELETED The attachment has been deleted..
An array of tags (key and value pairs) to associate with the registration attachment.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the registration attachment was created, in UNIX epoch time format.
" + } + } + }, + "CreateRegistrationRequest":{ + "type":"structure", + "required":["RegistrationType"], + "members":{ + "RegistrationType":{ + "shape":"RegistrationType", + "documentation":"The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of tags (key and value pairs) to associate with the registration.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken":true + } + } + }, + "CreateRegistrationResult":{ + "type":"structure", + "required":[ + "RegistrationArn", + "RegistrationId", + "RegistrationType", + "RegistrationStatus", + "CurrentVersionNumber", + "CreatedTimestamp" + ], + "members":{ + "RegistrationArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "RegistrationType":{ + "shape":"RegistrationType", + "documentation":"The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "RegistrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"The status of the registration.
CREATED: Your registration is created but not submitted.
SUBMITTED: Your registration has been submitted and is awaiting review.
REVIEWING: Your registration has been accepted and is being reviewed.
PROVISIONING: Your registration has been approved and your origination identity is being created.
COMPLETE: Your registration has been approved and and your origination identity has been created.
REQUIRES_UPDATES: You must fix your registration and resubmit it.
CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
DELETED: The registration has been deleted.
The current version number of the registration.
" + }, + "AdditionalAttributes":{ + "shape":"StringMap", + "documentation":"Metadata about a given registration which is specific to that registration type.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of tags (key and value pairs) to associate with the registration.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the registration was created, in UNIX epoch time format.
" + } + } + }, + "CreateRegistrationVersionRequest":{ + "type":"structure", + "required":["RegistrationId"], + "members":{ + "RegistrationId":{ + "shape":"RegistrationIdOrArn", + "documentation":"The unique identifier for the registration.
" + } + } + }, + "CreateRegistrationVersionResult":{ + "type":"structure", + "required":[ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "RegistrationVersionStatus", + "RegistrationVersionStatusHistory" + ], + "members":{ + "RegistrationArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "VersionNumber":{ + "shape":"RegistrationVersionNumber", + "documentation":"The new version number of the registration.
" + }, + "RegistrationVersionStatus":{ + "shape":"RegistrationVersionStatus", + "documentation":"The status of the registration.
DRAFT: The initial status of a registration version after it’s created.
SUBMITTED: Your registration has been submitted.
REVIEWING: Your registration has been accepted and is being reviewed.
APPROVED: Your registration has been approved.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DENIED: You must fix your registration and resubmit it.
REVOKED: Your previously approved registration has been revoked.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
A RegistrationVersionStatusHistory object that contains timestamps for the registration.
" + } + } + }, + "CreateVerifiedDestinationNumberRequest":{ + "type":"structure", + "required":["DestinationPhoneNumber"], + "members":{ + "DestinationPhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The verified destination phone number, in E.164 format.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of tags (key and value pairs) to associate with the destination number.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken":true + } + } + }, + "CreateVerifiedDestinationNumberResult":{ + "type":"structure", + "required":[ + "VerifiedDestinationNumberArn", + "VerifiedDestinationNumberId", + "DestinationPhoneNumber", + "Status", + "CreatedTimestamp" + ], + "members":{ + "VerifiedDestinationNumberArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the verified destination phone number.
" + }, + "VerifiedDestinationNumberId":{ + "shape":"String", + "documentation":"The unique identifier for the verified destination phone number.
" + }, + "DestinationPhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The verified destination phone number, in E.164 format.
" + }, + "Status":{ + "shape":"VerificationStatus", + "documentation":"The status of the verified destination phone number.
PENDING: The phone number hasn't been verified yet.
VERIFIED: The phone number is verified and can receive messages.
An array of tags (key and value pairs) to associate with the destination number.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the verified phone number was created, in UNIX epoch time format.
" + } + } + }, + "DeleteAccountDefaultProtectConfigurationRequest":{ + "type":"structure", + "members":{ + } + }, + "DeleteAccountDefaultProtectConfigurationResult":{ + "type":"structure", + "required":[ + "DefaultProtectConfigurationArn", + "DefaultProtectConfigurationId" + ], + "members":{ + "DefaultProtectConfigurationArn":{ + "shape":"ProtectConfigurationArn", + "documentation":"The Amazon Resource Name (ARN) of the account default protect configuration.
" + }, + "DefaultProtectConfigurationId":{ + "shape":"ProtectConfigurationId", + "documentation":"The unique identifier of the account default protect configuration.
" + } + } + }, + "DeleteConfigurationSetRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetNameOrArn", + "documentation":"The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
" + } + } + }, + "DeleteConfigurationSetResult":{ + "type":"structure", + "members":{ + "ConfigurationSetArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the deleted configuration set.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"The name of the deleted configuration set.
" + }, + "EventDestinations":{ + "shape":"EventDestinationList", + "documentation":"An array of any EventDestination objects that were associated with the deleted configuration set.
" + }, + "DefaultMessageType":{ + "shape":"MessageType", + "documentation":"The default message type of the configuration set that was deleted.
" + }, + "DefaultSenderId":{ + "shape":"SenderId", + "documentation":"The default Sender ID of the configuration set that was deleted.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time that the deleted configuration set was created in UNIX epoch time format.
" + } + } + }, + "DeleteDefaultMessageTypeRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetNameOrArn", + "documentation":"The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default message type from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
" + } + } + }, + "DeleteDefaultMessageTypeResult":{ + "type":"structure", + "members":{ + "ConfigurationSetArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the configuration set.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"The name of the configuration set.
" + }, + "MessageType":{ + "shape":"MessageType", + "documentation":"The current message type for the configuration set.
" + } + } + }, + "DeleteDefaultSenderIdRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetNameOrArn", + "documentation":"The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
" + } + } + }, + "DeleteDefaultSenderIdResult":{ + "type":"structure", + "members":{ + "ConfigurationSetArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the configuration set.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"The name of the configuration set.
" + }, + "SenderId":{ + "shape":"SenderId", + "documentation":"The current sender ID for the configuration set.
" + } + } + }, + "DeleteEventDestinationRequest":{ + "type":"structure", + "required":[ + "ConfigurationSetName", + "EventDestinationName" + ], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetNameOrArn", + "documentation":"The name of the configuration set or the configuration set's Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
" + }, + "EventDestinationName":{ + "shape":"EventDestinationName", + "documentation":"The name of the event destination to delete.
" + } + } + }, + "DeleteEventDestinationResult":{ + "type":"structure", + "members":{ + "ConfigurationSetArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the configuration set.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"The name of the configuration set the event destination was deleted from.
" + }, + "EventDestination":{ + "shape":"EventDestination", + "documentation":"The event destination object that was deleted.
" + } + } + }, + "DeleteKeywordRequest":{ + "type":"structure", + "required":[ + "OriginationIdentity", + "Keyword" + ], + "members":{ + "OriginationIdentity":{ + "shape":"PhoneOrPoolIdOrArn", + "documentation":"The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The keyword to delete.
" + } + } + }, + "DeleteKeywordResult":{ + "type":"structure", + "members":{ + "OriginationIdentityArn":{ + "shape":"String", + "documentation":"The PhoneNumberArn or PoolArn that the keyword was associated with.
" + }, + "OriginationIdentity":{ + "shape":"String", + "documentation":"The PhoneNumberId or PoolId that the keyword was associated with.
" + }, + "Keyword":{ + "shape":"Keyword", + "documentation":"The keyword that was deleted.
" + }, + "KeywordMessage":{ + "shape":"KeywordMessage", + "documentation":"The message that was associated with the deleted keyword.
" + }, + "KeywordAction":{ + "shape":"KeywordAction", + "documentation":"The action that was associated with the deleted keyword.
" + } + } + }, + "DeleteMediaMessageSpendLimitOverrideRequest":{ + "type":"structure", + "members":{ + } + }, + "DeleteMediaMessageSpendLimitOverrideResult":{ + "type":"structure", + "members":{ + "MonthlyLimit":{ + "shape":"MonthlyLimit", + "documentation":"The current monthly limit, in US dollars.
" + } + } + }, + "DeleteOptOutListRequest":{ + "type":"structure", + "required":["OptOutListName"], + "members":{ + "OptOutListName":{ + "shape":"OptOutListNameOrArn", + "documentation":"The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The Amazon Resource Name (ARN) of the OptOutList that was removed.
" + }, + "OptOutListName":{ + "shape":"OptOutListName", + "documentation":"The name of the OptOutList that was removed.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the OptOutList was created, in UNIX epoch time format.
" + } + } + }, + "DeleteOptedOutNumberRequest":{ + "type":"structure", + "required":[ + "OptOutListName", + "OptedOutNumber" + ], + "members":{ + "OptOutListName":{ + "shape":"OptOutListNameOrArn", + "documentation":"The OptOutListName or OptOutListArn to remove the phone number from.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The phone number, in E.164 format, to remove from the OptOutList.
" + } + } + }, + "DeleteOptedOutNumberResult":{ + "type":"structure", + "members":{ + "OptOutListArn":{ + "shape":"String", + "documentation":"The OptOutListArn that the phone number was removed from.
" + }, + "OptOutListName":{ + "shape":"OptOutListName", + "documentation":"The OptOutListName that the phone number was removed from.
" + }, + "OptedOutNumber":{ + "shape":"PhoneNumber", + "documentation":"The phone number that was removed from the OptOutList.
" + }, + "OptedOutTimestamp":{ + "shape":"Timestamp", + "documentation":"The time that the number was removed at, in UNIX epoch time format.
" + }, + "EndUserOptedOut":{ + "shape":"PrimitiveBoolean", + "documentation":"This is true if it was the end user who requested their phone number be removed.
" + } + } + }, + "DeletePoolRequest":{ + "type":"structure", + "required":["PoolId"], + "members":{ + "PoolId":{ + "shape":"PoolIdOrArn", + "documentation":"The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The Amazon Resource Name (ARN) of the pool that was deleted.
" + }, + "PoolId":{ + "shape":"String", + "documentation":"The PoolId of the pool that was deleted.
" + }, + "Status":{ + "shape":"PoolStatus", + "documentation":"The current status of the pool.
CREATING: The pool is currently being created and isn't yet available for use.
ACTIVE: The pool is active and available for use.
DELETING: The pool is being deleted.
The message type that was associated with the deleted pool.
" + }, + "TwoWayEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" + }, + "TwoWayChannelArn":{ + "shape":"TwoWayChannelArn", + "documentation":"The Amazon Resource Name (ARN) of the TwoWayChannel.
" + }, + "TwoWayChannelRole":{ + "shape":"IamRoleArn", + "documentation":"An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, + "SelfManagedOptOutsEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" + }, + "OptOutListName":{ + "shape":"OptOutListName", + "documentation":"The name of the OptOutList that was associated with the deleted pool.
" + }, + "SharedRoutesEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"Indicates whether shared routes are enabled for the pool.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the pool was created, in UNIX epoch time format.
" + } + } + }, + "DeleteProtectConfigurationRequest":{ + "type":"structure", + "required":["ProtectConfigurationId"], + "members":{ + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationIdOrArn", + "documentation":"The unique identifier for the protect configuration.
" + } + } + }, + "DeleteProtectConfigurationResult":{ + "type":"structure", + "required":[ + "ProtectConfigurationArn", + "ProtectConfigurationId", + "CreatedTimestamp", + "AccountDefault", + "DeletionProtectionEnabled" + ], + "members":{ + "ProtectConfigurationArn":{ + "shape":"ProtectConfigurationArn", + "documentation":"The Amazon Resource Name (ARN) of the protect configuration.
" + }, + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationId", + "documentation":"The unique identifier for the protect configuration.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the protect configuration was created, in UNIX epoch time format.
" + }, + "AccountDefault":{ + "shape":"PrimitiveBoolean", + "documentation":"This is true if the protect configuration is set as your account default protect configuration.
" + }, + "DeletionProtectionEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
" + } + } + }, + "DeleteRegistrationAttachmentRequest":{ + "type":"structure", + "required":["RegistrationAttachmentId"], + "members":{ + "RegistrationAttachmentId":{ + "shape":"RegistrationAttachmentIdOrArn", + "documentation":"The unique identifier for the registration attachment.
" + } + } + }, + "DeleteRegistrationAttachmentResult":{ + "type":"structure", + "required":[ + "RegistrationAttachmentArn", + "RegistrationAttachmentId", + "AttachmentStatus", + "CreatedTimestamp" + ], + "members":{ + "RegistrationAttachmentArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the registration attachment.
" + }, + "RegistrationAttachmentId":{ + "shape":"String", + "documentation":"The unique identifier for the registration attachment.
" + }, + "AttachmentStatus":{ + "shape":"AttachmentStatus", + "documentation":"The status of the registration attachment.
UPLOAD_IN_PROGRESS The attachment is being uploaded.
UPLOAD_COMPLETE The attachment has been uploaded.
UPLOAD_FAILED The attachment failed to uploaded.
DELETED The attachment has been deleted..
The error message if the upload failed.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the registration attachment was created, in UNIX epoch time format.
" + } + } + }, + "DeleteRegistrationFieldValueRequest":{ + "type":"structure", + "required":[ + "RegistrationId", + "FieldPath" + ], + "members":{ + "RegistrationId":{ + "shape":"RegistrationIdOrArn", + "documentation":"The unique identifier for the registration.
" + }, + "FieldPath":{ + "shape":"FieldPath", + "documentation":"The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
" + } + } + }, + "DeleteRegistrationFieldValueResult":{ + "type":"structure", + "required":[ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "FieldPath" + ], + "members":{ + "RegistrationArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "VersionNumber":{ + "shape":"RegistrationVersionNumber", + "documentation":"The version number of the registration.
" + }, + "FieldPath":{ + "shape":"FieldPath", + "documentation":"The path to the registration form field.
" + }, + "SelectChoices":{ + "shape":"SelectChoiceList", + "documentation":"An array of values for the form field.
" + }, + "TextValue":{ + "shape":"TextValue", + "documentation":"The text data for a free form field.
" + }, + "RegistrationAttachmentId":{ + "shape":"String", + "documentation":"The unique identifier for the registration attachment.
" + } + } + }, + "DeleteRegistrationRequest":{ + "type":"structure", + "required":["RegistrationId"], + "members":{ + "RegistrationId":{ + "shape":"RegistrationIdOrArn", + "documentation":"The unique identifier for the registration.
" + } + } + }, + "DeleteRegistrationResult":{ + "type":"structure", + "required":[ + "RegistrationArn", + "RegistrationId", + "RegistrationType", + "RegistrationStatus", + "CurrentVersionNumber", + "CreatedTimestamp" + ], + "members":{ + "RegistrationArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "RegistrationType":{ + "shape":"RegistrationType", + "documentation":"The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "RegistrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"The status of the registration.
CREATED: Your registration is created but not submitted.
SUBMITTED: Your registration has been submitted and is awaiting review.
REVIEWING: Your registration has been accepted and is being reviewed.
PROVISIONING: Your registration has been approved and your origination identity is being created.
COMPLETE: Your registration has been approved and and your origination identity has been created.
REQUIRES_UPDATES: You must fix your registration and resubmit it.
CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
DELETED: The registration has been deleted.
The current version number of the registration.
" + }, + "ApprovedVersionNumber":{ + "shape":"RegistrationVersionNumber", + "documentation":"The version number of the registration that was approved.
" + }, + "LatestDeniedVersionNumber":{ + "shape":"RegistrationVersionNumber", + "documentation":"The latest version number of the registration that was denied.
" + }, + "AdditionalAttributes":{ + "shape":"StringMap", + "documentation":"Metadata about a given registration which is specific to that registration type.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the registration was created, in UNIX epoch time format.
" + } + } + }, + "DeleteResourcePolicyRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource you're deleting the resource-based policy from.
" + } + } + }, + "DeleteResourcePolicyResult":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource that the resource-based policy was deleted from.
" + }, + "Policy":{ + "shape":"ResourcePolicy", + "documentation":"The JSON formatted resource-based policy that was deleted.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the resource-based policy was created, in UNIX epoch time format.
" + } + } + }, + "DeleteTextMessageSpendLimitOverrideRequest":{ + "type":"structure", + "members":{ + } + }, + "DeleteTextMessageSpendLimitOverrideResult":{ + "type":"structure", + "members":{ + "MonthlyLimit":{ + "shape":"MonthlyLimit", + "documentation":"The current monthly limit, in US dollars.
" + } + } + }, + "DeleteVerifiedDestinationNumberRequest":{ + "type":"structure", + "required":["VerifiedDestinationNumberId"], + "members":{ + "VerifiedDestinationNumberId":{ + "shape":"VerifiedDestinationNumberIdOrArn", + "documentation":"The unique identifier for the verified destination phone number.
" + } + } + }, + "DeleteVerifiedDestinationNumberResult":{ + "type":"structure", + "required":[ + "VerifiedDestinationNumberArn", + "VerifiedDestinationNumberId", + "DestinationPhoneNumber", + "CreatedTimestamp" + ], + "members":{ + "VerifiedDestinationNumberArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the verified destination phone number.
" + }, + "VerifiedDestinationNumberId":{ + "shape":"String", + "documentation":"The unique identifier for the verified destination phone number.
" + }, + "DestinationPhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The verified destination phone number, in E.164 format.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the destination phone number was created, in UNIX epoch time format.
" + } + } + }, + "DeleteVoiceMessageSpendLimitOverrideRequest":{ + "type":"structure", + "members":{ + } + }, + "DeleteVoiceMessageSpendLimitOverrideResult":{ + "type":"structure", + "members":{ + "MonthlyLimit":{ + "shape":"MonthlyLimit", + "documentation":"The current monthly limit, in US dollars.
" + } + } + }, + "DeliveryStreamArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:\\S+" + }, + "DescribeAccountAttributesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "DescribeAccountAttributesResult":{ + "type":"structure", + "members":{ + "AccountAttributes":{ + "shape":"AccountAttributeList", + "documentation":"An array of AccountAttributes objects.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } + }, + "DescribeAccountLimitsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "DescribeAccountLimitsResult":{ + "type":"structure", + "members":{ + "AccountLimits":{ + "shape":"AccountLimitList", + "documentation":"An array of AccountLimit objects that show the current spend limits.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } + }, + "DescribeConfigurationSetsRequest":{ + "type":"structure", + "members":{ + "ConfigurationSetNames":{ + "shape":"ConfigurationSetNameList", + "documentation":"An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.
" + }, + "Filters":{ + "shape":"ConfigurationSetFilterList", + "documentation":"An array of filters to apply to the results that are returned.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "DescribeConfigurationSetsResult":{ + "type":"structure", + "members":{ + "ConfigurationSets":{ + "shape":"ConfigurationSetInformationList", + "documentation":"An array of ConfigurationSets objects.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } + }, + "DescribeKeywordsRequest":{ + "type":"structure", + "required":["OriginationIdentity"], + "members":{ + "OriginationIdentity":{ + "shape":"PhoneOrPoolIdOrArn", + "documentation":"The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
An array of keywords to search for.
" + }, + "Filters":{ + "shape":"KeywordFilterList", + "documentation":"An array of keyword filters to filter the results.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "DescribeKeywordsResult":{ + "type":"structure", + "members":{ + "OriginationIdentityArn":{ + "shape":"String", + "documentation":"The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
" + }, + "OriginationIdentity":{ + "shape":"String", + "documentation":"The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
" + }, + "Keywords":{ + "shape":"KeywordInformationList", + "documentation":"An array of KeywordInformation objects that contain the results.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } + }, + "DescribeOptOutListsRequest":{ + "type":"structure", + "members":{ + "OptOutListNames":{ + "shape":"OptOutListNameList", + "documentation":"The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + }, + "Owner":{ + "shape":"Owner", + "documentation":"Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.
An array of OptOutListInformation objects that contain the details for the requested OptOutLists.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } + }, + "DescribeOptedOutNumbersRequest":{ + "type":"structure", + "required":["OptOutListName"], + "members":{ + "OptOutListName":{ + "shape":"OptOutListNameOrArn", + "documentation":"The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
An array of phone numbers to search for in the OptOutList.
" + }, + "Filters":{ + "shape":"OptedOutFilterList", + "documentation":"An array of OptedOutFilter objects to filter the results on.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "DescribeOptedOutNumbersResult":{ + "type":"structure", + "members":{ + "OptOutListArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the OptOutList.
" + }, + "OptOutListName":{ + "shape":"OptOutListName", + "documentation":"The name of the OptOutList.
" + }, + "OptedOutNumbers":{ + "shape":"OptedOutNumberInformationList", + "documentation":"An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } + }, + "DescribePhoneNumbersRequest":{ + "type":"structure", + "members":{ + "PhoneNumberIds":{ + "shape":"PhoneNumberIdList", + "documentation":"The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
An array of PhoneNumberFilter objects to filter the results.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + }, + "Owner":{ + "shape":"Owner", + "documentation":"Use SELF to filter the list of phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds parameters can't be used at the same time.
An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } + }, + "DescribePoolsRequest":{ + "type":"structure", + "members":{ + "PoolIds":{ + "shape":"PoolIdList", + "documentation":"The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
An array of PoolFilter objects to filter the results.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + }, + "Owner":{ + "shape":"Owner", + "documentation":"Use SELF to filter the list of Pools to ones your account owns or use SHARED to filter on Pools shared with your account. The Owner and PoolIds parameters can't be used at the same time.
An array of PoolInformation objects that contain the details for the requested pools.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } + }, + "DescribeProtectConfigurationsRequest":{ + "type":"structure", + "members":{ + "ProtectConfigurationIds":{ + "shape":"ProtectConfigurationIdList", + "documentation":"An array of protect configuration identifiers to search for.
" + }, + "Filters":{ + "shape":"ProtectConfigurationFilterList", + "documentation":"An array of ProtectConfigurationFilter objects to filter the results.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "DescribeProtectConfigurationsResult":{ + "type":"structure", + "members":{ + "ProtectConfigurations":{ + "shape":"ProtectConfigurationInformationList", + "documentation":"An array of ProtectConfigurationInformation objects that contain the details for the request.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + } + } + }, + "DescribeRegistrationAttachmentsRequest":{ + "type":"structure", + "members":{ + "RegistrationAttachmentIds":{ + "shape":"RegistrationAttachmentIdList", + "documentation":"The unique identifier of registration attachments to find. This is an array of RegistrationAttachmentId.
" + }, + "Filters":{ + "shape":"RegistrationAttachmentFilterList", + "documentation":"An array of RegistrationAttachmentFilter objects to filter the results.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "DescribeRegistrationAttachmentsResult":{ + "type":"structure", + "required":["RegistrationAttachments"], + "members":{ + "RegistrationAttachments":{ + "shape":"RegistrationAttachmentsInformationList", + "documentation":"An array of RegistrationAttachments objects that contain the details for the requested registration attachments.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + } + } + }, + "DescribeRegistrationFieldDefinitionsRequest":{ + "type":"structure", + "required":["RegistrationType"], + "members":{ + "RegistrationType":{ + "shape":"RegistrationType", + "documentation":"The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "SectionPath":{ + "shape":"SectionPath", + "documentation":"The path to the section of the registration.
" + }, + "FieldPaths":{ + "shape":"FieldPathList", + "documentation":"An array of paths to the registration form field.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "DescribeRegistrationFieldDefinitionsResult":{ + "type":"structure", + "required":[ + "RegistrationType", + "RegistrationFieldDefinitions" + ], + "members":{ + "RegistrationType":{ + "shape":"RegistrationType", + "documentation":"The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "RegistrationFieldDefinitions":{ + "shape":"RegistrationFieldDefinitionList", + "documentation":"An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + } + } + }, + "DescribeRegistrationFieldValuesRequest":{ + "type":"structure", + "required":["RegistrationId"], + "members":{ + "RegistrationId":{ + "shape":"RegistrationIdOrArn", + "documentation":"The unique identifier for the registration.
" + }, + "VersionNumber":{ + "shape":"RegistrationVersionNumber", + "documentation":"The version number of the registration.
" + }, + "SectionPath":{ + "shape":"SectionPath", + "documentation":"The path to the section of the registration.
" + }, + "FieldPaths":{ + "shape":"FieldPathList", + "documentation":"An array of paths to the registration form field.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "DescribeRegistrationFieldValuesResult":{ + "type":"structure", + "required":[ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "RegistrationFieldValues" + ], + "members":{ + "RegistrationArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "VersionNumber":{ + "shape":"RegistrationVersionNumber", + "documentation":"The current version of the registration.
" + }, + "RegistrationFieldValues":{ + "shape":"RegistrationFieldValueInformationList", + "documentation":"An array of RegistrationFieldValues objects that contain the values for the requested registration.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + } + } + }, + "DescribeRegistrationSectionDefinitionsRequest":{ + "type":"structure", + "required":["RegistrationType"], + "members":{ + "RegistrationType":{ + "shape":"RegistrationType", + "documentation":"The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "SectionPaths":{ + "shape":"SectionPathList", + "documentation":"An array of paths for the registration form section.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "DescribeRegistrationSectionDefinitionsResult":{ + "type":"structure", + "required":[ + "RegistrationType", + "RegistrationSectionDefinitions" + ], + "members":{ + "RegistrationType":{ + "shape":"RegistrationType", + "documentation":"The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "RegistrationSectionDefinitions":{ + "shape":"RegistrationSectionDefinitionList", + "documentation":"An array of RegistrationSectionDefinition objects.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + } + } + }, + "DescribeRegistrationTypeDefinitionsRequest":{ + "type":"structure", + "members":{ + "RegistrationTypes":{ + "shape":"RegistrationTypeList", + "documentation":"The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "Filters":{ + "shape":"RegistrationTypeFilterList", + "documentation":"An array of RegistrationFilter objects to filter the results.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "DescribeRegistrationTypeDefinitionsResult":{ + "type":"structure", + "required":["RegistrationTypeDefinitions"], + "members":{ + "RegistrationTypeDefinitions":{ + "shape":"RegistrationTypeDefinitionList", + "documentation":"The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + } + } + }, + "DescribeRegistrationVersionsRequest":{ + "type":"structure", + "required":["RegistrationId"], + "members":{ + "RegistrationId":{ + "shape":"RegistrationIdOrArn", + "documentation":"The unique identifier for the registration.
" + }, + "VersionNumbers":{ + "shape":"RegistrationVersionNumberList", + "documentation":"An array of registration version numbers.
" + }, + "Filters":{ + "shape":"RegistrationVersionFilterList", + "documentation":"An array of RegistrationVersionFilter objects to filter the results.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "DescribeRegistrationVersionsResult":{ + "type":"structure", + "required":[ + "RegistrationArn", + "RegistrationId", + "RegistrationVersions" + ], + "members":{ + "RegistrationArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "RegistrationVersions":{ + "shape":"RegistrationVersionInformationList", + "documentation":"An array of RegistrationVersions objects.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + } + } + }, + "DescribeRegistrationsRequest":{ + "type":"structure", + "members":{ + "RegistrationIds":{ + "shape":"RegistrationIdList", + "documentation":"An array of unique identifiers for each registration.
" + }, + "Filters":{ + "shape":"RegistrationFilterList", + "documentation":"An array of RegistrationFilter objects to filter the results.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "DescribeRegistrationsResult":{ + "type":"structure", + "required":["Registrations"], + "members":{ + "Registrations":{ + "shape":"RegistrationInformationList", + "documentation":"An array of RegistrationInformation objects.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + } + } + }, + "DescribeSenderIdsRequest":{ + "type":"structure", + "members":{ + "SenderIds":{ + "shape":"SenderIdList", + "documentation":"An array of SenderIdAndCountry objects to search for.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
An array of SenderIdFilter objects to filter the results.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + }, + "Owner":{ + "shape":"Owner", + "documentation":"Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.
An array of SernderIdInformation objects that contain the details for the requested SenderIds.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } + }, + "DescribeSpendLimitsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "DescribeSpendLimitsResult":{ + "type":"structure", + "members":{ + "SpendLimits":{ + "shape":"SpendLimitList", + "documentation":"An array of SpendLimit objects that contain the details for the requested spend limits.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } + }, + "DescribeVerifiedDestinationNumbersRequest":{ + "type":"structure", + "members":{ + "VerifiedDestinationNumberIds":{ + "shape":"VerifiedDestinationNumberIdList", + "documentation":"An array of VerifiedDestinationNumberid to retreive.
" + }, + "DestinationPhoneNumbers":{ + "shape":"DestinationPhoneNumberList", + "documentation":"An array of verified destination phone number, in E.164 format.
" + }, + "Filters":{ + "shape":"VerifiedDestinationNumberFilterList", + "documentation":"An array of VerifiedDestinationNumberFilter objects to filter the results.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "DescribeVerifiedDestinationNumbersResult":{ + "type":"structure", + "required":["VerifiedDestinationNumbers"], + "members":{ + "VerifiedDestinationNumbers":{ + "shape":"VerifiedDestinationNumberInformationList", + "documentation":"An array of VerifiedDestinationNumberInformation objects
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + } + } + }, + "DestinationCountryParameterKey":{ + "type":"string", + "enum":[ + "IN_TEMPLATE_ID", + "IN_ENTITY_ID" + ] + }, + "DestinationCountryParameterValue":{ + "type":"string", + "max":64, + "min":1, + "pattern":"\\S+" + }, + "DestinationCountryParameters":{ + "type":"map", + "key":{"shape":"DestinationCountryParameterKey"}, + "value":{"shape":"DestinationCountryParameterValue"}, + "max":10, + "min":0 + }, + "DestinationPhoneNumberList":{ + "type":"list", + "member":{"shape":"PhoneNumber"}, + "max":5, + "min":0 + }, + "DisassociateOriginationIdentityRequest":{ + "type":"structure", + "required":[ + "PoolId", + "OriginationIdentity", + "IsoCountryCode" + ], + "members":{ + "PoolId":{ + "shape":"PoolIdOrArn", + "documentation":"The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken":true + } + } + }, + "DisassociateOriginationIdentityResult":{ + "type":"structure", + "members":{ + "PoolArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the pool.
" + }, + "PoolId":{ + "shape":"String", + "documentation":"The PoolId of the pool no longer associated with the origination identity.
" + }, + "OriginationIdentityArn":{ + "shape":"String", + "documentation":"The PhoneNumberArn or SenderIdArn of the origination identity.
" + }, + "OriginationIdentity":{ + "shape":"String", + "documentation":"The PhoneNumberId or SenderId of the origination identity.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + } + } + }, + "DisassociateProtectConfigurationRequest":{ + "type":"structure", + "required":[ + "ProtectConfigurationId", + "ConfigurationSetName" + ], + "members":{ + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationIdOrArn", + "documentation":"The unique identifier for the protect configuration.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetNameOrArn", + "documentation":"The name of the ConfigurationSet.
" + } + } + }, + "DisassociateProtectConfigurationResult":{ + "type":"structure", + "required":[ + "ConfigurationSetArn", + "ConfigurationSetName", + "ProtectConfigurationArn", + "ProtectConfigurationId" + ], + "members":{ + "ConfigurationSetArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the configuration set.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"The name of the ConfigurationSet.
" + }, + "ProtectConfigurationArn":{ + "shape":"ProtectConfigurationArn", + "documentation":"The Amazon Resource Name (ARN) of the protect configuration.
" + }, + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationId", + "documentation":"The unique identifier for the protect configuration.
" + } + } + }, + "DiscardRegistrationVersionRequest":{ + "type":"structure", + "required":["RegistrationId"], + "members":{ + "RegistrationId":{ + "shape":"RegistrationIdOrArn", + "documentation":"The unique identifier for the registration.
" + } + } + }, + "DiscardRegistrationVersionResult":{ + "type":"structure", + "required":[ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "RegistrationVersionStatus", + "RegistrationVersionStatusHistory" + ], + "members":{ + "RegistrationArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "VersionNumber":{ + "shape":"RegistrationVersionNumber", + "documentation":"The version number of the registration.
" + }, + "RegistrationVersionStatus":{ + "shape":"RegistrationVersionStatus", + "documentation":"The status of the registration version.
DRAFT: The initial status of a registration version after it’s created.
SUBMITTED: Your registration has been submitted.
REVIEWING: Your registration has been accepted and is being reviewed.
APPROVED: Your registration has been approved.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DENIED: You must fix your registration and resubmit it.
REVOKED: Your previously approved registration has been revoked.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
" + } + } + }, + "EventDestination":{ + "type":"structure", + "required":[ + "EventDestinationName", + "Enabled", + "MatchingEventTypes" + ], + "members":{ + "EventDestinationName":{ + "shape":"EventDestinationName", + "documentation":"The name of the EventDestination.
" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"When set to true events will be logged.
" + }, + "MatchingEventTypes":{ + "shape":"EventTypeList", + "documentation":"An array of event types that determine which events to log.
The TEXT_SENT event type is not supported.
An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
" + }, + "KinesisFirehoseDestination":{ + "shape":"KinesisFirehoseDestination", + "documentation":"An object that contains information about an event destination for logging to Amazon Data Firehose.
" + }, + "SnsDestination":{ + "shape":"SnsDestination", + "documentation":"An object that contains information about an event destination that sends logging events to Amazon SNS.
" + } + }, + "documentation":"Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Firehose, or Amazon SNS.
" + }, + "EventDestinationList":{ + "type":"list", + "member":{"shape":"EventDestination"} + }, + "EventDestinationName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z0-9_-]+" + }, + "EventType":{ + "type":"string", + "enum":[ + "ALL", + "TEXT_ALL", + "TEXT_SENT", + "TEXT_PENDING", + "TEXT_QUEUED", + "TEXT_SUCCESSFUL", + "TEXT_DELIVERED", + "TEXT_INVALID", + "TEXT_INVALID_MESSAGE", + "TEXT_UNREACHABLE", + "TEXT_CARRIER_UNREACHABLE", + "TEXT_BLOCKED", + "TEXT_CARRIER_BLOCKED", + "TEXT_SPAM", + "TEXT_UNKNOWN", + "TEXT_TTL_EXPIRED", + "VOICE_ALL", + "VOICE_INITIATED", + "VOICE_RINGING", + "VOICE_ANSWERED", + "VOICE_COMPLETED", + "VOICE_BUSY", + "VOICE_NO_ANSWER", + "VOICE_FAILED", + "VOICE_TTL_EXPIRED", + "MEDIA_ALL", + "MEDIA_PENDING", + "MEDIA_QUEUED", + "MEDIA_SUCCESSFUL", + "MEDIA_DELIVERED", + "MEDIA_INVALID", + "MEDIA_INVALID_MESSAGE", + "MEDIA_UNREACHABLE", + "MEDIA_CARRIER_UNREACHABLE", + "MEDIA_BLOCKED", + "MEDIA_CARRIER_BLOCKED", + "MEDIA_SPAM", + "MEDIA_UNKNOWN", + "MEDIA_TTL_EXPIRED", + "MEDIA_FILE_INACCESSIBLE", + "MEDIA_FILE_TYPE_UNSUPPORTED", + "MEDIA_FILE_SIZE_EXCEEDED" + ] + }, + "EventTypeList":{ + "type":"list", + "member":{"shape":"EventType"}, + "max":43, + "min":1 + }, + "FieldPath":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[A-Za-z0-9_\\.]+" + }, + "FieldPathList":{ + "type":"list", + "member":{"shape":"FieldPath"}, + "max":5, + "min":0 + }, + "FieldRequirement":{ + "type":"string", + "enum":[ + "REQUIRED", + "CONDITIONAL", + "OPTIONAL" + ] + }, + "FieldType":{ + "type":"string", + "enum":[ + "SELECT", + "TEXT", + "ATTACHMENT" + ] + }, + "FilterValue":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[/\\.:A-Za-z0-9_-]+" + }, + "FilterValueList":{ + "type":"list", + "member":{"shape":"FilterValue"}, + "max":20, + "min":1 + }, + "GetProtectConfigurationCountryRuleSetRequest":{ + "type":"structure", + "required":[ + "ProtectConfigurationId", + "NumberCapability" + ], + "members":{ + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationIdOrArn", + "documentation":"The unique identifier for the protect configuration.
" + }, + "NumberCapability":{ + "shape":"NumberCapability", + "documentation":"The capability type to return the CountryRuleSet for. Valid values are SMS, VOICE, or MMS.
The Amazon Resource Name (ARN) of the protect configuration.
" + }, + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationId", + "documentation":"The unique identifier for the protect configuration.
" + }, + "NumberCapability":{ + "shape":"NumberCapability", + "documentation":"The capability type associated with the returned ProtectConfigurationCountryRuleSetInformation objects.
" + }, + "CountryRuleSet":{ + "shape":"ProtectConfigurationCountryRuleSet", + "documentation":"A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.
" + } + } + }, + "GetResourcePolicyRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.
" + } + } + }, + "GetResourcePolicyResult":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.
" + }, + "Policy":{ + "shape":"ResourcePolicy", + "documentation":"The JSON formatted string that contains the resource-based policy attached to the AWS End User Messaging SMS and Voice resource.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the resource-based policy was created, in UNIX epoch time format.
" + } + } + }, + "IamRoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:\\S+" + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"The unique identifier of the request.
" + } + }, + "documentation":"The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
", + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "IsoCountryCode":{ + "type":"string", + "max":2, + "min":2, + "pattern":"[A-Z]{2}" + }, + "Keyword":{ + "type":"string", + "max":30, + "min":1, + "pattern":"[ \\S]+" + }, + "KeywordAction":{ + "type":"string", + "enum":[ + "AUTOMATIC_RESPONSE", + "OPT_OUT", + "OPT_IN" + ] + }, + "KeywordFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"KeywordFilterName", + "documentation":"The name of the attribute to filter on.
" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"An array values to filter for.
" + } + }, + "documentation":"The information for keywords that meet a specified criteria.
" + }, + "KeywordFilterList":{ + "type":"list", + "member":{"shape":"KeywordFilter"}, + "max":20, + "min":0 + }, + "KeywordFilterName":{ + "type":"string", + "enum":["keyword-action"] + }, + "KeywordInformation":{ + "type":"structure", + "required":[ + "Keyword", + "KeywordMessage", + "KeywordAction" + ], + "members":{ + "Keyword":{ + "shape":"Keyword", + "documentation":"The keyword as a string.
" + }, + "KeywordMessage":{ + "shape":"KeywordMessage", + "documentation":"A custom message that can be used with the keyword.
" + }, + "KeywordAction":{ + "shape":"KeywordAction", + "documentation":"The action to perform for the keyword.
" + } + }, + "documentation":"The information for all keywords in a pool.
" + }, + "KeywordInformationList":{ + "type":"list", + "member":{"shape":"KeywordInformation"} + }, + "KeywordList":{ + "type":"list", + "member":{"shape":"Keyword"}, + "max":5, + "min":0 + }, + "KeywordMessage":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"(?!\\s*$)[\\s\\S]+" + }, + "KinesisFirehoseDestination":{ + "type":"structure", + "required":[ + "IamRoleArn", + "DeliveryStreamArn" + ], + "members":{ + "IamRoleArn":{ + "shape":"IamRoleArn", + "documentation":"The ARN of an Identity and Access Management role that is able to write event data to an Amazon Data Firehose destination.
" + }, + "DeliveryStreamArn":{ + "shape":"DeliveryStreamArn", + "documentation":"The Amazon Resource Name (ARN) of the delivery stream.
" + } + }, + "documentation":"Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with a Firehose event destination.
Event destinations, such as Firehose, are associated with configuration sets, which enable you to publish message sending events.
" + }, + "LanguageCode":{ + "type":"string", + "enum":[ + "DE_DE", + "EN_GB", + "EN_US", + "ES_419", + "ES_ES", + "FR_CA", + "FR_FR", + "IT_IT", + "JA_JP", + "KO_KR", + "PT_BR", + "ZH_CN", + "ZH_TW" + ] + }, + "ListPoolOriginationIdentitiesRequest":{ + "type":"structure", + "required":["PoolId"], + "members":{ + "PoolId":{ + "shape":"PoolIdOrArn", + "documentation":"The unique identifier for the pool. This value can be either the PoolId or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
An array of PoolOriginationIdentitiesFilter objects to filter the results..
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "ListPoolOriginationIdentitiesResult":{ + "type":"structure", + "members":{ + "PoolArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the pool.
" + }, + "PoolId":{ + "shape":"String", + "documentation":"The unique PoolId of the pool.
" + }, + "OriginationIdentities":{ + "shape":"OriginationIdentityMetadataList", + "documentation":"An array of any OriginationIdentityMetadata objects.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } + }, + "ListRegistrationAssociationsRequest":{ + "type":"structure", + "required":["RegistrationId"], + "members":{ + "RegistrationId":{ + "shape":"RegistrationIdOrArn", + "documentation":"The unique identifier for the registration.
" + }, + "Filters":{ + "shape":"RegistrationAssociationFilterList", + "documentation":"An array of RegistrationAssociationFilter to apply to the results that are returned.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per each request.
" + } + } + }, + "ListRegistrationAssociationsResult":{ + "type":"structure", + "required":[ + "RegistrationArn", + "RegistrationId", + "RegistrationType", + "RegistrationAssociations" + ], + "members":{ + "RegistrationArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "RegistrationType":{ + "shape":"RegistrationType", + "documentation":"The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "RegistrationAssociations":{ + "shape":"RegistrationAssociationMetadataList", + "documentation":"An array of RegistrationAssociationMetadata objects.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the resource to query for.
" + } + } + }, + "ListTagsForResourceResult":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the resource.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of key and value pair tags that are associated with the resource.
" + } + } + }, + "LogGroupArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:\\S+" + }, + "MaxPrice":{ + "type":"string", + "max":8, + "min":2, + "pattern":"[0-9]{0,2}\\.[0-9]{1,5}" + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MediaMessageOriginationIdentity":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/\\+-]+" + }, + "MediaUrlList":{ + "type":"list", + "member":{"shape":"MediaUrlValue"}, + "max":1, + "min":1 + }, + "MediaUrlValue":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"s3://([a-z0-9\\.-]{3,63})/(.+)" + }, + "MessageType":{ + "type":"string", + "enum":[ + "TRANSACTIONAL", + "PROMOTIONAL" + ] + }, + "MessageTypeList":{ + "type":"list", + "member":{"shape":"MessageType"}, + "max":2, + "min":0 + }, + "MonthlyLimit":{ + "type":"long", + "box":true, + "max":1000000000, + "min":0 + }, + "NextToken":{ + "type":"string", + "max":1024, + "min":1, + "pattern":".+" + }, + "NonEmptyTagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":1 + }, + "NumberCapability":{ + "type":"string", + "enum":[ + "SMS", + "VOICE", + "MMS" + ] + }, + "NumberCapabilityList":{ + "type":"list", + "member":{"shape":"NumberCapability"}, + "max":3, + "min":1 + }, + "NumberStatus":{ + "type":"string", + "enum":[ + "PENDING", + "ACTIVE", + "ASSOCIATING", + "DISASSOCIATING", + "DELETED" + ] + }, + "NumberType":{ + "type":"string", + "enum":[ + "SHORT_CODE", + "LONG_CODE", + "TOLL_FREE", + "TEN_DLC", + "SIMULATOR" + ] + }, + "OptOutListInformation":{ + "type":"structure", + "required":[ + "OptOutListArn", + "OptOutListName", + "CreatedTimestamp" + ], + "members":{ + "OptOutListArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the OptOutList.
" + }, + "OptOutListName":{ + "shape":"OptOutListName", + "documentation":"The name of the OptOutList.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the OutOutList was created, in UNIX epoch time format.
" + } + }, + "documentation":"The information for all OptOutList in an Amazon Web Services account.
" + }, + "OptOutListInformationList":{ + "type":"list", + "member":{"shape":"OptOutListInformation"} + }, + "OptOutListName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z0-9_-]+" + }, + "OptOutListNameList":{ + "type":"list", + "member":{"shape":"OptOutListNameOrArn"}, + "max":5, + "min":0 + }, + "OptOutListNameOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/-]+" + }, + "OptedOutFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"OptedOutFilterName", + "documentation":"The name of the attribute to filter on.
" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"An array of values to filter for.
" + } + }, + "documentation":"The information for opted out numbers that meet a specified criteria.
" + }, + "OptedOutFilterList":{ + "type":"list", + "member":{"shape":"OptedOutFilter"}, + "max":20, + "min":0 + }, + "OptedOutFilterName":{ + "type":"string", + "enum":["end-user-opted-out"] + }, + "OptedOutNumberInformation":{ + "type":"structure", + "required":[ + "OptedOutNumber", + "OptedOutTimestamp", + "EndUserOptedOut" + ], + "members":{ + "OptedOutNumber":{ + "shape":"PhoneNumber", + "documentation":"The phone number that is opted out.
" + }, + "OptedOutTimestamp":{ + "shape":"Timestamp", + "documentation":"The time that the op tout occurred, in UNIX epoch time format.
" + }, + "EndUserOptedOut":{ + "shape":"PrimitiveBoolean", + "documentation":"This is set to true if it was the end recipient that opted out.
" + } + }, + "documentation":"The information for an opted out number in an Amazon Web Services account.
" + }, + "OptedOutNumberInformationList":{ + "type":"list", + "member":{"shape":"OptedOutNumberInformation"} + }, + "OptedOutNumberList":{ + "type":"list", + "member":{"shape":"PhoneNumber"}, + "max":5, + "min":0 + }, + "OriginationIdentityMetadata":{ + "type":"structure", + "required":[ + "OriginationIdentityArn", + "OriginationIdentity", + "IsoCountryCode", + "NumberCapabilities" + ], + "members":{ + "OriginationIdentityArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with the origination identity.
" + }, + "OriginationIdentity":{ + "shape":"String", + "documentation":"The unique identifier of the origination identity.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "NumberCapabilities":{ + "shape":"NumberCapabilityList", + "documentation":"Describes if the origination identity can be used for text messages, voice calls or both.
" + }, + "PhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The phone number in E.164 format.
" + } + }, + "documentation":"The metadata for an origination identity associated with a pool.
" + }, + "OriginationIdentityMetadataList":{ + "type":"list", + "member":{"shape":"OriginationIdentityMetadata"} + }, + "Owner":{ + "type":"string", + "enum":[ + "SELF", + "SHARED" + ] + }, + "PhoneNumber":{ + "type":"string", + "max":20, + "min":1, + "pattern":"\\+?[1-9][0-9]{1,18}" + }, + "PhoneNumberFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"PhoneNumberFilterName", + "documentation":"The name of the attribute to filter on.
" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"An array values to filter for.
" + } + }, + "documentation":"The information for a phone number that meets a specified criteria.
" + }, + "PhoneNumberFilterList":{ + "type":"list", + "member":{"shape":"PhoneNumberFilter"}, + "max":20, + "min":0 + }, + "PhoneNumberFilterName":{ + "type":"string", + "enum":[ + "status", + "iso-country-code", + "message-type", + "number-capability", + "number-type", + "two-way-enabled", + "self-managed-opt-outs-enabled", + "opt-out-list-name", + "deletion-protection-enabled", + "two-way-channel-arn" + ] + }, + "PhoneNumberIdList":{ + "type":"list", + "member":{"shape":"PhoneNumberIdOrArn"}, + "max":5, + "min":0 + }, + "PhoneNumberIdOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/-]+" + }, + "PhoneNumberInformation":{ + "type":"structure", + "required":[ + "PhoneNumberArn", + "PhoneNumber", + "Status", + "IsoCountryCode", + "MessageType", + "NumberCapabilities", + "NumberType", + "MonthlyLeasingPrice", + "TwoWayEnabled", + "SelfManagedOptOutsEnabled", + "OptOutListName", + "DeletionProtectionEnabled", + "CreatedTimestamp" + ], + "members":{ + "PhoneNumberArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with the phone number.
" + }, + "PhoneNumberId":{ + "shape":"String", + "documentation":"The unique identifier for the phone number.
" + }, + "PhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The phone number in E.164 format.
" + }, + "Status":{ + "shape":"NumberStatus", + "documentation":"The current status of the phone number.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "MessageType":{ + "shape":"MessageType", + "documentation":"The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "NumberCapabilities":{ + "shape":"NumberCapabilityList", + "documentation":"Describes if the origination identity can be used for text messages, voice calls or both.
" + }, + "NumberType":{ + "shape":"NumberType", + "documentation":"The type of phone number.
" + }, + "MonthlyLeasingPrice":{ + "shape":"String", + "documentation":"The price, in US dollars, to lease the phone number.
" + }, + "TwoWayEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
" + }, + "TwoWayChannelArn":{ + "shape":"TwoWayChannelArn", + "documentation":"The Amazon Resource Name (ARN) of the two way channel.
" + }, + "TwoWayChannelRole":{ + "shape":"IamRoleArn", + "documentation":"An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, + "SelfManagedOptOutsEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs
" + }, + "OptOutListName":{ + "shape":"OptOutListName", + "documentation":"The name of the OptOutList associated with the phone number.
" + }, + "DeletionProtectionEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"When set to true the phone number can't be deleted.
" + }, + "PoolId":{ + "shape":"String", + "documentation":"The unique identifier of the pool associated with the phone number.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the phone number was created, in UNIX epoch time format.
" + } + }, + "documentation":"The information for a phone number, in E.164 format, in an Amazon Web Services account.
" + }, + "PhoneNumberInformationList":{ + "type":"list", + "member":{"shape":"PhoneNumberInformation"} + }, + "PhoneOrPoolIdOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/-]+" + }, + "PhoneOrSenderIdOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/-]+" + }, + "PoolFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"PoolFilterName", + "documentation":"The name of the attribute to filter on.
" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"An array values to filter for.
" + } + }, + "documentation":"The information for a pool that meets a specified criteria.
" + }, + "PoolFilterList":{ + "type":"list", + "member":{"shape":"PoolFilter"}, + "max":20, + "min":0 + }, + "PoolFilterName":{ + "type":"string", + "enum":[ + "status", + "message-type", + "two-way-enabled", + "self-managed-opt-outs-enabled", + "opt-out-list-name", + "shared-routes-enabled", + "deletion-protection-enabled", + "two-way-channel-arn" + ] + }, + "PoolIdList":{ + "type":"list", + "member":{"shape":"PoolIdOrArn"}, + "max":5, + "min":0 + }, + "PoolIdOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/-]+" + }, + "PoolInformation":{ + "type":"structure", + "required":[ + "PoolArn", + "PoolId", + "Status", + "MessageType", + "TwoWayEnabled", + "SelfManagedOptOutsEnabled", + "OptOutListName", + "SharedRoutesEnabled", + "DeletionProtectionEnabled", + "CreatedTimestamp" + ], + "members":{ + "PoolArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the pool.
" + }, + "PoolId":{ + "shape":"String", + "documentation":"The unique identifier for the pool.
" + }, + "Status":{ + "shape":"PoolStatus", + "documentation":"The current status of the pool.
" + }, + "MessageType":{ + "shape":"MessageType", + "documentation":"The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "TwoWayEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
" + }, + "TwoWayChannelArn":{ + "shape":"TwoWayChannelArn", + "documentation":"The Amazon Resource Name (ARN) of the two way channel.
" + }, + "TwoWayChannelRole":{ + "shape":"IamRoleArn", + "documentation":"An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, + "SelfManagedOptOutsEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs
" + }, + "OptOutListName":{ + "shape":"OptOutListName", + "documentation":"The name of the OptOutList associated with the pool.
" + }, + "SharedRoutesEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"Allows you to enable shared routes on your pool.
By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.
When set to true the pool can't be deleted.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the pool was created, in UNIX epoch time format.
" + } + }, + "documentation":"The information for a pool in an Amazon Web Services account.
" + }, + "PoolInformationList":{ + "type":"list", + "member":{"shape":"PoolInformation"} + }, + "PoolOriginationIdentitiesFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"PoolOriginationIdentitiesFilterName", + "documentation":"The name of the attribute to filter on.
" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"An array values to filter for.
" + } + }, + "documentation":"Information about origination identities associated with a pool that meets a specified criteria.
" + }, + "PoolOriginationIdentitiesFilterList":{ + "type":"list", + "member":{"shape":"PoolOriginationIdentitiesFilter"}, + "max":20, + "min":0 + }, + "PoolOriginationIdentitiesFilterName":{ + "type":"string", + "enum":[ + "iso-country-code", + "number-capability" + ] + }, + "PoolStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING" + ] + }, + "PrimitiveBoolean":{"type":"boolean"}, + "PrimitiveLong":{"type":"long"}, + "ProtectConfigurationArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"arn:\\S+" + }, + "ProtectConfigurationCountryRuleSet":{ + "type":"map", + "key":{"shape":"IsoCountryCode"}, + "value":{"shape":"ProtectConfigurationCountryRuleSetInformation"}, + "max":300, + "min":1 + }, + "ProtectConfigurationCountryRuleSetInformation":{ + "type":"structure", + "required":["ProtectStatus"], + "members":{ + "ProtectStatus":{ + "shape":"ProtectStatus", + "documentation":"The types of protection that can be used.
" + } + }, + "documentation":"The types of statuses that can be used.
" + }, + "ProtectConfigurationFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"ProtectConfigurationFilterName", + "documentation":"The name of the attribute to filter on.
" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"An array of values to filter for.
" + } + }, + "documentation":"The filter definition for filtering protect configurations that meet a specified criteria.
" + }, + "ProtectConfigurationFilterList":{ + "type":"list", + "member":{"shape":"ProtectConfigurationFilter"}, + "max":20, + "min":0 + }, + "ProtectConfigurationFilterName":{ + "type":"string", + "enum":[ + "account-default", + "deletion-protection-enabled" + ] + }, + "ProtectConfigurationId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z0-9_-]+" + }, + "ProtectConfigurationIdList":{ + "type":"list", + "member":{"shape":"ProtectConfigurationIdOrArn"}, + "max":5, + "min":0 + }, + "ProtectConfigurationIdOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/-]+" + }, + "ProtectConfigurationInformation":{ + "type":"structure", + "required":[ + "ProtectConfigurationArn", + "ProtectConfigurationId", + "CreatedTimestamp", + "AccountDefault", + "DeletionProtectionEnabled" + ], + "members":{ + "ProtectConfigurationArn":{ + "shape":"ProtectConfigurationArn", + "documentation":"The Amazon Resource Name (ARN) of the protect configuration.
" + }, + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationId", + "documentation":"The unique identifier for the protect configuration.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the protect configuration was created, in UNIX epoch time format.
" + }, + "AccountDefault":{ + "shape":"PrimitiveBoolean", + "documentation":"This is true if the protect configuration is set as your account default protect configuration.
" + }, + "DeletionProtectionEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
" + } + }, + "documentation":"Provides information on the specified protect configuration.
" + }, + "ProtectConfigurationInformationList":{ + "type":"list", + "member":{"shape":"ProtectConfigurationInformation"}, + "max":100, + "min":1 + }, + "ProtectStatus":{ + "type":"string", + "enum":[ + "ALLOW", + "BLOCK" + ] + }, + "PutKeywordRequest":{ + "type":"structure", + "required":[ + "OriginationIdentity", + "Keyword", + "KeywordMessage" + ], + "members":{ + "OriginationIdentity":{ + "shape":"PhoneOrPoolIdOrArn", + "documentation":"The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The new keyword to add.
" + }, + "KeywordMessage":{ + "shape":"KeywordMessage", + "documentation":"The message associated with the keyword.
" + }, + "KeywordAction":{ + "shape":"KeywordAction", + "documentation":"The action to perform for the new keyword when it is received.
AUTOMATIC_RESPONSE: A message is sent to the recipient.
OPT_OUT: Keeps the recipient from receiving future messages.
OPT_IN: The recipient wants to receive future messages.
The PhoneNumberArn or PoolArn that the keyword was associated with.
" + }, + "OriginationIdentity":{ + "shape":"String", + "documentation":"The PhoneNumberId or PoolId that the keyword was associated with.
" + }, + "Keyword":{ + "shape":"Keyword", + "documentation":"The keyword that was added.
" + }, + "KeywordMessage":{ + "shape":"KeywordMessage", + "documentation":"The message associated with the keyword.
" + }, + "KeywordAction":{ + "shape":"KeywordAction", + "documentation":"The action to perform when the keyword is used.
" + } + } + }, + "PutOptedOutNumberRequest":{ + "type":"structure", + "required":[ + "OptOutListName", + "OptedOutNumber" + ], + "members":{ + "OptOutListName":{ + "shape":"OptOutListNameOrArn", + "documentation":"The OptOutListName or OptOutListArn to add the phone number to.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The phone number to add to the OptOutList in E.164 format.
" + } + } + }, + "PutOptedOutNumberResult":{ + "type":"structure", + "members":{ + "OptOutListArn":{ + "shape":"String", + "documentation":"The OptOutListArn that the phone number was removed from.
" + }, + "OptOutListName":{ + "shape":"OptOutListName", + "documentation":"The OptOutListName that the phone number was removed from.
" + }, + "OptedOutNumber":{ + "shape":"PhoneNumber", + "documentation":"The phone number that was added to the OptOutList.
" + }, + "OptedOutTimestamp":{ + "shape":"Timestamp", + "documentation":"The time that the phone number was added to the OptOutList, in UNIX epoch time format.
" + }, + "EndUserOptedOut":{ + "shape":"PrimitiveBoolean", + "documentation":"This is true if it was the end user who requested their phone number be removed.
" + } + } + }, + "PutRegistrationFieldValueRequest":{ + "type":"structure", + "required":[ + "RegistrationId", + "FieldPath" + ], + "members":{ + "RegistrationId":{ + "shape":"RegistrationIdOrArn", + "documentation":"The unique identifier for the registration.
" + }, + "FieldPath":{ + "shape":"FieldPath", + "documentation":"The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
" + }, + "SelectChoices":{ + "shape":"SelectChoiceList", + "documentation":"An array of values for the form field.
" + }, + "TextValue":{ + "shape":"TextValue", + "documentation":"The text data for a free form field.
" + }, + "RegistrationAttachmentId":{ + "shape":"RegistrationAttachmentIdOrArn", + "documentation":"The unique identifier for the registration attachment.
" + } + } + }, + "PutRegistrationFieldValueResult":{ + "type":"structure", + "required":[ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "FieldPath" + ], + "members":{ + "RegistrationArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "VersionNumber":{ + "shape":"RegistrationVersionNumber", + "documentation":"The version number of the registration.
" + }, + "FieldPath":{ + "shape":"FieldPath", + "documentation":"The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
" + }, + "SelectChoices":{ + "shape":"SelectChoiceList", + "documentation":"An array of values for the form field.
" + }, + "TextValue":{ + "shape":"TextValue", + "documentation":"The text data for a free form field.
" + }, + "RegistrationAttachmentId":{ + "shape":"String", + "documentation":"The unique identifier for the registration attachment.
" + } + } + }, + "PutResourcePolicyRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Policy" + ], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource to attach the resource-based policy to.
" + }, + "Policy":{ + "shape":"ResourcePolicy", + "documentation":"The JSON formatted resource-based policy to attach.
" + } + } + }, + "PutResourcePolicyResult":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.
" + }, + "Policy":{ + "shape":"ResourcePolicy", + "documentation":"The JSON formatted Resource Policy.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the resource-based policy was created, in UNIX epoch time format.
" + } + } + }, + "RegistrationAssociationBehavior":{ + "type":"string", + "enum":[ + "ASSOCIATE_BEFORE_SUBMIT", + "ASSOCIATE_ON_APPROVAL", + "ASSOCIATE_AFTER_COMPLETE" + ] + }, + "RegistrationAssociationFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"RegistrationAssociationFilterName", + "documentation":"The name of the attribute to filter on.
" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"An array of values to filter for.
" + } + }, + "documentation":"The filter definition for filtering registrations that meets a specified criteria.
" + }, + "RegistrationAssociationFilterList":{ + "type":"list", + "member":{"shape":"RegistrationAssociationFilter"}, + "max":20, + "min":0 + }, + "RegistrationAssociationFilterName":{ + "type":"string", + "enum":[ + "resource-type", + "iso-country-code" + ] + }, + "RegistrationAssociationMetadata":{ + "type":"structure", + "required":[ + "ResourceArn", + "ResourceId", + "ResourceType" + ], + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
" + }, + "ResourceId":{ + "shape":"String", + "documentation":"The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
" + }, + "ResourceType":{ + "shape":"String", + "documentation":"The origination identity type.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "PhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The phone number associated with the registration in E.164 format.
" + } + }, + "documentation":"Metadata for the origination identity that is associated with the registration.
" + }, + "RegistrationAssociationMetadataList":{ + "type":"list", + "member":{"shape":"RegistrationAssociationMetadata"} + }, + "RegistrationAttachmentFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"RegistrationAttachmentFilterName", + "documentation":"The name of the attribute to filter on.
" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"An array of values to filter on.
" + } + }, + "documentation":"The filter definition for filtering registration attachments that meets a specified criteria.
" + }, + "RegistrationAttachmentFilterList":{ + "type":"list", + "member":{"shape":"RegistrationAttachmentFilter"}, + "max":20, + "min":0 + }, + "RegistrationAttachmentFilterName":{ + "type":"string", + "enum":["attachment-status"] + }, + "RegistrationAttachmentIdList":{ + "type":"list", + "member":{"shape":"RegistrationIdOrArn"}, + "max":5, + "min":0 + }, + "RegistrationAttachmentIdOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/-]+" + }, + "RegistrationAttachmentsInformation":{ + "type":"structure", + "required":[ + "RegistrationAttachmentArn", + "RegistrationAttachmentId", + "AttachmentStatus", + "CreatedTimestamp" + ], + "members":{ + "RegistrationAttachmentArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the registration attachment.
" + }, + "RegistrationAttachmentId":{ + "shape":"String", + "documentation":"The unique identifier for the registration attachment.
" + }, + "AttachmentStatus":{ + "shape":"AttachmentStatus", + "documentation":"The status of the registration attachment.
UPLOAD_IN_PROGRESS The attachment is being uploaded.
UPLOAD_COMPLETE The attachment has been uploaded.
UPLOAD_FAILED The attachment failed to uploaded.
DELETED The attachment has been deleted..
A description of why the upload didn't successfully complete.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the registration attachment was created, in UNIX epoch time format.
" + } + }, + "documentation":"Provides information on the specified registration attachments.
" + }, + "RegistrationAttachmentsInformationList":{ + "type":"list", + "member":{"shape":"RegistrationAttachmentsInformation"} + }, + "RegistrationDeniedReasonInformation":{ + "type":"structure", + "required":[ + "Reason", + "ShortDescription" + ], + "members":{ + "Reason":{ + "shape":"String", + "documentation":"The reason a registration was rejected.
" + }, + "ShortDescription":{ + "shape":"String", + "documentation":"A short description of the rejection reason.
" + }, + "LongDescription":{ + "shape":"String", + "documentation":"A long description of the rejection reason.
" + }, + "DocumentationTitle":{ + "shape":"String", + "documentation":"The title of the document.
" + }, + "DocumentationLink":{ + "shape":"String", + "documentation":"The link to the document.
" + } + }, + "documentation":"Provides the reason a registration was rejected.
" + }, + "RegistrationDeniedReasonInformationList":{ + "type":"list", + "member":{"shape":"RegistrationDeniedReasonInformation"} + }, + "RegistrationDisassociationBehavior":{ + "type":"string", + "enum":[ + "DISASSOCIATE_ALL_CLOSES_REGISTRATION", + "DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION", + "DELETE_REGISTRATION_DISASSOCIATES" + ] + }, + "RegistrationFieldDefinition":{ + "type":"structure", + "required":[ + "SectionPath", + "FieldPath", + "FieldType", + "FieldRequirement", + "DisplayHints" + ], + "members":{ + "SectionPath":{ + "shape":"SectionPath", + "documentation":"The section path of the field.
" + }, + "FieldPath":{ + "shape":"FieldPath", + "documentation":"The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
" + }, + "FieldType":{ + "shape":"FieldType", + "documentation":"The type of field.
" + }, + "FieldRequirement":{ + "shape":"FieldRequirement", + "documentation":"Specifies if the field for the registration form is required, conditional or optional.
" + }, + "SelectValidation":{ + "shape":"SelectValidation", + "documentation":"The validation rules for a select field.
" + }, + "TextValidation":{ + "shape":"TextValidation", + "documentation":"The validation rules for a text field.
" + }, + "DisplayHints":{ + "shape":"RegistrationFieldDisplayHints", + "documentation":"An array of RegistrationFieldDisplayHints objects for the field.
" + } + }, + "documentation":"Provides a description of the specified field.
" + }, + "RegistrationFieldDefinitionList":{ + "type":"list", + "member":{"shape":"RegistrationFieldDefinition"} + }, + "RegistrationFieldDisplayHints":{ + "type":"structure", + "required":[ + "Title", + "ShortDescription" + ], + "members":{ + "Title":{ + "shape":"String", + "documentation":"The title of the display hint.
" + }, + "ShortDescription":{ + "shape":"String", + "documentation":"A short description of the display hint.
" + }, + "LongDescription":{ + "shape":"String", + "documentation":"A full description of the display hint.
" + }, + "DocumentationTitle":{ + "shape":"String", + "documentation":"The title of the document the display hint is associated with.
" + }, + "DocumentationLink":{ + "shape":"String", + "documentation":"The link to the document the display hint is associated with.
" + }, + "SelectOptionDescriptions":{ + "shape":"SelectOptionDescriptionsList", + "documentation":"An array of SelectOptionDescription objects.
" + }, + "TextValidationDescription":{ + "shape":"String", + "documentation":"The validation rules for the text field.
" + }, + "ExampleTextValue":{ + "shape":"String", + "documentation":"Example text of what the value of a field should contain.
" + } + }, + "documentation":"Provides help information on the registration field.
" + }, + "RegistrationFieldValueInformation":{ + "type":"structure", + "required":["FieldPath"], + "members":{ + "FieldPath":{ + "shape":"FieldPath", + "documentation":"The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
" + }, + "SelectChoices":{ + "shape":"SelectChoiceList", + "documentation":"An array of values for the form field.
" + }, + "TextValue":{ + "shape":"TextValue", + "documentation":"The text data for a free form field.
" + }, + "RegistrationAttachmentId":{ + "shape":"RegistrationAttachmentIdOrArn", + "documentation":"The unique identifier for the registration attachment.
" + }, + "DeniedReason":{ + "shape":"String", + "documentation":"A description of why the registration was denied.
" + } + }, + "documentation":"Provides the values of the specified field.
" + }, + "RegistrationFieldValueInformationList":{ + "type":"list", + "member":{"shape":"RegistrationFieldValueInformation"} + }, + "RegistrationFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"RegistrationFilterName", + "documentation":"The name of the attribute to filter on.
" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"An array of values to filter on.
" + } + }, + "documentation":"The filter definition for filtering registrations that meets a specified criteria.
" + }, + "RegistrationFilterList":{ + "type":"list", + "member":{"shape":"RegistrationFilter"}, + "max":20, + "min":0 + }, + "RegistrationFilterName":{ + "type":"string", + "enum":[ + "registration-type", + "registration-status" + ] + }, + "RegistrationIdList":{ + "type":"list", + "member":{"shape":"RegistrationIdOrArn"}, + "max":5, + "min":0 + }, + "RegistrationIdOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/-]+" + }, + "RegistrationInformation":{ + "type":"structure", + "required":[ + "RegistrationArn", + "RegistrationId", + "RegistrationType", + "RegistrationStatus", + "CurrentVersionNumber", + "CreatedTimestamp" + ], + "members":{ + "RegistrationArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "RegistrationType":{ + "shape":"RegistrationType", + "documentation":"The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "RegistrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"The status of the registration.
CREATED: Your registration is created but not submitted.
SUBMITTED: Your registration has been submitted and is awaiting review.
REVIEWING: Your registration has been accepted and is being reviewed.
PROVISIONING: Your registration has been approved and your origination identity is being created.
COMPLETE: Your registration has been approved and and your origination identity has been created.
REQUIRES_UPDATES: You must fix your registration and resubmit it.
CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
DELETED: The registration has been deleted.
The current version number of the registration.
" + }, + "ApprovedVersionNumber":{ + "shape":"RegistrationVersionNumber", + "documentation":"The version number of the registration that was approved.
" + }, + "LatestDeniedVersionNumber":{ + "shape":"RegistrationVersionNumber", + "documentation":"The latest version number of the registration that was denied.
" + }, + "AdditionalAttributes":{ + "shape":"StringMap", + "documentation":"Metadata about a given registration which is specific to that registration type.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the registration was created, in UNIX epoch time format.
" + } + }, + "documentation":"Provides information about the requested registration.
" + }, + "RegistrationInformationList":{ + "type":"list", + "member":{"shape":"RegistrationInformation"} + }, + "RegistrationSectionDefinition":{ + "type":"structure", + "required":[ + "SectionPath", + "DisplayHints" + ], + "members":{ + "SectionPath":{ + "shape":"SectionPath", + "documentation":"The path to the section of the registration.
" + }, + "DisplayHints":{ + "shape":"RegistrationSectionDisplayHints", + "documentation":"The path to the section of the registration.
" + } + }, + "documentation":"Provides information on the specified section definition.
" + }, + "RegistrationSectionDefinitionList":{ + "type":"list", + "member":{"shape":"RegistrationSectionDefinition"} + }, + "RegistrationSectionDisplayHints":{ + "type":"structure", + "required":[ + "Title", + "ShortDescription" + ], + "members":{ + "Title":{ + "shape":"String", + "documentation":"The title of the display hint.
" + }, + "ShortDescription":{ + "shape":"String", + "documentation":"A short description of the display hint.
" + }, + "LongDescription":{ + "shape":"String", + "documentation":"A full description of the display hint.
" + }, + "DocumentationTitle":{ + "shape":"String", + "documentation":"The title of the document the display hint is associated with.
" + }, + "DocumentationLink":{ + "shape":"String", + "documentation":"The link to the document the display hint is associated with.
" + } + }, + "documentation":"Provides help information on the registration section.
" + }, + "RegistrationStatus":{ + "type":"string", + "enum":[ + "CREATED", + "SUBMITTED", + "REVIEWING", + "PROVISIONING", + "COMPLETE", + "REQUIRES_UPDATES", + "CLOSED", + "DELETED" + ] + }, + "RegistrationType":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z0-9_]+" + }, + "RegistrationTypeDefinition":{ + "type":"structure", + "required":[ + "RegistrationType", + "DisplayHints" + ], + "members":{ + "RegistrationType":{ + "shape":"RegistrationType", + "documentation":"The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "SupportedAssociations":{ + "shape":"SupportedAssociationList", + "documentation":"The supported association behavior for the registration type.
" + }, + "DisplayHints":{ + "shape":"RegistrationTypeDisplayHints", + "documentation":"Provides help information on the registration.
" + } + }, + "documentation":"Provides information on the supported registration type.
" + }, + "RegistrationTypeDefinitionList":{ + "type":"list", + "member":{"shape":"RegistrationTypeDefinition"} + }, + "RegistrationTypeDisplayHints":{ + "type":"structure", + "required":["Title"], + "members":{ + "Title":{ + "shape":"String", + "documentation":"The title of the display hint.
" + }, + "ShortDescription":{ + "shape":"String", + "documentation":"A short description of the display hint.
" + }, + "LongDescription":{ + "shape":"String", + "documentation":"A full description of the display hint.
" + }, + "DocumentationTitle":{ + "shape":"String", + "documentation":"The title of the document the display hint is associated with.
" + }, + "DocumentationLink":{ + "shape":"String", + "documentation":"The link to the document the display hint is associated with.
" + } + }, + "documentation":"Provides help information on the registration type.
" + }, + "RegistrationTypeFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"RegistrationTypeFilterName", + "documentation":"The name of the attribute to filter on.
" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"An array of values to filter on.
" + } + }, + "documentation":"The filter definition for filtering registration types that meets a specified criteria.
" + }, + "RegistrationTypeFilterList":{ + "type":"list", + "member":{"shape":"RegistrationTypeFilter"}, + "max":20, + "min":0 + }, + "RegistrationTypeFilterName":{ + "type":"string", + "enum":[ + "supported-association-resource-type", + "supported-association-iso-country-code" + ] + }, + "RegistrationTypeList":{ + "type":"list", + "member":{"shape":"RegistrationType"}, + "max":5, + "min":0 + }, + "RegistrationVersionFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"RegistrationVersionFilterName", + "documentation":"The name of the attribute to filter on.
" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"An array of values to filter on.
" + } + }, + "documentation":"The filter definition for filtering registration versions that meets a specified criteria.
" + }, + "RegistrationVersionFilterList":{ + "type":"list", + "member":{"shape":"RegistrationVersionFilter"}, + "max":20, + "min":0 + }, + "RegistrationVersionFilterName":{ + "type":"string", + "enum":["registration-version-status"] + }, + "RegistrationVersionInformation":{ + "type":"structure", + "required":[ + "VersionNumber", + "RegistrationVersionStatus", + "RegistrationVersionStatusHistory" + ], + "members":{ + "VersionNumber":{ + "shape":"RegistrationVersionNumber", + "documentation":"The version number of the registration.
" + }, + "RegistrationVersionStatus":{ + "shape":"RegistrationVersionStatus", + "documentation":"The status of the registration.
DRAFT: The initial status of a registration version after it’s created.
SUBMITTED: Your registration has been submitted.
REVIEWING: Your registration has been accepted and is being reviewed.
APPROVED: Your registration has been approved.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DENIED: You must fix your registration and resubmit it.
REVOKED: Your previously approved registration has been revoked.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
" + }, + "DeniedReasons":{ + "shape":"RegistrationDeniedReasonInformationList", + "documentation":"An array of RegistrationDeniedReasonInformation objects.
" + } + }, + "documentation":"Provides information about the specified version of the registration.
" + }, + "RegistrationVersionInformationList":{ + "type":"list", + "member":{"shape":"RegistrationVersionInformation"} + }, + "RegistrationVersionNumber":{ + "type":"long", + "box":true, + "max":100000, + "min":1 + }, + "RegistrationVersionNumberList":{ + "type":"list", + "member":{"shape":"RegistrationVersionNumber"}, + "max":5, + "min":0 + }, + "RegistrationVersionStatus":{ + "type":"string", + "enum":[ + "DRAFT", + "SUBMITTED", + "REVIEWING", + "APPROVED", + "DISCARDED", + "DENIED", + "REVOKED", + "ARCHIVED" + ] + }, + "RegistrationVersionStatusHistory":{ + "type":"structure", + "required":["DraftTimestamp"], + "members":{ + "DraftTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the registration was in the draft state, in UNIX epoch time format.
" + }, + "SubmittedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the registration was in the submitted state, in UNIX epoch time format.
" + }, + "ReviewingTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the registration was in the reviewing state, in UNIX epoch time format.
" + }, + "ApprovedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the registration was in the approved state, in UNIX epoch time format.
" + }, + "DiscardedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the registration was in the discarded state, in UNIX epoch time format.
" + }, + "DeniedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the registration was in the denied state, in UNIX epoch time format.
" + }, + "RevokedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the registration was in the revoked state, in UNIX epoch time format.
" + }, + "ArchivedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the registration was in the archived state, in UNIX epoch time format.
" + } + }, + "documentation":"The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
" + }, + "ReleasePhoneNumberRequest":{ + "type":"structure", + "required":["PhoneNumberId"], + "members":{ + "PhoneNumberId":{ + "shape":"PhoneNumberIdOrArn", + "documentation":"The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The PhoneNumberArn of the phone number that was released.
" + }, + "PhoneNumberId":{ + "shape":"String", + "documentation":"The PhoneNumberId of the phone number that was released.
" + }, + "PhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The phone number that was released.
" + }, + "Status":{ + "shape":"NumberStatus", + "documentation":"The current status of the request.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "MessageType":{ + "shape":"MessageType", + "documentation":"The message type that was associated with the phone number.
" + }, + "NumberCapabilities":{ + "shape":"NumberCapabilityList", + "documentation":"Specifies if the number could be used for text messages, voice, or both.
" + }, + "NumberType":{ + "shape":"NumberType", + "documentation":"The type of number that was released.
" + }, + "MonthlyLeasingPrice":{ + "shape":"String", + "documentation":"The monthly price of the phone number, in US dollars.
" + }, + "TwoWayEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" + }, + "TwoWayChannelArn":{ + "shape":"TwoWayChannelArn", + "documentation":"The Amazon Resource Name (ARN) of the TwoWayChannel.
" + }, + "TwoWayChannelRole":{ + "shape":"IamRoleArn", + "documentation":"An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, + "SelfManagedOptOutsEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" + }, + "OptOutListName":{ + "shape":"OptOutListName", + "documentation":"The name of the OptOutList that was associated with the phone number.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the phone number was created, in UNIX epoch time format.
" + } + } + }, + "ReleaseSenderIdRequest":{ + "type":"structure", + "required":[ + "SenderId", + "IsoCountryCode" + ], + "members":{ + "SenderId":{ + "shape":"SenderIdOrArn", + "documentation":"The sender ID to release.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + } + } + }, + "ReleaseSenderIdResult":{ + "type":"structure", + "required":[ + "SenderIdArn", + "SenderId", + "IsoCountryCode", + "MessageTypes", + "MonthlyLeasingPrice", + "Registered" + ], + "members":{ + "SenderIdArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with the SenderId.
" + }, + "SenderId":{ + "shape":"SenderId", + "documentation":"The sender ID that was released.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "MessageTypes":{ + "shape":"MessageTypeList", + "documentation":"The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "MonthlyLeasingPrice":{ + "shape":"String", + "documentation":"The monthly price, in US dollars, to lease the sender ID.
" + }, + "Registered":{ + "shape":"PrimitiveBoolean", + "documentation":"True if the sender ID is registered.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + } + } + }, + "RequestPhoneNumberRequest":{ + "type":"structure", + "required":[ + "IsoCountryCode", + "MessageType", + "NumberCapabilities", + "NumberType" + ], + "members":{ + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "MessageType":{ + "shape":"MessageType", + "documentation":"The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "NumberCapabilities":{ + "shape":"NumberCapabilityList", + "documentation":"Indicates if the phone number will be used for text messages, voice messages, or both.
" + }, + "NumberType":{ + "shape":"RequestableNumberType", + "documentation":"The type of phone number to request.
" + }, + "OptOutListName":{ + "shape":"OptOutListNameOrArn", + "documentation":"The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The pool to associated with the phone number. You can use the PoolId or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Use this field to attach your phone number for an external registration process.
" + }, + "DeletionProtectionEnabled":{ + "shape":"Boolean", + "documentation":"By default this is set to false. When set to true the phone number can't be deleted.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of tags (key and value pairs) associate with the requested phone number.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken":true + } + } + }, + "RequestPhoneNumberResult":{ + "type":"structure", + "members":{ + "PhoneNumberArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the requested phone number.
" + }, + "PhoneNumberId":{ + "shape":"String", + "documentation":"The unique identifier of the new phone number.
" + }, + "PhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The new phone number that was requested.
" + }, + "Status":{ + "shape":"NumberStatus", + "documentation":"The current status of the request.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "MessageType":{ + "shape":"MessageType", + "documentation":"The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "NumberCapabilities":{ + "shape":"NumberCapabilityList", + "documentation":"Indicates if the phone number will be used for text messages, voice messages or both.
" + }, + "NumberType":{ + "shape":"RequestableNumberType", + "documentation":"The type of number that was released.
" + }, + "MonthlyLeasingPrice":{ + "shape":"String", + "documentation":"The monthly price, in US dollars, to lease the phone number.
" + }, + "TwoWayEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" + }, + "TwoWayChannelArn":{ + "shape":"TwoWayChannelArn", + "documentation":"The ARN used to identify the two way channel.
" + }, + "TwoWayChannelRole":{ + "shape":"IamRoleArn", + "documentation":"An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, + "SelfManagedOptOutsEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" + }, + "OptOutListName":{ + "shape":"OptOutListName", + "documentation":"The name of the OptOutList that is associated with the requested phone number.
" + }, + "DeletionProtectionEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"By default this is set to false. When set to true the phone number can't be deleted.
" + }, + "PoolId":{ + "shape":"String", + "documentation":"The unique identifier of the pool associated with the phone number
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of key and value pair tags that are associated with the phone number.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the phone number was created, in UNIX epoch time format.
" + } + } + }, + "RequestSenderIdRequest":{ + "type":"structure", + "required":[ + "SenderId", + "IsoCountryCode" + ], + "members":{ + "SenderId":{ + "shape":"SenderId", + "documentation":"The sender ID string to request.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "MessageTypes":{ + "shape":"MessageTypeList", + "documentation":"The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "DeletionProtectionEnabled":{ + "shape":"Boolean", + "documentation":"By default this is set to false. When set to true the sender ID can't be deleted.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of tags (key and value pairs) to associate with the sender ID.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken":true + } + } + }, + "RequestSenderIdResult":{ + "type":"structure", + "required":[ + "SenderIdArn", + "SenderId", + "IsoCountryCode", + "MessageTypes", + "MonthlyLeasingPrice", + "DeletionProtectionEnabled", + "Registered" + ], + "members":{ + "SenderIdArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with the SenderId.
" + }, + "SenderId":{ + "shape":"SenderId", + "documentation":"The sender ID that was requested.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "MessageTypes":{ + "shape":"MessageTypeList", + "documentation":"The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "MonthlyLeasingPrice":{ + "shape":"String", + "documentation":"The monthly price, in US dollars, to lease the sender ID.
" + }, + "DeletionProtectionEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"By default this is set to false. When set to true the sender ID can't be deleted.
" + }, + "Registered":{ + "shape":"PrimitiveBoolean", + "documentation":"True if the sender ID is registered.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of tags (key and value pairs) to associate with the sender ID.
" + } + } + }, + "RequestableNumberType":{ + "type":"string", + "enum":[ + "LONG_CODE", + "TOLL_FREE", + "TEN_DLC", + "SIMULATOR" + ] + }, + "ResourceIdOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/-]+" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"The type of resource that caused the exception.
" + }, + "ResourceId":{ + "shape":"String", + "documentation":"The unique identifier of the resource.
" + } + }, + "documentation":"A requested resource couldn't be found.
", + "exception":true + }, + "ResourcePolicy":{ + "type":"string", + "max":10000, + "min":1 + }, + "ResourceType":{ + "type":"string", + "enum":[ + "account", + "phone-number", + "sender-id", + "pool", + "configuration-set", + "opt-out-list", + "event-destination", + "keyword", + "opted-out-number", + "registration", + "registration-attachment", + "verified-destination-number", + "protect-configuration", + "policy" + ] + }, + "SectionPath":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[A-Za-z0-9_]+" + }, + "SectionPathList":{ + "type":"list", + "member":{"shape":"SectionPath"}, + "max":5, + "min":0 + }, + "SelectChoice":{ + "type":"string", + "max":256, + "min":1 + }, + "SelectChoiceList":{ + "type":"list", + "member":{"shape":"SelectChoice"}, + "max":100, + "min":0 + }, + "SelectOptionDescription":{ + "type":"structure", + "required":["Option"], + "members":{ + "Option":{ + "shape":"String", + "documentation":"The value of the option.
" + }, + "Title":{ + "shape":"String", + "documentation":"The title of the select option.
" + }, + "Description":{ + "shape":"String", + "documentation":"A description of the option meaning.
" + } + }, + "documentation":"A description of each select option.
" + }, + "SelectOptionDescriptionsList":{ + "type":"list", + "member":{"shape":"SelectOptionDescription"} + }, + "SelectValidation":{ + "type":"structure", + "required":[ + "MinChoices", + "MaxChoices", + "Options" + ], + "members":{ + "MinChoices":{ + "shape":"Integer", + "documentation":"The minimum number of choices for the select.
" + }, + "MaxChoices":{ + "shape":"Integer", + "documentation":"The maximum number of choices for the select.
" + }, + "Options":{ + "shape":"StringList", + "documentation":"An array of strings for the possible selection options.
" + } + }, + "documentation":"Validation rules for a select field.
" + }, + "SendDestinationNumberVerificationCodeRequest":{ + "type":"structure", + "required":[ + "VerifiedDestinationNumberId", + "VerificationChannel" + ], + "members":{ + "VerifiedDestinationNumberId":{ + "shape":"VerifiedDestinationNumberIdOrArn", + "documentation":"The unique identifier for the verified destination phone number.
" + }, + "VerificationChannel":{ + "shape":"VerificationChannel", + "documentation":"Choose to send the verification code as an SMS or voice message.
" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"Choose the language to use for the message.
" + }, + "OriginationIdentity":{ + "shape":"VerificationMessageOriginationIdentity", + "documentation":"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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
" + }, + "Context":{ + "shape":"ContextMap", + "documentation":"You can specify custom data in this field. If you do, that data is logged to the event destination.
" + }, + "DestinationCountryParameters":{ + "shape":"DestinationCountryParameters", + "documentation":"This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
" + } + } + }, + "SendDestinationNumberVerificationCodeResult":{ + "type":"structure", + "required":["MessageId"], + "members":{ + "MessageId":{ + "shape":"String", + "documentation":"The unique identifier for the message.
" + } + } + }, + "SendMediaMessageRequest":{ + "type":"structure", + "required":[ + "DestinationPhoneNumber", + "OriginationIdentity" + ], + "members":{ + "DestinationPhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The destination phone number in E.164 format.
" + }, + "OriginationIdentity":{ + "shape":"MediaMessageOriginationIdentity", + "documentation":"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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The text body of the message.
" + }, + "MediaUrls":{ + "shape":"MediaUrlList", + "documentation":"An array of URLs to each media file to send.
The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetNameOrArn", + "documentation":"The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
" + }, + "MaxPrice":{ + "shape":"MaxPrice", + "documentation":"The maximum amount that you want to spend, in US dollars, per each MMS message.
" + }, + "TimeToLive":{ + "shape":"TimeToLive", + "documentation":"How long the text message is valid for. By default this is 72 hours.
" + }, + "Context":{ + "shape":"ContextMap", + "documentation":"You can specify custom data in this field. If you do, that data is logged to the event destination.
" + }, + "DryRun":{ + "shape":"PrimitiveBoolean", + "documentation":"When set to true, the message is checked and validated, but isn't sent to the end recipient.
" + }, + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationIdOrArn", + "documentation":"The unique identifier of the protect configuration to use.
" + } + } + }, + "SendMediaMessageResult":{ + "type":"structure", + "members":{ + "MessageId":{ + "shape":"String", + "documentation":"The unique identifier for the message.
" + } + } + }, + "SendTextMessageRequest":{ + "type":"structure", + "required":["DestinationPhoneNumber"], + "members":{ + "DestinationPhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The destination phone number in E.164 format.
" + }, + "OriginationIdentity":{ + "shape":"TextMessageOriginationIdentity", + "documentation":"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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The body of the text message.
" + }, + "MessageType":{ + "shape":"MessageType", + "documentation":"The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "Keyword":{ + "shape":"Keyword", + "documentation":"When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetNameOrArn", + "documentation":"The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
" + }, + "MaxPrice":{ + "shape":"MaxPrice", + "documentation":"The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than MaxPrice, the message is not sent and an error is returned.
How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return TTL_EXPIRED event.
You can specify custom data in this field. If you do, that data is logged to the event destination.
" + }, + "DestinationCountryParameters":{ + "shape":"DestinationCountryParameters", + "documentation":"This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process.
IN_TEMPLATE_ID The template ID that you received after completing the sender ID registration process.
Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.
When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.
The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..
The unique identifier for the protect configuration.
" + } + } + }, + "SendTextMessageResult":{ + "type":"structure", + "members":{ + "MessageId":{ + "shape":"String", + "documentation":"The unique identifier for the message.
" + } + } + }, + "SendVoiceMessageRequest":{ + "type":"structure", + "required":[ + "DestinationPhoneNumber", + "OriginationIdentity" + ], + "members":{ + "DestinationPhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The destination phone number in E.164 format.
" + }, + "OriginationIdentity":{ + "shape":"VoiceMessageOriginationIdentity", + "documentation":"The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The text to convert to a voice message.
" + }, + "MessageBodyTextType":{ + "shape":"VoiceMessageBodyTextType", + "documentation":"Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).
TEXT: This is the default value. When used the maximum character limit is 3000.
SSML: When used the maximum character limit is 6000 including SSML tagging.
The voice for the Amazon Polly service to use. By default this is set to \"MATTHEW\".
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetNameOrArn", + "documentation":"The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
" + }, + "MaxPricePerMinute":{ + "shape":"MaxPrice", + "documentation":"The maximum amount to spend per voice message, in US dollars.
" + }, + "TimeToLive":{ + "shape":"TimeToLive", + "documentation":"How long the voice message is valid for. By default this is 72 hours.
" + }, + "Context":{ + "shape":"ContextMap", + "documentation":"You can specify custom data in this field. If you do, that data is logged to the event destination.
" + }, + "DryRun":{ + "shape":"PrimitiveBoolean", + "documentation":"When set to true, the message is checked and validated, but isn't sent to the end recipient.
" + }, + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationIdOrArn", + "documentation":"The unique identifier for the protect configuration.
" + } + } + }, + "SendVoiceMessageResult":{ + "type":"structure", + "members":{ + "MessageId":{ + "shape":"String", + "documentation":"The unique identifier for the message.
" + } + } + }, + "SenderId":{ + "type":"string", + "max":11, + "min":1, + "pattern":"[A-Za-z0-9_-]+" + }, + "SenderIdAndCountry":{ + "type":"structure", + "required":[ + "SenderId", + "IsoCountryCode" + ], + "members":{ + "SenderId":{ + "shape":"SenderIdOrArn", + "documentation":"The unique identifier of the sender.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + } + }, + "documentation":"The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs in the AWS End User Messaging SMS User Guide.
" + }, + "SenderIdFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"SenderIdFilterName", + "documentation":"The name of the attribute to filter on.
" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"An array of values to filter for.
" + } + }, + "documentation":"The information for a sender ID that meets a specified criteria.
" + }, + "SenderIdFilterList":{ + "type":"list", + "member":{"shape":"SenderIdFilter"}, + "max":20, + "min":0 + }, + "SenderIdFilterName":{ + "type":"string", + "enum":[ + "sender-id", + "iso-country-code", + "message-type", + "deletion-protection-enabled", + "registered" + ] + }, + "SenderIdInformation":{ + "type":"structure", + "required":[ + "SenderIdArn", + "SenderId", + "IsoCountryCode", + "MessageTypes", + "MonthlyLeasingPrice", + "DeletionProtectionEnabled", + "Registered" + ], + "members":{ + "SenderIdArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with the SenderId.
" + }, + "SenderId":{ + "shape":"SenderId", + "documentation":"The alphanumeric sender ID in a specific country that you'd like to describe.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "MessageTypes":{ + "shape":"MessageTypeList", + "documentation":"The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "MonthlyLeasingPrice":{ + "shape":"String", + "documentation":"The monthly leasing price, in US dollars.
" + }, + "DeletionProtectionEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"By default this is set to false. When set to true the sender ID can't be deleted.
" + }, + "Registered":{ + "shape":"PrimitiveBoolean", + "documentation":"True if the sender ID is registered.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + } + }, + "documentation":"The information for all SenderIds in an Amazon Web Services account.
" + }, + "SenderIdInformationList":{ + "type":"list", + "member":{"shape":"SenderIdInformation"} + }, + "SenderIdList":{ + "type":"list", + "member":{"shape":"SenderIdAndCountry"}, + "max":5, + "min":0 + }, + "SenderIdOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/-]+" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "Reason":{ + "shape":"ServiceQuotaExceededExceptionReason", + "documentation":"The reason for the exception.
" + } + }, + "documentation":"The request would cause a service quota to be exceeded.
", + "exception":true + }, + "ServiceQuotaExceededExceptionReason":{ + "type":"string", + "enum":[ + "ASSOCIATIONS_PER_REGISTRATION", + "CONFIGURATION_SETS_PER_ACCOUNT", + "DAILY_DESTINATION_CALL_LIMIT", + "EVENT_DESTINATIONS_PER_CONFIGURATION_SET", + "KEYWORDS_PER_PHONE_NUMBER", + "KEYWORDS_PER_POOL", + "MONTHLY_SPEND_LIMIT_REACHED_FOR_MEDIA", + "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT", + "MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE", + "OPT_OUT_LISTS_PER_ACCOUNT", + "ORIGINATION_IDENTITIES_PER_POOL", + "PHONE_NUMBERS_PER_ACCOUNT", + "PHONE_NUMBERS_PER_REGISTRATION", + "POOLS_PER_ACCOUNT", + "REGISTRATION_ATTACHMENTS_CREATED_PER_DAY", + "REGISTRATION_ATTACHMENTS_PER_ACCOUNT", + "REGISTRATION_VERSIONS_CREATED_PER_DAY", + "REGISTRATIONS_PER_ACCOUNT", + "SENDER_IDS_PER_ACCOUNT", + "TAGS_PER_RESOURCE", + "VERIFIED_DESTINATION_NUMBERS_PER_ACCOUNT", + "VERIFICATION_ATTEMPTS_PER_DAY", + "PROTECT_CONFIGURATIONS_PER_ACCOUNT" + ] + }, + "SetAccountDefaultProtectConfigurationRequest":{ + "type":"structure", + "required":["ProtectConfigurationId"], + "members":{ + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationIdOrArn", + "documentation":"The unique identifier for the protect configuration.
" + } + } + }, + "SetAccountDefaultProtectConfigurationResult":{ + "type":"structure", + "required":[ + "DefaultProtectConfigurationArn", + "DefaultProtectConfigurationId" + ], + "members":{ + "DefaultProtectConfigurationArn":{ + "shape":"ProtectConfigurationArn", + "documentation":"The Amazon Resource Name (ARN) of the account default protect configuration.
" + }, + "DefaultProtectConfigurationId":{ + "shape":"ProtectConfigurationId", + "documentation":"The unique identifier of the account default protect configuration.
" + } + } + }, + "SetDefaultMessageTypeRequest":{ + "type":"structure", + "required":[ + "ConfigurationSetName", + "MessageType" + ], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetNameOrArn", + "documentation":"The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.
" + }, + "MessageType":{ + "shape":"MessageType", + "documentation":"The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + } + } + }, + "SetDefaultMessageTypeResult":{ + "type":"structure", + "members":{ + "ConfigurationSetArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the updated configuration set.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"The name of the configuration set that was updated.
" + }, + "MessageType":{ + "shape":"MessageType", + "documentation":"The new default message type of the configuration set.
" + } + } + }, + "SetDefaultSenderIdRequest":{ + "type":"structure", + "required":[ + "ConfigurationSetName", + "SenderId" + ], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetNameOrArn", + "documentation":"The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.
" + }, + "SenderId":{ + "shape":"SenderId", + "documentation":"The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as 'NOTICE'.
" + } + } + }, + "SetDefaultSenderIdResult":{ + "type":"structure", + "members":{ + "ConfigurationSetArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the updated configuration set.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"The name of the configuration set that was updated.
" + }, + "SenderId":{ + "shape":"SenderId", + "documentation":"The default sender ID to set for the ConfigurationSet.
" + } + } + }, + "SetMediaMessageSpendLimitOverrideRequest":{ + "type":"structure", + "required":["MonthlyLimit"], + "members":{ + "MonthlyLimit":{ + "shape":"MonthlyLimit", + "documentation":"The new monthly limit to enforce on text messages.
" + } + } + }, + "SetMediaMessageSpendLimitOverrideResult":{ + "type":"structure", + "members":{ + "MonthlyLimit":{ + "shape":"MonthlyLimit", + "documentation":"The current monthly limit to enforce on sending text messages.
" + } + } + }, + "SetTextMessageSpendLimitOverrideRequest":{ + "type":"structure", + "required":["MonthlyLimit"], + "members":{ + "MonthlyLimit":{ + "shape":"MonthlyLimit", + "documentation":"The new monthly limit to enforce on text messages.
" + } + } + }, + "SetTextMessageSpendLimitOverrideResult":{ + "type":"structure", + "members":{ + "MonthlyLimit":{ + "shape":"MonthlyLimit", + "documentation":"The current monthly limit to enforce on sending text messages.
" + } + } + }, + "SetVoiceMessageSpendLimitOverrideRequest":{ + "type":"structure", + "required":["MonthlyLimit"], + "members":{ + "MonthlyLimit":{ + "shape":"MonthlyLimit", + "documentation":"The new monthly limit to enforce on voice messages.
" + } + } + }, + "SetVoiceMessageSpendLimitOverrideResult":{ + "type":"structure", + "members":{ + "MonthlyLimit":{ + "shape":"MonthlyLimit", + "documentation":"The current monthly limit to enforce on sending voice messages.
" + } + } + }, + "SnsDestination":{ + "type":"structure", + "required":["TopicArn"], + "members":{ + "TopicArn":{ + "shape":"SnsTopicArn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
" + } + }, + "documentation":"An object that defines an Amazon SNS destination for events. You can use Amazon SNS to send notification when certain events occur.
" + }, + "SnsTopicArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:\\S+" + }, + "SpendLimit":{ + "type":"structure", + "required":[ + "Name", + "EnforcedLimit", + "MaxLimit", + "Overridden" + ], + "members":{ + "Name":{ + "shape":"SpendLimitName", + "documentation":"The name for the SpendLimit.
" + }, + "EnforcedLimit":{ + "shape":"PrimitiveLong", + "documentation":"The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month. This value has to be less than or equal to the amount in MaxLimit. To use this custom limit, Overridden must be set to true.
The maximum amount of money that you are able to spend to send messages each month, in US dollars.
" + }, + "Overridden":{ + "shape":"PrimitiveBoolean", + "documentation":"When set to True, the value that has been specified in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.
Describes the current monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting a spending quota increase in the AWS End User Messaging SMS User Guide.
" + }, + "SpendLimitList":{ + "type":"list", + "member":{"shape":"SpendLimit"} + }, + "SpendLimitName":{ + "type":"string", + "enum":[ + "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT", + "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT", + "MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT" + ] + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "StringMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "SubmitRegistrationVersionRequest":{ + "type":"structure", + "required":["RegistrationId"], + "members":{ + "RegistrationId":{ + "shape":"RegistrationIdOrArn", + "documentation":"The unique identifier for the registration.
" + } + } + }, + "SubmitRegistrationVersionResult":{ + "type":"structure", + "required":[ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "RegistrationVersionStatus", + "RegistrationVersionStatusHistory" + ], + "members":{ + "RegistrationArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "VersionNumber":{ + "shape":"RegistrationVersionNumber", + "documentation":"The version number of the registration.
" + }, + "RegistrationVersionStatus":{ + "shape":"RegistrationVersionStatus", + "documentation":"The status of the registration version.
DRAFT: The initial status of a registration version after it’s created.
SUBMITTED: Your registration has been submitted.
REVIEWING: Your registration has been accepted and is being reviewed.
APPROVED: Your registration has been approved.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DENIED: You must fix your registration and resubmit it.
REVOKED: Your previously approved registration has been revoked.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
" + } + } + }, + "SupportedAssociation":{ + "type":"structure", + "required":[ + "ResourceType", + "AssociationBehavior", + "DisassociationBehavior" + ], + "members":{ + "ResourceType":{ + "shape":"String", + "documentation":"Defines the behavior of when an origination identity and registration can be associated with each other.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "AssociationBehavior":{ + "shape":"RegistrationAssociationBehavior", + "documentation":"The association behavior.
ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.
ASSOCIATE_ON_APPROVAL This applies to all short code registrations. The short code will be automatically provisioned once the registration is approved.
ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.
The disassociation behavior.
DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed.
DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted.
DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.
The processing rules for when a registration can be associated with an origination identity and disassociated from an origination identity.
" + }, + "SupportedAssociationList":{ + "type":"list", + "member":{"shape":"SupportedAssociation"} + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"The key identifier, or name, of the tag.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The string value associated with the key of the tag.
" + } + }, + "documentation":"The list of tags to be added to the specified topic.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":".+" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the resource.
" + }, + "Tags":{ + "shape":"NonEmptyTagList", + "documentation":"An array of key and value pair tags that are associated with the resource.
" + } + } + }, + "TagResourceResult":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":".*" + }, + "TextMessageBody":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"(?!\\s*$)[\\s\\S]+" + }, + "TextMessageOriginationIdentity":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/\\+-]+" + }, + "TextValidation":{ + "type":"structure", + "required":[ + "MinLength", + "MaxLength", + "Pattern" + ], + "members":{ + "MinLength":{ + "shape":"Integer", + "documentation":"The minimum number of characters for the text field.
" + }, + "MaxLength":{ + "shape":"Integer", + "documentation":"The maximum number of characters for the text field.
" + }, + "Pattern":{ + "shape":"String", + "documentation":"The regular expression used to validate the text field.
" + } + }, + "documentation":"Validation rules for a text field.
" + }, + "TextValue":{ + "type":"string", + "max":2048, + "min":1 + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"An error that occurred because too many requests were sent during a certain amount of time.
", + "exception":true, + "retryable":{"throttling":true} + }, + "TimeToLive":{ + "type":"integer", + "box":true, + "max":259200, + "min":5 + }, + "Timestamp":{"type":"timestamp"}, + "TwoWayChannelArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"\\S+" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the resource.
" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"An array of tag key values to unassociate with the resource.
" + } + } + }, + "UntagResourceResult":{ + "type":"structure", + "members":{ + } + }, + "UpdateEventDestinationRequest":{ + "type":"structure", + "required":[ + "ConfigurationSetName", + "EventDestinationName" + ], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetNameOrArn", + "documentation":"The configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.
" + }, + "EventDestinationName":{ + "shape":"EventDestinationName", + "documentation":"The name to use for the event destination.
" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"When set to true logging is enabled.
" + }, + "MatchingEventTypes":{ + "shape":"EventTypeList", + "documentation":"An array of event types that determine which events to log.
The TEXT_SENT event type is not supported.
An object that contains information about an event destination that sends data to CloudWatch Logs.
" + }, + "KinesisFirehoseDestination":{ + "shape":"KinesisFirehoseDestination", + "documentation":"An object that contains information about an event destination for logging to Firehose.
" + }, + "SnsDestination":{ + "shape":"SnsDestination", + "documentation":"An object that contains information about an event destination that sends data to Amazon SNS.
" + } + } + }, + "UpdateEventDestinationResult":{ + "type":"structure", + "members":{ + "ConfigurationSetArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.
" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"The name of the configuration set.
" + }, + "EventDestination":{ + "shape":"EventDestination", + "documentation":"An EventDestination object containing the details of where events will be logged.
" + } + } + }, + "UpdatePhoneNumberRequest":{ + "type":"structure", + "required":["PhoneNumberId"], + "members":{ + "PhoneNumberId":{ + "shape":"PhoneNumberIdOrArn", + "documentation":"The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" + }, + "TwoWayChannelArn":{ + "shape":"TwoWayChannelArn", + "documentation":"The Amazon Resource Name (ARN) of the two way channel.
" + }, + "TwoWayChannelRole":{ + "shape":"IamRoleArn", + "documentation":"An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, + "SelfManagedOptOutsEnabled":{ + "shape":"Boolean", + "documentation":"By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" + }, + "OptOutListName":{ + "shape":"OptOutListNameOrArn", + "documentation":"The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.
" + }, + "DeletionProtectionEnabled":{ + "shape":"Boolean", + "documentation":"By default this is set to false. When set to true the phone number can't be deleted.
" + } + } + }, + "UpdatePhoneNumberResult":{ + "type":"structure", + "members":{ + "PhoneNumberArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the updated phone number.
" + }, + "PhoneNumberId":{ + "shape":"String", + "documentation":"The unique identifier of the phone number.
" + }, + "PhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The phone number that was updated.
" + }, + "Status":{ + "shape":"NumberStatus", + "documentation":"The current status of the request.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "MessageType":{ + "shape":"MessageType", + "documentation":"The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "NumberCapabilities":{ + "shape":"NumberCapabilityList", + "documentation":"Specifies if the number could be used for text messages, voice or both.
" + }, + "NumberType":{ + "shape":"NumberType", + "documentation":"The type of number that was requested.
" + }, + "MonthlyLeasingPrice":{ + "shape":"String", + "documentation":"The monthly leasing price of the phone number, in US dollars.
" + }, + "TwoWayEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" + }, + "TwoWayChannelArn":{ + "shape":"TwoWayChannelArn", + "documentation":"The Amazon Resource Name (ARN) of the two way channel.
" + }, + "TwoWayChannelRole":{ + "shape":"IamRoleArn", + "documentation":"An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, + "SelfManagedOptOutsEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"This is true if self managed opt-out are enabled.
" + }, + "OptOutListName":{ + "shape":"OptOutListName", + "documentation":"The name of the OptOutList associated with the phone number.
" + }, + "DeletionProtectionEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"When set to true the phone number can't be deleted.
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the phone number was created, in UNIX epoch time format.
" + } + } + }, + "UpdatePoolRequest":{ + "type":"structure", + "required":["PoolId"], + "members":{ + "PoolId":{ + "shape":"PoolIdOrArn", + "documentation":"The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" + }, + "TwoWayChannelArn":{ + "shape":"TwoWayChannelArn", + "documentation":"The Amazon Resource Name (ARN) of the two way channel.
" + }, + "TwoWayChannelRole":{ + "shape":"IamRoleArn", + "documentation":"An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, + "SelfManagedOptOutsEnabled":{ + "shape":"Boolean", + "documentation":"By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" + }, + "OptOutListName":{ + "shape":"OptOutListNameOrArn", + "documentation":"The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Indicates whether shared routes are enabled for the pool.
" + }, + "DeletionProtectionEnabled":{ + "shape":"Boolean", + "documentation":"When set to true the pool can't be deleted.
" + } + } + }, + "UpdatePoolResult":{ + "type":"structure", + "members":{ + "PoolArn":{ + "shape":"String", + "documentation":"The ARN of the pool.
" + }, + "PoolId":{ + "shape":"String", + "documentation":"The unique identifier of the pool.
" + }, + "Status":{ + "shape":"PoolStatus", + "documentation":"The current status of the pool update request.
" + }, + "MessageType":{ + "shape":"MessageType", + "documentation":"The type of message for the pool to use.
" + }, + "TwoWayEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" + }, + "TwoWayChannelArn":{ + "shape":"TwoWayChannelArn", + "documentation":"The Amazon Resource Name (ARN) of the two way channel.
" + }, + "TwoWayChannelRole":{ + "shape":"IamRoleArn", + "documentation":"An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, + "SelfManagedOptOutsEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" + }, + "OptOutListName":{ + "shape":"OptOutListName", + "documentation":"The name of the OptOutList associated with the pool.
" + }, + "SharedRoutesEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"Indicates whether shared routes are enabled for the pool.
" + }, + "DeletionProtectionEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"When set to true the pool can't be deleted.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the pool was created, in UNIX epoch time format.
" + } + } + }, + "UpdateProtectConfigurationCountryRuleSetRequest":{ + "type":"structure", + "required":[ + "ProtectConfigurationId", + "NumberCapability", + "CountryRuleSetUpdates" + ], + "members":{ + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationIdOrArn", + "documentation":"The unique identifier for the protect configuration.
" + }, + "NumberCapability":{ + "shape":"NumberCapability", + "documentation":"The number capability to apply the CountryRuleSetUpdates updates to.
" + }, + "CountryRuleSetUpdates":{ + "shape":"ProtectConfigurationCountryRuleSet", + "documentation":"A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.
" + } + } + }, + "UpdateProtectConfigurationCountryRuleSetResult":{ + "type":"structure", + "required":[ + "ProtectConfigurationArn", + "ProtectConfigurationId", + "NumberCapability", + "CountryRuleSet" + ], + "members":{ + "ProtectConfigurationArn":{ + "shape":"ProtectConfigurationArn", + "documentation":"The Amazon Resource Name (ARN) of the protect configuration.
" + }, + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationId", + "documentation":"The unique identifier for the protect configuration.
" + }, + "NumberCapability":{ + "shape":"NumberCapability", + "documentation":"The number capability that was updated
" + }, + "CountryRuleSet":{ + "shape":"ProtectConfigurationCountryRuleSet", + "documentation":"An array of ProtectConfigurationCountryRuleSetInformation containing the rules for the NumberCapability.
" + } + } + }, + "UpdateProtectConfigurationRequest":{ + "type":"structure", + "required":["ProtectConfigurationId"], + "members":{ + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationIdOrArn", + "documentation":"The unique identifier for the protect configuration.
" + }, + "DeletionProtectionEnabled":{ + "shape":"Boolean", + "documentation":"When set to true deletion protection is enabled. By default this is set to false.
" + } + } + }, + "UpdateProtectConfigurationResult":{ + "type":"structure", + "required":[ + "ProtectConfigurationArn", + "ProtectConfigurationId", + "CreatedTimestamp", + "AccountDefault", + "DeletionProtectionEnabled" + ], + "members":{ + "ProtectConfigurationArn":{ + "shape":"ProtectConfigurationArn", + "documentation":"The Amazon Resource Name (ARN) of the protect configuration.
" + }, + "ProtectConfigurationId":{ + "shape":"ProtectConfigurationId", + "documentation":"The unique identifier for the protect configuration.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the protect configuration was created, in UNIX epoch time format.
" + }, + "AccountDefault":{ + "shape":"PrimitiveBoolean", + "documentation":"This is true if the protect configuration is set as your account default protect configuration.
" + }, + "DeletionProtectionEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
" + } + } + }, + "UpdateSenderIdRequest":{ + "type":"structure", + "required":[ + "SenderId", + "IsoCountryCode" + ], + "members":{ + "SenderId":{ + "shape":"SenderIdOrArn", + "documentation":"The sender ID to update.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "DeletionProtectionEnabled":{ + "shape":"Boolean", + "documentation":"By default this is set to false. When set to true the sender ID can't be deleted.
" + } + } + }, + "UpdateSenderIdResult":{ + "type":"structure", + "required":[ + "SenderIdArn", + "SenderId", + "IsoCountryCode", + "MessageTypes", + "MonthlyLeasingPrice", + "DeletionProtectionEnabled", + "Registered" + ], + "members":{ + "SenderIdArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with the SenderId.
" + }, + "SenderId":{ + "shape":"SenderId", + "documentation":"The sender ID that was updated.
" + }, + "IsoCountryCode":{ + "shape":"IsoCountryCode", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "MessageTypes":{ + "shape":"MessageTypeList", + "documentation":"The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "MonthlyLeasingPrice":{ + "shape":"String", + "documentation":"The monthly price, in US dollars, to lease the sender ID.
" + }, + "DeletionProtectionEnabled":{ + "shape":"PrimitiveBoolean", + "documentation":"By default this is set to false. When set to true the sender ID can't be deleted.
" + }, + "Registered":{ + "shape":"PrimitiveBoolean", + "documentation":"True if the sender ID is registered..
" + }, + "RegistrationId":{ + "shape":"String", + "documentation":"The unique identifier for the registration.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "Reason":{ + "shape":"ValidationExceptionReason", + "documentation":"The reason for the exception.
" + }, + "Fields":{ + "shape":"ValidationExceptionFieldList", + "documentation":"The field that failed validation.
" + } + }, + "documentation":"A validation exception for a field.
", + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "Name", + "Message" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the field.
" + }, + "Message":{ + "shape":"String", + "documentation":"The message associated with the validation exception with information to help determine its cause.
" + } + }, + "documentation":"The field associated with the validation exception.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "CANNOT_ADD_OPTED_OUT_NUMBER", + "CANNOT_PARSE", + "COUNTRY_CODE_MISMATCH", + "DESTINATION_COUNTRY_BLOCKED", + "FIELD_VALIDATION_FAILED", + "ATTACHMENT_TYPE_NOT_SUPPORTED", + "INVALID_ARN", + "INVALID_FILTER_VALUES", + "INVALID_IDENTITY_FOR_DESTINATION_COUNTRY", + "INVALID_NEXT_TOKEN", + "INVALID_PARAMETER", + "INVALID_REQUEST", + "INVALID_REGISTRATION_ASSOCIATION", + "MAXIMUM_SIZE_EXCEEDED", + "MEDIA_TYPE_NOT_SUPPORTED", + "MISSING_PARAMETER", + "PARAMETERS_CANNOT_BE_USED_TOGETHER", + "PHONE_NUMBER_CANNOT_BE_OPTED_IN", + "PHONE_NUMBER_CANNOT_BE_RELEASED", + "PRICE_OVER_THRESHOLD", + "RESOURCE_NOT_ACCESSIBLE", + "REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT", + "SENDER_ID_NOT_REGISTERED", + "SENDER_ID_NOT_SUPPORTED", + "SENDER_ID_REQUIRES_REGISTRATION", + "TWO_WAY_TOPIC_NOT_PRESENT", + "TWO_WAY_NOT_ENABLED", + "TWO_WAY_NOT_SUPPORTED_IN_COUNTRY", + "TWO_WAY_NOT_SUPPORTED_IN_REGION", + "TWO_WAY_CHANNEL_NOT_PRESENT", + "UNKNOWN_REGISTRATION_FIELD", + "UNKNOWN_REGISTRATION_SECTION", + "UNKNOWN_REGISTRATION_TYPE", + "UNKNOWN_REGISTRATION_VERSION", + "UNKNOWN_OPERATION", + "REGISTRATION_FIELD_CANNOT_BE_DELETED", + "VERIFICATION_CODE_MISMATCH", + "VOICE_CAPABILITY_NOT_AVAILABLE", + "OTHER" + ] + }, + "VerificationChannel":{ + "type":"string", + "enum":[ + "TEXT", + "VOICE" + ] + }, + "VerificationCode":{ + "type":"string", + "max":20, + "min":1, + "pattern":"[A-Za-z0-9]+" + }, + "VerificationMessageOriginationIdentity":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/\\+-]+" + }, + "VerificationStatus":{ + "type":"string", + "enum":[ + "PENDING", + "VERIFIED" + ] + }, + "VerifiedDestinationNumberFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"VerifiedDestinationNumberFilterName", + "documentation":"The name of the attribute to filter on.
" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"An array of values to filter on.
" + } + }, + "documentation":"The filter definition for filtering verified destination phone numbers that meets a specified criteria.
" + }, + "VerifiedDestinationNumberFilterList":{ + "type":"list", + "member":{"shape":"VerifiedDestinationNumberFilter"}, + "max":20, + "min":0 + }, + "VerifiedDestinationNumberFilterName":{ + "type":"string", + "enum":["status"] + }, + "VerifiedDestinationNumberIdList":{ + "type":"list", + "member":{"shape":"VerifiedDestinationNumberIdOrArn"}, + "max":5, + "min":0 + }, + "VerifiedDestinationNumberIdOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/-]+" + }, + "VerifiedDestinationNumberInformation":{ + "type":"structure", + "required":[ + "VerifiedDestinationNumberArn", + "VerifiedDestinationNumberId", + "DestinationPhoneNumber", + "Status", + "CreatedTimestamp" + ], + "members":{ + "VerifiedDestinationNumberArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the verified destination phone number.
" + }, + "VerifiedDestinationNumberId":{ + "shape":"String", + "documentation":"The unique identifier for the verified destination phone number.
" + }, + "DestinationPhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The verified destination phone number, in E.164 format.
" + }, + "Status":{ + "shape":"VerificationStatus", + "documentation":"The status of the verified destination phone number.
PENDING: The phone number hasn't been verified yet.
VERIFIED: The phone number is verified and can receive messages.
The time when the destination phone number was created, in UNIX epoch time format.
" + } + }, + "documentation":"Provides information about the requested verified destintion phone number.
" + }, + "VerifiedDestinationNumberInformationList":{ + "type":"list", + "member":{"shape":"VerifiedDestinationNumberInformation"} + }, + "VerifyDestinationNumberRequest":{ + "type":"structure", + "required":[ + "VerifiedDestinationNumberId", + "VerificationCode" + ], + "members":{ + "VerifiedDestinationNumberId":{ + "shape":"VerifiedDestinationNumberIdOrArn", + "documentation":"The unique identifier for the verififed destination phone number.
" + }, + "VerificationCode":{ + "shape":"VerificationCode", + "documentation":"The verification code that was received by the verified destination phone number.
" + } + } + }, + "VerifyDestinationNumberResult":{ + "type":"structure", + "required":[ + "VerifiedDestinationNumberArn", + "VerifiedDestinationNumberId", + "DestinationPhoneNumber", + "Status", + "CreatedTimestamp" + ], + "members":{ + "VerifiedDestinationNumberArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the verified destination phone number.
" + }, + "VerifiedDestinationNumberId":{ + "shape":"String", + "documentation":"The unique identifier for the verified destination phone number.
" + }, + "DestinationPhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The phone number in E.164 format.
" + }, + "Status":{ + "shape":"VerificationStatus", + "documentation":"The status for being able to send messages to the phone number.
" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"The time when the destination phone number was created, in UNIX epoch time format.
" + } + } + }, + "VoiceId":{ + "type":"string", + "enum":[ + "AMY", + "ASTRID", + "BIANCA", + "BRIAN", + "CAMILA", + "CARLA", + "CARMEN", + "CELINE", + "CHANTAL", + "CONCHITA", + "CRISTIANO", + "DORA", + "EMMA", + "ENRIQUE", + "EWA", + "FILIZ", + "GERAINT", + "GIORGIO", + "GWYNETH", + "HANS", + "INES", + "IVY", + "JACEK", + "JAN", + "JOANNA", + "JOEY", + "JUSTIN", + "KARL", + "KENDRA", + "KIMBERLY", + "LEA", + "LIV", + "LOTTE", + "LUCIA", + "LUPE", + "MADS", + "MAJA", + "MARLENE", + "MATHIEU", + "MATTHEW", + "MAXIM", + "MIA", + "MIGUEL", + "MIZUKI", + "NAJA", + "NICOLE", + "PENELOPE", + "RAVEENA", + "RICARDO", + "RUBEN", + "RUSSELL", + "SALLI", + "SEOYEON", + "TAKUMI", + "TATYANA", + "VICKI", + "VITORIA", + "ZEINA", + "ZHIYU" + ] + }, + "VoiceMessageBody":{ + "type":"string", + "max":6000, + "min":1, + "pattern":"(?!\\s*$)[\\s\\S]+" + }, + "VoiceMessageBodyTextType":{ + "type":"string", + "enum":[ + "TEXT", + "SSML" + ] + }, + "VoiceMessageOriginationIdentity":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_:/\\+-]+" + } + }, + "documentation":"Welcome to the AWS End User Messaging SMS and Voice, version 2 API Reference. This guide provides information about AWS End User Messaging SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.
Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The AWS End User Messaging SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. AWS End User Messaging SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.
If you're new to AWS End User Messaging SMS and Voice, it's also helpful to review the AWS End User Messaging SMS User Guide. The AWS End User Messaging SMS User Guide provides tutorials, code samples, and procedures that demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with other Amazon Web Services services, and the quotas that apply to use of the service.
Regional availability
The AWS End User Messaging SMS and Voice version 2 API Reference is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Pinpoint endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.
" +} diff --git a/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/waiters-2.json b/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..13f60ee66be6a3d75208653e2bd7b563561adacc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/pinpoint-sms-voice-v2/2022-03-31/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/testbed/boto__botocore/botocore/data/pipes/2015-10-07/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/pipes/2015-10-07/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..cc9736a05c88d947b6d7e1d0a799ba3edcd1a0e2 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/pipes/2015-10-07/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pipes-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pipes-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pipes.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pipes.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/pipes/2015-10-07/paginators-1.json b/testbed/boto__botocore/botocore/data/pipes/2015-10-07/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..4663077cb456165bacedeb8e8e0f9c10f772c4a5 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/pipes/2015-10-07/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListPipes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "Limit", + "result_key": "Pipes" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/pipes/2015-10-07/service-2.json b/testbed/boto__botocore/botocore/data/pipes/2015-10-07/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..9aa12e8b64c129c93329ec5285d46ff5658fb9cd --- /dev/null +++ b/testbed/boto__botocore/botocore/data/pipes/2015-10-07/service-2.json @@ -0,0 +1,3264 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-10-07", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"pipes", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"Amazon EventBridge Pipes", + "serviceId":"Pipes", + "signatureVersion":"v4", + "signingName":"pipes", + "uid":"pipes-2015-10-07" + }, + "operations":{ + "CreatePipe":{ + "name":"CreatePipe", + "http":{ + "method":"POST", + "requestUri":"/v1/pipes/{Name}", + "responseCode":200 + }, + "input":{"shape":"CreatePipeRequest"}, + "output":{"shape":"CreatePipeResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
", + "idempotent":true + }, + "DeletePipe":{ + "name":"DeletePipe", + "http":{ + "method":"DELETE", + "requestUri":"/v1/pipes/{Name}", + "responseCode":200 + }, + "input":{"shape":"DeletePipeRequest"}, + "output":{"shape":"DeletePipeResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
", + "idempotent":true + }, + "DescribePipe":{ + "name":"DescribePipe", + "http":{ + "method":"GET", + "requestUri":"/v1/pipes/{Name}", + "responseCode":200 + }, + "input":{"shape":"DescribePipeRequest"}, + "output":{"shape":"DescribePipeResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"NotFoundException"} + ], + "documentation":"Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
" + }, + "ListPipes":{ + "name":"ListPipes", + "http":{ + "method":"GET", + "requestUri":"/v1/pipes", + "responseCode":200 + }, + "input":{"shape":"ListPipesRequest"}, + "output":{"shape":"ListPipesResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"NotFoundException"} + ], + "documentation":"Displays the tags associated with a pipe.
" + }, + "StartPipe":{ + "name":"StartPipe", + "http":{ + "method":"POST", + "requestUri":"/v1/pipes/{Name}/start", + "responseCode":200 + }, + "input":{"shape":"StartPipeRequest"}, + "output":{"shape":"StartPipeResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Start an existing pipe.
" + }, + "StopPipe":{ + "name":"StopPipe", + "http":{ + "method":"POST", + "requestUri":"/v1/pipes/{Name}/stop", + "responseCode":200 + }, + "input":{"shape":"StopPipeRequest"}, + "output":{"shape":"StopPipeResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Stop an existing pipe.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"NotFoundException"} + ], + "documentation":"Assigns one or more tags (key-value pairs) to the specified pipe. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a pipe that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the pipe. If you specify a tag key that is already associated with the pipe, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a pipe.
", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"NotFoundException"} + ], + "documentation":"Removes one or more tags from the specified pipes.
", + "idempotent":true + }, + "UpdatePipe":{ + "name":"UpdatePipe", + "http":{ + "method":"PUT", + "requestUri":"/v1/pipes/{Name}", + "responseCode":200 + }, + "input":{"shape":"UpdatePipeRequest"}, + "output":{"shape":"UpdatePipeResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Update an existing pipe. When you call UpdatePipe, EventBridge only the updates fields you have specified in the request; the rest remain unchanged. The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or TargetParameters objects. For example, DynamoDBStreamParameters or EventBridgeEventBusParameters. EventBridge updates the fields in these objects atomically as one and overrides existing values. This is by design, and means that if you don't specify an optional field in one of these Parameters objects, EventBridge sets that field to its system-default value during the update.
For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
", + "idempotent":true + } + }, + "shapes":{ + "Arn":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)" + }, + "ArnOrJsonPath":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)" + }, + "ArnOrUrl":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"smk://(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)" + }, + "AssignPublicIp":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "AwsVpcConfiguration":{ + "type":"structure", + "required":["Subnets"], + "members":{ + "Subnets":{ + "shape":"Subnets", + "documentation":"Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
" + }, + "AssignPublicIp":{ + "shape":"AssignPublicIp", + "documentation":"Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE.
This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
The size of the array, if this is an array batch job.
" + } + }, + "documentation":"The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.
" + }, + "BatchArraySize":{ + "type":"integer", + "box":true, + "max":10000, + "min":2 + }, + "BatchContainerOverrides":{ + "type":"structure", + "members":{ + "Command":{ + "shape":"StringList", + "documentation":"The command to send to the container that overrides the default command from the Docker image or the task definition.
" + }, + "Environment":{ + "shape":"BatchEnvironmentVariableList", + "documentation":"The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.
Environment variables cannot start with \"Batch\". This naming convention is reserved for variables that Batch sets.
The instance type to use for a multi-node parallel job.
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.
The overrides that are sent to a container.
" + }, + "BatchDependsOn":{ + "type":"list", + "member":{"shape":"BatchJobDependency"}, + "max":20, + "min":0 + }, + "BatchEnvironmentVariable":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the key-value pair. For environment variables, this is the name of the environment variable.
" + }, + "Value":{ + "shape":"String", + "documentation":"The value of the key-value pair. For environment variables, this is the value of the environment variable.
" + } + }, + "documentation":"The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.
Environment variables cannot start with \"Batch\". This naming convention is reserved for variables that Batch sets.
The job ID of the Batch job that's associated with this dependency.
" + }, + "Type":{ + "shape":"BatchJobDependencyType", + "documentation":"The type of the job dependency.
" + } + }, + "documentation":"An object that represents an Batch job dependency.
" + }, + "BatchJobDependencyType":{ + "type":"string", + "enum":[ + "N_TO_N", + "SEQUENTIAL" + ] + }, + "BatchParametersMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "BatchResourceRequirement":{ + "type":"structure", + "required":[ + "Type", + "Value" + ], + "members":{ + "Type":{ + "shape":"BatchResourceRequirementType", + "documentation":"The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
The quantity of the specified resource to reserve for the container. The values vary based on the type specified.
The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.
GPUs aren't available for jobs that are running on Fargate resources.
The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.
For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.
VCPU = 0.25
VCPU = 0.25 or 0.5
VCPU = 0.25, 0.5, or 1
VCPU = 0.5, or 1
VCPU = 0.5, 1, or 2
VCPU = 1 or 2
VCPU = 1, 2, 4, or 8
VCPU = 2 or 4
VCPU = 2, 4, or 8
VCPU = 4
VCPU = 4 or 8
VCPU = 8
VCPU = 8 or 16
VCPU = 16
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.
The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.
For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16
MEMORY = 512, 1024, or 2048
MEMORY = 1024, 2048, 3072, or 4096
MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440
MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880
The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
The number of times to move a job to the RUNNABLE status. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.
The retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide.
" + }, + "Boolean":{"type":"boolean"}, + "CapacityProvider":{ + "type":"string", + "max":255, + "min":1, + "sensitive":true + }, + "CapacityProviderStrategy":{ + "type":"list", + "member":{"shape":"CapacityProviderStrategyItem"}, + "max":6, + "min":0 + }, + "CapacityProviderStrategyItem":{ + "type":"structure", + "required":["capacityProvider"], + "members":{ + "capacityProvider":{ + "shape":"CapacityProvider", + "documentation":"The short name of the capacity provider.
" + }, + "weight":{ + "shape":"CapacityProviderStrategyItemWeight", + "documentation":"The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
" + }, + "base":{ + "shape":"CapacityProviderStrategyItemBase", + "documentation":"The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
" + } + }, + "documentation":"The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.
" + }, + "CapacityProviderStrategyItemBase":{ + "type":"integer", + "max":100000, + "min":0 + }, + "CapacityProviderStrategyItemWeight":{ + "type":"integer", + "max":1000, + "min":0 + }, + "CloudwatchLogGroupArn":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"(^arn:aws([a-z]|\\-)*:logs:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):log-group:[\\.\\-_/#A-Za-z0-9]{1,512}(:\\*)?)" + }, + "CloudwatchLogsLogDestination":{ + "type":"structure", + "members":{ + "LogGroupArn":{ + "shape":"CloudwatchLogGroupArn", + "documentation":"The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
" + } + }, + "documentation":"The Amazon CloudWatch Logs logging configuration settings for the pipe.
" + }, + "CloudwatchLogsLogDestinationParameters":{ + "type":"structure", + "required":["LogGroupArn"], + "members":{ + "LogGroupArn":{ + "shape":"CloudwatchLogGroupArn", + "documentation":"The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
" + } + }, + "documentation":"The Amazon CloudWatch Logs logging configuration settings for the pipe.
" + }, + "ConflictException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{"shape":"String"}, + "resourceId":{ + "shape":"String", + "documentation":"The ID of the resource that caused the exception.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The type of resource that caused the exception.
" + } + }, + "documentation":"An action you attempted resulted in an exception.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreatePipeRequest":{ + "type":"structure", + "required":[ + "Name", + "Source", + "Target", + "RoleArn" + ], + "members":{ + "Name":{ + "shape":"PipeName", + "documentation":"The name of the pipe.
", + "location":"uri", + "locationName":"Name" + }, + "Description":{ + "shape":"PipeDescription", + "documentation":"A description of the pipe.
" + }, + "DesiredState":{ + "shape":"RequestedPipeState", + "documentation":"The state the pipe should be in.
" + }, + "Source":{ + "shape":"ArnOrUrl", + "documentation":"The ARN of the source resource.
" + }, + "SourceParameters":{ + "shape":"PipeSourceParameters", + "documentation":"The parameters required to set up a source for your pipe.
" + }, + "Enrichment":{ + "shape":"OptionalArn", + "documentation":"The ARN of the enrichment resource.
" + }, + "EnrichmentParameters":{ + "shape":"PipeEnrichmentParameters", + "documentation":"The parameters required to set up enrichment on your pipe.
" + }, + "Target":{ + "shape":"Arn", + "documentation":"The ARN of the target resource.
" + }, + "TargetParameters":{ + "shape":"PipeTargetParameters", + "documentation":"The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The ARN of the role that allows the pipe to send data to the target.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The list of key-value pairs to associate with the pipe.
" + }, + "LogConfiguration":{ + "shape":"PipeLogConfigurationParameters", + "documentation":"The logging configuration settings for the pipe.
" + }, + "KmsKeyIdentifier":{ + "shape":"KmsKeyIdentifier", + "documentation":"The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt pipe data.
For more information, see Managing keys in the Key Management Service Developer Guide.
" + } + } + }, + "CreatePipeResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"PipeArn", + "documentation":"The ARN of the pipe.
" + }, + "Name":{ + "shape":"PipeName", + "documentation":"The name of the pipe.
" + }, + "DesiredState":{ + "shape":"RequestedPipeState", + "documentation":"The state the pipe should be in.
" + }, + "CurrentState":{ + "shape":"PipeState", + "documentation":"The state the pipe is in.
" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"The time the pipe was created.
" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
" + } + } + }, + "Database":{ + "type":"string", + "documentation":"// Redshift Database
", + "max":64, + "min":1, + "sensitive":true + }, + "DbUser":{ + "type":"string", + "documentation":"// Database user name
", + "max":128, + "min":1, + "sensitive":true + }, + "DeadLetterConfig":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"The ARN of the specified target for the dead-letter queue.
For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify either an Amazon SNS topic or Amazon SQS queue ARN.
" + } + }, + "documentation":"A DeadLetterConfig object that contains information about a dead-letter queue configuration.
The name of the pipe.
", + "location":"uri", + "locationName":"Name" + } + } + }, + "DeletePipeResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"PipeArn", + "documentation":"The ARN of the pipe.
" + }, + "Name":{ + "shape":"PipeName", + "documentation":"The name of the pipe.
" + }, + "DesiredState":{ + "shape":"RequestedPipeStateDescribeResponse", + "documentation":"The state the pipe should be in.
" + }, + "CurrentState":{ + "shape":"PipeState", + "documentation":"The state the pipe is in.
" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"The time the pipe was created.
" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
" + } + } + }, + "DescribePipeRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"PipeName", + "documentation":"The name of the pipe.
", + "location":"uri", + "locationName":"Name" + } + } + }, + "DescribePipeResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"PipeArn", + "documentation":"The ARN of the pipe.
" + }, + "Name":{ + "shape":"PipeName", + "documentation":"The name of the pipe.
" + }, + "Description":{ + "shape":"PipeDescription", + "documentation":"A description of the pipe.
" + }, + "DesiredState":{ + "shape":"RequestedPipeStateDescribeResponse", + "documentation":"The state the pipe should be in.
" + }, + "CurrentState":{ + "shape":"PipeState", + "documentation":"The state the pipe is in.
" + }, + "StateReason":{ + "shape":"PipeStateReason", + "documentation":"The reason the pipe is in its current state.
" + }, + "Source":{ + "shape":"ArnOrUrl", + "documentation":"The ARN of the source resource.
" + }, + "SourceParameters":{ + "shape":"PipeSourceParameters", + "documentation":"The parameters required to set up a source for your pipe.
" + }, + "Enrichment":{ + "shape":"OptionalArn", + "documentation":"The ARN of the enrichment resource.
" + }, + "EnrichmentParameters":{ + "shape":"PipeEnrichmentParameters", + "documentation":"The parameters required to set up enrichment on your pipe.
" + }, + "Target":{ + "shape":"Arn", + "documentation":"The ARN of the target resource.
" + }, + "TargetParameters":{ + "shape":"PipeTargetParameters", + "documentation":"The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The ARN of the role that allows the pipe to send data to the target.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The list of key-value pairs to associate with the pipe.
" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"The time the pipe was created.
" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
" + }, + "LogConfiguration":{ + "shape":"PipeLogConfiguration", + "documentation":"The logging configuration settings for the pipe.
" + }, + "KmsKeyIdentifier":{ + "shape":"KmsKeyIdentifier", + "documentation":"The identifier of the KMS customer managed key for EventBridge to use to encrypt pipe data, if one has been specified.
For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
" + } + } + }, + "DimensionMapping":{ + "type":"structure", + "required":[ + "DimensionValue", + "DimensionValueType", + "DimensionName" + ], + "members":{ + "DimensionValue":{ + "shape":"DimensionValue", + "documentation":"Dynamic path to the dimension value in the source event.
" + }, + "DimensionValueType":{ + "shape":"DimensionValueType", + "documentation":"The data type of the dimension for the time-series data.
" + }, + "DimensionName":{ + "shape":"DimensionName", + "documentation":"The metadata attributes of the time series. For example, the name and Availability Zone of an Amazon EC2 instance or the name of the manufacturer of a wind turbine are dimensions.
" + } + }, + "documentation":"Maps source data to a dimension in the target Timestream for LiveAnalytics table.
For more information, see Amazon Timestream for LiveAnalytics concepts
" + }, + "DimensionMappings":{ + "type":"list", + "member":{"shape":"DimensionMapping"}, + "max":128, + "min":1 + }, + "DimensionName":{ + "type":"string", + "max":256, + "min":1 + }, + "DimensionValue":{ + "type":"string", + "max":2048, + "min":1 + }, + "DimensionValueType":{ + "type":"string", + "enum":["VARCHAR"] + }, + "DynamoDBStreamStartPosition":{ + "type":"string", + "enum":[ + "TRIM_HORIZON", + "LATEST" + ] + }, + "EcsContainerOverride":{ + "type":"structure", + "members":{ + "Command":{ + "shape":"StringList", + "documentation":"The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
" + }, + "Cpu":{ + "shape":"Integer", + "documentation":"The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
" + }, + "EnvironmentFiles":{ + "shape":"EcsEnvironmentFileList", + "documentation":"A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
" + }, + "Memory":{ + "shape":"Integer", + "documentation":"The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
" + }, + "MemoryReservation":{ + "shape":"Integer", + "documentation":"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.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the container that receives the override. This parameter is required if any override is specified.
" + }, + "ResourceRequirements":{ + "shape":"EcsResourceRequirementsList", + "documentation":"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.
" + } + }, + "documentation":"The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {\"containerOverrides\": [ ] }. If a non-empty container override is specified, the name parameter must be included.
The file type to use. The only supported value is s3.
The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
" + } + }, + "documentation":"A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.
If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying environment variables in the Amazon Elastic Container Service Developer Guide.
This parameter is only supported for tasks hosted on Fargate using the following platform versions:
Linux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
The name of the key-value pair. For environment variables, this is the name of the environment variable.
" + }, + "value":{ + "shape":"String", + "documentation":"The value of the key-value pair. For environment variables, this is the value of the environment variable.
" + } + }, + "documentation":"The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
" + }, + "EcsEnvironmentVariableList":{ + "type":"list", + "member":{"shape":"EcsEnvironmentVariable"} + }, + "EcsEphemeralStorage":{ + "type":"structure", + "required":["sizeInGiB"], + "members":{ + "sizeInGiB":{ + "shape":"EphemeralStorageSize", + "documentation":"The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.
This parameter is only supported for tasks hosted on Fargate using Linux platform version 1.4.0 or later. This parameter is not supported for Windows containers on Fargate.
The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.
The Elastic Inference accelerator type to use.
" + } + }, + "documentation":"Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
" + }, + "EcsInferenceAcceleratorOverrideList":{ + "type":"list", + "member":{"shape":"EcsInferenceAcceleratorOverride"} + }, + "EcsResourceRequirement":{ + "type":"structure", + "required":[ + "type", + "value" + ], + "members":{ + "type":{ + "shape":"EcsResourceRequirementType", + "documentation":"The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator.
The value for the specified resource type.
If the GPU type is used, 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.
If the InferenceAccelerator type is used, the value matches the deviceName for an InferenceAccelerator specified in a task definition.
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
" + }, + "EcsResourceRequirementType":{ + "type":"string", + "enum":[ + "GPU", + "InferenceAccelerator" + ] + }, + "EcsResourceRequirementsList":{ + "type":"list", + "member":{"shape":"EcsResourceRequirement"} + }, + "EcsTaskOverride":{ + "type":"structure", + "members":{ + "ContainerOverrides":{ + "shape":"EcsContainerOverrideList", + "documentation":"One or more container overrides that are sent to a task.
" + }, + "Cpu":{ + "shape":"String", + "documentation":"The cpu override for the task.
" + }, + "EphemeralStorage":{ + "shape":"EcsEphemeralStorage", + "documentation":"The ephemeral storage setting override for the task.
This parameter is only supported for tasks hosted on Fargate that use the following platform versions:
Linux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
" + }, + "InferenceAcceleratorOverrides":{ + "shape":"EcsInferenceAcceleratorOverrideList", + "documentation":"The Elastic Inference accelerator override for the task.
" + }, + "Memory":{ + "shape":"String", + "documentation":"The memory override for the task.
" + }, + "TaskRoleArn":{ + "shape":"ArnOrJsonPath", + "documentation":"The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "documentation":"The overrides that are associated with a task.
" + }, + "EndpointString":{ + "type":"string", + "max":300, + "min":1, + "pattern":"(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}", + "sensitive":true + }, + "EphemeralStorageSize":{ + "type":"integer", + "box":true, + "max":200, + "min":21 + }, + "EpochTimeUnit":{ + "type":"string", + "enum":[ + "MILLISECONDS", + "SECONDS", + "MICROSECONDS", + "NANOSECONDS" + ] + }, + "ErrorMessage":{"type":"string"}, + "EventBridgeDetailType":{ + "type":"string", + "max":128, + "min":1, + "sensitive":true + }, + "EventBridgeEndpointId":{ + "type":"string", + "max":50, + "min":1, + "pattern":"[A-Za-z0-9\\-]+[\\.][A-Za-z0-9\\-]+", + "sensitive":true + }, + "EventBridgeEventResourceList":{ + "type":"list", + "member":{"shape":"ArnOrJsonPath"}, + "max":10, + "min":0 + }, + "EventBridgeEventSource":{ + "type":"string", + "max":256, + "min":1, + "pattern":".*(?=[/\\.\\-_A-Za-z0-9]+)((?!aws\\.).*)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*).*", + "sensitive":true + }, + "EventPattern":{ + "type":"string", + "max":4096, + "min":0, + "sensitive":true + }, + "Filter":{ + "type":"structure", + "members":{ + "Pattern":{ + "shape":"EventPattern", + "documentation":"The event pattern.
" + } + }, + "documentation":"Filter events using an event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
" + }, + "FilterCriteria":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"The event patterns.
" + } + }, + "documentation":"The collection of event patterns used to filter events.
To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.
For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
" + }, + "FilterList":{ + "type":"list", + "member":{"shape":"Filter"}, + "max":5, + "min":0 + }, + "FirehoseArn":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"(^arn:aws([a-z]|\\-)*:firehose:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):deliverystream/[a-zA-Z0-9_.-]{1,64})" + }, + "FirehoseLogDestination":{ + "type":"structure", + "members":{ + "DeliveryStreamArn":{ + "shape":"FirehoseArn", + "documentation":"The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.
" + } + }, + "documentation":"The Amazon Data Firehose logging configuration settings for the pipe.
" + }, + "FirehoseLogDestinationParameters":{ + "type":"structure", + "required":["DeliveryStreamArn"], + "members":{ + "DeliveryStreamArn":{ + "shape":"FirehoseArn", + "documentation":"Specifies the Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.
" + } + }, + "documentation":"The Amazon Data Firehose logging configuration settings for the pipe.
" + }, + "HeaderKey":{ + "type":"string", + "max":512, + "min":0, + "pattern":"[!#$%&'*+-.^_`|~0-9a-zA-Z]+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)" + }, + "HeaderParametersMap":{ + "type":"map", + "key":{"shape":"HeaderKey"}, + "value":{"shape":"HeaderValue"} + }, + "HeaderValue":{ + "type":"string", + "max":512, + "min":0, + "pattern":"[ \\t]*[\\x20-\\x7E]+([ \\t]+[\\x20-\\x7E]+)*[ \\t]*|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)", + "sensitive":true + }, + "IncludeExecutionData":{ + "type":"list", + "member":{"shape":"IncludeExecutionDataOption"} + }, + "IncludeExecutionDataOption":{ + "type":"string", + "enum":["ALL"] + }, + "InputTemplate":{ + "type":"string", + "max":8192, + "min":0, + "sensitive":true + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "retryAfterSeconds":{ + "shape":"Integer", + "documentation":"The number of seconds to wait before retrying the action that caused the exception.
", + "location":"header", + "locationName":"Retry-After" + } + }, + "documentation":"This exception occurs due to unexpected causes.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "JsonPath":{ + "type":"string", + "max":256, + "min":1, + "pattern":"\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*" + }, + "KafkaBootstrapServers":{ + "type":"list", + "member":{"shape":"EndpointString"}, + "max":2, + "min":0 + }, + "KafkaTopicName":{ + "type":"string", + "max":249, + "min":1, + "pattern":"[^.]([a-zA-Z0-9\\-_.]+)", + "sensitive":true + }, + "KinesisPartitionKey":{ + "type":"string", + "max":256, + "min":0, + "sensitive":true + }, + "KinesisStreamStartPosition":{ + "type":"string", + "enum":[ + "TRIM_HORIZON", + "LATEST", + "AT_TIMESTAMP" + ] + }, + "KmsKeyIdentifier":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"[a-zA-Z0-9_\\-/:]*" + }, + "LaunchType":{ + "type":"string", + "enum":[ + "EC2", + "FARGATE", + "EXTERNAL" + ] + }, + "LimitMax10":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, + "LimitMax100":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "LimitMax10000":{ + "type":"integer", + "box":true, + "max":10000, + "min":1 + }, + "LimitMin1":{ + "type":"integer", + "box":true, + "min":1 + }, + "ListPipesRequest":{ + "type":"structure", + "members":{ + "NamePrefix":{ + "shape":"PipeName", + "documentation":"A value that will return a subset of the pipes associated with this account. For example, \"NamePrefix\": \"ABC\" will return all endpoints with \"ABC\" in the name.
The state the pipe should be in.
", + "location":"querystring", + "locationName":"DesiredState" + }, + "CurrentState":{ + "shape":"PipeState", + "documentation":"The state the pipe is in.
", + "location":"querystring", + "locationName":"CurrentState" + }, + "SourcePrefix":{ + "shape":"ResourceArn", + "documentation":"The prefix matching the pipe source.
", + "location":"querystring", + "locationName":"SourcePrefix" + }, + "TargetPrefix":{ + "shape":"ResourceArn", + "documentation":"The prefix matching the pipe target.
", + "location":"querystring", + "locationName":"TargetPrefix" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of pipes to include in the response.
", + "location":"querystring", + "locationName":"Limit" + } + } + }, + "ListPipesResponse":{ + "type":"structure", + "members":{ + "Pipes":{ + "shape":"PipeList", + "documentation":"The pipes returned by the call.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The ARN of the pipe for which you want to view tags.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"The list of key-value pairs to associate with the pipe.
" + } + } + }, + "LogLevel":{ + "type":"string", + "enum":[ + "OFF", + "ERROR", + "INFO", + "TRACE" + ] + }, + "LogStreamName":{ + "type":"string", + "max":256, + "min":1 + }, + "MQBrokerAccessCredentials":{ + "type":"structure", + "members":{ + "BasicAuth":{ + "shape":"SecretManagerArn", + "documentation":"The ARN of the Secrets Manager secret.
" + } + }, + "documentation":"The Secrets Manager secret that stores your broker credentials.
", + "union":true + }, + "MQBrokerQueueName":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"[\\s\\S]*", + "sensitive":true + }, + "MSKAccessCredentials":{ + "type":"structure", + "members":{ + "SaslScram512Auth":{ + "shape":"SecretManagerArn", + "documentation":"The ARN of the Secrets Manager secret.
" + }, + "ClientCertificateTlsAuth":{ + "shape":"SecretManagerArn", + "documentation":"The ARN of the Secrets Manager secret.
" + } + }, + "documentation":"The Secrets Manager secret that stores your stream credentials.
", + "union":true + }, + "MSKStartPosition":{ + "type":"string", + "enum":[ + "TRIM_HORIZON", + "LATEST" + ] + }, + "MaximumBatchingWindowInSeconds":{ + "type":"integer", + "box":true, + "max":300, + "min":0 + }, + "MaximumRecordAgeInSeconds":{ + "type":"integer", + "box":true, + "max":604800, + "min":-1 + }, + "MaximumRetryAttemptsESM":{ + "type":"integer", + "box":true, + "max":10000, + "min":-1 + }, + "MeasureName":{ + "type":"string", + "max":1024, + "min":1 + }, + "MeasureValue":{ + "type":"string", + "max":2048, + "min":1 + }, + "MeasureValueType":{ + "type":"string", + "enum":[ + "DOUBLE", + "BIGINT", + "VARCHAR", + "BOOLEAN", + "TIMESTAMP" + ] + }, + "MessageDeduplicationId":{ + "type":"string", + "max":100, + "min":0, + "sensitive":true + }, + "MessageGroupId":{ + "type":"string", + "max":100, + "min":0, + "sensitive":true + }, + "MultiMeasureAttributeMapping":{ + "type":"structure", + "required":[ + "MeasureValue", + "MeasureValueType", + "MultiMeasureAttributeName" + ], + "members":{ + "MeasureValue":{ + "shape":"MeasureValue", + "documentation":"Dynamic path to the measurement attribute in the source event.
" + }, + "MeasureValueType":{ + "shape":"MeasureValueType", + "documentation":"Data type of the measurement attribute in the source event.
" + }, + "MultiMeasureAttributeName":{ + "shape":"MultiMeasureAttributeName", + "documentation":"Target measure name to be used.
" + } + }, + "documentation":"A mapping of a source event data field to a measure in a Timestream for LiveAnalytics record.
" + }, + "MultiMeasureAttributeMappings":{ + "type":"list", + "member":{"shape":"MultiMeasureAttributeMapping"}, + "max":256, + "min":1 + }, + "MultiMeasureAttributeName":{ + "type":"string", + "max":256, + "min":1 + }, + "MultiMeasureMapping":{ + "type":"structure", + "required":[ + "MultiMeasureName", + "MultiMeasureAttributeMappings" + ], + "members":{ + "MultiMeasureName":{ + "shape":"MultiMeasureName", + "documentation":"The name of the multiple measurements per record (multi-measure).
" + }, + "MultiMeasureAttributeMappings":{ + "shape":"MultiMeasureAttributeMappings", + "documentation":"Mappings that represent multiple source event fields mapped to measures in the same Timestream for LiveAnalytics record.
" + } + }, + "documentation":"Maps multiple measures from the source event to the same Timestream for LiveAnalytics record.
For more information, see Amazon Timestream for LiveAnalytics concepts
" + }, + "MultiMeasureMappings":{ + "type":"list", + "member":{"shape":"MultiMeasureMapping"}, + "max":1024, + "min":0 + }, + "MultiMeasureName":{ + "type":"string", + "max":256, + "min":1 + }, + "NetworkConfiguration":{ + "type":"structure", + "members":{ + "awsvpcConfiguration":{ + "shape":"AwsVpcConfiguration", + "documentation":"Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
This structure specifies the network configuration for an Amazon ECS task.
" + }, + "NextToken":{ + "type":"string", + "max":2048, + "min":1, + "sensitive":true + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"An entity that you specified does not exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "OnPartialBatchItemFailureStreams":{ + "type":"string", + "enum":["AUTOMATIC_BISECT"] + }, + "OptionalArn":{ + "type":"string", + "max":1600, + "min":0, + "pattern":"$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)" + }, + "PathParameter":{ + "type":"string", + "pattern":"(?!\\s*$).+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)", + "sensitive":true + }, + "PathParameterList":{ + "type":"list", + "member":{"shape":"PathParameter"} + }, + "Pipe":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"PipeName", + "documentation":"The name of the pipe.
" + }, + "Arn":{ + "shape":"PipeArn", + "documentation":"The ARN of the pipe.
" + }, + "DesiredState":{ + "shape":"RequestedPipeState", + "documentation":"The state the pipe should be in.
" + }, + "CurrentState":{ + "shape":"PipeState", + "documentation":"The state the pipe is in.
" + }, + "StateReason":{ + "shape":"PipeStateReason", + "documentation":"The reason the pipe is in its current state.
" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"The time the pipe was created.
" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
" + }, + "Source":{ + "shape":"ArnOrUrl", + "documentation":"The ARN of the source resource.
" + }, + "Target":{ + "shape":"Arn", + "documentation":"The ARN of the target resource.
" + }, + "Enrichment":{ + "shape":"OptionalArn", + "documentation":"The ARN of the enrichment resource.
" + } + }, + "documentation":"An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
" + }, + "PipeArn":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"arn:aws([a-z]|\\-)*:([a-zA-Z0-9\\-]+):([a-z]|\\d|\\-)*:([0-9]{12})?:(.+)" + }, + "PipeDescription":{ + "type":"string", + "max":512, + "min":0, + "pattern":".*", + "sensitive":true + }, + "PipeEnrichmentHttpParameters":{ + "type":"structure", + "members":{ + "PathParameterValues":{ + "shape":"PathParameterList", + "documentation":"The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"*\").
" + }, + "HeaderParameters":{ + "shape":"HeaderParametersMap", + "documentation":"The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
" + }, + "QueryStringParameters":{ + "shape":"QueryStringParametersMap", + "documentation":"The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
" + } + }, + "documentation":"These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.
" + }, + "PipeEnrichmentParameters":{ + "type":"structure", + "members":{ + "InputTemplate":{ + "shape":"InputTemplate", + "documentation":"Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.
To remove an input template, specify an empty string.
" + }, + "HttpParameters":{ + "shape":"PipeEnrichmentHttpParameters", + "documentation":"Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
" + } + }, + "documentation":"The parameters required to set up enrichment on your pipe.
" + }, + "PipeList":{ + "type":"list", + "member":{"shape":"Pipe"} + }, + "PipeLogConfiguration":{ + "type":"structure", + "members":{ + "S3LogDestination":{ + "shape":"S3LogDestination", + "documentation":"The Amazon S3 logging configuration settings for the pipe.
" + }, + "FirehoseLogDestination":{ + "shape":"FirehoseLogDestination", + "documentation":"The Amazon Data Firehose logging configuration settings for the pipe.
" + }, + "CloudwatchLogsLogDestination":{ + "shape":"CloudwatchLogsLogDestination", + "documentation":"The Amazon CloudWatch Logs logging configuration settings for the pipe.
" + }, + "Level":{ + "shape":"LogLevel", + "documentation":"The level of logging detail to include. This applies to all log destinations for the pipe.
" + }, + "IncludeExecutionData":{ + "shape":"IncludeExecutionData", + "documentation":"Whether the execution data (specifically, the payload, awsRequest, and awsResponse fields) is included in the log messages for this pipe.
This applies to all log destinations for the pipe.
For more information, see Including execution data in logs in the Amazon EventBridge User Guide.
" + } + }, + "documentation":"The logging configuration settings for the pipe.
" + }, + "PipeLogConfigurationParameters":{ + "type":"structure", + "required":["Level"], + "members":{ + "S3LogDestination":{ + "shape":"S3LogDestinationParameters", + "documentation":"The Amazon S3 logging configuration settings for the pipe.
" + }, + "FirehoseLogDestination":{ + "shape":"FirehoseLogDestinationParameters", + "documentation":"The Amazon Data Firehose logging configuration settings for the pipe.
" + }, + "CloudwatchLogsLogDestination":{ + "shape":"CloudwatchLogsLogDestinationParameters", + "documentation":"The Amazon CloudWatch Logs logging configuration settings for the pipe.
" + }, + "Level":{ + "shape":"LogLevel", + "documentation":"The level of logging detail to include. This applies to all log destinations for the pipe.
For more information, see Specifying EventBridge Pipes log level in the Amazon EventBridge User Guide.
" + }, + "IncludeExecutionData":{ + "shape":"IncludeExecutionData", + "documentation":"Specify ALL to include the execution data (specifically, the payload, awsRequest, and awsResponse fields) in the log messages for this pipe.
This applies to all log destinations for the pipe.
For more information, see Including execution data in logs in the Amazon EventBridge User Guide.
By default, execution data is not included.
" + } + }, + "documentation":"Specifies the logging configuration settings for the pipe.
When you call UpdatePipe, EventBridge updates the fields in the PipeLogConfigurationParameters object atomically as one and overrides existing values. This is by design. If you don't specify an optional field in any of the Amazon Web Services service parameters objects (CloudwatchLogsLogDestinationParameters, FirehoseLogDestinationParameters, or S3LogDestinationParameters), EventBridge sets that field to its system-default value during the update.
For example, suppose when you created the pipe you specified a Firehose stream log destination. You then update the pipe to add an Amazon S3 log destination. In addition to specifying the S3LogDestinationParameters for the new log destination, you must also specify the fields in the FirehoseLogDestinationParameters object in order to retain the Firehose stream log destination.
For more information on generating pipe log records, see Log EventBridge Pipes in the Amazon EventBridge User Guide.
" + }, + "PipeName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\.\\-_A-Za-z0-9]+" + }, + "PipeSourceActiveMQBrokerParameters":{ + "type":"structure", + "required":[ + "Credentials", + "QueueName" + ], + "members":{ + "Credentials":{ + "shape":"MQBrokerAccessCredentials", + "documentation":"The credentials needed to access the resource.
" + }, + "QueueName":{ + "shape":"MQBrokerQueueName", + "documentation":"The name of the destination queue to consume.
" + }, + "BatchSize":{ + "shape":"LimitMax10000", + "documentation":"The maximum number of records to include in each batch.
" + }, + "MaximumBatchingWindowInSeconds":{ + "shape":"MaximumBatchingWindowInSeconds", + "documentation":"The maximum length of a time to wait for events.
" + } + }, + "documentation":"The parameters for using an Active MQ broker as a source.
" + }, + "PipeSourceDynamoDBStreamParameters":{ + "type":"structure", + "required":["StartingPosition"], + "members":{ + "BatchSize":{ + "shape":"LimitMax10000", + "documentation":"The maximum number of records to include in each batch.
" + }, + "DeadLetterConfig":{ + "shape":"DeadLetterConfig", + "documentation":"Define the target queue to send dead-letter queue events to.
" + }, + "OnPartialBatchItemFailure":{ + "shape":"OnPartialBatchItemFailureStreams", + "documentation":"(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
The maximum length of a time to wait for events.
" + }, + "MaximumRecordAgeInSeconds":{ + "shape":"MaximumRecordAgeInSeconds", + "documentation":"(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
" + }, + "MaximumRetryAttempts":{ + "shape":"MaximumRetryAttemptsESM", + "documentation":"(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
" + }, + "ParallelizationFactor":{ + "shape":"LimitMax10", + "documentation":"(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
" + }, + "StartingPosition":{ + "shape":"DynamoDBStreamStartPosition", + "documentation":"(Streams only) The position in a stream from which to start reading.
" + } + }, + "documentation":"The parameters for using a DynamoDB stream as a source.
" + }, + "PipeSourceKinesisStreamParameters":{ + "type":"structure", + "required":["StartingPosition"], + "members":{ + "BatchSize":{ + "shape":"LimitMax10000", + "documentation":"The maximum number of records to include in each batch.
" + }, + "DeadLetterConfig":{ + "shape":"DeadLetterConfig", + "documentation":"Define the target queue to send dead-letter queue events to.
" + }, + "OnPartialBatchItemFailure":{ + "shape":"OnPartialBatchItemFailureStreams", + "documentation":"(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
The maximum length of a time to wait for events.
" + }, + "MaximumRecordAgeInSeconds":{ + "shape":"MaximumRecordAgeInSeconds", + "documentation":"(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
" + }, + "MaximumRetryAttempts":{ + "shape":"MaximumRetryAttemptsESM", + "documentation":"(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
" + }, + "ParallelizationFactor":{ + "shape":"LimitMax10", + "documentation":"(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
" + }, + "StartingPosition":{ + "shape":"KinesisStreamStartPosition", + "documentation":"(Streams only) The position in a stream from which to start reading.
" + }, + "StartingPositionTimestamp":{ + "shape":"Timestamp", + "documentation":"With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
The parameters for using a Kinesis stream as a source.
" + }, + "PipeSourceManagedStreamingKafkaParameters":{ + "type":"structure", + "required":["TopicName"], + "members":{ + "TopicName":{ + "shape":"KafkaTopicName", + "documentation":"The name of the topic that the pipe will read from.
" + }, + "StartingPosition":{ + "shape":"MSKStartPosition", + "documentation":"(Streams only) The position in a stream from which to start reading.
" + }, + "BatchSize":{ + "shape":"LimitMax10000", + "documentation":"The maximum number of records to include in each batch.
" + }, + "MaximumBatchingWindowInSeconds":{ + "shape":"MaximumBatchingWindowInSeconds", + "documentation":"The maximum length of a time to wait for events.
" + }, + "ConsumerGroupID":{ + "shape":"URI", + "documentation":"The name of the destination queue to consume.
" + }, + "Credentials":{ + "shape":"MSKAccessCredentials", + "documentation":"The credentials needed to access the resource.
" + } + }, + "documentation":"The parameters for using an MSK stream as a source.
" + }, + "PipeSourceParameters":{ + "type":"structure", + "members":{ + "FilterCriteria":{ + "shape":"FilterCriteria", + "documentation":"The collection of event patterns used to filter events.
To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.
For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
" + }, + "KinesisStreamParameters":{ + "shape":"PipeSourceKinesisStreamParameters", + "documentation":"The parameters for using a Kinesis stream as a source.
" + }, + "DynamoDBStreamParameters":{ + "shape":"PipeSourceDynamoDBStreamParameters", + "documentation":"The parameters for using a DynamoDB stream as a source.
" + }, + "SqsQueueParameters":{ + "shape":"PipeSourceSqsQueueParameters", + "documentation":"The parameters for using a Amazon SQS stream as a source.
" + }, + "ActiveMQBrokerParameters":{ + "shape":"PipeSourceActiveMQBrokerParameters", + "documentation":"The parameters for using an Active MQ broker as a source.
" + }, + "RabbitMQBrokerParameters":{ + "shape":"PipeSourceRabbitMQBrokerParameters", + "documentation":"The parameters for using a Rabbit MQ broker as a source.
" + }, + "ManagedStreamingKafkaParameters":{ + "shape":"PipeSourceManagedStreamingKafkaParameters", + "documentation":"The parameters for using an MSK stream as a source.
" + }, + "SelfManagedKafkaParameters":{ + "shape":"PipeSourceSelfManagedKafkaParameters", + "documentation":"The parameters for using a self-managed Apache Kafka stream as a source.
A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.
" + } + }, + "documentation":"The parameters required to set up a source for your pipe.
" + }, + "PipeSourceRabbitMQBrokerParameters":{ + "type":"structure", + "required":[ + "Credentials", + "QueueName" + ], + "members":{ + "Credentials":{ + "shape":"MQBrokerAccessCredentials", + "documentation":"The credentials needed to access the resource.
" + }, + "QueueName":{ + "shape":"MQBrokerQueueName", + "documentation":"The name of the destination queue to consume.
" + }, + "VirtualHost":{ + "shape":"URI", + "documentation":"The name of the virtual host associated with the source broker.
" + }, + "BatchSize":{ + "shape":"LimitMax10000", + "documentation":"The maximum number of records to include in each batch.
" + }, + "MaximumBatchingWindowInSeconds":{ + "shape":"MaximumBatchingWindowInSeconds", + "documentation":"The maximum length of a time to wait for events.
" + } + }, + "documentation":"The parameters for using a Rabbit MQ broker as a source.
" + }, + "PipeSourceSelfManagedKafkaParameters":{ + "type":"structure", + "required":["TopicName"], + "members":{ + "TopicName":{ + "shape":"KafkaTopicName", + "documentation":"The name of the topic that the pipe will read from.
" + }, + "StartingPosition":{ + "shape":"SelfManagedKafkaStartPosition", + "documentation":"(Streams only) The position in a stream from which to start reading.
" + }, + "AdditionalBootstrapServers":{ + "shape":"KafkaBootstrapServers", + "documentation":"An array of server URLs.
" + }, + "BatchSize":{ + "shape":"LimitMax10000", + "documentation":"The maximum number of records to include in each batch.
" + }, + "MaximumBatchingWindowInSeconds":{ + "shape":"MaximumBatchingWindowInSeconds", + "documentation":"The maximum length of a time to wait for events.
" + }, + "ConsumerGroupID":{ + "shape":"URI", + "documentation":"The name of the destination queue to consume.
" + }, + "Credentials":{ + "shape":"SelfManagedKafkaAccessConfigurationCredentials", + "documentation":"The credentials needed to access the resource.
" + }, + "ServerRootCaCertificate":{ + "shape":"SecretManagerArn", + "documentation":"The ARN of the Secrets Manager secret used for certification.
" + }, + "Vpc":{ + "shape":"SelfManagedKafkaAccessConfigurationVpc", + "documentation":"This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
" + } + }, + "documentation":"The parameters for using a self-managed Apache Kafka stream as a source.
A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.
" + }, + "PipeSourceSqsQueueParameters":{ + "type":"structure", + "members":{ + "BatchSize":{ + "shape":"LimitMax10000", + "documentation":"The maximum number of records to include in each batch.
" + }, + "MaximumBatchingWindowInSeconds":{ + "shape":"MaximumBatchingWindowInSeconds", + "documentation":"The maximum length of a time to wait for events.
" + } + }, + "documentation":"The parameters for using a Amazon SQS stream as a source.
" + }, + "PipeState":{ + "type":"string", + "enum":[ + "RUNNING", + "STOPPED", + "CREATING", + "UPDATING", + "DELETING", + "STARTING", + "STOPPING", + "CREATE_FAILED", + "UPDATE_FAILED", + "START_FAILED", + "STOP_FAILED", + "DELETE_FAILED", + "CREATE_ROLLBACK_FAILED", + "DELETE_ROLLBACK_FAILED", + "UPDATE_ROLLBACK_FAILED" + ] + }, + "PipeStateReason":{ + "type":"string", + "max":512, + "min":0, + "pattern":".*" + }, + "PipeTargetBatchJobParameters":{ + "type":"structure", + "required":[ + "JobDefinition", + "JobName" + ], + "members":{ + "JobDefinition":{ + "shape":"String", + "documentation":"The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
" + }, + "ArrayProperties":{ + "shape":"BatchArrayProperties", + "documentation":"The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.
" + }, + "RetryStrategy":{ + "shape":"BatchRetryStrategy", + "documentation":"The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
" + }, + "ContainerOverrides":{ + "shape":"BatchContainerOverrides", + "documentation":"The overrides that are sent to a container.
" + }, + "DependsOn":{ + "shape":"BatchDependsOn", + "documentation":"A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.
" + } + }, + "documentation":"The parameters for using an Batch job as a target.
" + }, + "PipeTargetCloudWatchLogsParameters":{ + "type":"structure", + "members":{ + "LogStreamName":{ + "shape":"LogStreamName", + "documentation":"The name of the log stream.
" + }, + "Timestamp":{ + "shape":"JsonPath", + "documentation":"The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
" + } + }, + "documentation":"The parameters for using an CloudWatch Logs log stream as a target.
" + }, + "PipeTargetEcsTaskParameters":{ + "type":"structure", + "required":["TaskDefinitionArn"], + "members":{ + "TaskDefinitionArn":{ + "shape":"ArnOrJsonPath", + "documentation":"The ARN of the task definition to use if the event target is an Amazon ECS task.
" + }, + "TaskCount":{ + "shape":"LimitMin1", + "documentation":"The number of tasks to create based on TaskDefinition. The default is 1.
Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Use this structure if the Amazon ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.
If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.
This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.
" + }, + "CapacityProviderStrategy":{ + "shape":"CapacityProviderStrategy", + "documentation":"The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
" + }, + "EnableExecuteCommand":{ + "shape":"Boolean", + "documentation":"Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
" + }, + "PlacementConstraints":{ + "shape":"PlacementConstraints", + "documentation":"An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
" + }, + "PlacementStrategy":{ + "shape":"PlacementStrategies", + "documentation":"The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
" + }, + "PropagateTags":{ + "shape":"PropagateTags", + "documentation":"Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
The reference ID to use for the task.
" + }, + "Overrides":{ + "shape":"EcsTaskOverride", + "documentation":"The overrides that are associated with a task.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
" + } + }, + "documentation":"The parameters for using an Amazon ECS task as a target.
" + }, + "PipeTargetEventBridgeEventBusParameters":{ + "type":"structure", + "members":{ + "EndpointId":{ + "shape":"EventBridgeEndpointId", + "documentation":"The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.
A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
" + }, + "Source":{ + "shape":"EventBridgeEventSource", + "documentation":"The source of the event.
" + }, + "Resources":{ + "shape":"EventBridgeEventResourceList", + "documentation":"Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
" + }, + "Time":{ + "shape":"JsonPath", + "documentation":"The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.
" + } + }, + "documentation":"The parameters for using an EventBridge event bus as a target.
" + }, + "PipeTargetHttpParameters":{ + "type":"structure", + "members":{ + "PathParameterValues":{ + "shape":"PathParameterList", + "documentation":"The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"*\").
" + }, + "HeaderParameters":{ + "shape":"HeaderParametersMap", + "documentation":"The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
" + }, + "QueryStringParameters":{ + "shape":"QueryStringParametersMap", + "documentation":"The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
" + } + }, + "documentation":"These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
" + }, + "PipeTargetInvocationType":{ + "type":"string", + "enum":[ + "REQUEST_RESPONSE", + "FIRE_AND_FORGET" + ] + }, + "PipeTargetKinesisStreamParameters":{ + "type":"structure", + "required":["PartitionKey"], + "members":{ + "PartitionKey":{ + "shape":"KinesisPartitionKey", + "documentation":"Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.
" + } + }, + "documentation":"The parameters for using a Kinesis stream as a target.
" + }, + "PipeTargetLambdaFunctionParameters":{ + "type":"structure", + "members":{ + "InvocationType":{ + "shape":"PipeTargetInvocationType", + "documentation":"Specify whether to invoke the function synchronously or asynchronously.
REQUEST_RESPONSE (default) - Invoke synchronously. This corresponds to the RequestResponse option in the InvocationType parameter for the Lambda Invoke API.
FIRE_AND_FORGET - Invoke asynchronously. This corresponds to the Event option in the InvocationType parameter for the Lambda Invoke API.
For more information, see Invocation types in the Amazon EventBridge User Guide.
" + } + }, + "documentation":"The parameters for using a Lambda function as a target.
" + }, + "PipeTargetParameters":{ + "type":"structure", + "members":{ + "InputTemplate":{ + "shape":"InputTemplate", + "documentation":"Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.
To remove an input template, specify an empty string.
" + }, + "LambdaFunctionParameters":{ + "shape":"PipeTargetLambdaFunctionParameters", + "documentation":"The parameters for using a Lambda function as a target.
" + }, + "StepFunctionStateMachineParameters":{ + "shape":"PipeTargetStateMachineParameters", + "documentation":"The parameters for using a Step Functions state machine as a target.
" + }, + "KinesisStreamParameters":{ + "shape":"PipeTargetKinesisStreamParameters", + "documentation":"The parameters for using a Kinesis stream as a target.
" + }, + "EcsTaskParameters":{ + "shape":"PipeTargetEcsTaskParameters", + "documentation":"The parameters for using an Amazon ECS task as a target.
" + }, + "BatchJobParameters":{ + "shape":"PipeTargetBatchJobParameters", + "documentation":"The parameters for using an Batch job as a target.
" + }, + "SqsQueueParameters":{ + "shape":"PipeTargetSqsQueueParameters", + "documentation":"The parameters for using a Amazon SQS stream as a target.
" + }, + "HttpParameters":{ + "shape":"PipeTargetHttpParameters", + "documentation":"These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
" + }, + "RedshiftDataParameters":{ + "shape":"PipeTargetRedshiftDataParameters", + "documentation":"These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
" + }, + "SageMakerPipelineParameters":{ + "shape":"PipeTargetSageMakerPipelineParameters", + "documentation":"The parameters for using a SageMaker pipeline as a target.
" + }, + "EventBridgeEventBusParameters":{ + "shape":"PipeTargetEventBridgeEventBusParameters", + "documentation":"The parameters for using an EventBridge event bus as a target.
" + }, + "CloudWatchLogsParameters":{ + "shape":"PipeTargetCloudWatchLogsParameters", + "documentation":"The parameters for using an CloudWatch Logs log stream as a target.
" + }, + "TimestreamParameters":{ + "shape":"PipeTargetTimestreamParameters", + "documentation":"The parameters for using a Timestream for LiveAnalytics table as a target.
" + } + }, + "documentation":"The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
" + }, + "PipeTargetRedshiftDataParameters":{ + "type":"structure", + "required":[ + "Database", + "Sqls" + ], + "members":{ + "SecretManagerArn":{ + "shape":"SecretManagerArnOrJsonPath", + "documentation":"The name or ARN of the secret that enables access to the database. Required when authenticating using Secrets Manager.
" + }, + "Database":{ + "shape":"Database", + "documentation":"The name of the database. Required when authenticating using temporary credentials.
" + }, + "DbUser":{ + "shape":"DbUser", + "documentation":"The database user name. Required when authenticating using temporary credentials.
" + }, + "StatementName":{ + "shape":"StatementName", + "documentation":"The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
" + }, + "WithEvent":{ + "shape":"Boolean", + "documentation":"Indicates whether to send an event back to EventBridge after the SQL statement runs.
" + }, + "Sqls":{ + "shape":"Sqls", + "documentation":"The SQL statement text to run.
" + } + }, + "documentation":"These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
" + }, + "PipeTargetSageMakerPipelineParameters":{ + "type":"structure", + "members":{ + "PipelineParameterList":{ + "shape":"SageMakerPipelineParameterList", + "documentation":"List of Parameter names and values for SageMaker Model Building Pipeline execution.
" + } + }, + "documentation":"The parameters for using a SageMaker pipeline as a target.
" + }, + "PipeTargetSqsQueueParameters":{ + "type":"structure", + "members":{ + "MessageGroupId":{ + "shape":"MessageGroupId", + "documentation":"The FIFO message group ID to use as the target.
" + }, + "MessageDeduplicationId":{ + "shape":"MessageDeduplicationId", + "documentation":"This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of sent messages.
" + } + }, + "documentation":"The parameters for using a Amazon SQS stream as a target.
" + }, + "PipeTargetStateMachineParameters":{ + "type":"structure", + "members":{ + "InvocationType":{ + "shape":"PipeTargetInvocationType", + "documentation":"Specify whether to invoke the Step Functions state machine synchronously or asynchronously.
REQUEST_RESPONSE (default) - Invoke synchronously. For more information, see StartSyncExecution in the Step Functions API Reference.
REQUEST_RESPONSE is not supported for STANDARD state machine workflows.
FIRE_AND_FORGET - Invoke asynchronously. For more information, see StartExecution in the Step Functions API Reference.
For more information, see Invocation types in the Amazon EventBridge User Guide.
" + } + }, + "documentation":"The parameters for using a Step Functions state machine as a target.
" + }, + "PipeTargetTimestreamParameters":{ + "type":"structure", + "required":[ + "TimeValue", + "VersionValue", + "DimensionMappings" + ], + "members":{ + "TimeValue":{ + "shape":"TimeValue", + "documentation":"Dynamic path to the source data field that represents the time value for your data.
" + }, + "EpochTimeUnit":{ + "shape":"EpochTimeUnit", + "documentation":"The granularity of the time units used. Default is MILLISECONDS.
Required if TimeFieldType is specified as EPOCH.
The type of time value used.
The default is EPOCH.
How to format the timestamps. For example, YYYY-MM-DDThh:mm:ss.sssTZD.
Required if TimeFieldType is specified as TIMESTAMP_FORMAT.
64 bit version value or source data field that represents the version value for your data.
Write requests with a higher version number will update the existing measure values of the record and version. In cases where the measure value is the same, the version will still be updated.
Default value is 1.
Timestream for LiveAnalytics does not support updating partial measure values in a record.
Write requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, Version will still be updated. Default value is 1.
Version must be 1 or greater, or you will receive a ValidationException error.
Map source data to dimensions in the target Timestream for LiveAnalytics table.
For more information, see Amazon Timestream for LiveAnalytics concepts
" + }, + "SingleMeasureMappings":{ + "shape":"SingleMeasureMappings", + "documentation":"Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.
" + }, + "MultiMeasureMappings":{ + "shape":"MultiMeasureMappings", + "documentation":"Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.
" + } + }, + "documentation":"The parameters for using a Timestream for LiveAnalytics table as a target.
" + }, + "PlacementConstraint":{ + "type":"structure", + "members":{ + "type":{ + "shape":"PlacementConstraintType", + "documentation":"The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
" + }, + "expression":{ + "shape":"PlacementConstraintExpression", + "documentation":"A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
" + }, + "PlacementConstraintExpression":{ + "type":"string", + "max":2000, + "min":0, + "sensitive":true + }, + "PlacementConstraintType":{ + "type":"string", + "enum":[ + "distinctInstance", + "memberOf" + ] + }, + "PlacementConstraints":{ + "type":"list", + "member":{"shape":"PlacementConstraint"}, + "max":10, + "min":0 + }, + "PlacementStrategies":{ + "type":"list", + "member":{"shape":"PlacementStrategy"}, + "max":5, + "min":0 + }, + "PlacementStrategy":{ + "type":"structure", + "members":{ + "type":{ + "shape":"PlacementStrategyType", + "documentation":"The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
" + }, + "field":{ + "shape":"PlacementStrategyField", + "documentation":"The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
" + } + }, + "documentation":"The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer Guide.
" + }, + "PlacementStrategyField":{ + "type":"string", + "max":255, + "min":0, + "sensitive":true + }, + "PlacementStrategyType":{ + "type":"string", + "enum":[ + "random", + "spread", + "binpack" + ] + }, + "PropagateTags":{ + "type":"string", + "enum":["TASK_DEFINITION"] + }, + "QueryStringKey":{ + "type":"string", + "max":512, + "min":0, + "pattern":"[^\\x00-\\x1F\\x7F]+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)" + }, + "QueryStringParametersMap":{ + "type":"map", + "key":{"shape":"QueryStringKey"}, + "value":{"shape":"QueryStringValue"} + }, + "QueryStringValue":{ + "type":"string", + "max":512, + "min":0, + "pattern":"[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)", + "sensitive":true + }, + "ReferenceId":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "RequestedPipeState":{ + "type":"string", + "enum":[ + "RUNNING", + "STOPPED" + ] + }, + "RequestedPipeStateDescribeResponse":{ + "type":"string", + "enum":[ + "RUNNING", + "STOPPED", + "DELETED" + ] + }, + "ResourceArn":{ + "type":"string", + "max":1600, + "min":1 + }, + "RoleArn":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z0-9+=,.@\\-_/]+" + }, + "S3LogDestination":{ + "type":"structure", + "members":{ + "BucketName":{ + "shape":"String", + "documentation":"The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
" + }, + "Prefix":{ + "shape":"String", + "documentation":"The prefix text with which to begin Amazon S3 log object names.
For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
" + }, + "BucketOwner":{ + "shape":"String", + "documentation":"The Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
" + }, + "OutputFormat":{ + "shape":"S3OutputFormat", + "documentation":"The format EventBridge uses for the log records.
EventBridge currently only supports json formatting.
The Amazon S3 logging configuration settings for the pipe.
" + }, + "S3LogDestinationParameters":{ + "type":"structure", + "required":[ + "BucketName", + "BucketOwner" + ], + "members":{ + "BucketName":{ + "shape":"S3LogDestinationParametersBucketNameString", + "documentation":"Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
" + }, + "BucketOwner":{ + "shape":"S3LogDestinationParametersBucketOwnerString", + "documentation":"Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
" + }, + "OutputFormat":{ + "shape":"S3OutputFormat", + "documentation":"How EventBridge should format the log records.
EventBridge currently only supports json formatting.
Specifies any prefix text with which to begin Amazon S3 log object names.
You can use prefixes to organize the data that you store in Amazon S3 buckets. A prefix is a string of characters at the beginning of the object key name. A prefix can be any length, subject to the maximum length of the object key name (1,024 bytes). For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
" + } + }, + "documentation":"The Amazon S3 logging configuration settings for the pipe.
" + }, + "S3LogDestinationParametersBucketNameString":{ + "type":"string", + "max":63, + "min":3 + }, + "S3LogDestinationParametersBucketOwnerString":{ + "type":"string", + "pattern":"\\d{12}" + }, + "S3LogDestinationParametersPrefixString":{ + "type":"string", + "max":256, + "min":0 + }, + "S3OutputFormat":{ + "type":"string", + "enum":[ + "json", + "plain", + "w3c" + ] + }, + "SageMakerPipelineParameter":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"SageMakerPipelineParameterName", + "documentation":"Name of parameter to start execution of a SageMaker Model Building Pipeline.
" + }, + "Value":{ + "shape":"SageMakerPipelineParameterValue", + "documentation":"Value of parameter to start execution of a SageMaker Model Building Pipeline.
" + } + }, + "documentation":"Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.
" + }, + "SageMakerPipelineParameterList":{ + "type":"list", + "member":{"shape":"SageMakerPipelineParameter"}, + "max":200, + "min":0 + }, + "SageMakerPipelineParameterName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)", + "sensitive":true + }, + "SageMakerPipelineParameterValue":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "SecretManagerArn":{ + "type":"string", + "documentation":"// Optional SecretManager ARN which stores the database credentials
", + "max":1600, + "min":1, + "pattern":"(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)" + }, + "SecretManagerArnOrJsonPath":{ + "type":"string", + "documentation":"// For targets, can either specify an ARN or a jsonpath pointing to the ARN.
", + "max":1600, + "min":1, + "pattern":"(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)" + }, + "SecurityGroup":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"sg-[0-9a-zA-Z]*|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)", + "sensitive":true + }, + "SecurityGroupId":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"sg-[0-9a-zA-Z]*", + "sensitive":true + }, + "SecurityGroupIds":{ + "type":"list", + "member":{"shape":"SecurityGroupId"}, + "documentation":"List of SecurityGroupId.
", + "max":5, + "min":0 + }, + "SecurityGroups":{ + "type":"list", + "member":{"shape":"SecurityGroup"}, + "max":5, + "min":0 + }, + "SelfManagedKafkaAccessConfigurationCredentials":{ + "type":"structure", + "members":{ + "BasicAuth":{ + "shape":"SecretManagerArn", + "documentation":"The ARN of the Secrets Manager secret.
" + }, + "SaslScram512Auth":{ + "shape":"SecretManagerArn", + "documentation":"The ARN of the Secrets Manager secret.
" + }, + "SaslScram256Auth":{ + "shape":"SecretManagerArn", + "documentation":"The ARN of the Secrets Manager secret.
" + }, + "ClientCertificateTlsAuth":{ + "shape":"SecretManagerArn", + "documentation":"The ARN of the Secrets Manager secret.
" + } + }, + "documentation":"The Secrets Manager secret that stores your stream credentials.
", + "union":true + }, + "SelfManagedKafkaAccessConfigurationVpc":{ + "type":"structure", + "members":{ + "Subnets":{ + "shape":"SubnetIds", + "documentation":"Specifies the subnets associated with the stream. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
" + }, + "SecurityGroup":{ + "shape":"SecurityGroupIds", + "documentation":"Specifies the security groups associated with the stream. These security groups must all be in the same VPC. You can specify as many as five security groups.
" + } + }, + "documentation":"This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
" + }, + "SelfManagedKafkaStartPosition":{ + "type":"string", + "enum":[ + "TRIM_HORIZON", + "LATEST" + ] + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType", + "serviceCode", + "quotaCode" + ], + "members":{ + "message":{"shape":"String"}, + "resourceId":{ + "shape":"String", + "documentation":"The ID of the resource that caused the exception.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The type of resource that caused the exception.
" + }, + "serviceCode":{ + "shape":"String", + "documentation":"The identifier of the service that caused the exception.
" + }, + "quotaCode":{ + "shape":"String", + "documentation":"The identifier of the quota that caused the exception.
" + } + }, + "documentation":"A quota has been exceeded.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SingleMeasureMapping":{ + "type":"structure", + "required":[ + "MeasureValue", + "MeasureValueType", + "MeasureName" + ], + "members":{ + "MeasureValue":{ + "shape":"MeasureValue", + "documentation":"Dynamic path of the source field to map to the measure in the record.
" + }, + "MeasureValueType":{ + "shape":"MeasureValueType", + "documentation":"Data type of the source field.
" + }, + "MeasureName":{ + "shape":"MeasureName", + "documentation":"Target measure name for the measurement attribute in the Timestream table.
" + } + }, + "documentation":"Maps a single source data field to a single record in the specified Timestream for LiveAnalytics table.
For more information, see Amazon Timestream for LiveAnalytics concepts
" + }, + "SingleMeasureMappings":{ + "type":"list", + "member":{"shape":"SingleMeasureMapping"}, + "max":8192, + "min":0 + }, + "Sql":{ + "type":"string", + "documentation":"// A single Redshift SQL
", + "max":100000, + "min":1, + "sensitive":true + }, + "Sqls":{ + "type":"list", + "member":{"shape":"Sql"}, + "documentation":"// A list of SQLs.
", + "max":40, + "min":1 + }, + "StartPipeRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"PipeName", + "documentation":"The name of the pipe.
", + "location":"uri", + "locationName":"Name" + } + } + }, + "StartPipeResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"PipeArn", + "documentation":"The ARN of the pipe.
" + }, + "Name":{ + "shape":"PipeName", + "documentation":"The name of the pipe.
" + }, + "DesiredState":{ + "shape":"RequestedPipeState", + "documentation":"The state the pipe should be in.
" + }, + "CurrentState":{ + "shape":"PipeState", + "documentation":"The state the pipe is in.
" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"The time the pipe was created.
" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
" + } + } + }, + "StatementName":{ + "type":"string", + "documentation":"// A name for Redshift DataAPI statement which can be used as filter of // ListStatement.
", + "max":500, + "min":1, + "sensitive":true + }, + "StopPipeRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"PipeName", + "documentation":"The name of the pipe.
", + "location":"uri", + "locationName":"Name" + } + } + }, + "StopPipeResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"PipeArn", + "documentation":"The ARN of the pipe.
" + }, + "Name":{ + "shape":"PipeName", + "documentation":"The name of the pipe.
" + }, + "DesiredState":{ + "shape":"RequestedPipeState", + "documentation":"The state the pipe should be in.
" + }, + "CurrentState":{ + "shape":"PipeState", + "documentation":"The state the pipe is in.
" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"The time the pipe was created.
" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
" + } + } + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Subnet":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"subnet-[0-9a-z]*|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)", + "sensitive":true + }, + "SubnetId":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"subnet-[0-9a-z]*", + "sensitive":true + }, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"}, + "documentation":"List of SubnetId.
", + "max":16, + "min":0 + }, + "Subnets":{ + "type":"list", + "member":{"shape":"Subnet"}, + "max":16, + "min":0 + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The value for the specified tag key.
" + } + }, + "documentation":"A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":0 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"PipeArn", + "documentation":"The ARN of the pipe.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The list of key-value pairs associated with the pipe.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "sensitive":true + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "serviceCode":{ + "shape":"String", + "documentation":"The identifier of the service that caused the exception.
" + }, + "quotaCode":{ + "shape":"String", + "documentation":"The identifier of the quota that caused the exception.
" + }, + "retryAfterSeconds":{ + "shape":"Integer", + "documentation":"The number of seconds to wait before retrying the action that caused the exception.
", + "location":"header", + "locationName":"Retry-After" + } + }, + "documentation":"An action was throttled.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "TimeFieldType":{ + "type":"string", + "enum":[ + "EPOCH", + "TIMESTAMP_FORMAT" + ] + }, + "TimeValue":{ + "type":"string", + "max":256, + "min":1 + }, + "Timestamp":{"type":"timestamp"}, + "TimestampFormat":{ + "type":"string", + "max":256, + "min":1 + }, + "URI":{ + "type":"string", + "max":200, + "min":1, + "pattern":"[a-zA-Z0-9-\\/*:_+=.@-]*", + "sensitive":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"PipeArn", + "documentation":"The ARN of the pipe.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"The list of tag keys to remove from the pipe.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdatePipeRequest":{ + "type":"structure", + "required":[ + "Name", + "RoleArn" + ], + "members":{ + "Name":{ + "shape":"PipeName", + "documentation":"The name of the pipe.
", + "location":"uri", + "locationName":"Name" + }, + "Description":{ + "shape":"PipeDescription", + "documentation":"A description of the pipe.
" + }, + "DesiredState":{ + "shape":"RequestedPipeState", + "documentation":"The state the pipe should be in.
" + }, + "SourceParameters":{ + "shape":"UpdatePipeSourceParameters", + "documentation":"The parameters required to set up a source for your pipe.
" + }, + "Enrichment":{ + "shape":"OptionalArn", + "documentation":"The ARN of the enrichment resource.
" + }, + "EnrichmentParameters":{ + "shape":"PipeEnrichmentParameters", + "documentation":"The parameters required to set up enrichment on your pipe.
" + }, + "Target":{ + "shape":"Arn", + "documentation":"The ARN of the target resource.
" + }, + "TargetParameters":{ + "shape":"PipeTargetParameters", + "documentation":"The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The ARN of the role that allows the pipe to send data to the target.
" + }, + "LogConfiguration":{ + "shape":"PipeLogConfigurationParameters", + "documentation":"The logging configuration settings for the pipe.
" + }, + "KmsKeyIdentifier":{ + "shape":"KmsKeyIdentifier", + "documentation":"The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
To update a pipe that is using the default Amazon Web Services owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.
To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string.
For more information, see Managing keys in the Key Management Service Developer Guide.
" + } + } + }, + "UpdatePipeResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"PipeArn", + "documentation":"The ARN of the pipe.
" + }, + "Name":{ + "shape":"PipeName", + "documentation":"The name of the pipe.
" + }, + "DesiredState":{ + "shape":"RequestedPipeState", + "documentation":"The state the pipe should be in.
" + }, + "CurrentState":{ + "shape":"PipeState", + "documentation":"The state the pipe is in.
" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"The time the pipe was created.
" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
" + } + } + }, + "UpdatePipeSourceActiveMQBrokerParameters":{ + "type":"structure", + "required":["Credentials"], + "members":{ + "Credentials":{ + "shape":"MQBrokerAccessCredentials", + "documentation":"The credentials needed to access the resource.
" + }, + "BatchSize":{ + "shape":"LimitMax10000", + "documentation":"The maximum number of records to include in each batch.
" + }, + "MaximumBatchingWindowInSeconds":{ + "shape":"MaximumBatchingWindowInSeconds", + "documentation":"The maximum length of a time to wait for events.
" + } + }, + "documentation":"The parameters for using an Active MQ broker as a source.
" + }, + "UpdatePipeSourceDynamoDBStreamParameters":{ + "type":"structure", + "members":{ + "BatchSize":{ + "shape":"LimitMax10000", + "documentation":"The maximum number of records to include in each batch.
" + }, + "DeadLetterConfig":{ + "shape":"DeadLetterConfig", + "documentation":"Define the target queue to send dead-letter queue events to.
" + }, + "OnPartialBatchItemFailure":{ + "shape":"OnPartialBatchItemFailureStreams", + "documentation":"(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
The maximum length of a time to wait for events.
" + }, + "MaximumRecordAgeInSeconds":{ + "shape":"MaximumRecordAgeInSeconds", + "documentation":"(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
" + }, + "MaximumRetryAttempts":{ + "shape":"MaximumRetryAttemptsESM", + "documentation":"(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
" + }, + "ParallelizationFactor":{ + "shape":"LimitMax10", + "documentation":"(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
" + } + }, + "documentation":"The parameters for using a DynamoDB stream as a source.
" + }, + "UpdatePipeSourceKinesisStreamParameters":{ + "type":"structure", + "members":{ + "BatchSize":{ + "shape":"LimitMax10000", + "documentation":"The maximum number of records to include in each batch.
" + }, + "DeadLetterConfig":{ + "shape":"DeadLetterConfig", + "documentation":"Define the target queue to send dead-letter queue events to.
" + }, + "OnPartialBatchItemFailure":{ + "shape":"OnPartialBatchItemFailureStreams", + "documentation":"(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
The maximum length of a time to wait for events.
" + }, + "MaximumRecordAgeInSeconds":{ + "shape":"MaximumRecordAgeInSeconds", + "documentation":"(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
" + }, + "MaximumRetryAttempts":{ + "shape":"MaximumRetryAttemptsESM", + "documentation":"(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
" + }, + "ParallelizationFactor":{ + "shape":"LimitMax10", + "documentation":"(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
" + } + }, + "documentation":"The parameters for using a Kinesis stream as a source.
" + }, + "UpdatePipeSourceManagedStreamingKafkaParameters":{ + "type":"structure", + "members":{ + "BatchSize":{ + "shape":"LimitMax10000", + "documentation":"The maximum number of records to include in each batch.
" + }, + "Credentials":{ + "shape":"MSKAccessCredentials", + "documentation":"The credentials needed to access the resource.
" + }, + "MaximumBatchingWindowInSeconds":{ + "shape":"MaximumBatchingWindowInSeconds", + "documentation":"The maximum length of a time to wait for events.
" + } + }, + "documentation":"The parameters for using an MSK stream as a source.
" + }, + "UpdatePipeSourceParameters":{ + "type":"structure", + "members":{ + "FilterCriteria":{ + "shape":"FilterCriteria", + "documentation":"The collection of event patterns used to filter events.
To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.
For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
" + }, + "KinesisStreamParameters":{ + "shape":"UpdatePipeSourceKinesisStreamParameters", + "documentation":"The parameters for using a Kinesis stream as a source.
" + }, + "DynamoDBStreamParameters":{ + "shape":"UpdatePipeSourceDynamoDBStreamParameters", + "documentation":"The parameters for using a DynamoDB stream as a source.
" + }, + "SqsQueueParameters":{ + "shape":"UpdatePipeSourceSqsQueueParameters", + "documentation":"The parameters for using a Amazon SQS stream as a source.
" + }, + "ActiveMQBrokerParameters":{ + "shape":"UpdatePipeSourceActiveMQBrokerParameters", + "documentation":"The parameters for using an Active MQ broker as a source.
" + }, + "RabbitMQBrokerParameters":{ + "shape":"UpdatePipeSourceRabbitMQBrokerParameters", + "documentation":"The parameters for using a Rabbit MQ broker as a source.
" + }, + "ManagedStreamingKafkaParameters":{ + "shape":"UpdatePipeSourceManagedStreamingKafkaParameters", + "documentation":"The parameters for using an MSK stream as a source.
" + }, + "SelfManagedKafkaParameters":{ + "shape":"UpdatePipeSourceSelfManagedKafkaParameters", + "documentation":"The parameters for using a self-managed Apache Kafka stream as a source.
A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.
" + } + }, + "documentation":"The parameters required to set up a source for your pipe.
" + }, + "UpdatePipeSourceRabbitMQBrokerParameters":{ + "type":"structure", + "required":["Credentials"], + "members":{ + "Credentials":{ + "shape":"MQBrokerAccessCredentials", + "documentation":"The credentials needed to access the resource.
" + }, + "BatchSize":{ + "shape":"LimitMax10000", + "documentation":"The maximum number of records to include in each batch.
" + }, + "MaximumBatchingWindowInSeconds":{ + "shape":"MaximumBatchingWindowInSeconds", + "documentation":"The maximum length of a time to wait for events.
" + } + }, + "documentation":"The parameters for using a Rabbit MQ broker as a source.
" + }, + "UpdatePipeSourceSelfManagedKafkaParameters":{ + "type":"structure", + "members":{ + "BatchSize":{ + "shape":"LimitMax10000", + "documentation":"The maximum number of records to include in each batch.
" + }, + "MaximumBatchingWindowInSeconds":{ + "shape":"MaximumBatchingWindowInSeconds", + "documentation":"The maximum length of a time to wait for events.
" + }, + "Credentials":{ + "shape":"SelfManagedKafkaAccessConfigurationCredentials", + "documentation":"The credentials needed to access the resource.
" + }, + "ServerRootCaCertificate":{ + "shape":"SecretManagerArn", + "documentation":"The ARN of the Secrets Manager secret used for certification.
" + }, + "Vpc":{ + "shape":"SelfManagedKafkaAccessConfigurationVpc", + "documentation":"This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
" + } + }, + "documentation":"The parameters for using a self-managed Apache Kafka stream as a source.
A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.
" + }, + "UpdatePipeSourceSqsQueueParameters":{ + "type":"structure", + "members":{ + "BatchSize":{ + "shape":"LimitMax10000", + "documentation":"The maximum number of records to include in each batch.
" + }, + "MaximumBatchingWindowInSeconds":{ + "shape":"MaximumBatchingWindowInSeconds", + "documentation":"The maximum length of a time to wait for events.
" + } + }, + "documentation":"The parameters for using a Amazon SQS stream as a source.
" + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "fieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"The list of fields for which validation failed and the corresponding failure messages.
" + } + }, + "documentation":"Indicates that an error has occurred while performing a validate operation.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "name", + "message" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of the exception.
" + }, + "message":{ + "shape":"ErrorMessage", + "documentation":"The message of the exception.
" + } + }, + "documentation":"Indicates that an error has occurred while performing a validate operation.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "VersionValue":{ + "type":"string", + "max":256, + "min":1 + } + }, + "documentation":"Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target. To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data.
" +} diff --git a/testbed/boto__botocore/botocore/data/pipes/2015-10-07/waiters-2.json b/testbed/boto__botocore/botocore/data/pipes/2015-10-07/waiters-2.json new file mode 100644 index 0000000000000000000000000000000000000000..13f60ee66be6a3d75208653e2bd7b563561adacc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/pipes/2015-10-07/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/testbed/boto__botocore/botocore/data/qbusiness/2023-11-27/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/qbusiness/2023-11-27/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..b82f5c2551f5ab121673eadf0970546296e0fd56 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/qbusiness/2023-11-27/endpoint-rule-set-1.json @@ -0,0 +1,247 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://qbusiness-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://qbusiness.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://qbusiness-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://qbusiness.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/qconnect/2020-10-19/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/qconnect/2020-10-19/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..cc28c8c33e5772ded0888c90d3de0a96ae685713 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/qconnect/2020-10-19/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wisdom-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wisdom-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wisdom.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wisdom.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/redshift-serverless/2021-04-21/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/redshift-serverless/2021-04-21/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..8139b1f39edc341be163f0c4bdf82508e7ffe0e5 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/redshift-serverless/2021-04-21/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://redshift-serverless-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://redshift-serverless-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://redshift-serverless.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://redshift-serverless.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/redshift-serverless/2021-04-21/paginators-1.json b/testbed/boto__botocore/botocore/data/redshift-serverless/2021-04-21/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..3c07bc624445d0646d47027058e501de11bdcc47 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/redshift-serverless/2021-04-21/paginators-1.json @@ -0,0 +1,64 @@ +{ + "pagination": { + "ListEndpointAccess": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "endpoints" + }, + "ListNamespaces": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "namespaces" + }, + "ListRecoveryPoints": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "recoveryPoints" + }, + "ListSnapshots": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "snapshots" + }, + "ListUsageLimits": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "usageLimits" + }, + "ListWorkgroups": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "workgroups" + }, + "ListTableRestoreStatus": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "tableRestoreStatuses" + }, + "ListCustomDomainAssociations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "associations" + }, + "ListScheduledActions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "scheduledActions" + }, + "ListSnapshotCopyConfigurations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "snapshotCopyConfigurations" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/redshift-serverless/2021-04-21/service-2.json b/testbed/boto__botocore/botocore/data/redshift-serverless/2021-04-21/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..26a91f59bbb16ffb2e5b6399b3a35aa895aa356e --- /dev/null +++ b/testbed/boto__botocore/botocore/data/redshift-serverless/2021-04-21/service-2.json @@ -0,0 +1,3883 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-04-21", + "endpointPrefix":"redshift-serverless", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Redshift Serverless", + "serviceId":"Redshift Serverless", + "signatureVersion":"v4", + "signingName":"redshift-serverless", + "targetPrefix":"RedshiftServerless", + "uid":"redshift-serverless-2021-04-21" + }, + "operations":{ + "ConvertRecoveryPointToSnapshot":{ + "name":"ConvertRecoveryPointToSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConvertRecoveryPointToSnapshotRequest"}, + "output":{"shape":"ConvertRecoveryPointToSnapshotResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"TooManyTagsException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.
" + }, + "CreateCustomDomainAssociation":{ + "name":"CreateCustomDomainAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCustomDomainAssociationRequest"}, + "output":{"shape":"CreateCustomDomainAssociationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Creates a custom domain association for Amazon Redshift Serverless.
" + }, + "CreateEndpointAccess":{ + "name":"CreateEndpointAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEndpointAccessRequest"}, + "output":{"shape":"CreateEndpointAccessResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates an Amazon Redshift Serverless managed VPC endpoint.
", + "idempotent":true + }, + "CreateNamespace":{ + "name":"CreateNamespace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNamespaceRequest"}, + "output":{"shape":"CreateNamespaceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"TooManyTagsException"} + ], + "documentation":"Creates a namespace in Amazon Redshift Serverless.
", + "idempotent":true + }, + "CreateScheduledAction":{ + "name":"CreateScheduledAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateScheduledActionRequest"}, + "output":{"shape":"CreateScheduledActionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the CreateSnapshot API operation.
Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.
", + "idempotent":true + }, + "CreateSnapshotCopyConfiguration":{ + "name":"CreateSnapshotCopyConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotCopyConfigurationRequest"}, + "output":{"shape":"CreateSnapshotCopyConfigurationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.
", + "idempotent":true + }, + "CreateUsageLimit":{ + "name":"CreateUsageLimit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUsageLimitRequest"}, + "output":{"shape":"CreateUsageLimitResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.
", + "idempotent":true + }, + "CreateWorkgroup":{ + "name":"CreateWorkgroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWorkgroupRequest"}, + "output":{"shape":"CreateWorkgroupResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InsufficientCapacityException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"TooManyTagsException"}, + {"shape":"Ipv6CidrBlockNotFoundException"} + ], + "documentation":"Creates an workgroup in Amazon Redshift Serverless.
", + "idempotent":true + }, + "DeleteCustomDomainAssociation":{ + "name":"DeleteCustomDomainAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCustomDomainAssociationRequest"}, + "output":{"shape":"DeleteCustomDomainAssociationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Deletes a custom domain association for Amazon Redshift Serverless.
" + }, + "DeleteEndpointAccess":{ + "name":"DeleteEndpointAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEndpointAccessRequest"}, + "output":{"shape":"DeleteEndpointAccessResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes an Amazon Redshift Serverless managed VPC endpoint.
", + "idempotent":true + }, + "DeleteNamespace":{ + "name":"DeleteNamespace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNamespaceRequest"}, + "output":{"shape":"DeleteNamespaceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes a namespace from Amazon Redshift Serverless. Before you delete the namespace, you can create a final snapshot that has all of the data within the namespace.
", + "idempotent":true + }, + "DeleteResourcePolicy":{ + "name":"DeleteResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResourcePolicyRequest"}, + "output":{"shape":"DeleteResourcePolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes the specified resource policy.
" + }, + "DeleteScheduledAction":{ + "name":"DeleteScheduledAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteScheduledActionRequest"}, + "output":{"shape":"DeleteScheduledActionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes a scheduled action.
", + "idempotent":true + }, + "DeleteSnapshot":{ + "name":"DeleteSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotRequest"}, + "output":{"shape":"DeleteSnapshotResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes a snapshot from Amazon Redshift Serverless.
", + "idempotent":true + }, + "DeleteSnapshotCopyConfiguration":{ + "name":"DeleteSnapshotCopyConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotCopyConfigurationRequest"}, + "output":{"shape":"DeleteSnapshotCopyConfigurationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a snapshot copy configuration
", + "idempotent":true + }, + "DeleteUsageLimit":{ + "name":"DeleteUsageLimit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUsageLimitRequest"}, + "output":{"shape":"DeleteUsageLimitResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes a usage limit from Amazon Redshift Serverless.
", + "idempotent":true + }, + "DeleteWorkgroup":{ + "name":"DeleteWorkgroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWorkgroupRequest"}, + "output":{"shape":"DeleteWorkgroupResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes a workgroup.
", + "idempotent":true + }, + "GetCredentials":{ + "name":"GetCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCredentialsRequest"}, + "output":{"shape":"GetCredentialsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.
By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes).
<p>The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources.</p> <p>If the <code>DbName</code> parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.</p> Gets information about a specific custom domain association.
" + }, + "GetEndpointAccess":{ + "name":"GetEndpointAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetEndpointAccessRequest"}, + "output":{"shape":"GetEndpointAccessResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns information, such as the name, about a VPC endpoint.
" + }, + "GetNamespace":{ + "name":"GetNamespace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetNamespaceRequest"}, + "output":{"shape":"GetNamespaceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns information about a namespace in Amazon Redshift Serverless.
" + }, + "GetRecoveryPoint":{ + "name":"GetRecoveryPoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRecoveryPointRequest"}, + "output":{"shape":"GetRecoveryPointResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns information about a recovery point.
" + }, + "GetResourcePolicy":{ + "name":"GetResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResourcePolicyRequest"}, + "output":{"shape":"GetResourcePolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns a resource policy.
" + }, + "GetScheduledAction":{ + "name":"GetScheduledAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetScheduledActionRequest"}, + "output":{"shape":"GetScheduledActionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns information about a scheduled action.
" + }, + "GetSnapshot":{ + "name":"GetSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSnapshotRequest"}, + "output":{"shape":"GetSnapshotResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns information about a specific snapshot.
" + }, + "GetTableRestoreStatus":{ + "name":"GetTableRestoreStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTableRestoreStatusRequest"}, + "output":{"shape":"GetTableRestoreStatusResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns information about a TableRestoreStatus object.
Returns information about a usage limit.
" + }, + "GetWorkgroup":{ + "name":"GetWorkgroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetWorkgroupRequest"}, + "output":{"shape":"GetWorkgroupResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns information about a specific workgroup.
" + }, + "ListCustomDomainAssociations":{ + "name":"ListCustomDomainAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCustomDomainAssociationsRequest"}, + "output":{"shape":"ListCustomDomainAssociationsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidPaginationException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Lists custom domain associations for Amazon Redshift Serverless.
" + }, + "ListEndpointAccess":{ + "name":"ListEndpointAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEndpointAccessRequest"}, + "output":{"shape":"ListEndpointAccessResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns an array of EndpointAccess objects and relevant information.
Returns information about a list of specified namespaces.
" + }, + "ListRecoveryPoints":{ + "name":"ListRecoveryPoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRecoveryPointsRequest"}, + "output":{"shape":"ListRecoveryPointsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns an array of recovery points.
" + }, + "ListScheduledActions":{ + "name":"ListScheduledActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListScheduledActionsRequest"}, + "output":{"shape":"ListScheduledActionsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidPaginationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns a list of scheduled actions. You can use the flags to filter the list of returned scheduled actions.
" + }, + "ListSnapshotCopyConfigurations":{ + "name":"ListSnapshotCopyConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSnapshotCopyConfigurationsRequest"}, + "output":{"shape":"ListSnapshotCopyConfigurationsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidPaginationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns a list of snapshot copy configurations.
" + }, + "ListSnapshots":{ + "name":"ListSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSnapshotsRequest"}, + "output":{"shape":"ListSnapshotsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns a list of snapshots.
" + }, + "ListTableRestoreStatus":{ + "name":"ListTableRestoreStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTableRestoreStatusRequest"}, + "output":{"shape":"ListTableRestoreStatusResponse"}, + "errors":[ + {"shape":"InvalidPaginationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns information about an array of TableRestoreStatus objects.
Lists the tags assigned to a resource.
" + }, + "ListUsageLimits":{ + "name":"ListUsageLimits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUsageLimitsRequest"}, + "output":{"shape":"ListUsageLimitsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidPaginationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Lists all usage limits within Amazon Redshift Serverless.
" + }, + "ListWorkgroups":{ + "name":"ListWorkgroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWorkgroupsRequest"}, + "output":{"shape":"ListWorkgroupsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns information about a list of specified workgroups.
" + }, + "PutResourcePolicy":{ + "name":"PutResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutResourcePolicyRequest"}, + "output":{"shape":"PutResourcePolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.
" + }, + "RestoreFromRecoveryPoint":{ + "name":"RestoreFromRecoveryPoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreFromRecoveryPointRequest"}, + "output":{"shape":"RestoreFromRecoveryPointResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Restore the data from a recovery point.
" + }, + "RestoreFromSnapshot":{ + "name":"RestoreFromSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreFromSnapshotRequest"}, + "output":{"shape":"RestoreFromSnapshotResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Restores a namespace from a snapshot.
", + "idempotent":true + }, + "RestoreTableFromRecoveryPoint":{ + "name":"RestoreTableFromRecoveryPoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreTableFromRecoveryPointRequest"}, + "output":{"shape":"RestoreTableFromRecoveryPointResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Restores a table from a recovery point to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.
" + }, + "RestoreTableFromSnapshot":{ + "name":"RestoreTableFromSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreTableFromSnapshotRequest"}, + "output":{"shape":"RestoreTableFromSnapshotResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Restores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"TooManyTagsException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Assigns one or more tags to a resource.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Removes a tag or set of tags from a resource.
" + }, + "UpdateCustomDomainAssociation":{ + "name":"UpdateCustomDomainAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateCustomDomainAssociationRequest"}, + "output":{"shape":"UpdateCustomDomainAssociationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Updates an Amazon Redshift Serverless certificate associated with a custom domain.
" + }, + "UpdateEndpointAccess":{ + "name":"UpdateEndpointAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateEndpointAccessRequest"}, + "output":{"shape":"UpdateEndpointAccessResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates an Amazon Redshift Serverless managed endpoint.
" + }, + "UpdateNamespace":{ + "name":"UpdateNamespace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateNamespaceRequest"}, + "output":{"shape":"UpdateNamespaceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"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.
Updates a scheduled action.
", + "idempotent":true + }, + "UpdateSnapshot":{ + "name":"UpdateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSnapshotRequest"}, + "output":{"shape":"UpdateSnapshotResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates a snapshot.
" + }, + "UpdateSnapshotCopyConfiguration":{ + "name":"UpdateSnapshotCopyConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSnapshotCopyConfigurationRequest"}, + "output":{"shape":"UpdateSnapshotCopyConfigurationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates a snapshot copy configuration.
" + }, + "UpdateUsageLimit":{ + "name":"UpdateUsageLimit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUsageLimitRequest"}, + "output":{"shape":"UpdateUsageLimitResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.
" + }, + "UpdateWorkgroup":{ + "name":"UpdateWorkgroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateWorkgroupRequest"}, + "output":{"shape":"UpdateWorkgroupResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InsufficientCapacityException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"Ipv6CidrBlockNotFoundException"} + ], + "documentation":"Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update baseCapacity or port in a single request, but you can't update both in the same request.
You do not have sufficient access to perform this action.
", + "exception":true + }, + "AccountIdList":{ + "type":"list", + "member":{"shape":"String"} + }, + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1 + }, + "Association":{ + "type":"structure", + "members":{ + "customDomainCertificateArn":{ + "shape":"CustomDomainCertificateArnString", + "documentation":"The custom domain name’s certificate Amazon resource name (ARN).
" + }, + "customDomainCertificateExpiryTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The expiration time for the certificate.
" + }, + "customDomainName":{ + "shape":"CustomDomainName", + "documentation":"The custom domain name associated with the workgroup.
" + }, + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the workgroup associated with the database.
" + } + }, + "documentation":"An object that represents the custom domain name association.
" + }, + "AssociationList":{ + "type":"list", + "member":{"shape":"Association"} + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ConfigParameter":{ + "type":"structure", + "members":{ + "parameterKey":{ + "shape":"ParameterKey", + "documentation":"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 query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
The value of the parameter to set.
" + } + }, + "documentation":"An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.
" + }, + "ConfigParameterList":{ + "type":"list", + "member":{"shape":"ConfigParameter"} + }, + "ConflictException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The submitted action has conflicts.
", + "exception":true + }, + "ConvertRecoveryPointToSnapshotRequest":{ + "type":"structure", + "required":[ + "recoveryPointId", + "snapshotName" + ], + "members":{ + "recoveryPointId":{ + "shape":"String", + "documentation":"The unique identifier of the recovery point.
" + }, + "retentionPeriod":{ + "shape":"Integer", + "documentation":"How long to retain the snapshot.
" + }, + "snapshotName":{ + "shape":"String", + "documentation":"The name of the snapshot.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"An array of Tag objects to associate with the created snapshot.
" + } + } + }, + "ConvertRecoveryPointToSnapshotResponse":{ + "type":"structure", + "members":{ + "snapshot":{ + "shape":"Snapshot", + "documentation":"The snapshot converted from the recovery point.
" + } + } + }, + "CreateCustomDomainAssociationRequest":{ + "type":"structure", + "required":[ + "customDomainCertificateArn", + "customDomainName", + "workgroupName" + ], + "members":{ + "customDomainCertificateArn":{ + "shape":"CustomDomainCertificateArnString", + "documentation":"The custom domain name’s certificate Amazon resource name (ARN).
" + }, + "customDomainName":{ + "shape":"CustomDomainName", + "documentation":"The custom domain name to associate with the workgroup.
" + }, + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the workgroup associated with the database.
" + } + } + }, + "CreateCustomDomainAssociationResponse":{ + "type":"structure", + "members":{ + "customDomainCertificateArn":{ + "shape":"CustomDomainCertificateArnString", + "documentation":"The custom domain name’s certificate Amazon resource name (ARN).
" + }, + "customDomainCertificateExpiryTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The expiration time for the certificate.
" + }, + "customDomainName":{ + "shape":"CustomDomainName", + "documentation":"The custom domain name to associate with the workgroup.
" + }, + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the workgroup associated with the database.
" + } + } + }, + "CreateEndpointAccessRequest":{ + "type":"structure", + "required":[ + "endpointName", + "subnetIds", + "workgroupName" + ], + "members":{ + "endpointName":{ + "shape":"String", + "documentation":"The name of the VPC endpoint. An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.
" + }, + "ownerAccount":{ + "shape":"OwnerAccount", + "documentation":"The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
" + }, + "subnetIds":{ + "shape":"SubnetIdList", + "documentation":"The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.
" + }, + "vpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"The unique identifiers of the security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
" + }, + "workgroupName":{ + "shape":"String", + "documentation":"The name of the workgroup to associate with the VPC endpoint.
" + } + } + }, + "CreateEndpointAccessResponse":{ + "type":"structure", + "members":{ + "endpoint":{ + "shape":"EndpointAccess", + "documentation":"The created VPC endpoint.
" + } + } + }, + "CreateNamespaceRequest":{ + "type":"structure", + "required":["namespaceName"], + "members":{ + "adminPasswordSecretKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"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.
The password of the administrator for the first database created in the namespace.
You can't use adminUserPassword if manageAdminPassword is true.
The username of the administrator for the first database created in the namespace.
" + }, + "dbName":{ + "shape":"String", + "documentation":"The name of the first database created in the namespace.
" + }, + "defaultIamRoleArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
" + }, + "iamRoles":{ + "shape":"IamRoleArnList", + "documentation":"A list of IAM roles to associate with the namespace.
" + }, + "kmsKeyId":{ + "shape":"String", + "documentation":"The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
" + }, + "logExports":{ + "shape":"LogExportList", + "documentation":"The types of logs the namespace can export. Available export types are userlog, connectionlog, and useractivitylog.
If true, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.
The name of the namespace.
" + }, + "redshiftIdcApplicationArn":{ + "shape":"RedshiftIdcApplicationArn", + "documentation":"The ARN for the Redshift application that integrates with IAM Identity Center.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"A list of tag instances.
" + } + } + }, + "CreateNamespaceResponse":{ + "type":"structure", + "members":{ + "namespace":{ + "shape":"Namespace", + "documentation":"The created namespace object.
" + } + } + }, + "CreateScheduledActionRequest":{ + "type":"structure", + "required":[ + "namespaceName", + "roleArn", + "schedule", + "scheduledActionName", + "targetAction" + ], + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"Indicates whether the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
" + }, + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"The name of the namespace for which to create a scheduled action.
" + }, + "roleArn":{ + "shape":"IamRoleArn", + "documentation":"The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide
" + }, + "schedule":{ + "shape":"Schedule", + "documentation":"The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
The description of the scheduled action.
" + }, + "scheduledActionName":{ + "shape":"ScheduledActionName", + "documentation":"The name of the scheduled action.
" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
" + }, + "targetAction":{"shape":"TargetAction"} + } + }, + "CreateScheduledActionResponse":{ + "type":"structure", + "members":{ + "scheduledAction":{ + "shape":"ScheduledActionResponse", + "documentation":"The returned ScheduledAction object that describes the properties of a scheduled action.
The KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
" + }, + "destinationRegion":{ + "shape":"String", + "documentation":"The destination Amazon Web Services Region that you want to copy snapshots to.
" + }, + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"The name of the namespace to copy snapshots from.
" + }, + "snapshotRetentionPeriod":{ + "shape":"Integer", + "documentation":"The retention period of the snapshots that you copy to the destination Amazon Web Services Region.
" + } + } + }, + "CreateSnapshotCopyConfigurationResponse":{ + "type":"structure", + "required":["snapshotCopyConfiguration"], + "members":{ + "snapshotCopyConfiguration":{ + "shape":"SnapshotCopyConfiguration", + "documentation":"The snapshot copy configuration object that is returned.
" + } + } + }, + "CreateSnapshotRequest":{ + "type":"structure", + "required":[ + "namespaceName", + "snapshotName" + ], + "members":{ + "namespaceName":{ + "shape":"String", + "documentation":"The namespace to create a snapshot for.
" + }, + "retentionPeriod":{ + "shape":"Integer", + "documentation":"How long to retain the created snapshot.
" + }, + "snapshotName":{ + "shape":"String", + "documentation":"The name of the snapshot.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"An array of Tag objects to associate with the snapshot.
" + } + } + }, + "CreateSnapshotResponse":{ + "type":"structure", + "members":{ + "snapshot":{ + "shape":"Snapshot", + "documentation":"The created snapshot object.
" + } + } + }, + "CreateSnapshotScheduleActionParameters":{ + "type":"structure", + "required":[ + "namespaceName", + "snapshotNamePrefix" + ], + "members":{ + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"The name of the namespace for which you want to configure a scheduled action to create a snapshot.
" + }, + "retentionPeriod":{ + "shape":"Integer", + "documentation":"The retention period of the snapshot created by the scheduled action.
" + }, + "snapshotNamePrefix":{ + "shape":"SnapshotNamePrefix", + "documentation":"A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"An array of Tag objects to associate with the snapshot.
" + } + }, + "documentation":"The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction.
" + }, + "CreateUsageLimitRequest":{ + "type":"structure", + "required":[ + "amount", + "resourceArn", + "usageType" + ], + "members":{ + "amount":{ + "shape":"Long", + "documentation":"The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.
" + }, + "breachAction":{ + "shape":"UsageLimitBreachAction", + "documentation":"The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.
" + }, + "period":{ + "shape":"UsageLimitPeriod", + "documentation":"The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
" + }, + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.
" + }, + "usageType":{ + "shape":"UsageLimitUsageType", + "documentation":"The type of Amazon Redshift Serverless usage to create a usage limit for.
" + } + } + }, + "CreateUsageLimitResponse":{ + "type":"structure", + "members":{ + "usageLimit":{ + "shape":"UsageLimit", + "documentation":"The returned usage limit object.
" + } + } + }, + "CreateWorkgroupRequest":{ + "type":"structure", + "required":[ + "namespaceName", + "workgroupName" + ], + "members":{ + "baseCapacity":{ + "shape":"Integer", + "documentation":"The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
" + }, + "configParameters":{ + "shape":"ConfigParameterList", + "documentation":"An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
" + }, + "ipAddressType":{ + "shape":"IpAddressType", + "documentation":"The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
" + }, + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"The name of the namespace to associate with the workgroup.
" + }, + "port":{ + "shape":"Integer", + "documentation":"The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
" + }, + "publiclyAccessible":{ + "shape":"Boolean", + "documentation":"A value that specifies whether the workgroup can be accessed from a public network.
" + }, + "securityGroupIds":{ + "shape":"SecurityGroupIdList", + "documentation":"An array of security group IDs to associate with the workgroup.
" + }, + "subnetIds":{ + "shape":"SubnetIdList", + "documentation":"An array of VPC subnet IDs to associate with the workgroup.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"A array of tag instances.
" + }, + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the created workgroup.
" + } + } + }, + "CreateWorkgroupResponse":{ + "type":"structure", + "members":{ + "workgroup":{ + "shape":"Workgroup", + "documentation":"The created workgroup object.
" + } + } + }, + "CustomDomainCertificateArnString":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:[\\w+=/,.@-]+:acm:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*" + }, + "CustomDomainName":{ + "type":"string", + "max":253, + "min":1, + "pattern":"^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$" + }, + "DbName":{"type":"string"}, + "DbPassword":{ + "type":"string", + "sensitive":true + }, + "DbUser":{ + "type":"string", + "sensitive":true + }, + "DeleteCustomDomainAssociationRequest":{ + "type":"structure", + "required":[ + "customDomainName", + "workgroupName" + ], + "members":{ + "customDomainName":{ + "shape":"CustomDomainName", + "documentation":"The custom domain name associated with the workgroup.
" + }, + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the workgroup associated with the database.
" + } + } + }, + "DeleteCustomDomainAssociationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteEndpointAccessRequest":{ + "type":"structure", + "required":["endpointName"], + "members":{ + "endpointName":{ + "shape":"String", + "documentation":"The name of the VPC endpoint to delete.
" + } + } + }, + "DeleteEndpointAccessResponse":{ + "type":"structure", + "members":{ + "endpoint":{ + "shape":"EndpointAccess", + "documentation":"The deleted VPC endpoint.
" + } + } + }, + "DeleteNamespaceRequest":{ + "type":"structure", + "required":["namespaceName"], + "members":{ + "finalSnapshotName":{ + "shape":"String", + "documentation":"The name of the snapshot to be created before the namespace is deleted.
" + }, + "finalSnapshotRetentionPeriod":{ + "shape":"Integer", + "documentation":"How long to retain the final snapshot.
" + }, + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"The name of the namespace to delete.
" + } + } + }, + "DeleteNamespaceResponse":{ + "type":"structure", + "required":["namespace"], + "members":{ + "namespace":{ + "shape":"Namespace", + "documentation":"The deleted namespace object.
" + } + } + }, + "DeleteResourcePolicyRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the policy to delete.
" + } + } + }, + "DeleteResourcePolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteScheduledActionRequest":{ + "type":"structure", + "required":["scheduledActionName"], + "members":{ + "scheduledActionName":{ + "shape":"ScheduledActionName", + "documentation":"The name of the scheduled action to delete.
" + } + } + }, + "DeleteScheduledActionResponse":{ + "type":"structure", + "members":{ + "scheduledAction":{ + "shape":"ScheduledActionResponse", + "documentation":"The deleted scheduled action object.
" + } + } + }, + "DeleteSnapshotCopyConfigurationRequest":{ + "type":"structure", + "required":["snapshotCopyConfigurationId"], + "members":{ + "snapshotCopyConfigurationId":{ + "shape":"String", + "documentation":"The ID of the snapshot copy configuration to delete.
" + } + } + }, + "DeleteSnapshotCopyConfigurationResponse":{ + "type":"structure", + "required":["snapshotCopyConfiguration"], + "members":{ + "snapshotCopyConfiguration":{ + "shape":"SnapshotCopyConfiguration", + "documentation":"The deleted snapshot copy configuration object.
" + } + } + }, + "DeleteSnapshotRequest":{ + "type":"structure", + "required":["snapshotName"], + "members":{ + "snapshotName":{ + "shape":"String", + "documentation":"The name of the snapshot to be deleted.
" + } + } + }, + "DeleteSnapshotResponse":{ + "type":"structure", + "members":{ + "snapshot":{ + "shape":"Snapshot", + "documentation":"The deleted snapshot object.
" + } + } + }, + "DeleteUsageLimitRequest":{ + "type":"structure", + "required":["usageLimitId"], + "members":{ + "usageLimitId":{ + "shape":"String", + "documentation":"The unique identifier of the usage limit to delete.
" + } + } + }, + "DeleteUsageLimitResponse":{ + "type":"structure", + "members":{ + "usageLimit":{ + "shape":"UsageLimit", + "documentation":"The deleted usage limit object.
" + } + } + }, + "DeleteWorkgroupRequest":{ + "type":"structure", + "required":["workgroupName"], + "members":{ + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the workgroup to be deleted.
" + } + } + }, + "DeleteWorkgroupResponse":{ + "type":"structure", + "required":["workgroup"], + "members":{ + "workgroup":{ + "shape":"Workgroup", + "documentation":"The deleted workgroup object.
" + } + } + }, + "Double":{ + "type":"double", + "box":true + }, + "Endpoint":{ + "type":"structure", + "members":{ + "address":{ + "shape":"String", + "documentation":"The DNS address of the VPC endpoint.
" + }, + "port":{ + "shape":"Integer", + "documentation":"The port that Amazon Redshift Serverless listens on.
" + }, + "vpcEndpoints":{ + "shape":"VpcEndpointList", + "documentation":"An array of VpcEndpoint objects.
The VPC endpoint object.
" + }, + "EndpointAccess":{ + "type":"structure", + "members":{ + "address":{ + "shape":"String", + "documentation":"The DNS address of the endpoint.
" + }, + "endpointArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the VPC endpoint.
" + }, + "endpointCreateTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time that the endpoint was created.
" + }, + "endpointName":{ + "shape":"String", + "documentation":"The name of the VPC endpoint.
" + }, + "endpointStatus":{ + "shape":"String", + "documentation":"The status of the VPC endpoint.
" + }, + "port":{ + "shape":"Integer", + "documentation":"The port number on which Amazon Redshift Serverless accepts incoming connections.
" + }, + "subnetIds":{ + "shape":"SubnetIdList", + "documentation":"The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
" + }, + "vpcEndpoint":{ + "shape":"VpcEndpoint", + "documentation":"The connection endpoint for connecting to Amazon Redshift Serverless.
" + }, + "vpcSecurityGroups":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"The security groups associated with the endpoint.
" + }, + "workgroupName":{ + "shape":"String", + "documentation":"The name of the workgroup associated with the endpoint.
" + } + }, + "documentation":"Information about an Amazon Redshift Serverless VPC endpoint.
" + }, + "EndpointAccessList":{ + "type":"list", + "member":{"shape":"EndpointAccess"} + }, + "GetCredentialsRequest":{ + "type":"structure", + "members":{ + "customDomainName":{ + "shape":"CustomDomainName", + "documentation":"The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request.
" + }, + "dbName":{ + "shape":"DbName", + "documentation":"The name of the database to get temporary authorization to log on to.
Constraints:
Must be 1 to 64 alphanumeric characters or hyphens.
Must contain only uppercase or 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 slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide
The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds.
" + }, + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the workgroup associated with the database.
" + } + } + }, + "GetCredentialsResponse":{ + "type":"structure", + "members":{ + "dbPassword":{ + "shape":"DbPassword", + "documentation":"A temporary password that authorizes the user name returned by DbUser to log on to the database DbName.
A database user name that is authorized to log on to the database DbName using the password DbPassword. If the specified DbUser exists in the database, the new user name has the same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC.
The date and time the password in DbPassword expires.
The date and time of when the DbUser and DbPassword authorization refreshes.
The custom domain name associated with the workgroup.
" + }, + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the workgroup associated with the database.
" + } + } + }, + "GetCustomDomainAssociationResponse":{ + "type":"structure", + "members":{ + "customDomainCertificateArn":{ + "shape":"CustomDomainCertificateArnString", + "documentation":"The custom domain name’s certificate Amazon resource name (ARN).
" + }, + "customDomainCertificateExpiryTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The expiration time for the certificate.
" + }, + "customDomainName":{ + "shape":"CustomDomainName", + "documentation":"The custom domain name associated with the workgroup.
" + }, + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the workgroup associated with the database.
" + } + } + }, + "GetEndpointAccessRequest":{ + "type":"structure", + "required":["endpointName"], + "members":{ + "endpointName":{ + "shape":"String", + "documentation":"The name of the VPC endpoint to return information for.
" + } + } + }, + "GetEndpointAccessResponse":{ + "type":"structure", + "members":{ + "endpoint":{ + "shape":"EndpointAccess", + "documentation":"The returned VPC endpoint.
" + } + } + }, + "GetNamespaceRequest":{ + "type":"structure", + "required":["namespaceName"], + "members":{ + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"The name of the namespace to retrieve information for.
" + } + } + }, + "GetNamespaceResponse":{ + "type":"structure", + "required":["namespace"], + "members":{ + "namespace":{ + "shape":"Namespace", + "documentation":"The returned namespace object.
" + } + } + }, + "GetRecoveryPointRequest":{ + "type":"structure", + "required":["recoveryPointId"], + "members":{ + "recoveryPointId":{ + "shape":"String", + "documentation":"The unique identifier of the recovery point to return information for.
" + } + } + }, + "GetRecoveryPointResponse":{ + "type":"structure", + "members":{ + "recoveryPoint":{ + "shape":"RecoveryPoint", + "documentation":"The returned recovery point object.
" + } + } + }, + "GetResourcePolicyRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the resource to return.
" + } + } + }, + "GetResourcePolicyResponse":{ + "type":"structure", + "members":{ + "resourcePolicy":{ + "shape":"ResourcePolicy", + "documentation":"The returned resource policy.
" + } + } + }, + "GetScheduledActionRequest":{ + "type":"structure", + "required":["scheduledActionName"], + "members":{ + "scheduledActionName":{ + "shape":"ScheduledActionName", + "documentation":"The name of the scheduled action.
" + } + } + }, + "GetScheduledActionResponse":{ + "type":"structure", + "members":{ + "scheduledAction":{ + "shape":"ScheduledActionResponse", + "documentation":"The returned scheduled action object.
" + } + } + }, + "GetSnapshotRequest":{ + "type":"structure", + "members":{ + "ownerAccount":{ + "shape":"String", + "documentation":"The owner Amazon Web Services account of a snapshot shared with another user.
" + }, + "snapshotArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the snapshot to return.
" + }, + "snapshotName":{ + "shape":"String", + "documentation":"The name of the snapshot to return.
" + } + } + }, + "GetSnapshotResponse":{ + "type":"structure", + "members":{ + "snapshot":{ + "shape":"Snapshot", + "documentation":"The returned snapshot object.
" + } + } + }, + "GetTableRestoreStatusRequest":{ + "type":"structure", + "required":["tableRestoreRequestId"], + "members":{ + "tableRestoreRequestId":{ + "shape":"String", + "documentation":"The ID of the RestoreTableFromSnapshot request to return status for.
The returned TableRestoreStatus object that contains information about the status of your RestoreTableFromSnapshot request.
The unique identifier of the usage limit to return information for.
" + } + } + }, + "GetUsageLimitResponse":{ + "type":"structure", + "members":{ + "usageLimit":{ + "shape":"UsageLimit", + "documentation":"The returned usage limit object.
" + } + } + }, + "GetWorkgroupRequest":{ + "type":"structure", + "required":["workgroupName"], + "members":{ + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the workgroup to return information for.
" + } + } + }, + "GetWorkgroupResponse":{ + "type":"structure", + "required":["workgroup"], + "members":{ + "workgroup":{ + "shape":"Workgroup", + "documentation":"The returned workgroup object.
" + } + } + }, + "IamRoleArn":{"type":"string"}, + "IamRoleArnList":{ + "type":"list", + "member":{"shape":"IamRoleArn"} + }, + "InsufficientCapacityException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"There is an insufficient capacity to perform the action.
", + "exception":true, + "retryable":{"throttling":false} + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request processing has failed because of an unknown error, exception or failure.
", + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "InvalidPaginationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The provided pagination token is invalid.
", + "exception":true + }, + "IpAddressType":{ + "type":"string", + "pattern":"^(ipv4|dualstack)$" + }, + "Ipv6CidrBlockNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.
", + "exception":true + }, + "KmsKeyId":{"type":"string"}, + "ListCustomDomainAssociationsRequest":{ + "type":"structure", + "members":{ + "customDomainCertificateArn":{ + "shape":"CustomDomainCertificateArnString", + "documentation":"The custom domain name’s certificate Amazon resource name (ARN).
" + }, + "customDomainName":{ + "shape":"CustomDomainName", + "documentation":"The custom domain name associated with the workgroup.
" + }, + "maxResults":{ + "shape":"ListCustomDomainAssociationsRequestMaxResultsInteger", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
A list of Association objects.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
If your initial ListEndpointAccess operation returns a nextToken, you can include the returned nextToken in following ListEndpointAccess operations, which returns results in the next page.
The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
" + }, + "vpcId":{ + "shape":"String", + "documentation":"The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.
" + }, + "workgroupName":{ + "shape":"String", + "documentation":"The name of the workgroup associated with the VPC endpoint to return.
" + } + } + }, + "ListEndpointAccessRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListEndpointAccessResponse":{ + "type":"structure", + "required":["endpoints"], + "members":{ + "endpoints":{ + "shape":"EndpointAccessList", + "documentation":"The returned VPC endpoints.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
If your initial ListNamespaces operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.
The list of returned namespaces.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
The time when creation of the recovery point finished.
" + }, + "maxResults":{ + "shape":"ListRecoveryPointsRequestMaxResultsInteger", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
The Amazon Resource Name (ARN) of the namespace from which to list recovery points.
" + }, + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"The name of the namespace to list recovery points for.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"If your initial ListRecoveryPoints operation returns a nextToken, you can include the returned nextToken in following ListRecoveryPoints operations, which returns results in the next page.
The time when the recovery point's creation was initiated.
" + } + } + }, + "ListRecoveryPointsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListRecoveryPointsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
The returned recovery point objects.
" + } + } + }, + "ListScheduledActionsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListScheduledActionsRequestMaxResultsInteger", + "documentation":"An optional parameter that specifies the maximum number of results to return. Use nextToken to display the next page of results.
The name of namespace associated with the scheduled action to retrieve.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" + }, + "scheduledActions":{ + "shape":"ScheduledActionsList", + "documentation":"All of the returned scheduled action association objects.
" + } + } + }, + "ListSnapshotCopyConfigurationsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListSnapshotCopyConfigurationsRequestMaxResultsInteger", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
The namespace from which to list all snapshot copy configurations.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
All of the returned snapshot copy configurations.
" + } + } + }, + "ListSnapshotsRequest":{ + "type":"structure", + "members":{ + "endTime":{ + "shape":"Timestamp", + "documentation":"The timestamp showing when the snapshot creation finished.
" + }, + "maxResults":{ + "shape":"ListSnapshotsRequestMaxResultsInteger", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.
" + }, + "namespaceName":{ + "shape":"String", + "documentation":"The namespace from which to list all snapshots.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
The owner Amazon Web Services account of the snapshot.
" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"The time when the creation of the snapshot was initiated.
" + } + } + }, + "ListSnapshotsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListSnapshotsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
All of the returned snapshot objects.
" + } + } + }, + "ListTableRestoreStatusRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListTableRestoreStatusRequestMaxResultsInteger", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
", + "box":true + }, + "namespaceName":{ + "shape":"String", + "documentation":"The namespace from which to list all of the statuses of RestoreTableFromSnapshot operations .
If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will return results on the next page.
The workgroup from which to list all of the statuses of RestoreTableFromSnapshot operations.
If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will returns results on the next page.
The array of returned TableRestoreStatus objects.
The Amazon Resource Name (ARN) of the resource to list tags for.
" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"A map of the key-value pairs assigned to the resource.
" + } + } + }, + "ListUsageLimitsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListUsageLimitsRequestMaxResultsInteger", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 100.
If your initial ListUsageLimits operation returns a nextToken, you can include the returned nextToken in following ListUsageLimits operations, which returns results in the next page.
The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.
" + }, + "usageType":{ + "shape":"UsageLimitUsageType", + "documentation":"The Amazon Redshift Serverless feature whose limits you want to see.
" + } + } + }, + "ListUsageLimitsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListUsageLimitsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
An array of returned usage limit objects.
" + } + } + }, + "ListWorkgroupsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListWorkgroupsRequestMaxResultsInteger", + "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
If your initial ListWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.
The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
" + } + } + }, + "ListWorkgroupsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListWorkgroupsResponse":{ + "type":"structure", + "required":["workgroups"], + "members":{ + "nextToken":{ + "shape":"String", + "documentation":" If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.
The returned array of workgroups.
" + } + } + }, + "LogExport":{ + "type":"string", + "enum":[ + "useractivitylog", + "userlog", + "connectionlog" + ] + }, + "LogExportList":{ + "type":"list", + "member":{"shape":"LogExport"}, + "max":16, + "min":0 + }, + "Long":{ + "type":"long", + "box":true + }, + "Namespace":{ + "type":"structure", + "members":{ + "adminPasswordSecretArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
" + }, + "adminPasswordSecretKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
" + }, + "adminUsername":{ + "shape":"DbUser", + "documentation":"The username of the administrator for the first database created in the namespace.
" + }, + "creationDate":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date of when the namespace was created.
" + }, + "dbName":{ + "shape":"String", + "documentation":"The name of the first database created in the namespace.
" + }, + "defaultIamRoleArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
" + }, + "iamRoles":{ + "shape":"IamRoleArnList", + "documentation":"A list of IAM roles to associate with the namespace.
" + }, + "kmsKeyId":{ + "shape":"String", + "documentation":"The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
" + }, + "logExports":{ + "shape":"LogExportList", + "documentation":"The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
" + }, + "namespaceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) associated with a namespace.
" + }, + "namespaceId":{ + "shape":"String", + "documentation":"The unique identifier of a namespace.
" + }, + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"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.
" + }, + "status":{ + "shape":"NamespaceStatus", + "documentation":"The status of the namespace.
" + } + }, + "documentation":"A collection of database objects and users.
" + }, + "NamespaceList":{ + "type":"list", + "member":{"shape":"Namespace"} + }, + "NamespaceName":{ + "type":"string", + "max":64, + "min":3, + "pattern":"^[a-z0-9-]+$" + }, + "NamespaceStatus":{ + "type":"string", + "enum":[ + "AVAILABLE", + "MODIFYING", + "DELETING" + ] + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "availabilityZone":{ + "shape":"String", + "documentation":"The availability Zone.
" + }, + "ipv6Address":{ + "shape":"String", + "documentation":"The IPv6 address of the network interface within the subnet.
" + }, + "networkInterfaceId":{ + "shape":"String", + "documentation":"The unique identifier of the network interface.
" + }, + "privateIpAddress":{ + "shape":"String", + "documentation":"The IPv4 address of the network interface within the subnet.
" + }, + "subnetId":{ + "shape":"String", + "documentation":"The unique identifier of the subnet.
" + } + }, + "documentation":"Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
" + }, + "NetworkInterfaceList":{ + "type":"list", + "member":{"shape":"NetworkInterface"} + }, + "NextInvocationsList":{ + "type":"list", + "member":{"shape":"Timestamp"} + }, + "OwnerAccount":{ + "type":"string", + "max":12, + "min":1, + "pattern":"(\\d{12})" + }, + "PaginationToken":{ + "type":"string", + "max":1024, + "min":8 + }, + "ParameterKey":{"type":"string"}, + "ParameterValue":{"type":"string"}, + "PutResourcePolicyRequest":{ + "type":"structure", + "required":[ + "policy", + "resourceArn" + ], + "members":{ + "policy":{ + "shape":"String", + "documentation":"The policy to create or update. For example, the following policy grants a user authorization to restore a snapshot.
\"{\\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\" : [{ \\\"Sid\\\": \\\"AllowUserRestoreFromSnapshot\\\", \\\"Principal\\\":{\\\"AWS\\\": [\\\"739247239426\\\"]}, \\\"Action\\\": [\\\"redshift-serverless:RestoreFromSnapshot\\\"] , \\\"Effect\\\": \\\"Allow\\\" }]}\"
The Amazon Resource Name (ARN) of the account to create or update a resource policy for.
" + } + } + }, + "PutResourcePolicyResponse":{ + "type":"structure", + "members":{ + "resourcePolicy":{ + "shape":"ResourcePolicy", + "documentation":"The policy that was created or updated.
" + } + } + }, + "RecoveryPoint":{ + "type":"structure", + "members":{ + "namespaceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the namespace the recovery point is associated with.
" + }, + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"The name of the namespace the recovery point is associated with.
" + }, + "recoveryPointCreateTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time the recovery point is created.
" + }, + "recoveryPointId":{ + "shape":"String", + "documentation":"The unique identifier of the recovery point.
" + }, + "totalSizeInMegaBytes":{ + "shape":"Double", + "documentation":"The total size of the data in the recovery point in megabytes.
" + }, + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the workgroup the recovery point is associated with.
" + } + }, + "documentation":"The automatically created recovery point of a namespace. Recovery points are created every 30 minutes and kept for 24 hours.
" + }, + "RecoveryPointList":{ + "type":"list", + "member":{"shape":"RecoveryPoint"} + }, + "RedshiftIdcApplicationArn":{ + "type":"string", + "max":1024, + "min":1 + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "resourceName":{ + "shape":"AmazonResourceName", + "documentation":"The name of the resource that could not be found.
" + } + }, + "documentation":"The resource could not be found.
", + "exception":true + }, + "ResourcePolicy":{ + "type":"structure", + "members":{ + "policy":{ + "shape":"String", + "documentation":"The resource policy.
" + }, + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the policy.
" + } + }, + "documentation":"The resource policy object. Currently, you can use policies to share snapshots across Amazon Web Services accounts.
" + }, + "RestoreFromRecoveryPointRequest":{ + "type":"structure", + "required":[ + "namespaceName", + "recoveryPointId", + "workgroupName" + ], + "members":{ + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"The name of the namespace to restore data into.
" + }, + "recoveryPointId":{ + "shape":"String", + "documentation":"The unique identifier of the recovery point to restore from.
" + }, + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the workgroup used to restore data.
" + } + } + }, + "RestoreFromRecoveryPointResponse":{ + "type":"structure", + "members":{ + "namespace":{ + "shape":"Namespace", + "documentation":"The namespace that data was restored into.
" + }, + "recoveryPointId":{ + "shape":"String", + "documentation":"The unique identifier of the recovery point used for the restore.
" + } + } + }, + "RestoreFromSnapshotRequest":{ + "type":"structure", + "required":[ + "namespaceName", + "workgroupName" + ], + "members":{ + "adminPasswordSecretKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
" + }, + "manageAdminPassword":{ + "shape":"Boolean", + "documentation":"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.
The name of the namespace to restore the snapshot to.
" + }, + "ownerAccount":{ + "shape":"String", + "documentation":"The Amazon Web Services account that owns the snapshot.
" + }, + "snapshotArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be specified at the same time as snapshotName.
The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.
" + }, + "snapshotName":{ + "shape":"String", + "documentation":"The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.
The name of the workgroup used to restore the snapshot.
" + } + } + }, + "RestoreFromSnapshotResponse":{ + "type":"structure", + "members":{ + "namespace":{"shape":"Namespace"}, + "ownerAccount":{ + "shape":"String", + "documentation":"The owner Amazon Web Services; account of the snapshot that was restored.
" + }, + "snapshotName":{ + "shape":"String", + "documentation":"The name of the snapshot used to restore the namespace.
" + } + } + }, + "RestoreTableFromRecoveryPointRequest":{ + "type":"structure", + "required":[ + "namespaceName", + "newTableName", + "recoveryPointId", + "sourceDatabaseName", + "sourceTableName", + "workgroupName" + ], + "members":{ + "activateCaseSensitiveIdentifier":{ + "shape":"Boolean", + "documentation":"Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.
" + }, + "namespaceName":{ + "shape":"String", + "documentation":"Namespace of the recovery point to restore from.
" + }, + "newTableName":{ + "shape":"String", + "documentation":"The name of the table to create from the restore operation.
" + }, + "recoveryPointId":{ + "shape":"String", + "documentation":"The ID of the recovery point to restore the table from.
" + }, + "sourceDatabaseName":{ + "shape":"String", + "documentation":"The name of the source database that contains the table being restored.
" + }, + "sourceSchemaName":{ + "shape":"String", + "documentation":"The name of the source schema that contains the table being restored.
" + }, + "sourceTableName":{ + "shape":"String", + "documentation":"The name of the source table being restored.
" + }, + "targetDatabaseName":{ + "shape":"String", + "documentation":"The name of the database to restore the table to.
" + }, + "targetSchemaName":{ + "shape":"String", + "documentation":"The name of the schema to restore the table to.
" + }, + "workgroupName":{ + "shape":"String", + "documentation":"The workgroup to restore the table to.
" + } + } + }, + "RestoreTableFromRecoveryPointResponse":{ + "type":"structure", + "members":{ + "tableRestoreStatus":{"shape":"TableRestoreStatus"} + } + }, + "RestoreTableFromSnapshotRequest":{ + "type":"structure", + "required":[ + "namespaceName", + "newTableName", + "snapshotName", + "sourceDatabaseName", + "sourceTableName", + "workgroupName" + ], + "members":{ + "activateCaseSensitiveIdentifier":{ + "shape":"Boolean", + "documentation":"Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.
" + }, + "namespaceName":{ + "shape":"String", + "documentation":"The namespace of the snapshot to restore from.
" + }, + "newTableName":{ + "shape":"String", + "documentation":"The name of the table to create from the restore operation.
" + }, + "snapshotName":{ + "shape":"String", + "documentation":"The name of the snapshot to restore the table from.
" + }, + "sourceDatabaseName":{ + "shape":"String", + "documentation":"The name of the source database that contains the table being restored.
" + }, + "sourceSchemaName":{ + "shape":"String", + "documentation":"The name of the source schema that contains the table being restored.
" + }, + "sourceTableName":{ + "shape":"String", + "documentation":"The name of the source table being restored.
" + }, + "targetDatabaseName":{ + "shape":"String", + "documentation":"The name of the database to restore the table to.
" + }, + "targetSchemaName":{ + "shape":"String", + "documentation":"The name of the schema to restore the table to.
" + }, + "workgroupName":{ + "shape":"String", + "documentation":"The workgroup to restore the table to.
" + } + } + }, + "RestoreTableFromSnapshotResponse":{ + "type":"structure", + "members":{ + "tableRestoreStatus":{ + "shape":"TableRestoreStatus", + "documentation":"The TableRestoreStatus object that contains the status of the restore operation.
" + } + } + }, + "Schedule":{ + "type":"structure", + "members":{ + "at":{ + "shape":"Timestamp", + "documentation":"The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
Format of cron expressions is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
The schedule of when Amazon Redshift Serverless should run the scheduled action.
", + "union":true + }, + "ScheduledActionAssociation":{ + "type":"structure", + "members":{ + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"Name of associated Amazon Redshift Serverless namespace.
" + }, + "scheduledActionName":{ + "shape":"ScheduledActionName", + "documentation":"Name of associated scheduled action.
" + } + }, + "documentation":"Contains names of objects associated with a scheduled action.
" + }, + "ScheduledActionName":{ + "type":"string", + "max":60, + "min":3, + "pattern":"^[a-z0-9-]+$" + }, + "ScheduledActionResponse":{ + "type":"structure", + "members":{ + "endTime":{ + "shape":"Timestamp", + "documentation":"The end time of
" + }, + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
" + }, + "nextInvocations":{ + "shape":"NextInvocationsList", + "documentation":"An array of timestamps of when the next scheduled actions will trigger.
" + }, + "roleArn":{ + "shape":"IamRoleArn", + "documentation":"The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide
" + }, + "schedule":{ + "shape":"Schedule", + "documentation":"The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
The description of the scheduled action.
" + }, + "scheduledActionName":{ + "shape":"ScheduledActionName", + "documentation":"The name of the scheduled action.
" + }, + "scheduledActionUuid":{ + "shape":"String", + "documentation":"The uuid of the scheduled action.
" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
" + }, + "state":{ + "shape":"State", + "documentation":"The state of the scheduled action.
" + }, + "targetAction":{"shape":"TargetAction"} + }, + "documentation":"The returned scheduled action object.
" + }, + "ScheduledActionsList":{ + "type":"list", + "member":{"shape":"ScheduledActionAssociation"} + }, + "SecurityGroupId":{"type":"string"}, + "SecurityGroupIdList":{ + "type":"list", + "member":{"shape":"SecurityGroupId"} + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The service limit was exceeded.
", + "exception":true + }, + "Snapshot":{ + "type":"structure", + "members":{ + "accountsWithProvisionedRestoreAccess":{ + "shape":"AccountIdList", + "documentation":"All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
" + }, + "accountsWithRestoreAccess":{ + "shape":"AccountIdList", + "documentation":"All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
" + }, + "actualIncrementalBackupSizeInMegaBytes":{ + "shape":"Double", + "documentation":"The size of the incremental backup in megabytes.
" + }, + "adminPasswordSecretArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
" + }, + "adminPasswordSecretKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
" + }, + "adminUsername":{ + "shape":"String", + "documentation":"The username of the database within a snapshot.
" + }, + "backupProgressInMegaBytes":{ + "shape":"Double", + "documentation":"The size in megabytes of the data that has been backed up to a snapshot.
" + }, + "currentBackupRateInMegaBytesPerSecond":{ + "shape":"Double", + "documentation":"The rate at which data is backed up into a snapshot in megabytes per second.
" + }, + "elapsedTimeInSeconds":{ + "shape":"Long", + "documentation":"The amount of time it took to back up data into a snapshot.
" + }, + "estimatedSecondsToCompletion":{ + "shape":"Long", + "documentation":"The estimated amount of seconds until the snapshot completes backup.
" + }, + "kmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"The unique identifier of the KMS key used to encrypt the snapshot.
" + }, + "namespaceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
" + }, + "namespaceName":{ + "shape":"String", + "documentation":"The name of the namepsace.
" + }, + "ownerAccount":{ + "shape":"String", + "documentation":"The owner Amazon Web Services; account of the snapshot.
" + }, + "snapshotArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the snapshot.
" + }, + "snapshotCreateTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The timestamp of when the snapshot was created.
" + }, + "snapshotName":{ + "shape":"String", + "documentation":"The name of the snapshot.
" + }, + "snapshotRemainingDays":{ + "shape":"Integer", + "documentation":"The amount of days until the snapshot is deleted.
" + }, + "snapshotRetentionPeriod":{ + "shape":"Integer", + "documentation":"The period of time, in days, of how long the snapshot is retained.
" + }, + "snapshotRetentionStartTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The timestamp of when data within the snapshot started getting retained.
" + }, + "status":{ + "shape":"SnapshotStatus", + "documentation":"The status of the snapshot.
" + }, + "totalBackupSizeInMegaBytes":{ + "shape":"Double", + "documentation":"The total size, in megabytes, of how big the snapshot is.
" + } + }, + "documentation":"A snapshot object that contains databases.
" + }, + "SnapshotCopyConfiguration":{ + "type":"structure", + "members":{ + "destinationKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
" + }, + "destinationRegion":{ + "shape":"String", + "documentation":"The destination Amazon Web Services Region to copy snapshots to.
" + }, + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"The name of the namespace to copy snapshots from in the source Amazon Web Services Region.
" + }, + "snapshotCopyConfigurationArn":{ + "shape":"String", + "documentation":"The ARN of the snapshot copy configuration object.
" + }, + "snapshotCopyConfigurationId":{ + "shape":"String", + "documentation":"The ID of the snapshot copy configuration object.
" + }, + "snapshotRetentionPeriod":{ + "shape":"Integer", + "documentation":"The retention period of snapshots that are copied to the destination Amazon Web Services Region.
" + } + }, + "documentation":"The object that you configure to copy snapshots from one namespace to a namespace in another Amazon Web Services Region.
" + }, + "SnapshotCopyConfigurations":{ + "type":"list", + "member":{"shape":"SnapshotCopyConfiguration"}, + "max":100, + "min":1 + }, + "SnapshotList":{ + "type":"list", + "member":{"shape":"Snapshot"} + }, + "SnapshotNamePrefix":{ + "type":"string", + "max":235, + "min":1 + }, + "SnapshotStatus":{ + "type":"string", + "enum":[ + "AVAILABLE", + "CREATING", + "DELETED", + "CANCELLED", + "FAILED", + "COPYING" + ] + }, + "State":{ + "type":"string", + "enum":[ + "ACTIVE", + "DISABLED" + ] + }, + "String":{"type":"string"}, + "SubnetId":{"type":"string"}, + "SubnetIdList":{ + "type":"list", + "member":{"shape":"SubnetId"} + }, + "SyntheticTimestamp_date_time":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "TableRestoreStatus":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"A message that explains the returned status. For example, if the status of the operation is FAILED, the message explains why the operation failed.
The namespace of the table being restored from.
" + }, + "newTableName":{ + "shape":"String", + "documentation":"The name of the table to create from the restore operation.
" + }, + "progressInMegaBytes":{ + "shape":"Long", + "documentation":"The amount of data restored to the new table so far, in megabytes (MB).
" + }, + "recoveryPointId":{ + "shape":"String", + "documentation":"The ID of the recovery point being restored from.
" + }, + "requestTime":{ + "shape":"Timestamp", + "documentation":"The time that the table restore request was made, in Universal Coordinated Time (UTC).
" + }, + "snapshotName":{ + "shape":"String", + "documentation":"The name of the snapshot being restored from.
" + }, + "sourceDatabaseName":{ + "shape":"String", + "documentation":"The name of the source database being restored from.
" + }, + "sourceSchemaName":{ + "shape":"String", + "documentation":"The name of the source schema being restored from.
" + }, + "sourceTableName":{ + "shape":"String", + "documentation":"The name of the source table being restored from.
" + }, + "status":{ + "shape":"String", + "documentation":"A value that describes the current state of the table restore request. Possible values are SUCCEEDED, FAILED, CANCELED, PENDING, and IN_PROGRESS.
The ID of the RestoreTableFromSnapshot request.
" + }, + "targetDatabaseName":{ + "shape":"String", + "documentation":"The name of the database to restore to.
" + }, + "targetSchemaName":{ + "shape":"String", + "documentation":"The name of the schema to restore to.
" + }, + "totalDataInMegaBytes":{ + "shape":"Long", + "documentation":"The total amount of data to restore to the new table, in megabytes (MB).
" + }, + "workgroupName":{ + "shape":"String", + "documentation":"The name of the workgroup being restored from.
" + } + }, + "documentation":"Contains information about a table restore request.
" + }, + "TableRestoreStatusList":{ + "type":"list", + "member":{"shape":"TableRestoreStatus"} + }, + "Tag":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"The key to use in the tag.
" + }, + "value":{ + "shape":"TagValue", + "documentation":"The value of the tag.
" + } + }, + "documentation":"A map of key-value pairs.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the resource to tag.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The map of the key-value pairs used to tag the resource.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TargetAction":{ + "type":"structure", + "members":{ + "createSnapshot":{"shape":"CreateSnapshotScheduleActionParameters"} + }, + "documentation":"A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.
\"{\"CreateSnapshot\": {\"NamespaceName\": \"sampleNamespace\",\"SnapshotName\": \"sampleSnapshot\", \"retentionPeriod\": \"1\"}}\"
The request was denied due to request throttling.
", + "exception":true, + "retryable":{"throttling":false} + }, + "Timestamp":{"type":"timestamp"}, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "resourceName":{ + "shape":"AmazonResourceName", + "documentation":"The name of the resource that exceeded the number of tags allowed for a resource.
" + } + }, + "documentation":"The request exceeded the number of tags allowed for a resource.
", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the resource to remove tags from.
" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"The tag or set of tags to remove from the resource.
" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateCustomDomainAssociationRequest":{ + "type":"structure", + "required":[ + "customDomainCertificateArn", + "customDomainName", + "workgroupName" + ], + "members":{ + "customDomainCertificateArn":{ + "shape":"CustomDomainCertificateArnString", + "documentation":"The custom domain name’s certificate Amazon resource name (ARN). This is optional.
" + }, + "customDomainName":{ + "shape":"CustomDomainName", + "documentation":"The custom domain name associated with the workgroup.
" + }, + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the workgroup associated with the database.
" + } + } + }, + "UpdateCustomDomainAssociationResponse":{ + "type":"structure", + "members":{ + "customDomainCertificateArn":{ + "shape":"CustomDomainCertificateArnString", + "documentation":"The custom domain name’s certificate Amazon resource name (ARN).
" + }, + "customDomainCertificateExpiryTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The expiration time for the certificate.
" + }, + "customDomainName":{ + "shape":"CustomDomainName", + "documentation":"The custom domain name associated with the workgroup.
" + }, + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the workgroup associated with the database.
" + } + } + }, + "UpdateEndpointAccessRequest":{ + "type":"structure", + "required":["endpointName"], + "members":{ + "endpointName":{ + "shape":"String", + "documentation":"The name of the VPC endpoint to update.
" + }, + "vpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"The list of VPC security groups associated with the endpoint after the endpoint is modified.
" + } + } + }, + "UpdateEndpointAccessResponse":{ + "type":"structure", + "members":{ + "endpoint":{ + "shape":"EndpointAccess", + "documentation":"The updated VPC endpoint.
" + } + } + }, + "UpdateNamespaceRequest":{ + "type":"structure", + "required":["namespaceName"], + "members":{ + "adminPasswordSecretKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"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.
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.
The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword.
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter must be updated together with iamRoles.
A list of IAM roles to associate with the namespace. This parameter must be updated together with defaultIamRoleArn.
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
" + }, + "logExports":{ + "shape":"LogExportList", + "documentation":"The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog.
If true, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.
The name of the namespace to update. You can't update the name of a namespace once it is created.
" + } + } + }, + "UpdateNamespaceResponse":{ + "type":"structure", + "required":["namespace"], + "members":{ + "namespace":{ + "shape":"Namespace", + "documentation":"A list of tag instances.
" + } + } + }, + "UpdateScheduledActionRequest":{ + "type":"structure", + "required":["scheduledActionName"], + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"Specifies whether to enable the scheduled action.
" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"The end time in UTC of the scheduled action to update.
" + }, + "roleArn":{ + "shape":"IamRoleArn", + "documentation":"The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide
" + }, + "schedule":{ + "shape":"Schedule", + "documentation":"The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
The descripion of the scheduled action to update to.
" + }, + "scheduledActionName":{ + "shape":"ScheduledActionName", + "documentation":"The name of the scheduled action to update to.
" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"The start time in UTC of the scheduled action to update to.
" + }, + "targetAction":{"shape":"TargetAction"} + } + }, + "UpdateScheduledActionResponse":{ + "type":"structure", + "members":{ + "scheduledAction":{ + "shape":"ScheduledActionResponse", + "documentation":"The ScheduledAction object that was updated.
" + } + } + }, + "UpdateSnapshotCopyConfigurationRequest":{ + "type":"structure", + "required":["snapshotCopyConfigurationId"], + "members":{ + "snapshotCopyConfigurationId":{ + "shape":"String", + "documentation":"The ID of the snapshot copy configuration to update.
" + }, + "snapshotRetentionPeriod":{ + "shape":"Integer", + "documentation":"The new retention period of how long to keep a snapshot in the destination Amazon Web Services Region.
" + } + } + }, + "UpdateSnapshotCopyConfigurationResponse":{ + "type":"structure", + "required":["snapshotCopyConfiguration"], + "members":{ + "snapshotCopyConfiguration":{ + "shape":"SnapshotCopyConfiguration", + "documentation":"The updated snapshot copy configuration object.
" + } + } + }, + "UpdateSnapshotRequest":{ + "type":"structure", + "required":["snapshotName"], + "members":{ + "retentionPeriod":{ + "shape":"Integer", + "documentation":"The new retention period of the snapshot.
" + }, + "snapshotName":{ + "shape":"String", + "documentation":"The name of the snapshot.
" + } + } + }, + "UpdateSnapshotResponse":{ + "type":"structure", + "members":{ + "snapshot":{ + "shape":"Snapshot", + "documentation":"The updated snapshot object.
" + } + } + }, + "UpdateUsageLimitRequest":{ + "type":"structure", + "required":["usageLimitId"], + "members":{ + "amount":{ + "shape":"Long", + "documentation":"The new limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.
" + }, + "breachAction":{ + "shape":"UsageLimitBreachAction", + "documentation":"The new action that Amazon Redshift Serverless takes when the limit is reached.
" + }, + "usageLimitId":{ + "shape":"String", + "documentation":"The identifier of the usage limit to update.
" + } + } + }, + "UpdateUsageLimitResponse":{ + "type":"structure", + "members":{ + "usageLimit":{ + "shape":"UsageLimit", + "documentation":"The updated usage limit object.
" + } + } + }, + "UpdateWorkgroupRequest":{ + "type":"structure", + "required":["workgroupName"], + "members":{ + "baseCapacity":{ + "shape":"Integer", + "documentation":"The new base data warehouse capacity in Redshift Processing Units (RPUs).
" + }, + "configParameters":{ + "shape":"ConfigParameterList", + "documentation":"An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
" + }, + "ipAddressType":{ + "shape":"IpAddressType", + "documentation":"The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
" + }, + "port":{ + "shape":"Integer", + "documentation":"The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
" + }, + "publiclyAccessible":{ + "shape":"Boolean", + "documentation":"A value that specifies whether the workgroup can be accessible from a public network.
" + }, + "securityGroupIds":{ + "shape":"SecurityGroupIdList", + "documentation":"An array of security group IDs to associate with the workgroup.
" + }, + "subnetIds":{ + "shape":"SubnetIdList", + "documentation":"An array of VPC subnet IDs to associate with the workgroup.
" + }, + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the workgroup to update. You can't update the name of a workgroup once it is created.
" + } + } + }, + "UpdateWorkgroupResponse":{ + "type":"structure", + "required":["workgroup"], + "members":{ + "workgroup":{ + "shape":"Workgroup", + "documentation":"The updated workgroup object.
" + } + } + }, + "UsageLimit":{ + "type":"structure", + "members":{ + "amount":{ + "shape":"Long", + "documentation":"The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.
" + }, + "breachAction":{ + "shape":"UsageLimitBreachAction", + "documentation":"The action that Amazon Redshift Serverless takes when the limit is reached.
" + }, + "period":{ + "shape":"UsageLimitPeriod", + "documentation":"The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
" + }, + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
" + }, + "usageLimitArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the resource associated with the usage limit.
" + }, + "usageLimitId":{ + "shape":"String", + "documentation":"The identifier of the usage limit.
" + }, + "usageType":{ + "shape":"UsageLimitUsageType", + "documentation":"The Amazon Redshift Serverless feature to limit.
" + } + }, + "documentation":"The usage limit object.
" + }, + "UsageLimitBreachAction":{ + "type":"string", + "enum":[ + "log", + "emit-metric", + "deactivate" + ] + }, + "UsageLimitPeriod":{ + "type":"string", + "enum":[ + "daily", + "weekly", + "monthly" + ] + }, + "UsageLimitUsageType":{ + "type":"string", + "enum":[ + "serverless-compute", + "cross-region-datasharing" + ] + }, + "UsageLimits":{ + "type":"list", + "member":{"shape":"UsageLimit"}, + "max":100, + "min":1 + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The input failed to satisfy the constraints specified by an AWS service.
", + "exception":true + }, + "VpcEndpoint":{ + "type":"structure", + "members":{ + "networkInterfaces":{ + "shape":"NetworkInterfaceList", + "documentation":"One or more network interfaces of the endpoint. Also known as an interface endpoint.
" + }, + "vpcEndpointId":{ + "shape":"String", + "documentation":"The connection endpoint ID for connecting to Amazon Redshift Serverless.
" + }, + "vpcId":{ + "shape":"String", + "documentation":"The VPC identifier that the endpoint is associated with.
" + } + }, + "documentation":"The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
" + }, + "VpcEndpointList":{ + "type":"list", + "member":{"shape":"VpcEndpoint"} + }, + "VpcIds":{ + "type":"list", + "member":{"shape":"String"} + }, + "VpcSecurityGroupId":{"type":"string"}, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{"shape":"VpcSecurityGroupId"} + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "status":{ + "shape":"String", + "documentation":"The status of the VPC security group.
" + }, + "vpcSecurityGroupId":{ + "shape":"VpcSecurityGroupId", + "documentation":"The unique identifier of the VPC security group.
" + } + }, + "documentation":"Describes the members of a VPC security group.
" + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{"shape":"VpcSecurityGroupMembership"} + }, + "Workgroup":{ + "type":"structure", + "members":{ + "baseCapacity":{ + "shape":"Integer", + "documentation":"The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
" + }, + "configParameters":{ + "shape":"ConfigParameterList", + "documentation":"An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
The creation date of the workgroup.
" + }, + "crossAccountVpcs":{ + "shape":"VpcIds", + "documentation":"A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.
" + }, + "customDomainCertificateArn":{ + "shape":"CustomDomainCertificateArnString", + "documentation":"The custom domain name’s certificate Amazon resource name (ARN).
" + }, + "customDomainCertificateExpiryTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The expiration time for the certificate.
" + }, + "customDomainName":{ + "shape":"CustomDomainName", + "documentation":"The custom domain name associated with the workgroup.
" + }, + "endpoint":{ + "shape":"Endpoint", + "documentation":"The endpoint that is created from the workgroup.
" + }, + "enhancedVpcRouting":{ + "shape":"Boolean", + "documentation":"The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
" + }, + "ipAddressType":{ + "shape":"IpAddressType", + "documentation":"The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
" + }, + "namespaceName":{ + "shape":"String", + "documentation":"The namespace the workgroup is associated with.
" + }, + "patchVersion":{ + "shape":"String", + "documentation":"The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.
" + }, + "port":{ + "shape":"Integer", + "documentation":"The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
" + }, + "publiclyAccessible":{ + "shape":"Boolean", + "documentation":"A value that specifies whether the workgroup can be accessible from a public network.
" + }, + "securityGroupIds":{ + "shape":"SecurityGroupIdList", + "documentation":"An array of security group IDs to associate with the workgroup.
" + }, + "status":{ + "shape":"WorkgroupStatus", + "documentation":"The status of the workgroup.
" + }, + "subnetIds":{ + "shape":"SubnetIdList", + "documentation":"An array of subnet IDs the workgroup is associated with.
" + }, + "workgroupArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) that links to the workgroup.
" + }, + "workgroupId":{ + "shape":"String", + "documentation":"The unique identifier of the workgroup.
" + }, + "workgroupName":{ + "shape":"WorkgroupName", + "documentation":"The name of the workgroup.
" + }, + "workgroupVersion":{ + "shape":"String", + "documentation":"The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.
" + } + }, + "documentation":"The collection of computing resources from which an endpoint is created.
" + }, + "WorkgroupList":{ + "type":"list", + "member":{"shape":"Workgroup"} + }, + "WorkgroupName":{ + "type":"string", + "max":64, + "min":3, + "pattern":"^[a-z0-9-]+$" + }, + "WorkgroupStatus":{ + "type":"string", + "enum":[ + "CREATING", + "AVAILABLE", + "MODIFYING", + "DELETING" + ] + } + }, + "documentation":"This is an interface reference for Amazon Redshift Serverless. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift Serverless.
Amazon Redshift Serverless automatically provisions data warehouse capacity and intelligently scales the underlying resources based on workload demands. Amazon Redshift Serverless adjusts capacity in seconds to deliver consistently high performance and simplified operations for even the most demanding and volatile workloads. Amazon Redshift Serverless lets you focus on using your data to acquire new insights for your business and customers.
To learn more about Amazon Redshift Serverless, see What is Amazon Redshift Serverless.
" +} diff --git a/testbed/boto__botocore/botocore/data/repostspace/2022-05-13/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/repostspace/2022-05-13/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..cd894866eb4881e2dd0800d70881c6c84289e896 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/repostspace/2022-05-13/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://repostspace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://repostspace-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://repostspace.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://repostspace.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/resource-explorer-2/2022-07-28/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/resource-explorer-2/2022-07-28/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..4d806fc8104b652e5829871477c2bf758f28b69f --- /dev/null +++ b/testbed/boto__botocore/botocore/data/resource-explorer-2/2022-07-28/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://resource-explorer-2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://resource-explorer-2-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://resource-explorer-2.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://resource-explorer-2.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/resource-explorer-2/2022-07-28/paginators-1.json b/testbed/boto__botocore/botocore/data/resource-explorer-2/2022-07-28/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..2acd787094a0946b7e4fba2d4744974bfdb0f71f --- /dev/null +++ b/testbed/boto__botocore/botocore/data/resource-explorer-2/2022-07-28/paginators-1.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "ListIndexes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Indexes" + }, + "ListSupportedResourceTypes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ResourceTypes" + }, + "ListViews": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Views" + }, + "Search": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Resources" + }, + "ListIndexesForMembers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Indexes" + }, + "ListResources": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Resources" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/resource-explorer-2/2022-07-28/paginators-1.sdk-extras.json b/testbed/boto__botocore/botocore/data/resource-explorer-2/2022-07-28/paginators-1.sdk-extras.json new file mode 100644 index 0000000000000000000000000000000000000000..92a00fe22cee05cf1705f03b5adf97838b98a90b --- /dev/null +++ b/testbed/boto__botocore/botocore/data/resource-explorer-2/2022-07-28/paginators-1.sdk-extras.json @@ -0,0 +1,18 @@ +{ + "version": 1.0, + "merge": { + "pagination": { + "Search": { + "non_aggregate_keys": [ + "ViewArn", + "Count" + ] + }, + "ListResources": { + "non_aggregate_keys": [ + "ViewArn" + ] + } + } + } +} diff --git a/testbed/boto__botocore/botocore/data/resource-explorer-2/2022-07-28/service-2.json b/testbed/boto__botocore/botocore/data/resource-explorer-2/2022-07-28/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..f8625af30e1e3bf8d4b786c30fa8ac3a28c31318 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/resource-explorer-2/2022-07-28/service-2.json @@ -0,0 +1,1583 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-07-28", + "endpointPrefix":"resource-explorer-2", + "jsonVersion":"1.1", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"AWS Resource Explorer", + "serviceId":"Resource Explorer 2", + "signatureVersion":"v4", + "signingName":"resource-explorer-2", + "uid":"resource-explorer-2-2022-07-28", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "AssociateDefaultView":{ + "name":"AssociateDefaultView", + "http":{ + "method":"POST", + "requestUri":"/AssociateDefaultView", + "responseCode":200 + }, + "input":{"shape":"AssociateDefaultViewInput"}, + "output":{"shape":"AssociateDefaultViewOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Sets the specified view as the default for the Amazon Web Services Region in which you call this operation. When a user performs a Search that doesn't explicitly specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for searches performed in this Amazon Web Services Region.
If an Amazon Web Services Region doesn't have a default view configured, then users must explicitly specify a view with every Search operation performed in that Region.
Retrieves details about a list of views.
" + }, + "CreateIndex":{ + "name":"CreateIndex", + "http":{ + "method":"POST", + "requestUri":"/CreateIndex", + "responseCode":200 + }, + "input":{"shape":"CreateIndexInput"}, + "output":{"shape":"CreateIndexOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.
This operation creates only a local index. To promote the local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.
For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see Turn on Resource Explorer to index your resources in an Amazon Web Services Region in the Amazon Web Services Resource Explorer User Guide.
If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then this operation also creates a service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate your resources to populate the index.
Action: resource-explorer-2:CreateIndex
Resource: The ARN of the index (as it will exist after the operation completes) in the Amazon Web Services Region and account in which you're trying to create the index. Use the wildcard character (*) at the end of the string to match the eventual UUID. For example, the following Resource element restricts the role or user to creating an index in only the us-east-2 Region of the specified account.
\"Resource\": \"arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*\"
Alternatively, you can use \"Resource\": \"*\" to allow the role or user to create an index in any Region.
Action: iam:CreateServiceLinkedRole
Resource: No specific resource (*).
This permission is required only the first time you create an index to turn on Resource Explorer in the account. Resource Explorer uses this to create the service-linked role needed to index the resources in your account. Resource Explorer uses the same service-linked role for all additional indexes you create afterwards.
Creates a view that users can query by using the Search operation. Results from queries that you make using this view include only resources that match the view's Filters. For more information about Amazon Web Services Resource Explorer views, see Managing views in the Amazon Web Services Resource Explorer User Guide.
Only the principals with an IAM identity-based policy that grants Allow to the Search action on a Resource with the Amazon resource name (ARN) of this view can Search using views you create with this operation.
Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region. When you delete an index, Resource Explorer stops discovering and indexing resources in that Region. Resource Explorer also deletes all views in that Region. These actions occur as asynchronous background tasks. You can check to see when the actions are complete by using the GetIndex operation and checking the Status response value.
If the index you delete is the aggregator index for the Amazon Web Services account, you must wait 24 hours before you can promote another local index to be the aggregator index for the account. Users can't perform account-wide searches using Resource Explorer until another aggregator index is configured.
Deletes the specified view.
If the specified view is the default view for its Amazon Web Services Region, then all Search operations in that Region must explicitly specify the view to use until you configure a new default by calling the AssociateDefaultView operation.
", + "idempotent":true + }, + "DisassociateDefaultView":{ + "name":"DisassociateDefaultView", + "http":{ + "method":"POST", + "requestUri":"/DisassociateDefaultView", + "responseCode":200 + }, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"After you call this operation, the affected Amazon Web Services Region no longer has a default view. All Search operations in that Region must explicitly specify a view or the operation fails. You can configure a new default by calling the AssociateDefaultView operation.
If an Amazon Web Services Region doesn't have a default view configured, then users must explicitly specify a view with every Search operation performed in that Region.
Retrieves the status of your account's Amazon Web Services service access, and validates the service linked role required to access the multi-account search feature. Only the management account can invoke this API call.
" + }, + "GetDefaultView":{ + "name":"GetDefaultView", + "http":{ + "method":"POST", + "requestUri":"/GetDefaultView", + "responseCode":200 + }, + "output":{"shape":"GetDefaultViewOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves the Amazon Resource Name (ARN) of the view that is the default for the Amazon Web Services Region in which you call this operation. You can then call GetView to retrieve the details of that view.
" + }, + "GetIndex":{ + "name":"GetIndex", + "http":{ + "method":"POST", + "requestUri":"/GetIndex", + "responseCode":200 + }, + "output":{"shape":"GetIndexOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.
" + }, + "GetView":{ + "name":"GetView", + "http":{ + "method":"POST", + "requestUri":"/GetView", + "responseCode":200 + }, + "input":{"shape":"GetViewInput"}, + "output":{"shape":"GetViewOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves details of the specified view.
" + }, + "ListIndexes":{ + "name":"ListIndexes", + "http":{ + "method":"POST", + "requestUri":"/ListIndexes", + "responseCode":200 + }, + "input":{"shape":"ListIndexesInput"}, + "output":{"shape":"ListIndexesOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.
" + }, + "ListIndexesForMembers":{ + "name":"ListIndexesForMembers", + "http":{ + "method":"POST", + "requestUri":"/ListIndexesForMembers", + "responseCode":200 + }, + "input":{"shape":"ListIndexesForMembersInput"}, + "output":{"shape":"ListIndexesForMembersOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of a member's indexes in all Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer. Only the management account or a delegated administrator with service access enabled can invoke this API call.
" + }, + "ListResources":{ + "name":"ListResources", + "http":{ + "method":"POST", + "requestUri":"/ListResources", + "responseCode":200 + }, + "input":{"shape":"ListResourcesInput"}, + "output":{"shape":"ListResourcesOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a list of resources and their details that match the specified criteria. This query must use a view. If you don’t explicitly specify a view, then Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation.
" + }, + "ListSupportedResourceTypes":{ + "name":"ListSupportedResourceTypes", + "http":{ + "method":"POST", + "requestUri":"/ListSupportedResourceTypes", + "responseCode":200 + }, + "input":{"shape":"ListSupportedResourceTypesInput"}, + "output":{"shape":"ListSupportedResourceTypesOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists the tags that are attached to the specified resource.
" + }, + "ListViews":{ + "name":"ListViews", + "http":{ + "method":"POST", + "requestUri":"/ListViews", + "responseCode":200 + }, + "input":{"shape":"ListViewsInput"}, + "output":{"shape":"ListViewsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you call this operation.
Always check the NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
Searches for resources and displays details about all resources that match the specified criteria. You must specify a query string.
All search queries must use a view. If you don't explicitly specify a view, then Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation. The results are the logical intersection of the results that match both the QueryString parameter supplied to this operation and the SearchFilter parameter attached to the view.
For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.
If your search results are empty, or are missing results that you think should be there, see Troubleshooting Resource Explorer search.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.
", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.
" + }, + "UpdateIndexType":{ + "name":"UpdateIndexType", + "http":{ + "method":"POST", + "requestUri":"/UpdateIndexType", + "responseCode":200 + }, + "input":{"shape":"UpdateIndexTypeInput"}, + "output":{"shape":"UpdateIndexTypeOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Changes the type of the index from one of the following types to the other. For more information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.
AGGREGATOR index type
The index contains information about resources from all Amazon Web Services Regions in the Amazon Web Services account in which you've created a Resource Explorer index. Resource information from all other Regions is replicated to this Region's index.
When you change the index type to AGGREGATOR, Resource Explorer turns on replication of all discovered resource information from the other Amazon Web Services Regions in your account to this index. You can then, from this Region only, perform resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account. Turning on replication from all other Regions is performed by asynchronous background tasks. You can check the status of the asynchronous tasks by using the GetIndex operation. When the asynchronous tasks complete, the Status response of that operation changes from UPDATING to ACTIVE. After that, you can start to see results from other Amazon Web Services Regions in query results. However, it can take several hours for replication from all other Regions to complete.
You can have only one aggregator index per Amazon Web Services account. Before you can promote a different index to be the aggregator index for the account, you must first demote the existing aggregator index to type LOCAL.
LOCAL index type
The index contains information about resources in only the Amazon Web Services Region in which the index exists. If an aggregator index in another Region exists, then information in this local index is replicated to the aggregator index.
When you change the index type to LOCAL, Resource Explorer turns off the replication of resource information from all other Amazon Web Services Regions in the Amazon Web Services account to this Region. The aggregator index remains in the UPDATING state until all replication with other Regions successfully stops. You can check the status of the asynchronous task by using the GetIndex operation. When Resource Explorer successfully stops all replication with other Regions, the Status response of that operation changes from UPDATING to ACTIVE. Separately, the resource information from other Regions that was previously stored in the index is deleted within 30 days by another background task. Until that asynchronous task completes, some results from other Regions can continue to appear in search results.
After you demote an aggregator index to a local index, you must wait 24 hours before you can promote another index to be the new aggregator index for the account.
Modifies some of the details of a view. You can change the filter string and the list of included properties. You can't change the name of the view.
" + } + }, + "shapes":{ + "AWSServiceAccessStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The credentials that you used to call this operation don't have the minimum required permissions.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccountId":{ + "type":"string", + "max":2048, + "min":1 + }, + "AssociateDefaultViewInput":{ + "type":"structure", + "required":["ViewArn"], + "members":{ + "ViewArn":{ + "shape":"AssociateDefaultViewInputViewArnString", + "documentation":"The Amazon resource name (ARN) of the view to set as the default for the Amazon Web Services Region and Amazon Web Services account in which you call this operation. The specified view must already exist in the called Region.
" + } + } + }, + "AssociateDefaultViewInputViewArnString":{ + "type":"string", + "max":1011, + "min":1 + }, + "AssociateDefaultViewOutput":{ + "type":"structure", + "members":{ + "ViewArn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the view that the operation set as the default for queries made in the Amazon Web Services Region and Amazon Web Services account in which you called this operation.
" + } + } + }, + "BatchGetViewError":{ + "type":"structure", + "required":[ + "ErrorMessage", + "ViewArn" + ], + "members":{ + "ErrorMessage":{ + "shape":"String", + "documentation":"The description of the error for the specified view.
" + }, + "ViewArn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the view for which Resource Explorer failed to retrieve details.
" + } + }, + "documentation":"A collection of error messages for any views that Amazon Web Services Resource Explorer couldn't retrieve details.
" + }, + "BatchGetViewErrors":{ + "type":"list", + "member":{"shape":"BatchGetViewError"} + }, + "BatchGetViewInput":{ + "type":"structure", + "members":{ + "ViewArns":{ + "shape":"BatchGetViewInputViewArnsList", + "documentation":"A list of Amazon resource names (ARNs) that identify the views you want details for.
" + } + } + }, + "BatchGetViewInputViewArnsList":{ + "type":"list", + "member":{"shape":"String"}, + "max":20, + "min":1 + }, + "BatchGetViewOutput":{ + "type":"structure", + "members":{ + "Errors":{ + "shape":"BatchGetViewErrors", + "documentation":"If any of the specified ARNs result in an error, then this structure describes the error.
" + }, + "Views":{ + "shape":"ViewList", + "documentation":"A structure with a list of objects with details for each of the specified views.
" + } + } + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ConflictException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"If you attempted to create a view, then the request failed because either you specified parameters that didn’t match the original request, or you attempted to create a view with a name that already exists in this Amazon Web Services Region.
If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.
If you attempted to update an index type to AGGREGATOR, then the request failed because you already have an AGGREGATOR index in a different Amazon Web Services Region.
This value helps ensure idempotency. Resource Explorer uses this value to prevent the accidental creation of duplicate versions. We recommend that you generate a UUID-type value to ensure the uniqueness of your index.
", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The specified tags are attached only to the index created in this Amazon Web Services Region. The tags aren't attached to any of the resources listed in the index.
" + } + } + }, + "CreateIndexOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The ARN of the new local index for the Region. You can reference this ARN in IAM permission policies to authorize the following operations: DeleteIndex | GetIndex | UpdateIndexType | CreateView
" + }, + "CreatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and timestamp when the index was created.
" + }, + "State":{ + "shape":"IndexState", + "documentation":"Indicates the current state of the index. You can check for changes to the state for asynchronous operations by calling the GetIndex operation.
The state can remain in the CREATING or UPDATING state for several hours as Resource Explorer discovers the information about your resources and populates the index.
This value helps ensure idempotency. Resource Explorer uses this value to prevent the accidental creation of duplicate versions. We recommend that you generate a UUID-type value to ensure the uniqueness of your views.
", + "idempotencyToken":true + }, + "Filters":{ + "shape":"SearchFilter", + "documentation":"An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a Search operation, the filter string is combined with the search's QueryString parameter using a logical AND operator.
For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the letters us and is not tagged with a key Stage that has the value prod.
Specifies optional fields that you want included in search results from this view. It is a list of objects that each describe a field to include.
The default is an empty list, with no optional fields included in the results.
" + }, + "Scope":{ + "shape":"CreateViewInputScopeString", + "documentation":"The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"Tag key and value pairs that are attached to the view.
" + }, + "ViewName":{ + "shape":"ViewName", + "documentation":"The name of the new view. This name appears in the list of views in Resource Explorer.
The name must be no more than 64 characters long, and can include letters, digits, and the dash (-) character. The name must be unique within its Amazon Web Services Region.
" + } + } + }, + "CreateViewInputClientTokenString":{ + "type":"string", + "max":2048, + "min":1 + }, + "CreateViewInputScopeString":{ + "type":"string", + "max":2048, + "min":1 + }, + "CreateViewOutput":{ + "type":"structure", + "members":{ + "View":{ + "shape":"View", + "documentation":"A structure that contains the details about the new view.
" + } + } + }, + "DeleteIndexInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the index that you want to delete.
" + } + } + }, + "DeleteIndexOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the index that you successfully started the deletion process.
This operation is asynchronous. To check its status, call the GetIndex operation.
The date and time when you last updated this index.
" + }, + "State":{ + "shape":"IndexState", + "documentation":"Indicates the current state of the index.
" + } + } + }, + "DeleteViewInput":{ + "type":"structure", + "required":["ViewArn"], + "members":{ + "ViewArn":{ + "shape":"DeleteViewInputViewArnString", + "documentation":"The Amazon resource name (ARN) of the view that you want to delete.
" + } + } + }, + "DeleteViewInputViewArnString":{ + "type":"string", + "max":1011, + "min":1 + }, + "DeleteViewOutput":{ + "type":"structure", + "members":{ + "ViewArn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the view that you successfully deleted.
" + } + } + }, + "Document":{ + "type":"structure", + "members":{ + }, + "document":true + }, + "GetAccountLevelServiceConfigurationOutput":{ + "type":"structure", + "members":{ + "OrgConfiguration":{ + "shape":"OrgConfiguration", + "documentation":"Details about the organization, and whether configuration is ENABLED or DISABLED.
The Amazon resource name (ARN) of the view that is the current default for the Amazon Web Services Region in which you called this operation.
" + } + } + }, + "GetIndexOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the index.
" + }, + "CreatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time when the index was originally created.
" + }, + "LastUpdatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time when the index was last updated.
" + }, + "ReplicatingFrom":{ + "shape":"RegionList", + "documentation":"This response value is present only if this index is Type=AGGREGATOR.
A list of the Amazon Web Services Regions that replicate their content to the index in this Region.
" + }, + "ReplicatingTo":{ + "shape":"RegionList", + "documentation":"This response value is present only if this index is Type=LOCAL.
The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.
" + }, + "State":{ + "shape":"IndexState", + "documentation":"The current state of the index in this Amazon Web Services Region.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"Tag key and value pairs that are attached to the index.
" + }, + "Type":{ + "shape":"IndexType", + "documentation":"The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.
" + } + } + }, + "GetViewInput":{ + "type":"structure", + "required":["ViewArn"], + "members":{ + "ViewArn":{ + "shape":"GetViewInputViewArnString", + "documentation":"The Amazon resource name (ARN) of the view that you want information about.
" + } + } + }, + "GetViewInputViewArnString":{ + "type":"string", + "max":1011, + "min":1 + }, + "GetViewOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"Tag key and value pairs that are attached to the view.
" + }, + "View":{ + "shape":"View", + "documentation":"A structure that contains the details for the requested view.
" + } + } + }, + "IncludedProperty":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"IncludedPropertyNameString", + "documentation":"The name of the property that is included in this view.
You can specify the following property names for this field:
Tags
Information about an additional property that describes a resource, that you can optionally include in the view. This lets you view that property in search results, and filter your search results based on the value of the property.
" + }, + "IncludedPropertyList":{ + "type":"list", + "member":{"shape":"IncludedProperty"} + }, + "IncludedPropertyNameString":{ + "type":"string", + "max":1011, + "min":1 + }, + "Index":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the index.
" + }, + "Region":{ + "shape":"String", + "documentation":"The Amazon Web Services Region in which the index exists.
" + }, + "Type":{ + "shape":"IndexType", + "documentation":"The type of index. It can be one of the following values:
LOCAL – The index contains information about resources from only the same Amazon Web Services Region.
AGGREGATOR – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.
An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers. Creating an index in an Amazon Web Services Region turns on Resource Explorer and lets it discover your resources.
By default, an index is local, meaning that it contains information about resources in only the same Region as the index. However, you can promote the index of one Region in the account by calling UpdateIndexType to convert it into an aggregator index. The aggregator index receives a replicated copy of the index information from all other Regions where Resource Explorer is turned on. This allows search operations in that Region to return results from all Regions in the account.
" + }, + "IndexList":{ + "type":"list", + "member":{"shape":"Index"} + }, + "IndexState":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING", + "DELETED", + "UPDATING" + ] + }, + "IndexType":{ + "type":"string", + "enum":[ + "LOCAL", + "AGGREGATOR" + ] + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request failed because of internal service error. Try your request again later.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "ListIndexesForMembersInput":{ + "type":"structure", + "required":["AccountIdList"], + "members":{ + "AccountIdList":{ + "shape":"ListIndexesForMembersInputAccountIdListList", + "documentation":"The account IDs will limit the output to only indexes from these accounts.
" + }, + "MaxResults":{ + "shape":"ListIndexesForMembersInputMaxResultsInteger", + "documentation":"The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.
An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.
A structure that contains the details and status of each index.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. The pagination tokens expire after 24 hours.
The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.
An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.
If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.
" + }, + "Type":{ + "shape":"IndexType", + "documentation":"If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.
Use this option to discover the aggregator index for your account.
" + } + } + }, + "ListIndexesInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListIndexesInputNextTokenString":{ + "type":"string", + "max":2048, + "min":1 + }, + "ListIndexesInputRegionsList":{ + "type":"list", + "member":{"shape":"String"}, + "max":20, + "min":0 + }, + "ListIndexesOutput":{ + "type":"structure", + "members":{ + "Indexes":{ + "shape":"IndexList", + "documentation":"A structure that contains the details and status of each index.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. The pagination tokens expire after 24 hours.
The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.
An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.
Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a 401 Unauthorized exception.
" + } + } + }, + "ListResourcesInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "ListResourcesInputNextTokenString":{ + "type":"string", + "max":2048, + "min":1 + }, + "ListResourcesInputViewArnString":{ + "type":"string", + "max":1000, + "min":0 + }, + "ListResourcesOutput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"ListResourcesOutputNextTokenString", + "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. The pagination tokens expire after 24 hours.
The list of structures that describe the resources that match the query.
" + }, + "ViewArn":{ + "shape":"ListResourcesOutputViewArnString", + "documentation":"The Amazon resource name (ARN) of the view that this operation used to perform the search.
" + } + } + }, + "ListResourcesOutputNextTokenString":{ + "type":"string", + "max":2048, + "min":1 + }, + "ListResourcesOutputViewArnString":{ + "type":"string", + "max":1011, + "min":1 + }, + "ListSupportedResourceTypesInput":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListSupportedResourceTypesInputMaxResultsInteger", + "documentation":"The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.
An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. The pagination tokens expire after 24 hours.
The list of resource types supported by Resource Explorer.
" + } + } + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the view or index that you want to attach tags to.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"The tag key and value pairs that you want to attach to the specified view or index.
" + } + } + }, + "ListViewsInput":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListViewsInputMaxResultsInteger", + "documentation":"The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.
An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. The pagination tokens expire after 24 hours.
The list of views available in the Amazon Web Services Region in which you called this operation.
" + } + } + }, + "Long":{ + "type":"long", + "box":true + }, + "MemberIndex":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"String", + "documentation":"The account ID for the index.
" + }, + "Arn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the index.
" + }, + "Region":{ + "shape":"String", + "documentation":"The Amazon Web Services Region in which the index exists.
" + }, + "Type":{ + "shape":"IndexType", + "documentation":"The type of index. It can be one of the following values:
LOCAL – The index contains information about resources from only the same Amazon Web Services Region.
AGGREGATOR – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.
An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers.
" + }, + "MemberIndexList":{ + "type":"list", + "member":{"shape":"MemberIndex"} + }, + "OrgConfiguration":{ + "type":"structure", + "required":["AWSServiceAccessStatus"], + "members":{ + "AWSServiceAccessStatus":{ + "shape":"AWSServiceAccessStatus", + "documentation":"This value displays whether your Amazon Web Services service access is ENABLED or DISABLED.
This value shows whether or not you have a valid a service-linked role required to start the multi-account search feature.
" + } + }, + "documentation":"This is a structure that contains the status of Amazon Web Services service access, and whether you have a valid service-linked role to enable multi-account search for your organization.
" + }, + "QueryString":{ + "type":"string", + "max":1280, + "min":0, + "sensitive":true + }, + "RegionList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Resource":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the resource.
" + }, + "LastReportedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time that Resource Explorer last queried this resource and updated the index with the latest information about the resource.
" + }, + "OwningAccountId":{ + "shape":"String", + "documentation":"The Amazon Web Services account that owns the resource.
" + }, + "Properties":{ + "shape":"ResourcePropertyList", + "documentation":"A structure with additional type-specific details about the resource. These properties can be added by turning on integration between Resource Explorer and other Amazon Web Services services.
" + }, + "Region":{ + "shape":"String", + "documentation":"The Amazon Web Services Region in which the resource was created and exists.
" + }, + "ResourceType":{ + "shape":"String", + "documentation":"The type of the resource.
" + }, + "Service":{ + "shape":"String", + "documentation":"The Amazon Web Servicesservice that owns the resource and is responsible for creating and updating it.
" + } + }, + "documentation":"A resource in Amazon Web Services that Amazon Web Services Resource Explorer has discovered, and for which it has stored information in the index of the Amazon Web Services Region that contains the resource.
" + }, + "ResourceCount":{ + "type":"structure", + "members":{ + "Complete":{ + "shape":"Boolean", + "documentation":"Indicates whether the TotalResources value represents an exhaustive count of search results.
If True, it indicates that the search was exhaustive. Every resource that matches the query was counted.
If False, then the search reached the limit of 1,000 matching results, and stopped counting.
The number of resources that match the search query. This value can't exceed 1,000. If there are more than 1,000 resources that match the query, then only 1,000 are counted and the Complete field is set to false. We recommend that you refine your query to return a smaller number of results.
Information about the number of results that match the query. At this time, Amazon Web Services Resource Explorer doesn't count more than 1,000 matches for any query. This structure provides information about whether the query exceeded this limit.
This field is included in every page when you paginate the results.
" + }, + "ResourceList":{ + "type":"list", + "member":{"shape":"Resource"} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceProperty":{ + "type":"structure", + "members":{ + "Data":{ + "shape":"Document", + "documentation":"Details about this property. The content of this field is a JSON object that varies based on the resource type.
" + }, + "LastReportedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time that the information about this resource property was last updated.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of this property of the resource.
" + } + }, + "documentation":"A structure that describes a property of a resource.
" + }, + "ResourcePropertyList":{ + "type":"list", + "member":{"shape":"ResourceProperty"} + }, + "ResourceTypeList":{ + "type":"list", + "member":{"shape":"SupportedResourceType"} + }, + "SearchFilter":{ + "type":"structure", + "required":["FilterString"], + "members":{ + "FilterString":{ + "shape":"SearchFilterFilterStringString", + "documentation":"The string that contains the search keywords, prefixes, and operators to control the results that can be returned by a Search operation. For more details, see Search query syntax.
" + } + }, + "documentation":"A search filter defines which resources can be part of a search query result set.
", + "sensitive":true + }, + "SearchFilterFilterStringString":{ + "type":"string", + "max":2048, + "min":0 + }, + "SearchInput":{ + "type":"structure", + "required":["QueryString"], + "members":{ + "MaxResults":{ + "shape":"SearchInputMaxResultsInteger", + "documentation":"The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.
An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.
A string that includes keywords and filters that specify the resources that you want to include in the results.
For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.
The search is completely case insensitive. You can specify an empty string to return all results up to the limit of 1,000 total results.
The operation can return only the first 1,000 results. If the resource you want is not included, then use a different value for QueryString to refine the results.
Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a 401 Unauthorized exception.
The number of resources that match the query.
" + }, + "NextToken":{ + "shape":"SearchOutputNextTokenString", + "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. The pagination tokens expire after 24 hours.
The list of structures that describe the resources that match the query.
" + }, + "ViewArn":{ + "shape":"SearchOutputViewArnString", + "documentation":"The Amazon resource name (ARN) of the view that this operation used to perform the search.
" + } + } + }, + "SearchOutputNextTokenString":{ + "type":"string", + "max":2048, + "min":1 + }, + "SearchOutputViewArnString":{ + "type":"string", + "max":1011, + "min":1 + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "Message", + "Name", + "Value" + ], + "members":{ + "Message":{"shape":"String"}, + "Name":{ + "shape":"String", + "documentation":"The name of the service quota that was exceeded by the request.
" + }, + "Value":{ + "shape":"String", + "documentation":"The current value for the quota that the request tried to exceed.
" + } + }, + "documentation":"The request failed because it exceeds a service quota.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"}, + "sensitive":true + }, + "SupportedResourceType":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"String", + "documentation":"The unique identifier of the resource type.
" + }, + "Service":{ + "shape":"String", + "documentation":"The Amazon Web Servicesservice that is associated with the resource type. This is the primary service that lets you create and interact with resources of this type.
" + } + }, + "documentation":"A structure that describes a resource type supported by Amazon Web Services Resource Explorer.
" + }, + "SyntheticTimestamp_date_time":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "TagMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"}, + "sensitive":true + }, + "TagResourceInput":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"A list of tag key and value pairs that you want to attach to the specified view or index.
" + }, + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the view or index that you want to attach tags to.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The principal making the request isn't permitted to perform the operation.
", + "error":{ + "httpStatusCode":401, + "senderFault":true + }, + "exception":true + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the view or index that you want to remove tags from.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"StringList", + "documentation":"A list of the keys for the tags that you want to remove from the specified view or index.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateIndexTypeInput":{ + "type":"structure", + "required":[ + "Arn", + "Type" + ], + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the index that you want to update.
" + }, + "Type":{ + "shape":"IndexType", + "documentation":"The type of the index. To understand the difference between LOCAL and AGGREGATOR, see Turning on cross-Region search in the Amazon Web Services Resource Explorer User Guide.
The Amazon resource name (ARN) of the index that you updated.
" + }, + "LastUpdatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and timestamp when the index was last updated.
" + }, + "State":{ + "shape":"IndexState", + "documentation":"Indicates the state of the request to update the index. This operation is asynchronous. Call the GetIndex operation to check for changes.
" + }, + "Type":{ + "shape":"IndexType", + "documentation":"Specifies the type of the specified index after the operation completes.
" + } + } + }, + "UpdateViewInput":{ + "type":"structure", + "required":["ViewArn"], + "members":{ + "Filters":{ + "shape":"SearchFilter", + "documentation":"An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a Search operation, the filter string is combined with the search's QueryString parameter using a logical AND operator.
For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the letters us and is not tagged with a key Stage that has the value prod.
Specifies optional fields that you want included in search results from this view. It is a list of objects that each describe a field to include.
The default is an empty list, with no optional fields included in the results.
" + }, + "ViewArn":{ + "shape":"UpdateViewInputViewArnString", + "documentation":"The Amazon resource name (ARN) of the view that you want to modify.
" + } + } + }, + "UpdateViewInputViewArnString":{ + "type":"string", + "max":1011, + "min":1 + }, + "UpdateViewOutput":{ + "type":"structure", + "members":{ + "View":{ + "shape":"View", + "documentation":"Details about the view that you changed with this operation.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "required":["Message"], + "members":{ + "FieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"An array of the request fields that had validation errors.
" + }, + "Message":{"shape":"String"} + }, + "documentation":"You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "Name", + "ValidationIssue" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the request field that had a validation error.
" + }, + "ValidationIssue":{ + "shape":"String", + "documentation":"The validation error caused by the request field.
" + } + }, + "documentation":"A structure that describes a request field with a validation error.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "View":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"SearchFilter", + "documentation":"An array of SearchFilter objects that specify which resources can be included in the results of queries made using this view.
" + }, + "IncludedProperties":{ + "shape":"IncludedPropertyList", + "documentation":"A structure that contains additional information about the view.
" + }, + "LastUpdatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time when this view was last modified.
" + }, + "Owner":{ + "shape":"String", + "documentation":"The Amazon Web Services account that owns this view.
" + }, + "Scope":{ + "shape":"String", + "documentation":"An Amazon resource name (ARN) of an Amazon Web Services account, an organization, or an organizational unit (OU) that specifies whether this view includes resources from only the specified Amazon Web Services account, all accounts in the specified organization, or all accounts in the specified OU.
If not specified, the value defaults to the Amazon Web Services account used to call this operation.
" + }, + "ViewArn":{ + "shape":"String", + "documentation":"The Amazon resource name (ARN) of the view.
" + } + }, + "documentation":"A view is a structure that defines a set of filters that provide a view into the information in the Amazon Web Services Resource Explorer index. The filters specify which information from the index is visible to the users of the view. For example, you can specify filters that include only resources that are tagged with the key \"ENV\" and the value \"DEVELOPMENT\" in the results returned by this view. You could also create a second view that includes only resources that are tagged with \"ENV\" and \"PRODUCTION\".
" + }, + "ViewArnList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ViewList":{ + "type":"list", + "member":{"shape":"View"} + }, + "ViewName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9\\-]{1,64}$" + } + }, + "documentation":"Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can explore your resources using an internet search engine-like experience. Examples of resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB tables. You can search for your resources using resource metadata like names, tags, and IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn the service on, to simplify your cross-Region workloads.
Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which you turn on Resource Explorer. Resource Explorer creates and maintains an index in each Region, with the details of that Region's resources.
You can search across all of the indexed Regions in your account by designating one of your Amazon Web Services Regions to contain the aggregator index for the account. When you promote a local index in a Region to become the aggregator index for the account, Resource Explorer automatically replicates the index information from all local indexes in the other Regions to the aggregator index. Therefore, the Region with the aggregator index has a copy of all resource information for all Regions in the account where you turned on Resource Explorer. As a result, views in the aggregator index Region include resources from all of the indexed Regions in your account.
For more information about Amazon Web Services Resource Explorer, including how to enable and configure the service, see the Amazon Web Services Resource Explorer User Guide.
" +} diff --git a/testbed/boto__botocore/botocore/data/rolesanywhere/2018-05-10/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/rolesanywhere/2018-05-10/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..8f0a912dd046729d1da08b56568f31afc266694b --- /dev/null +++ b/testbed/boto__botocore/botocore/data/rolesanywhere/2018-05-10/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://rolesanywhere-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://rolesanywhere-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://rolesanywhere.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://rolesanywhere.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/rolesanywhere/2018-05-10/paginators-1.json b/testbed/boto__botocore/botocore/data/rolesanywhere/2018-05-10/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..97298614bfac6f97143af195d8c54a5734498695 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/rolesanywhere/2018-05-10/paginators-1.json @@ -0,0 +1,24 @@ +{ + "pagination": { + "ListCrls": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "crls" + }, + "ListProfiles": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "profiles" + }, + "ListSubjects": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "subjects" + }, + "ListTrustAnchors": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "trustAnchors" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/rolesanywhere/2018-05-10/service-2.json b/testbed/boto__botocore/botocore/data/rolesanywhere/2018-05-10/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..0e2891a73e0f4d86ad22cd140a43e650f37aa460 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/rolesanywhere/2018-05-10/service-2.json @@ -0,0 +1,1710 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-05-10", + "endpointPrefix":"rolesanywhere", + "jsonVersion":"1.1", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"IAM Roles Anywhere", + "serviceId":"RolesAnywhere", + "signatureVersion":"v4", + "signingName":"rolesanywhere", + "uid":"rolesanywhere-2018-05-10", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "CreateProfile":{ + "name":"CreateProfile", + "http":{ + "method":"POST", + "requestUri":"/profiles", + "responseCode":201 + }, + "input":{"shape":"CreateProfileRequest"}, + "output":{"shape":"ProfileDetailResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a profile, a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.
Required permissions: rolesanywhere:CreateProfile.
Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA). You can define a trust anchor as a reference to an Private Certificate Authority (Private CA) or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials.
Required permissions: rolesanywhere:CreateTrustAnchor.
Delete an entry from the attribute mapping rules enforced by a given profile.
", + "idempotent":true + }, + "DeleteCrl":{ + "name":"DeleteCrl", + "http":{ + "method":"DELETE", + "requestUri":"/crl/{crlId}", + "responseCode":200 + }, + "input":{"shape":"ScalarCrlRequest"}, + "output":{"shape":"CrlDetailResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a certificate revocation list (CRL).
Required permissions: rolesanywhere:DeleteCrl.
Deletes a profile.
Required permissions: rolesanywhere:DeleteProfile.
Deletes a trust anchor.
Required permissions: rolesanywhere:DeleteTrustAnchor.
Disables a certificate revocation list (CRL).
Required permissions: rolesanywhere:DisableCrl.
Disables a profile. When disabled, temporary credential requests with this profile fail.
Required permissions: rolesanywhere:DisableProfile.
Disables a trust anchor. When disabled, temporary credential requests specifying this trust anchor are unauthorized.
Required permissions: rolesanywhere:DisableTrustAnchor.
Enables a certificate revocation list (CRL). When enabled, certificates stored in the CRL are unauthorized to receive session credentials.
Required permissions: rolesanywhere:EnableCrl.
Enables temporary credential requests for a profile.
Required permissions: rolesanywhere:EnableProfile.
Enables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation.
Required permissions: rolesanywhere:EnableTrustAnchor.
Gets a certificate revocation list (CRL).
Required permissions: rolesanywhere:GetCrl.
Gets a profile.
Required permissions: rolesanywhere:GetProfile.
Gets a subject, which associates a certificate identity with authentication attempts. The subject stores auditing information such as the status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication.
Required permissions: rolesanywhere:GetSubject.
Gets a trust anchor.
Required permissions: rolesanywhere:GetTrustAnchor.
Imports the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate Authority (CA).In order to be properly imported, a CRL must be in PEM format. IAM Roles Anywhere validates against the CRL before issuing credentials.
Required permissions: rolesanywhere:ImportCrl.
Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListCrls.
Lists all profiles in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListProfiles.
Lists the subjects in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListSubjects.
Lists the tags attached to the resource.
Required permissions: rolesanywhere:ListTagsForResource.
Lists the trust anchors in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListTrustAnchors.
Put an entry in the attribute mapping rules that will be enforced by a given profile. A mapping specifies a certificate field and one or more specifiers that have contextual meanings.
", + "idempotent":true + }, + "PutNotificationSettings":{ + "name":"PutNotificationSettings", + "http":{ + "method":"PATCH", + "requestUri":"/put-notifications-settings", + "responseCode":200 + }, + "input":{"shape":"PutNotificationSettingsRequest"}, + "output":{"shape":"PutNotificationSettingsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Attaches a list of notification settings to a trust anchor.
A notification setting includes information such as event name, threshold, status of the notification setting, and the channel to notify.
Required permissions: rolesanywhere:PutNotificationSettings.
Resets the custom notification setting to IAM Roles Anywhere default setting.
Required permissions: rolesanywhere:ResetNotificationSettings.
Attaches tags to a resource.
Required permissions: rolesanywhere:TagResource.
Removes tags from the resource.
Required permissions: rolesanywhere:UntagResource.
Updates the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate authority (CA). IAM Roles Anywhere validates against the CRL before issuing credentials.
Required permissions: rolesanywhere:UpdateCrl.
Updates a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.
Required permissions: rolesanywhere:UpdateProfile.
Updates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. You can define a trust anchor as a reference to an Private Certificate Authority (Private CA) or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials.
Required permissions: rolesanywhere:UpdateTrustAnchor.
You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1 + }, + "AttributeMapping":{ + "type":"structure", + "members":{ + "certificateField":{ + "shape":"CertificateField", + "documentation":"Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.
" + }, + "mappingRules":{ + "shape":"MappingRules", + "documentation":"A list of mapping entries for every supported specifier or sub-field.
" + } + }, + "documentation":"A mapping applied to the authenticating end-entity certificate.
" + }, + "AttributeMappings":{ + "type":"list", + "member":{"shape":"AttributeMapping"} + }, + "Blob":{"type":"blob"}, + "Boolean":{ + "type":"boolean", + "box":true + }, + "CertificateField":{ + "type":"string", + "enum":[ + "x509Subject", + "x509Issuer", + "x509SAN" + ] + }, + "CreateProfileRequest":{ + "type":"structure", + "required":[ + "name", + "roleArns" + ], + "members":{ + "acceptRoleSessionName":{ + "shape":"Boolean", + "documentation":"Used to determine if a custom role session name will be accepted in a temporary credential request.
" + }, + "durationSeconds":{ + "shape":"CreateProfileRequestDurationSecondsInteger", + "documentation":" Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.
Specifies whether the profile is enabled.
" + }, + "managedPolicyArns":{ + "shape":"ManagedPolicyList", + "documentation":"A list of managed policy ARNs that apply to the vended session credentials.
" + }, + "name":{ + "shape":"ResourceName", + "documentation":"The name of the profile.
" + }, + "requireInstanceProperties":{ + "shape":"Boolean", + "documentation":"Specifies whether instance properties are required in temporary credential requests with this profile.
" + }, + "roleArns":{ + "shape":"RoleArnList", + "documentation":"A list of IAM roles that this profile can assume in a temporary credential request.
" + }, + "sessionPolicy":{ + "shape":"String", + "documentation":"A session policy that applies to the trust boundary of the vended session credentials.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags to attach to the profile.
" + } + } + }, + "CreateProfileRequestDurationSecondsInteger":{ + "type":"integer", + "box":true, + "max":43200, + "min":900 + }, + "CreateTrustAnchorRequest":{ + "type":"structure", + "required":[ + "name", + "source" + ], + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"Specifies whether the trust anchor is enabled.
" + }, + "name":{ + "shape":"ResourceName", + "documentation":"The name of the trust anchor.
" + }, + "notificationSettings":{ + "shape":"NotificationSettings", + "documentation":"A list of notification settings to be associated to the trust anchor.
" + }, + "source":{ + "shape":"Source", + "documentation":"The trust anchor type and its related certificate data.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags to attach to the trust anchor.
" + } + } + }, + "CredentialSummaries":{ + "type":"list", + "member":{"shape":"CredentialSummary"} + }, + "CredentialSummary":{ + "type":"structure", + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"Indicates whether the credential is enabled.
" + }, + "failed":{ + "shape":"Boolean", + "documentation":"Indicates whether the temporary credential request was successful.
" + }, + "issuer":{ + "shape":"String", + "documentation":"The fully qualified domain name of the issuing certificate for the presented end-entity certificate.
" + }, + "seenAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The ISO-8601 time stamp of when the certificate was last used in a temporary credential request.
" + }, + "serialNumber":{ + "shape":"String", + "documentation":"The serial number of the certificate.
" + }, + "x509CertificateData":{ + "shape":"String", + "documentation":"The PEM-encoded data of the certificate.
" + } + }, + "documentation":"A record of a presented X509 credential from a temporary credential request.
" + }, + "CrlDetail":{ + "type":"structure", + "members":{ + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The ISO-8601 timestamp when the certificate revocation list (CRL) was created.
" + }, + "crlArn":{ + "shape":"String", + "documentation":"The ARN of the certificate revocation list (CRL).
" + }, + "crlData":{ + "shape":"Blob", + "documentation":"The state of the certificate revocation list (CRL) after a read or write operation.
" + }, + "crlId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the certificate revocation list (CRL).
" + }, + "enabled":{ + "shape":"Boolean", + "documentation":"Indicates whether the certificate revocation list (CRL) is enabled.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the certificate revocation list (CRL).
" + }, + "trustAnchorArn":{ + "shape":"String", + "documentation":"The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.
" + }, + "updatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The ISO-8601 timestamp when the certificate revocation list (CRL) was last updated.
" + } + }, + "documentation":"The state of the certificate revocation list (CRL) after a read or write operation.
" + }, + "CrlDetailResponse":{ + "type":"structure", + "required":["crl"], + "members":{ + "crl":{ + "shape":"CrlDetail", + "documentation":"The state of the certificate revocation list (CRL) after a read or write operation.
" + } + } + }, + "CrlDetails":{ + "type":"list", + "member":{"shape":"CrlDetail"} + }, + "DeleteAttributeMappingRequest":{ + "type":"structure", + "required":[ + "certificateField", + "profileId" + ], + "members":{ + "certificateField":{ + "shape":"CertificateField", + "documentation":"Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.
", + "location":"querystring", + "locationName":"certificateField" + }, + "profileId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the profile.
", + "location":"uri", + "locationName":"profileId" + }, + "specifiers":{ + "shape":"SpecifierList", + "documentation":"A list of specifiers of a certificate field; for example, CN, OU, UID from a Subject.
", + "location":"querystring", + "locationName":"specifiers" + } + } + }, + "DeleteAttributeMappingResponse":{ + "type":"structure", + "required":["profile"], + "members":{ + "profile":{ + "shape":"ProfileDetail", + "documentation":"The state of the profile after a read or write operation.
" + } + } + }, + "ImportCrlRequest":{ + "type":"structure", + "required":[ + "crlData", + "name", + "trustAnchorArn" + ], + "members":{ + "crlData":{ + "shape":"ImportCrlRequestCrlDataBlob", + "documentation":"The x509 v3 specified certificate revocation list (CRL).
" + }, + "enabled":{ + "shape":"Boolean", + "documentation":"Specifies whether the certificate revocation list (CRL) is enabled.
" + }, + "name":{ + "shape":"ResourceName", + "documentation":"The name of the certificate revocation list (CRL).
" + }, + "tags":{ + "shape":"TagList", + "documentation":"A list of tags to attach to the certificate revocation list (CRL).
" + }, + "trustAnchorArn":{ + "shape":"TrustAnchorArn", + "documentation":"The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.
" + } + } + }, + "ImportCrlRequestCrlDataBlob":{ + "type":"blob", + "max":300000, + "min":1 + }, + "InstanceProperties":{ + "type":"list", + "member":{"shape":"InstanceProperty"} + }, + "InstanceProperty":{ + "type":"structure", + "members":{ + "failed":{ + "shape":"Boolean", + "documentation":"Indicates whether the temporary credential request was successful.
" + }, + "properties":{ + "shape":"InstancePropertyMap", + "documentation":"A list of instanceProperty objects.
" + }, + "seenAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The ISO-8601 time stamp of when the certificate was last used in a temporary credential request.
" + } + }, + "documentation":"A key-value pair you set that identifies a property of the authenticating instance.
" + }, + "InstancePropertyMap":{ + "type":"map", + "key":{"shape":"InstancePropertyMapKeyString"}, + "value":{"shape":"InstancePropertyMapValueString"}, + "max":50, + "min":0 + }, + "InstancePropertyMapKeyString":{ + "type":"string", + "max":200, + "min":1 + }, + "InstancePropertyMapValueString":{ + "type":"string", + "max":200, + "min":1 + }, + "Integer":{ + "type":"integer", + "box":true + }, + "ListCrlsResponse":{ + "type":"structure", + "members":{ + "crls":{ + "shape":"CrlDetails", + "documentation":"A list of certificate revocation lists (CRL).
" + }, + "nextToken":{ + "shape":"String", + "documentation":"A token that indicates where the output should continue from, if a previous request did not show all results. To get the next results, make the request again with this value.
" + } + } + }, + "ListProfilesResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"A token that indicates where the output should continue from, if a previous request did not show all results. To get the next results, make the request again with this value.
" + }, + "profiles":{ + "shape":"ProfileDetails", + "documentation":"A list of profiles.
" + } + } + }, + "ListRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"ListRequestNextTokenString", + "documentation":"A token that indicates where the output should continue from, if a previous request did not show all results. To get the next results, make the request again with this value.
", + "location":"querystring", + "locationName":"nextToken" + }, + "pageSize":{ + "shape":"Integer", + "documentation":"The number of resources in the paginated list.
", + "location":"querystring", + "locationName":"pageSize" + } + } + }, + "ListRequestNextTokenString":{ + "type":"string", + "max":10000, + "min":1 + }, + "ListSubjectsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"A token that indicates where the output should continue from, if a previous request did not show all results. To get the next results, make the request again with this value.
" + }, + "subjects":{ + "shape":"SubjectSummaries", + "documentation":"A list of subjects.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the resource.
", + "location":"querystring", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"A list of tags attached to the resource.
" + } + } + }, + "ListTrustAnchorsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"A token that indicates where the output should continue from, if a previous request did not show all results. To get the next results, make the request again with this value.
" + }, + "trustAnchors":{ + "shape":"TrustAnchorDetails", + "documentation":"A list of trust anchors.
" + } + } + }, + "ManagedPolicyList":{ + "type":"list", + "member":{"shape":"ManagedPolicyListMemberString"}, + "max":50, + "min":0 + }, + "ManagedPolicyListMemberString":{ + "type":"string", + "max":200, + "min":1 + }, + "MappingRule":{ + "type":"structure", + "required":["specifier"], + "members":{ + "specifier":{ + "shape":"MappingRuleSpecifierString", + "documentation":"Specifier within a certificate field, such as CN, OU, or UID from the Subject field.
" + } + }, + "documentation":"A single mapping entry for each supported specifier or sub-field.
" + }, + "MappingRuleSpecifierString":{ + "type":"string", + "max":60, + "min":0 + }, + "MappingRules":{ + "type":"list", + "member":{"shape":"MappingRule"} + }, + "NotificationChannel":{ + "type":"string", + "enum":["ALL"] + }, + "NotificationEvent":{ + "type":"string", + "enum":[ + "CA_CERTIFICATE_EXPIRY", + "END_ENTITY_CERTIFICATE_EXPIRY" + ] + }, + "NotificationSetting":{ + "type":"structure", + "required":[ + "enabled", + "event" + ], + "members":{ + "channel":{ + "shape":"NotificationChannel", + "documentation":"The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.
In the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.
Indicates whether the notification setting is enabled.
" + }, + "event":{ + "shape":"NotificationEvent", + "documentation":"The event to which this notification setting is applied.
" + }, + "threshold":{ + "shape":"NotificationSettingThresholdInteger", + "documentation":"The number of days before a notification event. This value is required for a notification setting that is enabled.
" + } + }, + "documentation":"Customizable notification settings that will be applied to notification events. IAM Roles Anywhere consumes these settings while notifying across multiple channels - CloudWatch metrics, EventBridge, and Health Dashboard.
" + }, + "NotificationSettingDetail":{ + "type":"structure", + "required":[ + "enabled", + "event" + ], + "members":{ + "channel":{ + "shape":"NotificationChannel", + "documentation":"The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.
In the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.
The principal that configured the notification setting. For default settings configured by IAM Roles Anywhere, the value is rolesanywhere.amazonaws.com, and for customized notifications settings, it is the respective account ID.
Indicates whether the notification setting is enabled.
" + }, + "event":{ + "shape":"NotificationEvent", + "documentation":"The event to which this notification setting is applied.
" + }, + "threshold":{ + "shape":"NotificationSettingDetailThresholdInteger", + "documentation":"The number of days before a notification event.
" + } + }, + "documentation":"The state of a notification setting.
A notification setting includes information such as event name, threshold, status of the notification setting, and the channel to notify.
" + }, + "NotificationSettingDetailConfiguredByString":{ + "type":"string", + "max":200, + "min":1 + }, + "NotificationSettingDetailThresholdInteger":{ + "type":"integer", + "box":true, + "max":360, + "min":1 + }, + "NotificationSettingDetails":{ + "type":"list", + "member":{"shape":"NotificationSettingDetail"}, + "max":50, + "min":0 + }, + "NotificationSettingKey":{ + "type":"structure", + "required":["event"], + "members":{ + "channel":{ + "shape":"NotificationChannel", + "documentation":"The specified channel of notification.
" + }, + "event":{ + "shape":"NotificationEvent", + "documentation":"The notification setting event to reset.
" + } + }, + "documentation":"A notification setting key to reset. A notification setting key includes the event and the channel.
" + }, + "NotificationSettingKeys":{ + "type":"list", + "member":{"shape":"NotificationSettingKey"}, + "max":50, + "min":0 + }, + "NotificationSettingThresholdInteger":{ + "type":"integer", + "box":true, + "max":360, + "min":1 + }, + "NotificationSettings":{ + "type":"list", + "member":{"shape":"NotificationSetting"}, + "max":50, + "min":0 + }, + "ProfileArn":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"^arn:aws(-[^:]+)?:rolesanywhere(:.*){2}(:profile.*)$" + }, + "ProfileDetail":{ + "type":"structure", + "members":{ + "acceptRoleSessionName":{ + "shape":"Boolean", + "documentation":"Used to determine if a custom role session name will be accepted in a temporary credential request.
" + }, + "attributeMappings":{ + "shape":"AttributeMappings", + "documentation":"A mapping applied to the authenticating end-entity certificate.
" + }, + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The ISO-8601 timestamp when the profile was created.
" + }, + "createdBy":{ + "shape":"String", + "documentation":"The Amazon Web Services account that created the profile.
" + }, + "durationSeconds":{ + "shape":"Integer", + "documentation":" Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.
Indicates whether the profile is enabled.
" + }, + "managedPolicyArns":{ + "shape":"ManagedPolicyList", + "documentation":"A list of managed policy ARNs that apply to the vended session credentials.
" + }, + "name":{ + "shape":"ResourceName", + "documentation":"The name of the profile.
" + }, + "profileArn":{ + "shape":"ProfileArn", + "documentation":"The ARN of the profile.
" + }, + "profileId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the profile.
" + }, + "requireInstanceProperties":{ + "shape":"Boolean", + "documentation":"Specifies whether instance properties are required in temporary credential requests with this profile.
" + }, + "roleArns":{ + "shape":"RoleArnList", + "documentation":"A list of IAM roles that this profile can assume in a temporary credential request.
" + }, + "sessionPolicy":{ + "shape":"String", + "documentation":"A session policy that applies to the trust boundary of the vended session credentials.
" + }, + "updatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The ISO-8601 timestamp when the profile was last updated.
" + } + }, + "documentation":"The state of the profile after a read or write operation.
" + }, + "ProfileDetailResponse":{ + "type":"structure", + "members":{ + "profile":{ + "shape":"ProfileDetail", + "documentation":"The state of the profile after a read or write operation.
" + } + } + }, + "ProfileDetails":{ + "type":"list", + "member":{"shape":"ProfileDetail"} + }, + "PutAttributeMappingRequest":{ + "type":"structure", + "required":[ + "certificateField", + "mappingRules", + "profileId" + ], + "members":{ + "certificateField":{ + "shape":"CertificateField", + "documentation":"Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.
" + }, + "mappingRules":{ + "shape":"MappingRules", + "documentation":"A list of mapping entries for every supported specifier or sub-field.
" + }, + "profileId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the profile.
", + "location":"uri", + "locationName":"profileId" + } + } + }, + "PutAttributeMappingResponse":{ + "type":"structure", + "required":["profile"], + "members":{ + "profile":{ + "shape":"ProfileDetail", + "documentation":"The state of the profile after a read or write operation.
" + } + } + }, + "PutNotificationSettingsRequest":{ + "type":"structure", + "required":[ + "notificationSettings", + "trustAnchorId" + ], + "members":{ + "notificationSettings":{ + "shape":"NotificationSettings", + "documentation":"A list of notification settings to be associated to the trust anchor.
" + }, + "trustAnchorId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the trust anchor.
" + } + } + }, + "PutNotificationSettingsResponse":{ + "type":"structure", + "required":["trustAnchor"], + "members":{ + "trustAnchor":{"shape":"TrustAnchorDetail"} + } + }, + "ResetNotificationSettingsRequest":{ + "type":"structure", + "required":[ + "notificationSettingKeys", + "trustAnchorId" + ], + "members":{ + "notificationSettingKeys":{ + "shape":"NotificationSettingKeys", + "documentation":"A list of notification setting keys to reset. A notification setting key includes the event and the channel.
" + }, + "trustAnchorId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the trust anchor.
" + } + } + }, + "ResetNotificationSettingsResponse":{ + "type":"structure", + "required":["trustAnchor"], + "members":{ + "trustAnchor":{"shape":"TrustAnchorDetail"} + } + }, + "ResourceName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[ a-zA-Z0-9-_]*$" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The resource could not be found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "RoleArn":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"^arn:aws(-[^:]+)?:iam(:.*){2}(:role.*)$" + }, + "RoleArnList":{ + "type":"list", + "member":{"shape":"RoleArn"}, + "max":250, + "min":0 + }, + "ScalarCrlRequest":{ + "type":"structure", + "required":["crlId"], + "members":{ + "crlId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the certificate revocation list (CRL).
", + "location":"uri", + "locationName":"crlId" + } + } + }, + "ScalarProfileRequest":{ + "type":"structure", + "required":["profileId"], + "members":{ + "profileId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the profile.
", + "location":"uri", + "locationName":"profileId" + } + } + }, + "ScalarSubjectRequest":{ + "type":"structure", + "required":["subjectId"], + "members":{ + "subjectId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the subject.
", + "location":"uri", + "locationName":"subjectId" + } + } + }, + "ScalarTrustAnchorRequest":{ + "type":"structure", + "required":["trustAnchorId"], + "members":{ + "trustAnchorId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the trust anchor.
", + "location":"uri", + "locationName":"trustAnchorId" + } + } + }, + "Source":{ + "type":"structure", + "members":{ + "sourceData":{ + "shape":"SourceData", + "documentation":"The data field of the trust anchor depending on its type.
" + }, + "sourceType":{ + "shape":"TrustAnchorType", + "documentation":"The type of the trust anchor.
" + } + }, + "documentation":"The trust anchor type and its related certificate data.
" + }, + "SourceData":{ + "type":"structure", + "members":{ + "acmPcaArn":{ + "shape":"String", + "documentation":" The root certificate of the Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. Included for trust anchors of type AWS_ACM_PCA.
The PEM-encoded data for the certificate anchor. Included for trust anchors of type CERTIFICATE_BUNDLE.
The data field of the trust anchor depending on its type.
", + "union":true + }, + "SourceDataX509CertificateDataString":{ + "type":"string", + "max":8000, + "min":1 + }, + "SpecifierList":{ + "type":"list", + "member":{"shape":"String"} + }, + "String":{"type":"string"}, + "SubjectDetail":{ + "type":"structure", + "members":{ + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The ISO-8601 timestamp when the subject was created.
" + }, + "credentials":{ + "shape":"CredentialSummaries", + "documentation":"The temporary session credentials vended at the last authenticating call with this subject.
" + }, + "enabled":{ + "shape":"Boolean", + "documentation":"The enabled status of the subject.
" + }, + "instanceProperties":{ + "shape":"InstanceProperties", + "documentation":"The specified instance properties associated with the request.
" + }, + "lastSeenAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The ISO-8601 timestamp of the last time this subject requested temporary session credentials.
" + }, + "subjectArn":{ + "shape":"String", + "documentation":"The ARN of the resource.
" + }, + "subjectId":{ + "shape":"Uuid", + "documentation":"The id of the resource
" + }, + "updatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The ISO-8601 timestamp when the subject was last updated.
" + }, + "x509Subject":{ + "shape":"String", + "documentation":"The x509 principal identifier of the authenticating certificate.
" + } + }, + "documentation":"The state of the subject after a read or write operation.
" + }, + "SubjectDetailResponse":{ + "type":"structure", + "members":{ + "subject":{ + "shape":"SubjectDetail", + "documentation":"The state of the subject after a read or write operation.
" + } + } + }, + "SubjectSummaries":{ + "type":"list", + "member":{"shape":"SubjectSummary"} + }, + "SubjectSummary":{ + "type":"structure", + "members":{ + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The ISO-8601 time stamp of when the certificate was first used in a temporary credential request.
" + }, + "enabled":{ + "shape":"Boolean", + "documentation":"The enabled status of the subject.
" + }, + "lastSeenAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The ISO-8601 time stamp of when the certificate was last used in a temporary credential request.
" + }, + "subjectArn":{ + "shape":"String", + "documentation":"The ARN of the resource.
" + }, + "subjectId":{ + "shape":"Uuid", + "documentation":"The id of the resource.
" + }, + "updatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The ISO-8601 timestamp when the subject was last updated.
" + }, + "x509Subject":{ + "shape":"String", + "documentation":"The x509 principal identifier of the authenticating certificate.
" + } + }, + "documentation":"A summary representation of subjects.
" + }, + "SyntheticTimestamp_date_time":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "Tag":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"The tag key.
" + }, + "value":{ + "shape":"TagValue", + "documentation":"The tag value.
" + } + }, + "documentation":"A label that consists of a key and value you define.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[ a-zA-Z0-9_.:/=+@-]*$", + "sensitive":true + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the resource.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags to attach to the resource.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^[ a-zA-Z0-9_.:/=+@-]*$", + "sensitive":true + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Too many tags.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TrustAnchorArn":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"^arn:aws(-[^:]+)?:rolesanywhere(:.*){2}(:trust-anchor.*)$" + }, + "TrustAnchorDetail":{ + "type":"structure", + "members":{ + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The ISO-8601 timestamp when the trust anchor was created.
" + }, + "enabled":{ + "shape":"Boolean", + "documentation":"Indicates whether the trust anchor is enabled.
" + }, + "name":{ + "shape":"ResourceName", + "documentation":"The name of the trust anchor.
" + }, + "notificationSettings":{ + "shape":"NotificationSettingDetails", + "documentation":"A list of notification settings to be associated to the trust anchor.
" + }, + "source":{ + "shape":"Source", + "documentation":"The trust anchor type and its related certificate data.
" + }, + "trustAnchorArn":{ + "shape":"String", + "documentation":"The ARN of the trust anchor.
" + }, + "trustAnchorId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the trust anchor.
" + }, + "updatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The ISO-8601 timestamp when the trust anchor was last updated.
" + } + }, + "documentation":"The state of the trust anchor after a read or write operation.
" + }, + "TrustAnchorDetailResponse":{ + "type":"structure", + "required":["trustAnchor"], + "members":{ + "trustAnchor":{ + "shape":"TrustAnchorDetail", + "documentation":"The state of the trust anchor after a read or write operation.
" + } + } + }, + "TrustAnchorDetails":{ + "type":"list", + "member":{"shape":"TrustAnchorDetail"} + }, + "TrustAnchorType":{ + "type":"string", + "enum":[ + "AWS_ACM_PCA", + "CERTIFICATE_BUNDLE", + "SELF_SIGNED_REPOSITORY" + ] + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the resource.
" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"A list of keys. Tag keys are the unique identifiers of tags.
" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateCrlRequest":{ + "type":"structure", + "required":["crlId"], + "members":{ + "crlData":{ + "shape":"UpdateCrlRequestCrlDataBlob", + "documentation":"The x509 v3 specified certificate revocation list (CRL).
" + }, + "crlId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the certificate revocation list (CRL).
", + "location":"uri", + "locationName":"crlId" + }, + "name":{ + "shape":"ResourceName", + "documentation":"The name of the Crl.
" + } + } + }, + "UpdateCrlRequestCrlDataBlob":{ + "type":"blob", + "max":300000, + "min":1 + }, + "UpdateProfileRequest":{ + "type":"structure", + "required":["profileId"], + "members":{ + "acceptRoleSessionName":{ + "shape":"Boolean", + "documentation":"Used to determine if a custom role session name will be accepted in a temporary credential request.
" + }, + "durationSeconds":{ + "shape":"UpdateProfileRequestDurationSecondsInteger", + "documentation":" Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.
A list of managed policy ARNs that apply to the vended session credentials.
" + }, + "name":{ + "shape":"ResourceName", + "documentation":"The name of the profile.
" + }, + "profileId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the profile.
", + "location":"uri", + "locationName":"profileId" + }, + "roleArns":{ + "shape":"RoleArnList", + "documentation":"A list of IAM roles that this profile can assume in a temporary credential request.
" + }, + "sessionPolicy":{ + "shape":"UpdateProfileRequestSessionPolicyString", + "documentation":"A session policy that applies to the trust boundary of the vended session credentials.
" + } + } + }, + "UpdateProfileRequestDurationSecondsInteger":{ + "type":"integer", + "box":true, + "max":43200, + "min":900 + }, + "UpdateProfileRequestSessionPolicyString":{ + "type":"string", + "max":100000, + "min":1 + }, + "UpdateTrustAnchorRequest":{ + "type":"structure", + "required":["trustAnchorId"], + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"The name of the trust anchor.
" + }, + "source":{ + "shape":"Source", + "documentation":"The trust anchor type and its related certificate data.
" + }, + "trustAnchorId":{ + "shape":"Uuid", + "documentation":"The unique identifier of the trust anchor.
", + "location":"uri", + "locationName":"trustAnchorId" + } + } + }, + "Uuid":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}" + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Validation exception error.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + }, + "documentation":"Identity and Access Management Roles Anywhere provides a secure way for your workloads such as servers, containers, and applications that run outside of Amazon Web Services to obtain temporary Amazon Web Services credentials. Your workloads can use the same IAM policies and roles you have for native Amazon Web Services applications to access Amazon Web Services resources. Using IAM Roles Anywhere eliminates the need to manage long-term credentials for workloads running outside of Amazon Web Services.
To use IAM Roles Anywhere, your workloads must use X.509 certificates issued by their certificate authority (CA). You register the CA with IAM Roles Anywhere as a trust anchor to establish trust between your public key infrastructure (PKI) and IAM Roles Anywhere. If you don't manage your own PKI system, you can use Private Certificate Authority to create a CA and then use that to establish trust with IAM Roles Anywhere.
This guide describes the IAM Roles Anywhere operations that you can call programmatically. For more information about IAM Roles Anywhere, see the IAM Roles Anywhere User Guide.
" +} diff --git a/testbed/boto__botocore/botocore/data/sagemaker-geospatial/2020-05-27/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/sagemaker-geospatial/2020-05-27/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..ab594a484adc0216c934573dfef329445bb96a47 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/sagemaker-geospatial/2020-05-27/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://sagemaker-geospatial-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://sagemaker-geospatial-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://sagemaker-geospatial.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://sagemaker-geospatial.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/sagemaker-geospatial/2020-05-27/paginators-1.json b/testbed/boto__botocore/botocore/data/sagemaker-geospatial/2020-05-27/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..8802d9431cb5ce9013c69b32d176f60dd410ac2f --- /dev/null +++ b/testbed/boto__botocore/botocore/data/sagemaker-geospatial/2020-05-27/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListEarthObservationJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "EarthObservationJobSummaries" + }, + "ListRasterDataCollections": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RasterDataCollectionSummaries" + }, + "ListVectorEnrichmentJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "VectorEnrichmentJobSummaries" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/sagemaker-geospatial/2020-05-27/service-2.json b/testbed/boto__botocore/botocore/data/sagemaker-geospatial/2020-05-27/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..712ccbe08daf5f78360750720378d4f2e6a1c5f8 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/sagemaker-geospatial/2020-05-27/service-2.json @@ -0,0 +1,2899 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-05-27", + "endpointPrefix":"sagemaker-geospatial", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon SageMaker geospatial capabilities", + "serviceId":"SageMaker Geospatial", + "signatureVersion":"v4", + "signingName":"sagemaker-geospatial", + "uid":"sagemaker-geospatial-2020-05-27" + }, + "operations":{ + "DeleteEarthObservationJob":{ + "name":"DeleteEarthObservationJob", + "http":{ + "method":"DELETE", + "requestUri":"/earth-observation-jobs/{Arn}", + "responseCode":200 + }, + "input":{"shape":"DeleteEarthObservationJobInput"}, + "output":{"shape":"DeleteEarthObservationJobOutput"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Use this operation to delete an Earth Observation job.
", + "idempotent":true + }, + "DeleteVectorEnrichmentJob":{ + "name":"DeleteVectorEnrichmentJob", + "http":{ + "method":"DELETE", + "requestUri":"/vector-enrichment-jobs/{Arn}", + "responseCode":200 + }, + "input":{"shape":"DeleteVectorEnrichmentJobInput"}, + "output":{"shape":"DeleteVectorEnrichmentJobOutput"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Use this operation to delete a Vector Enrichment job.
", + "idempotent":true + }, + "ExportEarthObservationJob":{ + "name":"ExportEarthObservationJob", + "http":{ + "method":"POST", + "requestUri":"/export-earth-observation-job", + "responseCode":200 + }, + "input":{"shape":"ExportEarthObservationJobInput"}, + "output":{"shape":"ExportEarthObservationJobOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an Amazon S3 location.
" + }, + "ExportVectorEnrichmentJob":{ + "name":"ExportVectorEnrichmentJob", + "http":{ + "method":"POST", + "requestUri":"/export-vector-enrichment-jobs", + "responseCode":200 + }, + "input":{"shape":"ExportVectorEnrichmentJobInput"}, + "output":{"shape":"ExportVectorEnrichmentJobOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
" + }, + "GetEarthObservationJob":{ + "name":"GetEarthObservationJob", + "http":{ + "method":"GET", + "requestUri":"/earth-observation-jobs/{Arn}", + "responseCode":200 + }, + "input":{"shape":"GetEarthObservationJobInput"}, + "output":{"shape":"GetEarthObservationJobOutput"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Get the details for a previously initiated Earth Observation job.
" + }, + "GetRasterDataCollection":{ + "name":"GetRasterDataCollection", + "http":{ + "method":"GET", + "requestUri":"/raster-data-collection/{Arn}", + "responseCode":200 + }, + "input":{"shape":"GetRasterDataCollectionInput"}, + "output":{"shape":"GetRasterDataCollectionOutput"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Use this operation to get details of a specific raster data collection.
" + }, + "GetTile":{ + "name":"GetTile", + "http":{ + "method":"GET", + "requestUri":"/tile/{z}/{x}/{y}", + "responseCode":200 + }, + "input":{"shape":"GetTileInput"}, + "output":{"shape":"GetTileOutput"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Gets a web mercator tile for the given Earth Observation job.
" + }, + "GetVectorEnrichmentJob":{ + "name":"GetVectorEnrichmentJob", + "http":{ + "method":"GET", + "requestUri":"/vector-enrichment-jobs/{Arn}", + "responseCode":200 + }, + "input":{"shape":"GetVectorEnrichmentJobInput"}, + "output":{"shape":"GetVectorEnrichmentJobOutput"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
" + }, + "ListEarthObservationJobs":{ + "name":"ListEarthObservationJobs", + "http":{ + "method":"POST", + "requestUri":"/list-earth-observation-jobs", + "responseCode":200 + }, + "input":{"shape":"ListEarthObservationJobInput"}, + "output":{"shape":"ListEarthObservationJobOutput"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
" + }, + "ListRasterDataCollections":{ + "name":"ListRasterDataCollections", + "http":{ + "method":"GET", + "requestUri":"/raster-data-collections", + "responseCode":200 + }, + "input":{"shape":"ListRasterDataCollectionsInput"}, + "output":{"shape":"ListRasterDataCollectionsOutput"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Use this operation to get raster data collections.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{ResourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Lists the tags attached to the resource.
" + }, + "ListVectorEnrichmentJobs":{ + "name":"ListVectorEnrichmentJobs", + "http":{ + "method":"POST", + "requestUri":"/list-vector-enrichment-jobs", + "responseCode":200 + }, + "input":{"shape":"ListVectorEnrichmentJobInput"}, + "output":{"shape":"ListVectorEnrichmentJobOutput"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves a list of vector enrichment jobs.
" + }, + "SearchRasterDataCollection":{ + "name":"SearchRasterDataCollection", + "http":{ + "method":"POST", + "requestUri":"/search-raster-data-collection", + "responseCode":200 + }, + "input":{"shape":"SearchRasterDataCollectionInput"}, + "output":{"shape":"SearchRasterDataCollectionOutput"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
" + }, + "StartEarthObservationJob":{ + "name":"StartEarthObservationJob", + "http":{ + "method":"POST", + "requestUri":"/earth-observation-jobs", + "responseCode":200 + }, + "input":{"shape":"StartEarthObservationJobInput"}, + "output":{"shape":"StartEarthObservationJobOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Use this operation to create an Earth observation job.
", + "idempotent":true + }, + "StartVectorEnrichmentJob":{ + "name":"StartVectorEnrichmentJob", + "http":{ + "method":"POST", + "requestUri":"/vector-enrichment-jobs", + "responseCode":200 + }, + "input":{"shape":"StartVectorEnrichmentJobInput"}, + "output":{"shape":"StartVectorEnrichmentJobOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.
", + "idempotent":true + }, + "StopEarthObservationJob":{ + "name":"StopEarthObservationJob", + "http":{ + "method":"POST", + "requestUri":"/earth-observation-jobs/stop", + "responseCode":200 + }, + "input":{"shape":"StopEarthObservationJobInput"}, + "output":{"shape":"StopEarthObservationJobOutput"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Use this operation to stop an existing earth observation job.
" + }, + "StopVectorEnrichmentJob":{ + "name":"StopVectorEnrichmentJob", + "http":{ + "method":"POST", + "requestUri":"/vector-enrichment-jobs/stop", + "responseCode":200 + }, + "input":{"shape":"StopVectorEnrichmentJobInput"}, + "output":{"shape":"StopVectorEnrichmentJobOutput"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Stops the Vector Enrichment job for a given job ARN.
", + "idempotent":true + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"PUT", + "requestUri":"/tags/{ResourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"The resource you want to tag.
", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{ResourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"The resource you want to untag.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AlgorithmNameCloudRemoval":{ + "type":"string", + "enum":["INTERPOLATION"] + }, + "AlgorithmNameGeoMosaic":{ + "type":"string", + "enum":[ + "NEAR", + "BILINEAR", + "CUBIC", + "CUBICSPLINE", + "LANCZOS", + "AVERAGE", + "RMS", + "MODE", + "MAX", + "MIN", + "MED", + "Q1", + "Q3", + "SUM" + ] + }, + "AlgorithmNameResampling":{ + "type":"string", + "enum":[ + "NEAR", + "BILINEAR", + "CUBIC", + "CUBICSPLINE", + "LANCZOS", + "AVERAGE", + "RMS", + "MODE", + "MAX", + "MIN", + "MED", + "Q1", + "Q3", + "SUM" + ] + }, + "AreaOfInterest":{ + "type":"structure", + "members":{ + "AreaOfInterestGeometry":{ + "shape":"AreaOfInterestGeometry", + "documentation":"A GeoJSON object representing the geographic extent in the coordinate space.
" + } + }, + "documentation":"The geographic extent of the Earth Observation job.
", + "union":true + }, + "AreaOfInterestGeometry":{ + "type":"structure", + "members":{ + "MultiPolygonGeometry":{ + "shape":"MultiPolygonGeometryInput", + "documentation":"The structure representing the MultiPolygon Geometry.
" + }, + "PolygonGeometry":{ + "shape":"PolygonGeometryInput", + "documentation":"The structure representing Polygon Geometry.
" + } + }, + "documentation":"A GeoJSON object representing the geographic extent in the coordinate space.
", + "union":true + }, + "Arn":{ + "type":"string", + "max":2048, + "min":1 + }, + "AssetValue":{ + "type":"structure", + "members":{ + "Href":{ + "shape":"String", + "documentation":"Link to the asset object.
" + } + }, + "documentation":"The structure containing the asset properties.
" + }, + "AssetsMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"AssetValue"} + }, + "BandMathConfigInput":{ + "type":"structure", + "members":{ + "CustomIndices":{ + "shape":"CustomIndicesInput", + "documentation":"CustomIndices that are computed.
" + }, + "PredefinedIndices":{ + "shape":"StringListInput", + "documentation":"One or many of the supported predefined indices to compute. Allowed values: NDVI, EVI2, MSAVI, NDWI, NDMI, NDSI, and WDRVI.
Input structure for the BandMath operation type. Defines Predefined and CustomIndices to be computed using BandMath.
" + }, + "BinaryFile":{ + "type":"blob", + "streaming":true + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "CloudMaskingConfigInput":{ + "type":"structure", + "members":{ + }, + "documentation":"Input structure for CloudMasking operation type.
" + }, + "CloudRemovalConfigInput":{ + "type":"structure", + "members":{ + "AlgorithmName":{ + "shape":"AlgorithmNameCloudRemoval", + "documentation":"The name of the algorithm used for cloud removal.
" + }, + "InterpolationValue":{ + "shape":"String", + "documentation":"The interpolation value you provide for cloud removal.
" + }, + "TargetBands":{ + "shape":"StringListInput", + "documentation":"TargetBands to be returned in the output of CloudRemoval operation.
" + } + }, + "documentation":"Input structure for Cloud Removal Operation type
" + }, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "EQUALS", + "NOT_EQUALS", + "STARTS_WITH" + ] + }, + "ConflictException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{ + "shape":"String", + "documentation":"Identifier of the resource affected.
" + } + }, + "documentation":"Updating or deleting a resource can cause an inconsistent state.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CustomIndicesInput":{ + "type":"structure", + "members":{ + "Operations":{ + "shape":"OperationsListInput", + "documentation":"A list of BandMath indices to compute.
" + } + }, + "documentation":"Input object defining the custom BandMath indices to compute.
" + }, + "DataCollectionArn":{ + "type":"string", + "pattern":"^arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:raster-data-collection/(public|premium|user)/[a-z0-9]{12,}$" + }, + "DataCollectionType":{ + "type":"string", + "enum":[ + "PUBLIC", + "PREMIUM", + "USER" + ] + }, + "DataCollectionsList":{ + "type":"list", + "member":{"shape":"RasterDataCollectionMetadata"} + }, + "DeleteEarthObservationJobInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"EarthObservationJobArn", + "documentation":"The Amazon Resource Name (ARN) of the Earth Observation job being deleted.
", + "location":"uri", + "locationName":"Arn" + } + } + }, + "DeleteEarthObservationJobOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteVectorEnrichmentJobInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"VectorEnrichmentJobArn", + "documentation":"The Amazon Resource Name (ARN) of the Vector Enrichment job being deleted.
", + "location":"uri", + "locationName":"Arn" + } + } + }, + "DeleteVectorEnrichmentJobOutput":{ + "type":"structure", + "members":{ + } + }, + "Double":{ + "type":"double", + "box":true + }, + "EarthObservationJobArn":{ + "type":"string", + "pattern":"^arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:earth-observation-job/[a-z0-9]{12,}$" + }, + "EarthObservationJobErrorDetails":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"A detailed message describing the error in an Earth Observation job.
" + }, + "Type":{ + "shape":"EarthObservationJobErrorType", + "documentation":"The type of error in an Earth Observation job.
" + } + }, + "documentation":"The structure representing the errors in an EarthObservationJob.
" + }, + "EarthObservationJobErrorType":{ + "type":"string", + "enum":[ + "CLIENT_ERROR", + "SERVER_ERROR" + ] + }, + "EarthObservationJobExportStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ] + }, + "EarthObservationJobList":{ + "type":"list", + "member":{"shape":"ListEarthObservationJobOutputConfig"} + }, + "EarthObservationJobOutputBands":{ + "type":"list", + "member":{"shape":"OutputBand"} + }, + "EarthObservationJobStatus":{ + "type":"string", + "enum":[ + "INITIALIZING", + "IN_PROGRESS", + "STOPPING", + "COMPLETED", + "STOPPED", + "FAILED", + "DELETING", + "DELETED" + ] + }, + "EoCloudCoverInput":{ + "type":"structure", + "required":[ + "LowerBound", + "UpperBound" + ], + "members":{ + "LowerBound":{ + "shape":"Float", + "documentation":"Lower bound for EoCloudCover.
" + }, + "UpperBound":{ + "shape":"Float", + "documentation":"Upper bound for EoCloudCover.
" + } + }, + "documentation":"The structure representing the EoCloudCover filter.
" + }, + "ExecutionRoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+$" + }, + "ExportEarthObservationJobInput":{ + "type":"structure", + "required":[ + "Arn", + "ExecutionRoleArn", + "OutputConfig" + ], + "members":{ + "Arn":{ + "shape":"EarthObservationJobArn", + "documentation":"The input Amazon Resource Name (ARN) of the Earth Observation job being exported.
" + }, + "ClientToken":{ + "shape":"ExportEarthObservationJobInputClientTokenString", + "documentation":"A unique token that guarantees that the call to this API is idempotent.
", + "idempotencyToken":true + }, + "ExecutionRoleArn":{ + "shape":"ExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
" + }, + "ExportSourceImages":{ + "shape":"Boolean", + "documentation":"The source images provided to the Earth Observation job being exported.
" + }, + "OutputConfig":{ + "shape":"OutputConfigInput", + "documentation":"An object containing information about the output file.
" + } + } + }, + "ExportEarthObservationJobInputClientTokenString":{ + "type":"string", + "max":64, + "min":36 + }, + "ExportEarthObservationJobOutput":{ + "type":"structure", + "required":[ + "Arn", + "CreationTime", + "ExecutionRoleArn", + "ExportStatus", + "OutputConfig" + ], + "members":{ + "Arn":{ + "shape":"EarthObservationJobArn", + "documentation":"The output Amazon Resource Name (ARN) of the Earth Observation job being exported.
" + }, + "CreationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The creation time.
" + }, + "ExecutionRoleArn":{ + "shape":"ExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
" + }, + "ExportSourceImages":{ + "shape":"Boolean", + "documentation":"The source images provided to the Earth Observation job being exported.
" + }, + "ExportStatus":{ + "shape":"EarthObservationJobExportStatus", + "documentation":"The status of the results of the Earth Observation job being exported.
" + }, + "OutputConfig":{ + "shape":"OutputConfigInput", + "documentation":"An object containing information about the output file.
" + } + } + }, + "ExportErrorDetails":{ + "type":"structure", + "members":{ + "ExportResults":{ + "shape":"ExportErrorDetailsOutput", + "documentation":"The structure for returning the export error details while exporting results of an Earth Observation job.
" + }, + "ExportSourceImages":{ + "shape":"ExportErrorDetailsOutput", + "documentation":"The structure for returning the export error details while exporting the source images of an Earth Observation job.
" + } + }, + "documentation":"The structure for returning the export error details in a GetEarthObservationJob.
" + }, + "ExportErrorDetailsOutput":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"A detailed message describing the error in an export EarthObservationJob operation.
" + }, + "Type":{ + "shape":"ExportErrorType", + "documentation":"The type of error in an export EarthObservationJob operation.
" + } + }, + "documentation":"The structure representing the errors in an export EarthObservationJob operation.
" + }, + "ExportErrorType":{ + "type":"string", + "enum":[ + "CLIENT_ERROR", + "SERVER_ERROR" + ] + }, + "ExportS3DataInput":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "KmsKeyId":{ + "shape":"KmsKey", + "documentation":"The Key Management Service key ID for server-side encryption.
" + }, + "S3Uri":{ + "shape":"S3Uri", + "documentation":"The URL to the Amazon S3 data input.
" + } + }, + "documentation":"The structure containing the Amazon S3 path to export the Earth Observation job output.
" + }, + "ExportVectorEnrichmentJobInput":{ + "type":"structure", + "required":[ + "Arn", + "ExecutionRoleArn", + "OutputConfig" + ], + "members":{ + "Arn":{ + "shape":"VectorEnrichmentJobArn", + "documentation":"The Amazon Resource Name (ARN) of the Vector Enrichment job.
" + }, + "ClientToken":{ + "shape":"ExportVectorEnrichmentJobInputClientTokenString", + "documentation":"A unique token that guarantees that the call to this API is idempotent.
", + "idempotencyToken":true + }, + "ExecutionRoleArn":{ + "shape":"ExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM rolewith permission to upload to the location in OutputConfig.
" + }, + "OutputConfig":{ + "shape":"ExportVectorEnrichmentJobOutputConfig", + "documentation":"Output location information for exporting Vector Enrichment Job results.
" + } + } + }, + "ExportVectorEnrichmentJobInputClientTokenString":{ + "type":"string", + "max":64, + "min":36 + }, + "ExportVectorEnrichmentJobOutput":{ + "type":"structure", + "required":[ + "Arn", + "CreationTime", + "ExecutionRoleArn", + "ExportStatus", + "OutputConfig" + ], + "members":{ + "Arn":{ + "shape":"VectorEnrichmentJobArn", + "documentation":"The Amazon Resource Name (ARN) of the Vector Enrichment job being exported.
" + }, + "CreationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The creation time.
" + }, + "ExecutionRoleArn":{ + "shape":"ExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role with permission to upload to the location in OutputConfig.
" + }, + "ExportStatus":{ + "shape":"VectorEnrichmentJobExportStatus", + "documentation":"The status of the results the Vector Enrichment job being exported.
" + }, + "OutputConfig":{ + "shape":"ExportVectorEnrichmentJobOutputConfig", + "documentation":"Output location information for exporting Vector Enrichment Job results.
" + } + } + }, + "ExportVectorEnrichmentJobOutputConfig":{ + "type":"structure", + "required":["S3Data"], + "members":{ + "S3Data":{ + "shape":"VectorEnrichmentJobS3Data", + "documentation":"The input structure for Amazon S3 data; representing the Amazon S3 location of the input data objects.
" + } + }, + "documentation":"An object containing information about the output file.
" + }, + "Filter":{ + "type":"structure", + "required":[ + "Name", + "Type" + ], + "members":{ + "Maximum":{ + "shape":"Float", + "documentation":"The maximum value of the filter.
" + }, + "Minimum":{ + "shape":"Float", + "documentation":"The minimum value of the filter.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the filter.
" + }, + "Type":{ + "shape":"String", + "documentation":"The type of the filter being used.
" + } + }, + "documentation":"The structure representing the filters supported by a RasterDataCollection.
" + }, + "FilterList":{ + "type":"list", + "member":{"shape":"Filter"} + }, + "Float":{ + "type":"float", + "box":true + }, + "GeoMosaicConfigInput":{ + "type":"structure", + "members":{ + "AlgorithmName":{ + "shape":"AlgorithmNameGeoMosaic", + "documentation":"The name of the algorithm being used for geomosaic.
" + }, + "TargetBands":{ + "shape":"StringListInput", + "documentation":"The target bands for geomosaic.
" + } + }, + "documentation":"Input configuration information for the geomosaic.
" + }, + "Geometry":{ + "type":"structure", + "required":[ + "Coordinates", + "Type" + ], + "members":{ + "Coordinates":{ + "shape":"LinearRings", + "documentation":"The coordinates of the GeoJson Geometry.
" + }, + "Type":{ + "shape":"String", + "documentation":"GeoJson Geometry types like Polygon and MultiPolygon.
" + } + }, + "documentation":"The structure representing a Geometry in terms of Type and Coordinates as per GeoJson spec.
" + }, + "GetEarthObservationJobInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"EarthObservationJobArn", + "documentation":"The Amazon Resource Name (ARN) of the Earth Observation job.
", + "location":"uri", + "locationName":"Arn" + } + } + }, + "GetEarthObservationJobOutput":{ + "type":"structure", + "required":[ + "Arn", + "CreationTime", + "DurationInSeconds", + "InputConfig", + "JobConfig", + "Name", + "Status" + ], + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the Earth Observation job.
" + }, + "CreationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The creation time of the initiated Earth Observation job.
" + }, + "DurationInSeconds":{ + "shape":"Integer", + "documentation":"The duration of Earth Observation job, in seconds.
" + }, + "ErrorDetails":{ + "shape":"EarthObservationJobErrorDetails", + "documentation":"Details about the errors generated during the Earth Observation job.
" + }, + "ExecutionRoleArn":{ + "shape":"ExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
" + }, + "ExportErrorDetails":{ + "shape":"ExportErrorDetails", + "documentation":"Details about the errors generated during ExportEarthObservationJob.
" + }, + "ExportStatus":{ + "shape":"EarthObservationJobExportStatus", + "documentation":"The status of the Earth Observation job.
" + }, + "InputConfig":{ + "shape":"InputConfigOutput", + "documentation":"Input data for the Earth Observation job.
" + }, + "JobConfig":{ + "shape":"JobConfigInput", + "documentation":"An object containing information about the job configuration.
" + }, + "KmsKeyId":{ + "shape":"KmsKey", + "documentation":"The Key Management Service key ID for server-side encryption.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the Earth Observation job.
" + }, + "OutputBands":{ + "shape":"EarthObservationJobOutputBands", + "documentation":"Bands available in the output of an operation.
" + }, + "Status":{ + "shape":"EarthObservationJobStatus", + "documentation":"The status of a previously initiated Earth Observation job.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"Each tag consists of a key and a value.
" + } + } + }, + "GetRasterDataCollectionInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"DataCollectionArn", + "documentation":"The Amazon Resource Name (ARN) of the raster data collection.
", + "location":"uri", + "locationName":"Arn" + } + } + }, + "GetRasterDataCollectionOutput":{ + "type":"structure", + "required":[ + "Arn", + "Description", + "DescriptionPageUrl", + "ImageSourceBands", + "Name", + "SupportedFilters", + "Type" + ], + "members":{ + "Arn":{ + "shape":"DataCollectionArn", + "documentation":"The Amazon Resource Name (ARN) of the raster data collection.
" + }, + "Description":{ + "shape":"String", + "documentation":"A description of the raster data collection.
" + }, + "DescriptionPageUrl":{ + "shape":"String", + "documentation":"The URL of the description page.
" + }, + "ImageSourceBands":{ + "shape":"ImageSourceBandList", + "documentation":"The list of image source bands in the raster data collection.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the raster data collection.
" + }, + "SupportedFilters":{ + "shape":"FilterList", + "documentation":"The filters supported by the raster data collection.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"Each tag consists of a key and a value.
" + }, + "Type":{ + "shape":"DataCollectionType", + "documentation":"The raster data collection type.
" + } + } + }, + "GetTileInput":{ + "type":"structure", + "required":[ + "Arn", + "ImageAssets", + "Target", + "x", + "y", + "z" + ], + "members":{ + "Arn":{ + "shape":"EarthObservationJobArn", + "documentation":"The Amazon Resource Name (ARN) of the tile operation.
", + "location":"querystring", + "locationName":"Arn" + }, + "ExecutionRoleArn":{ + "shape":"ExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role that you specify.
", + "location":"querystring", + "locationName":"ExecutionRoleArn" + }, + "ImageAssets":{ + "shape":"StringListInput", + "documentation":"The particular assets or bands to tile.
", + "location":"querystring", + "locationName":"ImageAssets" + }, + "ImageMask":{ + "shape":"Boolean", + "documentation":"Determines whether or not to return a valid data mask.
", + "location":"querystring", + "locationName":"ImageMask" + }, + "OutputDataType":{ + "shape":"OutputType", + "documentation":"The output data type of the tile operation.
", + "location":"querystring", + "locationName":"OutputDataType" + }, + "OutputFormat":{ + "shape":"String", + "documentation":"The data format of the output tile. The formats include .npy, .png and .jpg.
", + "location":"querystring", + "locationName":"OutputFormat" + }, + "PropertyFilters":{ + "shape":"String", + "documentation":"Property filters for the imagery to tile.
", + "location":"querystring", + "locationName":"PropertyFilters" + }, + "Target":{ + "shape":"TargetOptions", + "documentation":"Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.
", + "location":"querystring", + "locationName":"Target" + }, + "TimeRangeFilter":{ + "shape":"String", + "documentation":"Time range filter applied to imagery to find the images to tile.
", + "location":"querystring", + "locationName":"TimeRangeFilter" + }, + "x":{ + "shape":"Integer", + "documentation":"The x coordinate of the tile input.
", + "location":"uri", + "locationName":"x" + }, + "y":{ + "shape":"Integer", + "documentation":"The y coordinate of the tile input.
", + "location":"uri", + "locationName":"y" + }, + "z":{ + "shape":"Integer", + "documentation":"The z coordinate of the tile input.
", + "location":"uri", + "locationName":"z" + } + } + }, + "GetTileOutput":{ + "type":"structure", + "members":{ + "BinaryFile":{ + "shape":"BinaryFile", + "documentation":"The output binary file.
" + } + }, + "payload":"BinaryFile" + }, + "GetVectorEnrichmentJobInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"VectorEnrichmentJobArn", + "documentation":"The Amazon Resource Name (ARN) of the Vector Enrichment job.
", + "location":"uri", + "locationName":"Arn" + } + } + }, + "GetVectorEnrichmentJobOutput":{ + "type":"structure", + "required":[ + "Arn", + "CreationTime", + "DurationInSeconds", + "ExecutionRoleArn", + "InputConfig", + "JobConfig", + "Name", + "Status", + "Type" + ], + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the Vector Enrichment job.
" + }, + "CreationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The creation time.
" + }, + "DurationInSeconds":{ + "shape":"Integer", + "documentation":"The duration of the Vector Enrichment job, in seconds.
" + }, + "ErrorDetails":{ + "shape":"VectorEnrichmentJobErrorDetails", + "documentation":"Details about the errors generated during the Vector Enrichment job.
" + }, + "ExecutionRoleArn":{ + "shape":"ExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
" + }, + "ExportErrorDetails":{ + "shape":"VectorEnrichmentJobExportErrorDetails", + "documentation":"Details about the errors generated during the ExportVectorEnrichmentJob.
" + }, + "ExportStatus":{ + "shape":"VectorEnrichmentJobExportStatus", + "documentation":"The export status of the Vector Enrichment job being initiated.
" + }, + "InputConfig":{ + "shape":"VectorEnrichmentJobInputConfig", + "documentation":"Input configuration information for the Vector Enrichment job.
" + }, + "JobConfig":{ + "shape":"VectorEnrichmentJobConfig", + "documentation":"An object containing information about the job configuration.
" + }, + "KmsKeyId":{ + "shape":"KmsKey", + "documentation":"The Key Management Service key ID for server-side encryption.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the Vector Enrichment job.
" + }, + "Status":{ + "shape":"VectorEnrichmentJobStatus", + "documentation":"The status of the initiated Vector Enrichment job.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"Each tag consists of a key and a value.
" + }, + "Type":{ + "shape":"VectorEnrichmentJobType", + "documentation":"The type of the Vector Enrichment job being initiated.
" + } + } + }, + "GroupBy":{ + "type":"string", + "enum":[ + "ALL", + "YEARLY" + ] + }, + "ImageSourceBandList":{ + "type":"list", + "member":{"shape":"String"} + }, + "InputConfigInput":{ + "type":"structure", + "members":{ + "PreviousEarthObservationJobArn":{ + "shape":"EarthObservationJobArn", + "documentation":"The Amazon Resource Name (ARN) of the previous Earth Observation job.
" + }, + "RasterDataCollectionQuery":{ + "shape":"RasterDataCollectionQueryInput", + "documentation":"The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn,TimeRange and Property Filters.
" + } + }, + "documentation":"Input configuration information.
" + }, + "InputConfigOutput":{ + "type":"structure", + "members":{ + "PreviousEarthObservationJobArn":{ + "shape":"EarthObservationJobArn", + "documentation":"The Amazon Resource Name (ARN) of the previous Earth Observation job.
" + }, + "RasterDataCollectionQuery":{ + "shape":"RasterDataCollectionQueryOutput", + "documentation":"The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn, RasterDataCollectionName, TimeRange, and Property Filters.
" + } + }, + "documentation":"The InputConfig for an EarthObservationJob response.
" + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{ + "shape":"String", + "documentation":"" + } + }, + "documentation":"The request processing has failed because of an unknown error, exception, or failure.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "ItemSource":{ + "type":"structure", + "required":[ + "DateTime", + "Geometry", + "Id" + ], + "members":{ + "Assets":{ + "shape":"AssetsMap", + "documentation":"This is a dictionary of Asset Objects data associated with the Item that can be downloaded or streamed, each with a unique key.
" + }, + "DateTime":{ + "shape":"Timestamp", + "documentation":"The searchable date and time of the item, in UTC.
" + }, + "Geometry":{ + "shape":"Geometry", + "documentation":"The item Geometry in GeoJson format.
" + }, + "Id":{ + "shape":"String", + "documentation":"A unique Id for the source item.
" + }, + "Properties":{ + "shape":"Properties", + "documentation":"This field contains additional properties of the item.
" + } + }, + "documentation":"The structure representing the items in the response for SearchRasterDataCollection.
" + }, + "ItemSourceList":{ + "type":"list", + "member":{"shape":"ItemSource"} + }, + "JobConfigInput":{ + "type":"structure", + "members":{ + "BandMathConfig":{ + "shape":"BandMathConfigInput", + "documentation":"An object containing information about the job configuration for BandMath.
" + }, + "CloudMaskingConfig":{ + "shape":"CloudMaskingConfigInput", + "documentation":"An object containing information about the job configuration for cloud masking.
" + }, + "CloudRemovalConfig":{ + "shape":"CloudRemovalConfigInput", + "documentation":"An object containing information about the job configuration for cloud removal.
" + }, + "GeoMosaicConfig":{ + "shape":"GeoMosaicConfigInput", + "documentation":"An object containing information about the job configuration for geomosaic.
" + }, + "LandCoverSegmentationConfig":{ + "shape":"LandCoverSegmentationConfigInput", + "documentation":"An object containing information about the job configuration for land cover segmentation.
" + }, + "ResamplingConfig":{ + "shape":"ResamplingConfigInput", + "documentation":"An object containing information about the job configuration for resampling.
" + }, + "StackConfig":{ + "shape":"StackConfigInput", + "documentation":"An object containing information about the job configuration for a Stacking Earth Observation job.
" + }, + "TemporalStatisticsConfig":{ + "shape":"TemporalStatisticsConfigInput", + "documentation":"An object containing information about the job configuration for temporal statistics.
" + }, + "ZonalStatisticsConfig":{ + "shape":"ZonalStatisticsConfigInput", + "documentation":"An object containing information about the job configuration for zonal statistics.
" + } + }, + "documentation":"The input structure for the JobConfig in an EarthObservationJob.
", + "union":true + }, + "KmsKey":{ + "type":"string", + "max":2048, + "min":0 + }, + "LandCoverSegmentationConfigInput":{ + "type":"structure", + "members":{ + }, + "documentation":"The input structure for Land Cover Operation type.
" + }, + "LandsatCloudCoverLandInput":{ + "type":"structure", + "required":[ + "LowerBound", + "UpperBound" + ], + "members":{ + "LowerBound":{ + "shape":"Float", + "documentation":"The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value.
" + }, + "UpperBound":{ + "shape":"Float", + "documentation":"The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value.
" + } + }, + "documentation":"The structure representing Land Cloud Cover property for Landsat data collection.
" + }, + "LinearRing":{ + "type":"list", + "member":{"shape":"Position"}, + "min":4 + }, + "LinearRings":{ + "type":"list", + "member":{"shape":"LinearRing"}, + "min":1 + }, + "LinearRingsList":{ + "type":"list", + "member":{"shape":"LinearRings"} + }, + "ListEarthObservationJobInput":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListEarthObservationJobInputMaxResultsInteger", + "documentation":"The total number of items to return.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
" + }, + "SortBy":{ + "shape":"String", + "documentation":"The parameter by which to sort the results.
" + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"An optional value that specifies whether you want the results sorted in Ascending or Descending order.
A filter that retrieves only jobs with a specific status.
" + } + } + }, + "ListEarthObservationJobInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":20, + "min":1 + }, + "ListEarthObservationJobOutput":{ + "type":"structure", + "required":["EarthObservationJobSummaries"], + "members":{ + "EarthObservationJobSummaries":{ + "shape":"EarthObservationJobList", + "documentation":"Contains summary information about the Earth Observation jobs.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
" + } + } + }, + "ListEarthObservationJobOutputConfig":{ + "type":"structure", + "required":[ + "Arn", + "CreationTime", + "DurationInSeconds", + "Name", + "OperationType", + "Status" + ], + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the list of the Earth Observation jobs.
" + }, + "CreationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The creation time.
" + }, + "DurationInSeconds":{ + "shape":"Integer", + "documentation":"The duration of the session, in seconds.
" + }, + "Name":{ + "shape":"String", + "documentation":"The names of the Earth Observation jobs in the list.
" + }, + "OperationType":{ + "shape":"String", + "documentation":"The operation type for an Earth Observation job.
" + }, + "Status":{ + "shape":"EarthObservationJobStatus", + "documentation":"The status of the list of the Earth Observation jobs.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"Each tag consists of a key and a value.
" + } + }, + "documentation":"An object containing information about the output file.
" + }, + "ListRasterDataCollectionsInput":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListRasterDataCollectionsInputMaxResultsInteger", + "documentation":"The total number of items to return.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
", + "location":"querystring", + "locationName":"NextToken" + } + } + }, + "ListRasterDataCollectionsInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":20, + "min":1 + }, + "ListRasterDataCollectionsOutput":{ + "type":"structure", + "required":["RasterDataCollectionSummaries"], + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
" + }, + "RasterDataCollectionSummaries":{ + "shape":"DataCollectionsList", + "documentation":"Contains summary information about the raster data collection.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource you want to tag.
", + "location":"uri", + "locationName":"ResourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"Each tag consists of a key and a value.
" + } + } + }, + "ListVectorEnrichmentJobInput":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListVectorEnrichmentJobInputMaxResultsInteger", + "documentation":"The maximum number of items to return.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
" + }, + "SortBy":{ + "shape":"String", + "documentation":"The parameter by which to sort the results.
" + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"An optional value that specifies whether you want the results sorted in Ascending or Descending order.
A filter that retrieves only jobs with a specific status.
" + } + } + }, + "ListVectorEnrichmentJobInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":20, + "min":1 + }, + "ListVectorEnrichmentJobOutput":{ + "type":"structure", + "required":["VectorEnrichmentJobSummaries"], + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
" + }, + "VectorEnrichmentJobSummaries":{ + "shape":"VectorEnrichmentJobList", + "documentation":"Contains summary information about the Vector Enrichment jobs.
" + } + } + }, + "ListVectorEnrichmentJobOutputConfig":{ + "type":"structure", + "required":[ + "Arn", + "CreationTime", + "DurationInSeconds", + "Name", + "Status", + "Type" + ], + "members":{ + "Arn":{ + "shape":"VectorEnrichmentJobArn", + "documentation":"The Amazon Resource Name (ARN) of the list of the Vector Enrichment jobs.
" + }, + "CreationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The creation time.
" + }, + "DurationInSeconds":{ + "shape":"Integer", + "documentation":"The duration of the session, in seconds.
" + }, + "Name":{ + "shape":"String", + "documentation":"The names of the Vector Enrichment jobs in the list.
" + }, + "Status":{ + "shape":"VectorEnrichmentJobStatus", + "documentation":"The status of the Vector Enrichment jobs list.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"Each tag consists of a key and a value.
" + }, + "Type":{ + "shape":"VectorEnrichmentJobType", + "documentation":"The type of the list of Vector Enrichment jobs.
" + } + }, + "documentation":"An object containing information about the output file.
" + }, + "LogicalOperator":{ + "type":"string", + "enum":["AND"] + }, + "MapMatchingConfig":{ + "type":"structure", + "required":[ + "IdAttributeName", + "TimestampAttributeName", + "XAttributeName", + "YAttributeName" + ], + "members":{ + "IdAttributeName":{ + "shape":"String", + "documentation":"The field name for the data that describes the identifier representing a collection of GPS points belonging to an individual trace.
" + }, + "TimestampAttributeName":{ + "shape":"String", + "documentation":"The name of the timestamp attribute.
" + }, + "XAttributeName":{ + "shape":"String", + "documentation":"The name of the X-attribute
" + }, + "YAttributeName":{ + "shape":"String", + "documentation":"The name of the Y-attribute
" + } + }, + "documentation":"The input structure for Map Matching operation type.
" + }, + "MultiPolygonGeometryInput":{ + "type":"structure", + "required":["Coordinates"], + "members":{ + "Coordinates":{ + "shape":"LinearRingsList", + "documentation":"The coordinates of the multipolygon geometry.
" + } + }, + "documentation":"The structure representing Polygon Geometry based on the GeoJson spec.
" + }, + "NextToken":{ + "type":"string", + "max":8192, + "min":0, + "sensitive":true + }, + "Operation":{ + "type":"structure", + "required":[ + "Equation", + "Name" + ], + "members":{ + "Equation":{ + "shape":"String", + "documentation":"Textual representation of the math operation; Equation used to compute the spectral index.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the operation.
" + }, + "OutputType":{ + "shape":"OutputType", + "documentation":"The type of the operation.
" + } + }, + "documentation":"Represents an arithmetic operation to compute spectral index.
" + }, + "OperationsListInput":{ + "type":"list", + "member":{"shape":"Operation"}, + "min":1 + }, + "OutputBand":{ + "type":"structure", + "required":[ + "BandName", + "OutputDataType" + ], + "members":{ + "BandName":{ + "shape":"String", + "documentation":"The name of the band.
" + }, + "OutputDataType":{ + "shape":"OutputType", + "documentation":"The datatype of the output band.
" + } + }, + "documentation":"A single EarthObservationJob output band.
" + }, + "OutputConfigInput":{ + "type":"structure", + "required":["S3Data"], + "members":{ + "S3Data":{ + "shape":"ExportS3DataInput", + "documentation":"Path to Amazon S3 storage location for the output configuration file.
" + } + }, + "documentation":"The response structure for an OutputConfig returned by an ExportEarthObservationJob.
" + }, + "OutputResolutionResamplingInput":{ + "type":"structure", + "required":["UserDefined"], + "members":{ + "UserDefined":{ + "shape":"UserDefined", + "documentation":"User Defined Resolution for the output of Resampling operation defined by value and unit.
" + } + }, + "documentation":"OutputResolution Configuration indicating the target resolution for the output of Resampling operation.
" + }, + "OutputResolutionStackInput":{ + "type":"structure", + "members":{ + "Predefined":{ + "shape":"PredefinedResolution", + "documentation":"A string value representing Predefined Output Resolution for a stacking operation. Allowed values are HIGHEST, LOWEST, and AVERAGE.
The structure representing User Output Resolution for a Stacking operation defined as a value and unit.
" + } + }, + "documentation":"The input structure representing Output Resolution for Stacking Operation.
" + }, + "OutputType":{ + "type":"string", + "enum":[ + "INT32", + "FLOAT32", + "INT16", + "FLOAT64", + "UINT16" + ] + }, + "PlatformInput":{ + "type":"structure", + "required":["Value"], + "members":{ + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"The ComparisonOperator to use with PlatformInput.
" + }, + "Value":{ + "shape":"String", + "documentation":"The value of the platform.
" + } + }, + "documentation":"The input structure for specifying Platform. Platform refers to the unique name of the specific platform the instrument is attached to. For satellites it is the name of the satellite, eg. landsat-8 (Landsat-8), sentinel-2a.
" + }, + "PolygonGeometryInput":{ + "type":"structure", + "required":["Coordinates"], + "members":{ + "Coordinates":{ + "shape":"LinearRings", + "documentation":"Coordinates representing a Polygon based on the GeoJson spec.
" + } + }, + "documentation":"The structure representing Polygon Geometry based on the GeoJson spec.
" + }, + "Position":{ + "type":"list", + "member":{"shape":"Double"}, + "max":2, + "min":2, + "sensitive":true + }, + "PredefinedResolution":{ + "type":"string", + "enum":[ + "HIGHEST", + "LOWEST", + "AVERAGE" + ] + }, + "Properties":{ + "type":"structure", + "members":{ + "EoCloudCover":{ + "shape":"Float", + "documentation":"Estimate of cloud cover.
" + }, + "LandsatCloudCoverLand":{ + "shape":"Float", + "documentation":"Land cloud cover for Landsat Data Collection.
" + }, + "Platform":{ + "shape":"String", + "documentation":"Platform property. Platform refers to the unique name of the specific platform the instrument is attached to. For satellites it is the name of the satellite, eg. landsat-8 (Landsat-8), sentinel-2a.
" + }, + "ViewOffNadir":{ + "shape":"Float", + "documentation":"The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).
" + }, + "ViewSunAzimuth":{ + "shape":"Float", + "documentation":"The sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360).
" + }, + "ViewSunElevation":{ + "shape":"Float", + "documentation":"The sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90-90). Negative values indicate the sun is below the horizon, e.g. sun elevation of -10° means the data was captured during nautical twilight.
" + } + }, + "documentation":"Properties associated with the Item.
" + }, + "Property":{ + "type":"structure", + "members":{ + "EoCloudCover":{ + "shape":"EoCloudCoverInput", + "documentation":"The structure representing EoCloudCover property filter containing a lower bound and upper bound.
" + }, + "LandsatCloudCoverLand":{ + "shape":"LandsatCloudCoverLandInput", + "documentation":"The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound.
" + }, + "Platform":{ + "shape":"PlatformInput", + "documentation":"The structure representing Platform property filter consisting of value and comparison operator.
" + }, + "ViewOffNadir":{ + "shape":"ViewOffNadirInput", + "documentation":"The structure representing ViewOffNadir property filter containing a lower bound and upper bound.
" + }, + "ViewSunAzimuth":{ + "shape":"ViewSunAzimuthInput", + "documentation":"The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound.
" + }, + "ViewSunElevation":{ + "shape":"ViewSunElevationInput", + "documentation":"The structure representing ViewSunElevation property filter containing a lower bound and upper bound.
" + } + }, + "documentation":"Represents a single searchable property to search on.
", + "union":true + }, + "PropertyFilter":{ + "type":"structure", + "required":["Property"], + "members":{ + "Property":{ + "shape":"Property", + "documentation":"Represents a single property to match with when searching a raster data collection.
" + } + }, + "documentation":"The structure representing a single PropertyFilter.
" + }, + "PropertyFilters":{ + "type":"structure", + "members":{ + "LogicalOperator":{ + "shape":"LogicalOperator", + "documentation":"The Logical Operator used to combine the Property Filters.
" + }, + "Properties":{ + "shape":"PropertyFiltersList", + "documentation":"A list of Property Filters.
" + } + }, + "documentation":"A list of PropertyFilter objects.
" + }, + "PropertyFiltersList":{ + "type":"list", + "member":{"shape":"PropertyFilter"} + }, + "RasterDataCollectionMetadata":{ + "type":"structure", + "required":[ + "Arn", + "Description", + "Name", + "SupportedFilters", + "Type" + ], + "members":{ + "Arn":{ + "shape":"DataCollectionArn", + "documentation":"The Amazon Resource Name (ARN) of the raster data collection.
" + }, + "Description":{ + "shape":"String", + "documentation":"A description of the raster data collection.
" + }, + "DescriptionPageUrl":{ + "shape":"String", + "documentation":"The description URL of the raster data collection.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the raster data collection.
" + }, + "SupportedFilters":{ + "shape":"FilterList", + "documentation":"The list of filters supported by the raster data collection.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"Each tag consists of a key and a value.
" + }, + "Type":{ + "shape":"DataCollectionType", + "documentation":"The type of raster data collection.
" + } + }, + "documentation":"Response object containing details for a specific RasterDataCollection.
" + }, + "RasterDataCollectionQueryInput":{ + "type":"structure", + "required":[ + "RasterDataCollectionArn", + "TimeRangeFilter" + ], + "members":{ + "AreaOfInterest":{ + "shape":"AreaOfInterest", + "documentation":"The area of interest being queried for the raster data collection.
" + }, + "PropertyFilters":{ + "shape":"PropertyFilters", + "documentation":"The list of Property filters used in the Raster Data Collection Query.
" + }, + "RasterDataCollectionArn":{ + "shape":"DataCollectionArn", + "documentation":"The Amazon Resource Name (ARN) of the raster data collection.
" + }, + "TimeRangeFilter":{ + "shape":"TimeRangeFilterInput", + "documentation":"The TimeRange Filter used in the RasterDataCollection Query.
" + } + }, + "documentation":"The input structure for Raster Data Collection Query containing the Area of Interest, TimeRange Filters, and Property Filters.
" + }, + "RasterDataCollectionQueryOutput":{ + "type":"structure", + "required":[ + "RasterDataCollectionArn", + "RasterDataCollectionName", + "TimeRangeFilter" + ], + "members":{ + "AreaOfInterest":{ + "shape":"AreaOfInterest", + "documentation":"The Area of Interest used in the search.
" + }, + "PropertyFilters":{ + "shape":"PropertyFilters", + "documentation":"Property filters used in the search.
" + }, + "RasterDataCollectionArn":{ + "shape":"DataCollectionArn", + "documentation":"The ARN of the Raster Data Collection against which the search is done.
" + }, + "RasterDataCollectionName":{ + "shape":"String", + "documentation":"The name of the raster data collection.
" + }, + "TimeRangeFilter":{ + "shape":"TimeRangeFilterOutput", + "documentation":"The TimeRange filter used in the search.
" + } + }, + "documentation":"The output structure contains the Raster Data Collection Query input along with some additional metadata.
" + }, + "RasterDataCollectionQueryWithBandFilterInput":{ + "type":"structure", + "required":["TimeRangeFilter"], + "members":{ + "AreaOfInterest":{ + "shape":"AreaOfInterest", + "documentation":"The Area of interest to be used in the search query.
" + }, + "BandFilter":{ + "shape":"StringListInput", + "documentation":"The list of Bands to be displayed in the result for each item.
" + }, + "PropertyFilters":{ + "shape":"PropertyFilters", + "documentation":"The Property Filters used in the search query.
" + }, + "TimeRangeFilter":{ + "shape":"TimeRangeFilterInput", + "documentation":"The TimeRange Filter used in the search query.
" + } + }, + "documentation":"This is a RasterDataCollectionQueryInput containing AreaOfInterest, Time Range filter and Property filters.
" + }, + "ResamplingConfigInput":{ + "type":"structure", + "required":["OutputResolution"], + "members":{ + "AlgorithmName":{ + "shape":"AlgorithmNameResampling", + "documentation":"The name of the algorithm used for resampling.
" + }, + "OutputResolution":{ + "shape":"OutputResolutionResamplingInput", + "documentation":"The structure representing output resolution (in target georeferenced units) of the result of resampling operation.
" + }, + "TargetBands":{ + "shape":"StringListInput", + "documentation":"Bands used in the operation. If no target bands are specified, it uses all bands available in the input.
" + } + }, + "documentation":"The structure representing input for resampling operation.
" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{ + "shape":"String", + "documentation":"Identifier of the resource that was not found.
" + } + }, + "documentation":"The request references a resource which does not exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReverseGeocodingConfig":{ + "type":"structure", + "required":[ + "XAttributeName", + "YAttributeName" + ], + "members":{ + "XAttributeName":{ + "shape":"String", + "documentation":"The field name for the data that describes x-axis coordinate, eg. longitude of a point.
" + }, + "YAttributeName":{ + "shape":"String", + "documentation":"The field name for the data that describes y-axis coordinate, eg. latitude of a point.
" + } + }, + "documentation":"The input structure for Reverse Geocoding operation type.
" + }, + "S3Uri":{ + "type":"string", + "pattern":"^s3://([^/]+)/?(.*)$" + }, + "SearchRasterDataCollectionInput":{ + "type":"structure", + "required":[ + "Arn", + "RasterDataCollectionQuery" + ], + "members":{ + "Arn":{ + "shape":"DataCollectionArn", + "documentation":"The Amazon Resource Name (ARN) of the raster data collection.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
" + }, + "RasterDataCollectionQuery":{ + "shape":"RasterDataCollectionQueryWithBandFilterInput", + "documentation":"RasterDataCollectionQuery consisting of AreaOfInterest(AOI), PropertyFilters and TimeRangeFilterInput used in SearchRasterDataCollection.
" + } + } + }, + "SearchRasterDataCollectionOutput":{ + "type":"structure", + "required":["ApproximateResultCount"], + "members":{ + "ApproximateResultCount":{ + "shape":"Integer", + "documentation":"Approximate number of results in the response.
" + }, + "Items":{ + "shape":"ItemSourceList", + "documentation":"List of items matching the Raster DataCollectionQuery.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
" + } + } + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{ + "shape":"String", + "documentation":"Identifier of the resource affected.
" + } + }, + "documentation":"You have exceeded the service quota.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SortOrder":{ + "type":"string", + "enum":[ + "ASCENDING", + "DESCENDING" + ] + }, + "StackConfigInput":{ + "type":"structure", + "members":{ + "OutputResolution":{ + "shape":"OutputResolutionStackInput", + "documentation":"The structure representing output resolution (in target georeferenced units) of the result of stacking operation.
" + }, + "TargetBands":{ + "shape":"StringListInput", + "documentation":"A list of bands to be stacked in the specified order. When the parameter is not provided, all the available bands in the data collection are stacked in the alphabetical order of their asset names.
" + } + }, + "documentation":"The input structure for Stacking Operation.
" + }, + "StartEarthObservationJobInput":{ + "type":"structure", + "required":[ + "ExecutionRoleArn", + "InputConfig", + "JobConfig", + "Name" + ], + "members":{ + "ClientToken":{ + "shape":"StartEarthObservationJobInputClientTokenString", + "documentation":"A unique token that guarantees that the call to this API is idempotent.
", + "idempotencyToken":true + }, + "ExecutionRoleArn":{ + "shape":"ExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
" + }, + "InputConfig":{ + "shape":"InputConfigInput", + "documentation":"Input configuration information for the Earth Observation job.
" + }, + "JobConfig":{ + "shape":"JobConfigInput", + "documentation":"An object containing information about the job configuration.
" + }, + "KmsKeyId":{ + "shape":"KmsKey", + "documentation":"The Key Management Service key ID for server-side encryption.
" + }, + "Name":{ + "shape":"StartEarthObservationJobInputNameString", + "documentation":"The name of the Earth Observation job.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"Each tag consists of a key and a value.
" + } + } + }, + "StartEarthObservationJobInputClientTokenString":{ + "type":"string", + "max":64, + "min":36 + }, + "StartEarthObservationJobInputNameString":{ + "type":"string", + "max":200, + "min":0 + }, + "StartEarthObservationJobOutput":{ + "type":"structure", + "required":[ + "Arn", + "CreationTime", + "DurationInSeconds", + "ExecutionRoleArn", + "JobConfig", + "Name", + "Status" + ], + "members":{ + "Arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the Earth Observation job.
" + }, + "CreationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The creation time.
" + }, + "DurationInSeconds":{ + "shape":"Integer", + "documentation":"The duration of the session, in seconds.
" + }, + "ExecutionRoleArn":{ + "shape":"ExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
" + }, + "InputConfig":{ + "shape":"InputConfigOutput", + "documentation":"Input configuration information for the Earth Observation job.
" + }, + "JobConfig":{ + "shape":"JobConfigInput", + "documentation":"An object containing information about the job configuration.
" + }, + "KmsKeyId":{ + "shape":"KmsKey", + "documentation":"The Key Management Service key ID for server-side encryption.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the Earth Observation job.
" + }, + "Status":{ + "shape":"EarthObservationJobStatus", + "documentation":"The status of the Earth Observation job.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"Each tag consists of a key and a value.
" + } + } + }, + "StartVectorEnrichmentJobInput":{ + "type":"structure", + "required":[ + "ExecutionRoleArn", + "InputConfig", + "JobConfig", + "Name" + ], + "members":{ + "ClientToken":{ + "shape":"StartVectorEnrichmentJobInputClientTokenString", + "documentation":"A unique token that guarantees that the call to this API is idempotent.
", + "idempotencyToken":true + }, + "ExecutionRoleArn":{ + "shape":"ExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
" + }, + "InputConfig":{ + "shape":"VectorEnrichmentJobInputConfig", + "documentation":"Input configuration information for the Vector Enrichment job.
" + }, + "JobConfig":{ + "shape":"VectorEnrichmentJobConfig", + "documentation":"An object containing information about the job configuration.
" + }, + "KmsKeyId":{ + "shape":"KmsKey", + "documentation":"The Key Management Service key ID for server-side encryption.
" + }, + "Name":{ + "shape":"StartVectorEnrichmentJobInputNameString", + "documentation":"The name of the Vector Enrichment job.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"Each tag consists of a key and a value.
" + } + } + }, + "StartVectorEnrichmentJobInputClientTokenString":{ + "type":"string", + "max":64, + "min":36 + }, + "StartVectorEnrichmentJobInputNameString":{ + "type":"string", + "max":200, + "min":0 + }, + "StartVectorEnrichmentJobOutput":{ + "type":"structure", + "required":[ + "Arn", + "CreationTime", + "DurationInSeconds", + "ExecutionRoleArn", + "InputConfig", + "JobConfig", + "Name", + "Status", + "Type" + ], + "members":{ + "Arn":{ + "shape":"VectorEnrichmentJobArn", + "documentation":"The Amazon Resource Name (ARN) of the Vector Enrichment job.
" + }, + "CreationTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The creation time.
" + }, + "DurationInSeconds":{ + "shape":"Integer", + "documentation":"The duration of the Vector Enrichment job, in seconds.
" + }, + "ExecutionRoleArn":{ + "shape":"ExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
" + }, + "InputConfig":{ + "shape":"VectorEnrichmentJobInputConfig", + "documentation":"Input configuration information for starting the Vector Enrichment job.
" + }, + "JobConfig":{ + "shape":"VectorEnrichmentJobConfig", + "documentation":"An object containing information about the job configuration.
" + }, + "KmsKeyId":{ + "shape":"KmsKey", + "documentation":"The Key Management Service key ID for server-side encryption.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the Vector Enrichment job.
" + }, + "Status":{ + "shape":"VectorEnrichmentJobStatus", + "documentation":"The status of the Vector Enrichment job being started.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"Each tag consists of a key and a value.
" + }, + "Type":{ + "shape":"VectorEnrichmentJobType", + "documentation":"The type of the Vector Enrichment job.
" + } + } + }, + "StopEarthObservationJobInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"EarthObservationJobArn", + "documentation":"The Amazon Resource Name (ARN) of the Earth Observation job being stopped.
" + } + } + }, + "StopEarthObservationJobOutput":{ + "type":"structure", + "members":{ + } + }, + "StopVectorEnrichmentJobInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"VectorEnrichmentJobArn", + "documentation":"The Amazon Resource Name (ARN) of the Vector Enrichment job.
" + } + } + }, + "StopVectorEnrichmentJobOutput":{ + "type":"structure", + "members":{ + } + }, + "String":{"type":"string"}, + "StringListInput":{ + "type":"list", + "member":{"shape":"String"}, + "min":1 + }, + "SyntheticTimestamp_date_time":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"String"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource you want to tag.
", + "location":"uri", + "locationName":"ResourceArn" + }, + "Tags":{ + "shape":"Tags", + "documentation":"Each tag consists of a key and a value.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "Tags":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "TargetOptions":{ + "type":"string", + "enum":[ + "INPUT", + "OUTPUT" + ] + }, + "TemporalStatistics":{ + "type":"string", + "enum":[ + "MEAN", + "MEDIAN", + "STANDARD_DEVIATION" + ] + }, + "TemporalStatisticsConfigInput":{ + "type":"structure", + "required":["Statistics"], + "members":{ + "GroupBy":{ + "shape":"GroupBy", + "documentation":"The input for the temporal statistics grouping by time frequency option.
" + }, + "Statistics":{ + "shape":"TemporalStatisticsListInput", + "documentation":"The list of the statistics method options.
" + }, + "TargetBands":{ + "shape":"StringListInput", + "documentation":"The list of target band names for the temporal statistic to calculate.
" + } + }, + "documentation":"The structure representing the configuration for Temporal Statistics operation.
" + }, + "TemporalStatisticsListInput":{ + "type":"list", + "member":{"shape":"TemporalStatistics"}, + "min":1 + }, + "ThrottlingException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{ + "shape":"String", + "documentation":"" + } + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "TimeRangeFilterInput":{ + "type":"structure", + "required":[ + "EndTime", + "StartTime" + ], + "members":{ + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end time for the time-range filter.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start time for the time-range filter.
" + } + }, + "documentation":"The input for the time-range filter.
", + "sensitive":true + }, + "TimeRangeFilterOutput":{ + "type":"structure", + "required":[ + "EndTime", + "StartTime" + ], + "members":{ + "EndTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The ending time for the time range filter.
" + }, + "StartTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The starting time for the time range filter.
" + } + }, + "documentation":"The output structure of the time range filter.
", + "sensitive":true + }, + "Timestamp":{"type":"timestamp"}, + "Unit":{ + "type":"string", + "enum":["METERS"] + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource you want to untag.
", + "location":"uri", + "locationName":"ResourceArn" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"Keys of the tags you want to remove.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UserDefined":{ + "type":"structure", + "required":[ + "Unit", + "Value" + ], + "members":{ + "Unit":{ + "shape":"Unit", + "documentation":"The units for output resolution of the result.
" + }, + "Value":{ + "shape":"Float", + "documentation":"The value for output resolution of the result.
" + } + }, + "documentation":"The output resolution (in target georeferenced units) of the result of the operation
" + }, + "ValidationException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{ + "shape":"String", + "documentation":"" + } + }, + "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "VectorEnrichmentJobArn":{ + "type":"string", + "pattern":"^arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:vector-enrichment-job/[a-z0-9]{12,}$" + }, + "VectorEnrichmentJobConfig":{ + "type":"structure", + "members":{ + "MapMatchingConfig":{ + "shape":"MapMatchingConfig", + "documentation":"The input structure for Map Matching operation type.
" + }, + "ReverseGeocodingConfig":{ + "shape":"ReverseGeocodingConfig", + "documentation":"The input structure for Reverse Geocoding operation type.
" + } + }, + "documentation":"It contains configs such as ReverseGeocodingConfig and MapMatchingConfig.
", + "union":true + }, + "VectorEnrichmentJobDataSourceConfigInput":{ + "type":"structure", + "members":{ + "S3Data":{ + "shape":"VectorEnrichmentJobS3Data", + "documentation":"The input structure for the Amazon S3 data that represents the Amazon S3 location of the input data objects.
" + } + }, + "documentation":"The input structure for the data source that represents the storage type of the input data objects.
", + "union":true + }, + "VectorEnrichmentJobDocumentType":{ + "type":"string", + "enum":["CSV"] + }, + "VectorEnrichmentJobErrorDetails":{ + "type":"structure", + "members":{ + "ErrorMessage":{ + "shape":"String", + "documentation":"A message that you define and then is processed and rendered by the Vector Enrichment job when the error occurs.
" + }, + "ErrorType":{ + "shape":"VectorEnrichmentJobErrorType", + "documentation":"The type of error generated during the Vector Enrichment job.
" + } + }, + "documentation":"VectorEnrichmentJob error details in response from GetVectorEnrichmentJob.
" + }, + "VectorEnrichmentJobErrorType":{ + "type":"string", + "enum":[ + "CLIENT_ERROR", + "SERVER_ERROR" + ] + }, + "VectorEnrichmentJobExportErrorDetails":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"The message providing details about the errors generated during the Vector Enrichment job.
" + }, + "Type":{ + "shape":"VectorEnrichmentJobExportErrorType", + "documentation":"The output error details for an Export operation on a Vector Enrichment job.
" + } + }, + "documentation":"VectorEnrichmentJob export error details in response from GetVectorEnrichmentJob.
" + }, + "VectorEnrichmentJobExportErrorType":{ + "type":"string", + "enum":[ + "CLIENT_ERROR", + "SERVER_ERROR" + ] + }, + "VectorEnrichmentJobExportStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ] + }, + "VectorEnrichmentJobInputConfig":{ + "type":"structure", + "required":[ + "DataSourceConfig", + "DocumentType" + ], + "members":{ + "DataSourceConfig":{ + "shape":"VectorEnrichmentJobDataSourceConfigInput", + "documentation":"The input structure for the data source that represents the storage type of the input data objects.
" + }, + "DocumentType":{ + "shape":"VectorEnrichmentJobDocumentType", + "documentation":"The input structure that defines the data source file type.
" + } + }, + "documentation":"The input structure for the InputConfig in a VectorEnrichmentJob.
" + }, + "VectorEnrichmentJobList":{ + "type":"list", + "member":{"shape":"ListVectorEnrichmentJobOutputConfig"} + }, + "VectorEnrichmentJobS3Data":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "KmsKeyId":{ + "shape":"KmsKey", + "documentation":"The Key Management Service key ID for server-side encryption.
" + }, + "S3Uri":{ + "shape":"S3Uri", + "documentation":"The URL to the Amazon S3 data for the Vector Enrichment job.
" + } + }, + "documentation":"The Amazon S3 data for the Vector Enrichment job.
" + }, + "VectorEnrichmentJobStatus":{ + "type":"string", + "enum":[ + "INITIALIZING", + "IN_PROGRESS", + "STOPPING", + "STOPPED", + "COMPLETED", + "FAILED", + "DELETING", + "DELETED" + ] + }, + "VectorEnrichmentJobType":{ + "type":"string", + "enum":[ + "REVERSE_GEOCODING", + "MAP_MATCHING" + ] + }, + "ViewOffNadirInput":{ + "type":"structure", + "required":[ + "LowerBound", + "UpperBound" + ], + "members":{ + "LowerBound":{ + "shape":"Float", + "documentation":"The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value.
" + }, + "UpperBound":{ + "shape":"Float", + "documentation":"The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value.
" + } + }, + "documentation":"The input structure for specifying ViewOffNadir property filter. ViewOffNadir refers to the angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).
" + }, + "ViewSunAzimuthInput":{ + "type":"structure", + "required":[ + "LowerBound", + "UpperBound" + ], + "members":{ + "LowerBound":{ + "shape":"Float", + "documentation":"The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value.
" + }, + "UpperBound":{ + "shape":"Float", + "documentation":"The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value.
" + } + }, + "documentation":"The input structure for specifying ViewSunAzimuth property filter. ViewSunAzimuth refers to the Sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360).
" + }, + "ViewSunElevationInput":{ + "type":"structure", + "required":[ + "LowerBound", + "UpperBound" + ], + "members":{ + "LowerBound":{ + "shape":"Float", + "documentation":"The lower bound to view the sun elevation.
" + }, + "UpperBound":{ + "shape":"Float", + "documentation":"The upper bound to view the sun elevation.
" + } + }, + "documentation":"The input structure for specifying ViewSunElevation angle property filter.
" + }, + "ZonalStatistics":{ + "type":"string", + "enum":[ + "MEAN", + "MEDIAN", + "STANDARD_DEVIATION", + "MAX", + "MIN", + "SUM" + ] + }, + "ZonalStatisticsConfigInput":{ + "type":"structure", + "required":[ + "Statistics", + "ZoneS3Path" + ], + "members":{ + "Statistics":{ + "shape":"ZonalStatisticsListInput", + "documentation":"List of zonal statistics to compute.
" + }, + "TargetBands":{ + "shape":"StringListInput", + "documentation":"Bands used in the operation. If no target bands are specified, it uses all bands available input.
" + }, + "ZoneS3Path":{ + "shape":"S3Uri", + "documentation":"The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.
" + }, + "ZoneS3PathKmsKeyId":{ + "shape":"KmsKey", + "documentation":"The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
// Amazon Resource Name (ARN) of a KMS Key
\"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>\"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
" + } + }, + "documentation":"The structure representing input configuration of ZonalStatistics operation.
" + }, + "ZonalStatisticsListInput":{ + "type":"list", + "member":{"shape":"ZonalStatistics"}, + "min":1 + } + }, + "documentation":"Provides APIs for creating and managing SageMaker geospatial resources.
" +} diff --git a/testbed/boto__botocore/botocore/data/sagemaker-metrics/2022-09-30/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/sagemaker-metrics/2022-09-30/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..037361e96f69b826ad07e24e6017909f18e8864e --- /dev/null +++ b/testbed/boto__botocore/botocore/data/sagemaker-metrics/2022-09-30/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://metrics.sagemaker-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://metrics.sagemaker-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://metrics.sagemaker.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://metrics.sagemaker.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/sagemaker-metrics/2022-09-30/paginators-1.json b/testbed/boto__botocore/botocore/data/sagemaker-metrics/2022-09-30/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..ea142457a6a77d6e6a54942329f1199bc2f2a60c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/sagemaker-metrics/2022-09-30/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/testbed/boto__botocore/botocore/data/sagemaker-metrics/2022-09-30/service-2.json b/testbed/boto__botocore/botocore/data/sagemaker-metrics/2022-09-30/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..74c09d9ebd76a7092e61dba37bc6d9a34d8fd71e --- /dev/null +++ b/testbed/boto__botocore/botocore/data/sagemaker-metrics/2022-09-30/service-2.json @@ -0,0 +1,304 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-09-30", + "endpointPrefix":"metrics.sagemaker", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceAbbreviation":"SageMaker Metrics", + "serviceFullName":"Amazon SageMaker Metrics Service", + "serviceId":"SageMaker Metrics", + "signatureVersion":"v4", + "signingName":"sagemaker", + "uid":"sagemaker-metrics-2022-09-30", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "BatchGetMetrics":{ + "name":"BatchGetMetrics", + "http":{ + "method":"POST", + "requestUri":"/BatchGetMetrics" + }, + "input":{"shape":"BatchGetMetricsRequest"}, + "output":{"shape":"BatchGetMetricsResponse"}, + "documentation":"Used to retrieve training metrics from SageMaker.
" + }, + "BatchPutMetrics":{ + "name":"BatchPutMetrics", + "http":{ + "method":"PUT", + "requestUri":"/BatchPutMetrics" + }, + "input":{"shape":"BatchPutMetricsRequest"}, + "output":{"shape":"BatchPutMetricsResponse"}, + "documentation":"Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio.
" + } + }, + "shapes":{ + "BatchGetMetricsRequest":{ + "type":"structure", + "required":["MetricQueries"], + "members":{ + "MetricQueries":{ + "shape":"MetricQueryList", + "documentation":"Queries made to retrieve training metrics from SageMaker.
" + } + } + }, + "BatchGetMetricsResponse":{ + "type":"structure", + "members":{ + "MetricQueryResults":{ + "shape":"MetricQueryResultList", + "documentation":"The results of a query to retrieve training metrics from SageMaker.
" + } + } + }, + "BatchPutMetricsError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"PutMetricsErrorCode", + "documentation":"The error code of an error that occured when attempting to put metrics.
METRIC_LIMIT_EXCEEDED: The maximum amount of metrics per resource is exceeded.
INTERNAL_ERROR: An internal error occured.
VALIDATION_ERROR: The metric data failed validation.
CONFLICT_ERROR: Multiple requests attempted to modify the same data simultaneously.
An index that corresponds to the metric in the request.
" + } + }, + "documentation":"An error that occured when putting the metric data.
" + }, + "BatchPutMetricsErrorList":{ + "type":"list", + "member":{"shape":"BatchPutMetricsError"}, + "max":10, + "min":1 + }, + "BatchPutMetricsRequest":{ + "type":"structure", + "required":[ + "TrialComponentName", + "MetricData" + ], + "members":{ + "TrialComponentName":{ + "shape":"ExperimentEntityName", + "documentation":"The name of the Trial Component to associate with the metrics. The Trial Component name must be entirely lowercase.
" + }, + "MetricData":{ + "shape":"RawMetricDataList", + "documentation":"A list of raw metric values to put.
" + } + } + }, + "BatchPutMetricsResponse":{ + "type":"structure", + "members":{ + "Errors":{ + "shape":"BatchPutMetricsErrorList", + "documentation":"Lists any errors that occur when inserting metric data.
" + } + } + }, + "Double":{"type":"double"}, + "ExperimentEntityName":{ + "type":"string", + "max":120, + "min":1, + "pattern":"^[a-z0-9](-*[a-z0-9]){0,119}" + }, + "Integer":{"type":"integer"}, + "Long":{"type":"long"}, + "Message":{ + "type":"string", + "max":2048, + "pattern":".*" + }, + "MetricName":{ + "type":"string", + "max":255, + "min":1, + "pattern":".+" + }, + "MetricQuery":{ + "type":"structure", + "required":[ + "MetricName", + "ResourceArn", + "MetricStat", + "Period", + "XAxisType" + ], + "members":{ + "MetricName":{ + "shape":"MetricName", + "documentation":"The name of the metric to retrieve.
" + }, + "ResourceArn":{ + "shape":"SageMakerResourceArn", + "documentation":"The ARN of the SageMaker resource to retrieve metrics for.
" + }, + "MetricStat":{ + "shape":"MetricStatistic", + "documentation":"The metrics stat type of metrics to retrieve.
" + }, + "Period":{ + "shape":"Period", + "documentation":"The time period of metrics to retrieve.
" + }, + "XAxisType":{ + "shape":"XAxisType", + "documentation":"The x-axis type of metrics to retrieve.
" + }, + "Start":{ + "shape":"Long", + "documentation":"The start time of metrics to retrieve.
", + "box":true + }, + "End":{ + "shape":"Long", + "documentation":"The end time of metrics to retrieve.
", + "box":true + } + }, + "documentation":"Specifies a query to retrieve training metrics from SageMaker.
" + }, + "MetricQueryList":{ + "type":"list", + "member":{"shape":"MetricQuery"}, + "max":100, + "min":1 + }, + "MetricQueryResult":{ + "type":"structure", + "required":[ + "Status", + "XAxisValues", + "MetricValues" + ], + "members":{ + "Status":{ + "shape":"MetricQueryResultStatus", + "documentation":"The status of the metric query.
" + }, + "Message":{ + "shape":"Message", + "documentation":"A message describing the status of the metric query.
" + }, + "XAxisValues":{ + "shape":"XAxisValues", + "documentation":"The values for the x-axis of the metrics.
" + }, + "MetricValues":{ + "shape":"MetricValues", + "documentation":"The metric values retrieved by the query.
" + } + }, + "documentation":"The result of a query to retrieve training metrics from SageMaker.
" + }, + "MetricQueryResultList":{ + "type":"list", + "member":{"shape":"MetricQueryResult"}, + "max":100, + "min":1 + }, + "MetricQueryResultStatus":{ + "type":"string", + "enum":[ + "Complete", + "Truncated", + "InternalError", + "ValidationError" + ] + }, + "MetricStatistic":{ + "type":"string", + "enum":[ + "Min", + "Max", + "Avg", + "Count", + "StdDev", + "Last" + ] + }, + "MetricValues":{ + "type":"list", + "member":{"shape":"Double"} + }, + "Period":{ + "type":"string", + "enum":[ + "OneMinute", + "FiveMinute", + "OneHour", + "IterationNumber" + ] + }, + "PutMetricsErrorCode":{ + "type":"string", + "enum":[ + "METRIC_LIMIT_EXCEEDED", + "INTERNAL_ERROR", + "VALIDATION_ERROR", + "CONFLICT_ERROR" + ] + }, + "RawMetricData":{ + "type":"structure", + "required":[ + "MetricName", + "Timestamp", + "Value" + ], + "members":{ + "MetricName":{ + "shape":"MetricName", + "documentation":"The name of the metric.
" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"The time that the metric was recorded.
" + }, + "Step":{ + "shape":"Step", + "documentation":"The metric step (epoch).
" + }, + "Value":{ + "shape":"Double", + "documentation":"The metric value.
" + } + }, + "documentation":"The raw metric data to associate with the resource.
" + }, + "RawMetricDataList":{ + "type":"list", + "member":{"shape":"RawMetricData"}, + "max":10, + "min":1 + }, + "SageMakerResourceArn":{ + "type":"string", + "max":2048, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-].*/.*" + }, + "Step":{ + "type":"integer", + "min":0 + }, + "Timestamp":{"type":"timestamp"}, + "XAxisType":{ + "type":"string", + "enum":[ + "IterationNumber", + "Timestamp" + ] + }, + "XAxisValues":{ + "type":"list", + "member":{"shape":"Long"} + } + }, + "documentation":"Contains all data plane API operations and data types for Amazon SageMaker Metrics. Use these APIs to put and retrieve (get) features related to your training run.
" +} diff --git a/testbed/boto__botocore/botocore/data/scheduler/2021-06-30/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/scheduler/2021-06-30/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..4913426138fb93a4c141e3eb7760dedfe29f8a6c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/scheduler/2021-06-30/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://scheduler-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://scheduler-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://scheduler.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://scheduler.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/scheduler/2021-06-30/paginators-1.json b/testbed/boto__botocore/botocore/data/scheduler/2021-06-30/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..93b98ee2e05f7c806e41363f8f7fbfe92190039e --- /dev/null +++ b/testbed/boto__botocore/botocore/data/scheduler/2021-06-30/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListScheduleGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ScheduleGroups" + }, + "ListSchedules": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Schedules" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/scheduler/2021-06-30/service-2.json b/testbed/boto__botocore/botocore/data/scheduler/2021-06-30/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..f9dbfdb1ccbfa1fe6aae266a9693517fdc18cf12 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/scheduler/2021-06-30/service-2.json @@ -0,0 +1,1574 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-06-30", + "endpointPrefix":"scheduler", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon EventBridge Scheduler", + "serviceId":"Scheduler", + "signatureVersion":"v4", + "signingName":"scheduler", + "uid":"scheduler-2021-06-30" + }, + "operations":{ + "CreateSchedule":{ + "name":"CreateSchedule", + "http":{ + "method":"POST", + "requestUri":"/schedules/{Name}", + "responseCode":200 + }, + "input":{"shape":"CreateScheduleInput"}, + "output":{"shape":"CreateScheduleOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Creates the specified schedule.
", + "idempotent":true + }, + "CreateScheduleGroup":{ + "name":"CreateScheduleGroup", + "http":{ + "method":"POST", + "requestUri":"/schedule-groups/{Name}", + "responseCode":200 + }, + "input":{"shape":"CreateScheduleGroupInput"}, + "output":{"shape":"CreateScheduleGroupOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Creates the specified schedule group.
", + "idempotent":true + }, + "DeleteSchedule":{ + "name":"DeleteSchedule", + "http":{ + "method":"DELETE", + "requestUri":"/schedules/{Name}", + "responseCode":200 + }, + "input":{"shape":"DeleteScheduleInput"}, + "output":{"shape":"DeleteScheduleOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Deletes the specified schedule.
", + "idempotent":true + }, + "DeleteScheduleGroup":{ + "name":"DeleteScheduleGroup", + "http":{ + "method":"DELETE", + "requestUri":"/schedule-groups/{Name}", + "responseCode":200 + }, + "input":{"shape":"DeleteScheduleGroupInput"}, + "output":{"shape":"DeleteScheduleGroupOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Deletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all schedules associated with the group. When you delete a group, it remains in a DELETING state until all of its associated schedules are deleted. Schedules associated with the group that are set to run while the schedule group is in the process of being deleted might continue to invoke their targets until the schedule group and its associated schedules are deleted.
This operation is eventually consistent.
Retrieves the specified schedule.
" + }, + "GetScheduleGroup":{ + "name":"GetScheduleGroup", + "http":{ + "method":"GET", + "requestUri":"/schedule-groups/{Name}", + "responseCode":200 + }, + "input":{"shape":"GetScheduleGroupInput"}, + "output":{"shape":"GetScheduleGroupOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves the specified schedule group.
" + }, + "ListScheduleGroups":{ + "name":"ListScheduleGroups", + "http":{ + "method":"GET", + "requestUri":"/schedule-groups", + "responseCode":200 + }, + "input":{"shape":"ListScheduleGroupsInput"}, + "output":{"shape":"ListScheduleGroupsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a paginated list of your schedule groups.
" + }, + "ListSchedules":{ + "name":"ListSchedules", + "http":{ + "method":"GET", + "requestUri":"/schedules", + "responseCode":200 + }, + "input":{"shape":"ListSchedulesInput"}, + "output":{"shape":"ListSchedulesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a paginated list of your EventBridge Scheduler schedules.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{ResourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Lists the tags associated with the Scheduler resource.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{ResourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{ResourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Removes one or more tags from the specified EventBridge Scheduler schedule group.
", + "idempotent":true + }, + "UpdateSchedule":{ + "name":"UpdateSchedule", + "http":{ + "method":"PUT", + "requestUri":"/schedules/{Name}", + "responseCode":200 + }, + "input":{"shape":"UpdateScheduleInput"}, + "output":{"shape":"UpdateScheduleOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":" Updates the specified schedule. When you call UpdateSchedule, EventBridge Scheduler uses all values, including empty values, specified in the request and overrides the existing schedule. This is by design. This means that if you do not set an optional field in your request, that field will be set to its system-default value after the update.
Before calling this operation, we recommend that you call the GetSchedule API operation and make a note of all optional parameters for your UpdateSchedule call.
Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE.
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
" + }, + "Subnets":{ + "shape":"Subnets", + "documentation":"Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
" + } + }, + "documentation":"This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
" + }, + "CapacityProvider":{ + "type":"string", + "max":255, + "min":1 + }, + "CapacityProviderStrategy":{ + "type":"list", + "member":{"shape":"CapacityProviderStrategyItem"}, + "max":6, + "min":0 + }, + "CapacityProviderStrategyItem":{ + "type":"structure", + "required":["capacityProvider"], + "members":{ + "base":{ + "shape":"CapacityProviderStrategyItemBase", + "documentation":"The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
The short name of the capacity provider.
" + }, + "weight":{ + "shape":"CapacityProviderStrategyItemWeight", + "documentation":"The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
" + } + }, + "documentation":"The details of a capacity provider strategy.
" + }, + "CapacityProviderStrategyItemBase":{ + "type":"integer", + "max":100000, + "min":0 + }, + "CapacityProviderStrategyItemWeight":{ + "type":"integer", + "max":1000, + "min":0 + }, + "ClientToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9-_]+$" + }, + "ConflictException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"Updating or deleting the resource can cause an inconsistent state.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateScheduleGroupInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
", + "idempotencyToken":true + }, + "Name":{ + "shape":"ScheduleGroupName", + "documentation":"The name of the schedule group that you are creating.
", + "location":"uri", + "locationName":"Name" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The list of tags to associate with the schedule group.
" + } + } + }, + "CreateScheduleGroupOutput":{ + "type":"structure", + "required":["ScheduleGroupArn"], + "members":{ + "ScheduleGroupArn":{ + "shape":"ScheduleGroupArn", + "documentation":"The Amazon Resource Name (ARN) of the schedule group.
" + } + } + }, + "CreateScheduleInput":{ + "type":"structure", + "required":[ + "FlexibleTimeWindow", + "Name", + "ScheduleExpression", + "Target" + ], + "members":{ + "ActionAfterCompletion":{ + "shape":"ActionAfterCompletion", + "documentation":"Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
", + "idempotencyToken":true + }, + "Description":{ + "shape":"Description", + "documentation":"The description you specify for the schedule.
" + }, + "EndDate":{ + "shape":"EndDate", + "documentation":"The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
" + }, + "GroupName":{ + "shape":"ScheduleGroupName", + "documentation":"The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
" + }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
" + }, + "Name":{ + "shape":"Name", + "documentation":"The name of the schedule that you are creating.
", + "location":"uri", + "locationName":"Name" + }, + "ScheduleExpression":{ + "shape":"ScheduleExpression", + "documentation":"The expression that defines when the schedule runs. The following formats are supported.
at expression - at(yyyy-mm-ddThh:mm:ss)
rate expression - rate(value unit)
cron expression - cron(fields)
You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.
A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).
A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days
For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.
" + }, + "ScheduleExpressionTimezone":{ + "shape":"ScheduleExpressionTimezone", + "documentation":"The timezone in which the scheduling expression is evaluated.
" + }, + "StartDate":{ + "shape":"StartDate", + "documentation":"The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.
Specifies whether the schedule is enabled or disabled.
" + }, + "Target":{ + "shape":"Target", + "documentation":"The schedule's target.
" + } + } + }, + "CreateScheduleOutput":{ + "type":"structure", + "required":["ScheduleArn"], + "members":{ + "ScheduleArn":{ + "shape":"ScheduleArn", + "documentation":"The Amazon Resource Name (ARN) of the schedule.
" + } + } + }, + "CreationDate":{"type":"timestamp"}, + "DeadLetterConfig":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"DeadLetterConfigArnString", + "documentation":"The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.
" + } + }, + "documentation":"An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.
" + }, + "DeadLetterConfigArnString":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"^arn:aws(-[a-z]+)?:sqs:[a-z0-9\\-]+:\\d{12}:[a-zA-Z0-9\\-_]+$" + }, + "DeleteScheduleGroupInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
", + "idempotencyToken":true, + "location":"querystring", + "locationName":"clientToken" + }, + "Name":{ + "shape":"ScheduleGroupName", + "documentation":"The name of the schedule group to delete.
", + "location":"uri", + "locationName":"Name" + } + } + }, + "DeleteScheduleGroupOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteScheduleInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
", + "idempotencyToken":true, + "location":"querystring", + "locationName":"clientToken" + }, + "GroupName":{ + "shape":"ScheduleGroupName", + "documentation":"The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.
", + "location":"querystring", + "locationName":"groupName" + }, + "Name":{ + "shape":"Name", + "documentation":"The name of the schedule to delete.
", + "location":"uri", + "locationName":"Name" + } + } + }, + "DeleteScheduleOutput":{ + "type":"structure", + "members":{ + } + }, + "Description":{ + "type":"string", + "max":512, + "min":0 + }, + "DetailType":{ + "type":"string", + "max":128, + "min":1 + }, + "EcsParameters":{ + "type":"structure", + "required":["TaskDefinitionArn"], + "members":{ + "CapacityProviderStrategy":{ + "shape":"CapacityProviderStrategy", + "documentation":"The capacity provider strategy to use for the task.
" + }, + "EnableECSManagedTags":{ + "shape":"EnableECSManagedTags", + "documentation":"Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS Developer Guide.
" + }, + "EnableExecuteCommand":{ + "shape":"EnableExecuteCommand", + "documentation":"Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
" + }, + "Group":{ + "shape":"Group", + "documentation":"Specifies an ECS task group for the task. The maximum length is 255 characters.
" + }, + "LaunchType":{ + "shape":"LaunchType", + "documentation":"Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide.
This structure specifies the network configuration for an ECS task.
" + }, + "PlacementConstraints":{ + "shape":"PlacementConstraints", + "documentation":"An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
" + }, + "PlacementStrategy":{ + "shape":"PlacementStrategies", + "documentation":"The task placement strategy for a task or service.
" + }, + "PlatformVersion":{ + "shape":"PlatformVersion", + "documentation":"Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use Amazon ECS's TagResource API action.
The reference ID to use for the task.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information, see RunTask in the Amazon ECS API Reference.
The number of tasks to create based on TaskDefinition. The default is 1.
The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.
" + } + }, + "documentation":"The templated target type for the Amazon ECS RunTask API operation.
A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
" + }, + "Source":{ + "shape":"Source", + "documentation":"The source of the event.
" + } + }, + "documentation":"The templated target type for the EventBridge PutEvents API operation.
The maximum time window during which a schedule can be invoked.
" + }, + "Mode":{ + "shape":"FlexibleTimeWindowMode", + "documentation":"Determines whether the schedule is invoked within a flexible time window.
" + } + }, + "documentation":"Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
" + }, + "FlexibleTimeWindowMode":{ + "type":"string", + "enum":[ + "OFF", + "FLEXIBLE" + ] + }, + "GetScheduleGroupInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"ScheduleGroupName", + "documentation":"The name of the schedule group to retrieve.
", + "location":"uri", + "locationName":"Name" + } + } + }, + "GetScheduleGroupOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"ScheduleGroupArn", + "documentation":"The Amazon Resource Name (ARN) of the schedule group.
" + }, + "CreationDate":{ + "shape":"CreationDate", + "documentation":"The time at which the schedule group was created.
" + }, + "LastModificationDate":{ + "shape":"LastModificationDate", + "documentation":"The time at which the schedule group was last modified.
" + }, + "Name":{ + "shape":"ScheduleGroupName", + "documentation":"The name of the schedule group.
" + }, + "State":{ + "shape":"ScheduleGroupState", + "documentation":"Specifies the state of the schedule group.
" + } + } + }, + "GetScheduleInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "GroupName":{ + "shape":"ScheduleGroupName", + "documentation":"The name of the schedule group associated with this schedule. If you omit this, EventBridge Scheduler assumes that the schedule is associated with the default group.
", + "location":"querystring", + "locationName":"groupName" + }, + "Name":{ + "shape":"Name", + "documentation":"The name of the schedule to retrieve.
", + "location":"uri", + "locationName":"Name" + } + } + }, + "GetScheduleOutput":{ + "type":"structure", + "members":{ + "ActionAfterCompletion":{ + "shape":"ActionAfterCompletion", + "documentation":"Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
" + }, + "Arn":{ + "shape":"ScheduleArn", + "documentation":"The Amazon Resource Name (ARN) of the schedule.
" + }, + "CreationDate":{ + "shape":"CreationDate", + "documentation":"The time at which the schedule was created.
" + }, + "Description":{ + "shape":"Description", + "documentation":"The description of the schedule.
" + }, + "EndDate":{ + "shape":"EndDate", + "documentation":"The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
" + }, + "GroupName":{ + "shape":"ScheduleGroupName", + "documentation":"The name of the schedule group associated with this schedule.
" + }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.
" + }, + "LastModificationDate":{ + "shape":"LastModificationDate", + "documentation":"The time at which the schedule was last modified.
" + }, + "Name":{ + "shape":"Name", + "documentation":"The name of the schedule.
" + }, + "ScheduleExpression":{ + "shape":"ScheduleExpression", + "documentation":"The expression that defines when the schedule runs. The following formats are supported.
at expression - at(yyyy-mm-ddThh:mm:ss)
rate expression - rate(value unit)
cron expression - cron(fields)
You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.
A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).
A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days
For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.
" + }, + "ScheduleExpressionTimezone":{ + "shape":"ScheduleExpressionTimezone", + "documentation":"The timezone in which the scheduling expression is evaluated.
" + }, + "StartDate":{ + "shape":"StartDate", + "documentation":"The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.
Specifies whether the schedule is enabled or disabled.
" + }, + "Target":{ + "shape":"Target", + "documentation":"The schedule target.
" + } + } + }, + "Group":{ + "type":"string", + "max":255, + "min":1 + }, + "InternalServerException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"Unexpected error encountered while processing the request.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "KinesisParameters":{ + "type":"structure", + "required":["PartitionKey"], + "members":{ + "PartitionKey":{ + "shape":"TargetPartitionKey", + "documentation":"Specifies the shard to which EventBridge Scheduler sends the event. For more information, see Amazon Kinesis Data Streams terminology and concepts in the Amazon Kinesis Streams Developer Guide.
" + } + }, + "documentation":"The templated target type for the Amazon Kinesis PutRecord API operation.
If specified, limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
The name prefix that you can use to return a filtered list of your schedule groups.
", + "location":"querystring", + "locationName":"NamePrefix" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token returned by a previous call to retrieve the next set of results.
", + "location":"querystring", + "locationName":"NextToken" + } + } + }, + "ListScheduleGroupsOutput":{ + "type":"structure", + "required":["ScheduleGroups"], + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"Indicates whether there are additional results to retrieve. If the value is null, there are no more results.
" + }, + "ScheduleGroups":{ + "shape":"ScheduleGroupList", + "documentation":"The schedule groups that match the specified criteria.
" + } + } + }, + "ListSchedulesInput":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"ScheduleGroupName", + "documentation":"If specified, only lists the schedules whose associated schedule group matches the given filter.
", + "location":"querystring", + "locationName":"ScheduleGroup" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"If specified, limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
Schedule name prefix to return the filtered list of resources.
", + "location":"querystring", + "locationName":"NamePrefix" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token returned by a previous call to retrieve the next set of results.
", + "location":"querystring", + "locationName":"NextToken" + }, + "State":{ + "shape":"ScheduleState", + "documentation":"If specified, only lists the schedules whose current state matches the given filter.
", + "location":"querystring", + "locationName":"State" + } + } + }, + "ListSchedulesOutput":{ + "type":"structure", + "required":["Schedules"], + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"Indicates whether there are additional results to retrieve. If the value is null, there are no more results.
" + }, + "Schedules":{ + "shape":"ScheduleList", + "documentation":"The schedules that match the specified criteria.
" + } + } + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"TagResourceArn", + "documentation":"The ARN of the EventBridge Scheduler resource for which you want to view tags.
", + "location":"uri", + "locationName":"ResourceArn" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"The list of tags associated with the specified resource.
" + } + } + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MaximumEventAgeInSeconds":{ + "type":"integer", + "box":true, + "max":86400, + "min":60 + }, + "MaximumRetryAttempts":{ + "type":"integer", + "box":true, + "max":185, + "min":0 + }, + "MaximumWindowInMinutes":{ + "type":"integer", + "box":true, + "max":1440, + "min":1 + }, + "MessageGroupId":{ + "type":"string", + "max":128, + "min":1 + }, + "Name":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[0-9a-zA-Z-_.]+$" + }, + "NamePrefix":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[0-9a-zA-Z-_.]+$" + }, + "NetworkConfiguration":{ + "type":"structure", + "members":{ + "awsvpcConfiguration":{ + "shape":"AwsVpcConfiguration", + "documentation":"Specifies the Amazon VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
" + } + }, + "documentation":"Specifies the network configuration for an ECS task.
" + }, + "NextToken":{ + "type":"string", + "max":2048, + "min":1 + }, + "PlacementConstraint":{ + "type":"structure", + "members":{ + "expression":{ + "shape":"PlacementConstraintExpression", + "documentation":"A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon ECS Developer Guide.
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
An object representing a constraint on task placement.
" + }, + "PlacementConstraintExpression":{ + "type":"string", + "max":2000, + "min":0 + }, + "PlacementConstraintType":{ + "type":"string", + "enum":[ + "distinctInstance", + "memberOf" + ] + }, + "PlacementConstraints":{ + "type":"list", + "member":{"shape":"PlacementConstraint"}, + "max":10, + "min":0 + }, + "PlacementStrategies":{ + "type":"list", + "member":{"shape":"PlacementStrategy"}, + "max":5, + "min":0 + }, + "PlacementStrategy":{ + "type":"structure", + "members":{ + "field":{ + "shape":"PlacementStrategyField", + "documentation":"The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or instanceId, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
" + } + }, + "documentation":"The task placement strategy for a task or service.
" + }, + "PlacementStrategyField":{ + "type":"string", + "max":255, + "min":0 + }, + "PlacementStrategyType":{ + "type":"string", + "enum":[ + "random", + "spread", + "binpack" + ] + }, + "PlatformVersion":{ + "type":"string", + "max":64, + "min":1 + }, + "PropagateTags":{ + "type":"string", + "enum":["TASK_DEFINITION"] + }, + "ReferenceId":{ + "type":"string", + "max":1024, + "min":0 + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request references a resource which does not exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "RetryPolicy":{ + "type":"structure", + "members":{ + "MaximumEventAgeInSeconds":{ + "shape":"MaximumEventAgeInSeconds", + "documentation":"The maximum amount of time, in seconds, to continue to make retry attempts.
" + }, + "MaximumRetryAttempts":{ + "shape":"MaximumRetryAttempts", + "documentation":"The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is reached.
A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
Name of parameter to start execution of a SageMaker Model Building Pipeline.
" + }, + "Value":{ + "shape":"SageMakerPipelineParameterValue", + "documentation":"Value of parameter to start execution of a SageMaker Model Building Pipeline.
" + } + }, + "documentation":"The name and value pair of a parameter to use to start execution of a SageMaker Model Building Pipeline.
" + }, + "SageMakerPipelineParameterList":{ + "type":"list", + "member":{"shape":"SageMakerPipelineParameter"}, + "max":200, + "min":0 + }, + "SageMakerPipelineParameterName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[A-Za-z0-9\\-_]*$" + }, + "SageMakerPipelineParameterValue":{ + "type":"string", + "max":1024, + "min":1 + }, + "SageMakerPipelineParameters":{ + "type":"structure", + "members":{ + "PipelineParameterList":{ + "shape":"SageMakerPipelineParameterList", + "documentation":"List of parameter names and values to use when executing the SageMaker Model Building Pipeline.
" + } + }, + "documentation":"The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
The Amazon Resource Name (ARN) of the schedule group.
" + }, + "CreationDate":{ + "shape":"CreationDate", + "documentation":"The time at which the schedule group was created.
" + }, + "LastModificationDate":{ + "shape":"LastModificationDate", + "documentation":"The time at which the schedule group was last modified.
" + }, + "Name":{ + "shape":"ScheduleGroupName", + "documentation":"The name of the schedule group.
" + }, + "State":{ + "shape":"ScheduleGroupState", + "documentation":"Specifies the state of the schedule group.
" + } + }, + "documentation":"The details of a schedule group.
" + }, + "ScheduleList":{ + "type":"list", + "member":{"shape":"ScheduleSummary"} + }, + "ScheduleState":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "ScheduleSummary":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"ScheduleArn", + "documentation":"The Amazon Resource Name (ARN) of the schedule.
" + }, + "CreationDate":{ + "shape":"CreationDate", + "documentation":"The time at which the schedule was created.
" + }, + "GroupName":{ + "shape":"ScheduleGroupName", + "documentation":"The name of the schedule group associated with this schedule.
" + }, + "LastModificationDate":{ + "shape":"LastModificationDate", + "documentation":"The time at which the schedule was last modified.
" + }, + "Name":{ + "shape":"Name", + "documentation":"The name of the schedule.
" + }, + "State":{ + "shape":"ScheduleState", + "documentation":"Specifies whether the schedule is enabled or disabled.
" + }, + "Target":{ + "shape":"TargetSummary", + "documentation":"The schedule's target details.
" + } + }, + "documentation":"The details of a schedule.
" + }, + "SecurityGroup":{ + "type":"string", + "max":1000, + "min":1 + }, + "SecurityGroups":{ + "type":"list", + "member":{"shape":"SecurityGroup"}, + "max":5, + "min":1 + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request exceeds a service quota.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "Source":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^(?=[/\\.\\-_A-Za-z0-9]+)((?!aws\\.).*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$" + }, + "SqsParameters":{ + "type":"structure", + "members":{ + "MessageGroupId":{ + "shape":"MessageGroupId", + "documentation":"The FIFO message group ID to use as the target.
" + } + }, + "documentation":"The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide.
The key for the tag.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The value for the tag.
" + } + }, + "documentation":"Tag to associate with a schedule group.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TagResourceArn":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"^arn:aws(-[a-z]+)?:scheduler:[a-z0-9\\-]+:\\d{12}:schedule-group\\/[0-9a-zA-Z-_.]+$" + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"TagResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the schedule group that you are adding tags to.
", + "location":"uri", + "locationName":"ResourceArn" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The list of tags to associate with the schedule group.
" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1 + }, + "Tags":{ + "type":"list", + "member":{"shape":"TagMap"}, + "max":50, + "min":0 + }, + "Target":{ + "type":"structure", + "required":[ + "Arn", + "RoleArn" + ], + "members":{ + "Arn":{ + "shape":"TargetArn", + "documentation":"The Amazon Resource Name (ARN) of the target.
" + }, + "DeadLetterConfig":{ + "shape":"DeadLetterConfig", + "documentation":"An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.
" + }, + "EcsParameters":{ + "shape":"EcsParameters", + "documentation":"The templated target type for the Amazon ECS RunTask API operation.
The templated target type for the EventBridge PutEvents API operation.
The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.
" + }, + "KinesisParameters":{ + "shape":"KinesisParameters", + "documentation":"The templated target type for the Amazon Kinesis PutRecord API operation.
A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
" + }, + "SageMakerPipelineParameters":{ + "shape":"SageMakerPipelineParameters", + "documentation":"The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide.
The schedule's target. EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.
" + }, + "TargetArn":{ + "type":"string", + "max":1600, + "min":1 + }, + "TargetInput":{ + "type":"string", + "min":1 + }, + "TargetPartitionKey":{ + "type":"string", + "max":256, + "min":1 + }, + "TargetSummary":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"TargetArn", + "documentation":"The Amazon Resource Name (ARN) of the target.
" + } + }, + "documentation":"The details of a target.
" + }, + "TaskCount":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, + "TaskDefinitionArn":{ + "type":"string", + "max":1600, + "min":1 + }, + "ThrottlingException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"TagResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the schedule group from which you are removing tags.
", + "location":"uri", + "locationName":"ResourceArn" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"The list of tag keys to remove from the resource.
", + "location":"querystring", + "locationName":"TagKeys" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateScheduleInput":{ + "type":"structure", + "required":[ + "FlexibleTimeWindow", + "Name", + "ScheduleExpression", + "Target" + ], + "members":{ + "ActionAfterCompletion":{ + "shape":"ActionAfterCompletion", + "documentation":"Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
", + "idempotencyToken":true + }, + "Description":{ + "shape":"Description", + "documentation":"The description you specify for the schedule.
" + }, + "EndDate":{ + "shape":"EndDate", + "documentation":"The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
" + }, + "GroupName":{ + "shape":"ScheduleGroupName", + "documentation":"The name of the schedule group with which the schedule is associated. You must provide this value in order for EventBridge Scheduler to find the schedule you want to update. If you omit this value, EventBridge Scheduler assumes the group is associated to the default group.
" + }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The ARN for the customer managed KMS key that that you want EventBridge Scheduler to use to encrypt and decrypt your data.
" + }, + "Name":{ + "shape":"Name", + "documentation":"The name of the schedule that you are updating.
", + "location":"uri", + "locationName":"Name" + }, + "ScheduleExpression":{ + "shape":"ScheduleExpression", + "documentation":"The expression that defines when the schedule runs. The following formats are supported.
at expression - at(yyyy-mm-ddThh:mm:ss)
rate expression - rate(value unit)
cron expression - cron(fields)
You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.
A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).
A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days
For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.
" + }, + "ScheduleExpressionTimezone":{ + "shape":"ScheduleExpressionTimezone", + "documentation":"The timezone in which the scheduling expression is evaluated.
" + }, + "StartDate":{ + "shape":"StartDate", + "documentation":"The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.
Specifies whether the schedule is enabled or disabled.
" + }, + "Target":{ + "shape":"Target", + "documentation":"The schedule target. You can use this operation to change the target that your schedule invokes.
" + } + } + }, + "UpdateScheduleOutput":{ + "type":"structure", + "required":["ScheduleArn"], + "members":{ + "ScheduleArn":{ + "shape":"ScheduleArn", + "documentation":"The Amazon Resource Name (ARN) of the schedule that you updated.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The input fails to satisfy the constraints specified by an AWS service.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + }, + "documentation":"Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one central, managed service. EventBridge Scheduler delivers your tasks reliably, with built-in mechanisms that adjust your schedules based on the availability of downstream targets. The following reference lists the available API actions, and data types for EventBridge Scheduler.
" +} diff --git a/testbed/boto__botocore/botocore/data/securitylake/2018-05-10/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/securitylake/2018-05-10/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..f72c5adafeedf325bd2be5fd10dc2c21b4dbf574 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/securitylake/2018-05-10/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://securitylake-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://securitylake-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://securitylake.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://securitylake.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/securitylake/2018-05-10/paginators-1.json b/testbed/boto__botocore/botocore/data/securitylake/2018-05-10/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..19e482b211275eef3eca3ca0a6eff195019d7793 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/securitylake/2018-05-10/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "GetDataLakeSources": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "dataLakeSources" + }, + "ListDataLakeExceptions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "exceptions" + }, + "ListLogSources": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "sources" + }, + "ListSubscribers": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "subscribers" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/securitylake/2018-05-10/paginators-1.sdk-extras.json b/testbed/boto__botocore/botocore/data/securitylake/2018-05-10/paginators-1.sdk-extras.json new file mode 100644 index 0000000000000000000000000000000000000000..41ae7fe618b8b8888975df1b39a915b159850b7a --- /dev/null +++ b/testbed/boto__botocore/botocore/data/securitylake/2018-05-10/paginators-1.sdk-extras.json @@ -0,0 +1,12 @@ +{ + "version": 1.0, + "merge": { + "pagination": { + "GetDataLakeSources": { + "non_aggregate_keys": [ + "dataLakeArn" + ] + } + } + } +} diff --git a/testbed/boto__botocore/botocore/data/securitylake/2018-05-10/service-2.json b/testbed/boto__botocore/botocore/data/securitylake/2018-05-10/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..c1c96cff08d2e7c564d746e0c3472ee51014f039 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/securitylake/2018-05-10/service-2.json @@ -0,0 +1,2291 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-05-10", + "endpointPrefix":"securitylake", + "jsonVersion":"1.1", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"Amazon Security Lake", + "serviceId":"SecurityLake", + "signatureVersion":"v4", + "signingName":"securitylake", + "uid":"securitylake-2018-05-10", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "CreateAwsLogSource":{ + "name":"CreateAwsLogSource", + "http":{ + "method":"POST", + "requestUri":"/v1/datalake/logsources/aws", + "responseCode":200 + }, + "input":{"shape":"CreateAwsLogSourceRequest"}, + "output":{"shape":"CreateAwsLogSourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables source types for member accounts in required Amazon Web Services Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. Once you add an Amazon Web Service as a source, Security Lake starts collecting logs and events from it.
You can use this API only to enable natively supported Amazon Web Services as a source. Use CreateCustomLogSource to enable data collection from a custom source.
Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source. Security Lake can collect logs and events from third-party custom sources. After creating the appropriate IAM role to invoke Glue crawler, use this API to add a custom source name in Security Lake. This operation creates a partition in the Amazon S3 bucket for Security Lake as the target location for log files from the custom source. In addition, this operation also creates an associated Glue table and an Glue crawler.
", + "idempotent":true + }, + "CreateDataLake":{ + "name":"CreateDataLake", + "http":{ + "method":"POST", + "requestUri":"/v1/datalake", + "responseCode":200 + }, + "input":{"shape":"CreateDataLakeRequest"}, + "output":{"shape":"CreateDataLakeResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable Security Lake in Amazon Web Services Regions with customized settings before enabling log collection in Regions. To specify particular Regions, configure these Regions using the configurations parameter. If you have already enabled Security Lake in a Region when you call this command, the command will update the Region if you provide new configuration parameters. If you have not already enabled Security Lake in the Region when you call this API, it will set up the data lake in the Region with the specified configurations.
When you enable Security Lake, it starts ingesting security data after the CreateAwsLogSource call. This includes ingesting security data from sources, storing data, and making data accessible to subscribers. Security Lake also enables all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. For more information, see the Amazon Security Lake User Guide.
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
" + }, + "CreateDataLakeOrganizationConfiguration":{ + "name":"CreateDataLakeOrganizationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/v1/datalake/organization/configuration", + "responseCode":200 + }, + "input":{"shape":"CreateDataLakeOrganizationConfigurationRequest"}, + "output":{"shape":"CreateDataLakeOrganizationConfigurationResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Automatically enables Amazon Security Lake for new member accounts in your organization. Security Lake is not automatically enabled for any existing member accounts in your organization.
" + }, + "CreateSubscriber":{ + "name":"CreateSubscriber", + "http":{ + "method":"POST", + "requestUri":"/v1/subscribers", + "responseCode":200 + }, + "input":{"shape":"CreateSubscriberRequest"}, + "output":{"shape":"CreateSubscriberResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Creates a subscription permission for accounts that are already enabled in Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.
" + }, + "CreateSubscriberNotification":{ + "name":"CreateSubscriberNotification", + "http":{ + "method":"POST", + "requestUri":"/v1/subscribers/{subscriberId}/notification", + "responseCode":200 + }, + "input":{"shape":"CreateSubscriberNotificationRequest"}, + "output":{"shape":"CreateSubscriberNotificationResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake. You can create only one subscriber notification per subscriber.
" + }, + "DeleteAwsLogSource":{ + "name":"DeleteAwsLogSource", + "http":{ + "method":"POST", + "requestUri":"/v1/datalake/logsources/aws/delete", + "responseCode":200 + }, + "input":{"shape":"DeleteAwsLogSourceRequest"}, + "output":{"shape":"DeleteAwsLogSourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Removes a natively supported Amazon Web Service as an Amazon Security Lake source. You can remove a source for one or more Regions. When you remove the source, Security Lake stops collecting data from that source in the specified Regions and accounts, and subscribers can no longer consume new data from the source. However, subscribers can still consume data that Security Lake collected from the source before removal.
You can choose any source type in any Amazon Web Services Region for either accounts that are part of a trusted organization or standalone accounts.
" + }, + "DeleteCustomLogSource":{ + "name":"DeleteCustomLogSource", + "http":{ + "method":"DELETE", + "requestUri":"/v1/datalake/logsources/custom/{sourceName}", + "responseCode":200 + }, + "input":{"shape":"DeleteCustomLogSourceRequest"}, + "output":{"shape":"DeleteCustomLogSourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.
", + "idempotent":true + }, + "DeleteDataLake":{ + "name":"DeleteDataLake", + "http":{ + "method":"POST", + "requestUri":"/v1/datalake/delete", + "responseCode":200 + }, + "input":{"shape":"DeleteDataLakeRequest"}, + "output":{"shape":"DeleteDataLakeResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"When you disable Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions and it stops collecting data from your sources. Also, this API automatically takes steps to remove the account from Security Lake. However, Security Lake retains all of your existing settings and the resources that it created in your Amazon Web Services account in the current Amazon Web Services Region.
The DeleteDataLake operation does not delete the data that is stored in your Amazon S3 bucket, which is owned by your Amazon Web Services account. For more information, see the Amazon Security Lake User Guide.
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
", + "idempotent":true + }, + "DeleteDataLakeOrganizationConfiguration":{ + "name":"DeleteDataLakeOrganizationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/v1/datalake/organization/configuration/delete", + "responseCode":200 + }, + "input":{"shape":"DeleteDataLakeOrganizationConfigurationRequest"}, + "output":{"shape":"DeleteDataLakeOrganizationConfigurationResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Turns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations. Only the delegated Security Lake administrator for an organization can perform this operation. If the delegated Security Lake administrator performs this operation, new member accounts won't automatically contribute data to the data lake.
" + }, + "DeleteSubscriber":{ + "name":"DeleteSubscriber", + "http":{ + "method":"DELETE", + "requestUri":"/v1/subscribers/{subscriberId}", + "responseCode":200 + }, + "input":{"shape":"DeleteSubscriberRequest"}, + "output":{"shape":"DeleteSubscriberResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Deletes the subscription permission and all notification settings for accounts that are already enabled in Amazon Security Lake. When you run DeleteSubscriber, the subscriber will no longer consume data from Security Lake and the subscriber is removed. This operation deletes the subscriber and removes access to data in the current Amazon Web Services Region.
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
", + "idempotent":true + }, + "DeregisterDataLakeDelegatedAdministrator":{ + "name":"DeregisterDataLakeDelegatedAdministrator", + "http":{ + "method":"DELETE", + "requestUri":"/v1/datalake/delegate", + "responseCode":200 + }, + "input":{"shape":"DeregisterDataLakeDelegatedAdministratorRequest"}, + "output":{"shape":"DeregisterDataLakeDelegatedAdministratorResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Deletes the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.
", + "idempotent":true + }, + "GetDataLakeExceptionSubscription":{ + "name":"GetDataLakeExceptionSubscription", + "http":{ + "method":"GET", + "requestUri":"/v1/datalake/exceptions/subscription", + "responseCode":200 + }, + "input":{"shape":"GetDataLakeExceptionSubscriptionRequest"}, + "output":{"shape":"GetDataLakeExceptionSubscriptionResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves the details of exception notifications for the account in Amazon Security Lake.
" + }, + "GetDataLakeOrganizationConfiguration":{ + "name":"GetDataLakeOrganizationConfiguration", + "http":{ + "method":"GET", + "requestUri":"/v1/datalake/organization/configuration", + "responseCode":200 + }, + "input":{"shape":"GetDataLakeOrganizationConfigurationRequest"}, + "output":{"shape":"GetDataLakeOrganizationConfigurationResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security Lake. This API does not take input parameters.
" + }, + "GetDataLakeSources":{ + "name":"GetDataLakeSources", + "http":{ + "method":"POST", + "requestUri":"/v1/datalake/sources", + "responseCode":200 + }, + "input":{"shape":"GetDataLakeSourcesRequest"}, + "output":{"shape":"GetDataLakeSourcesResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves a snapshot of the current Region, including whether Amazon Security Lake is enabled for those accounts and which sources Security Lake is collecting data from.
" + }, + "GetSubscriber":{ + "name":"GetSubscriber", + "http":{ + "method":"GET", + "requestUri":"/v1/subscribers/{subscriberId}", + "responseCode":200 + }, + "input":{"shape":"GetSubscriberRequest"}, + "output":{"shape":"GetSubscriberResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.
" + }, + "ListDataLakeExceptions":{ + "name":"ListDataLakeExceptions", + "http":{ + "method":"POST", + "requestUri":"/v1/datalake/exceptions", + "responseCode":200 + }, + "input":{"shape":"ListDataLakeExceptionsRequest"}, + "output":{"shape":"ListDataLakeExceptionsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
" + }, + "ListDataLakes":{ + "name":"ListDataLakes", + "http":{ + "method":"GET", + "requestUri":"/v1/datalakes", + "responseCode":200 + }, + "input":{"shape":"ListDataLakesRequest"}, + "output":{"shape":"ListDataLakesResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions. You can use this operation to determine whether Security Lake is enabled for a Region.
" + }, + "ListLogSources":{ + "name":"ListLogSources", + "http":{ + "method":"POST", + "requestUri":"/v1/datalake/logsources/list", + "responseCode":200 + }, + "input":{"shape":"ListLogSourcesRequest"}, + "output":{"shape":"ListLogSourcesResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves the log sources in the current Amazon Web Services Region.
" + }, + "ListSubscribers":{ + "name":"ListSubscribers", + "http":{ + "method":"GET", + "requestUri":"/v1/subscribers", + "responseCode":200 + }, + "input":{"shape":"ListSubscribersRequest"}, + "output":{"shape":"ListSubscribersResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/v1/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves the tags (keys and values) that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
" + }, + "RegisterDataLakeDelegatedAdministrator":{ + "name":"RegisterDataLakeDelegatedAdministrator", + "http":{ + "method":"POST", + "requestUri":"/v1/datalake/delegate", + "responseCode":200 + }, + "input":{"shape":"RegisterDataLakeDelegatedAdministratorRequest"}, + "output":{"shape":"RegisterDataLakeDelegatedAdministratorResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Designates the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/v1/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Adds or updates one or more tags that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region. A tag is a label that you can define and associate with Amazon Web Services resources. Each tag consists of a required tag key and an associated tag value. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor for a tag key. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide.
", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/v1/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Removes one or more tags (keys and values) from an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
", + "idempotent":true + }, + "UpdateDataLake":{ + "name":"UpdateDataLake", + "http":{ + "method":"PUT", + "requestUri":"/v1/datalake", + "responseCode":200 + }, + "input":{"shape":"UpdateDataLakeRequest"}, + "output":{"shape":"UpdateDataLakeResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Specifies where to store your security data and for how long. You can add a rollup Region to consolidate data from multiple Amazon Web Services Regions.
", + "idempotent":true + }, + "UpdateDataLakeExceptionSubscription":{ + "name":"UpdateDataLakeExceptionSubscription", + "http":{ + "method":"PUT", + "requestUri":"/v1/datalake/exceptions/subscription", + "responseCode":200 + }, + "input":{"shape":"UpdateDataLakeExceptionSubscriptionRequest"}, + "output":{"shape":"UpdateDataLakeExceptionSubscriptionResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
", + "idempotent":true + }, + "UpdateSubscriber":{ + "name":"UpdateSubscriber", + "http":{ + "method":"PUT", + "requestUri":"/v1/subscribers/{subscriberId}", + "responseCode":200 + }, + "input":{"shape":"UpdateSubscriberRequest"}, + "output":{"shape":"UpdateSubscriberResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Updates an existing subscription for the given Amazon Security Lake account ID. You can update a subscriber by changing the sources that the subscriber consumes data from.
", + "idempotent":true + }, + "UpdateSubscriberNotification":{ + "name":"UpdateSubscriberNotification", + "http":{ + "method":"PUT", + "requestUri":"/v1/subscribers/{subscriberId}/notification", + "responseCode":200 + }, + "input":{"shape":"UpdateSubscriberNotificationRequest"}, + "output":{"shape":"UpdateSubscriberNotificationResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
", + "idempotent":true + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "errorCode":{ + "shape":"String", + "documentation":"A coded string to provide more information about the access denied exception. You can use the error code to check the exception type.
" + }, + "message":{"shape":"String"} + }, + "documentation":"You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccessType":{ + "type":"string", + "enum":[ + "LAKEFORMATION", + "S3" + ] + }, + "AccessTypeList":{ + "type":"list", + "member":{"shape":"AccessType"} + }, + "AccountList":{ + "type":"list", + "member":{"shape":"AwsAccountId"} + }, + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"^arn:(aws|aws-us-gov|aws-cn):securitylake:[A-za-z0-9_/.\\-]{0,63}:[A-za-z0-9_/.\\-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.\\-]{0,127}$" + }, + "AwsAccountId":{ + "type":"string", + "max":12, + "min":12, + "pattern":"^[0-9]{12}$" + }, + "AwsIdentity":{ + "type":"structure", + "required":[ + "externalId", + "principal" + ], + "members":{ + "externalId":{ + "shape":"ExternalId", + "documentation":"The external ID used to estalish trust relationship with the AWS identity.
" + }, + "principal":{ + "shape":"AwsPrincipal", + "documentation":"The AWS identity principal.
" + } + }, + "documentation":"The AWS identity.
" + }, + "AwsLogSourceConfiguration":{ + "type":"structure", + "required":[ + "regions", + "sourceName" + ], + "members":{ + "accounts":{ + "shape":"AccountList", + "documentation":"Specify the Amazon Web Services account information where you want to enable Security Lake.
" + }, + "regions":{ + "shape":"RegionList", + "documentation":"Specify the Regions where you want to enable Security Lake.
" + }, + "sourceName":{ + "shape":"AwsLogSourceName", + "documentation":"The name for a Amazon Web Services source. This must be a Regionally unique value.
" + }, + "sourceVersion":{ + "shape":"AwsLogSourceVersion", + "documentation":"The version for a Amazon Web Services source. This must be a Regionally unique value.
" + } + }, + "documentation":"The Security Lake logs source configuration file describes the information needed to generate Security Lake logs.
" + }, + "AwsLogSourceConfigurationList":{ + "type":"list", + "member":{"shape":"AwsLogSourceConfiguration"}, + "max":50, + "min":1 + }, + "AwsLogSourceName":{ + "type":"string", + "enum":[ + "ROUTE53", + "VPC_FLOW", + "SH_FINDINGS", + "CLOUD_TRAIL_MGMT", + "LAMBDA_EXECUTION", + "S3_DATA", + "EKS_AUDIT", + "WAF" + ] + }, + "AwsLogSourceResource":{ + "type":"structure", + "members":{ + "sourceName":{ + "shape":"AwsLogSourceName", + "documentation":"The name for a Amazon Web Services source. This must be a Regionally unique value.
" + }, + "sourceVersion":{ + "shape":"AwsLogSourceVersion", + "documentation":"The version for a Amazon Web Services source. This must be a Regionally unique value.
" + } + }, + "documentation":"Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services.
" + }, + "AwsLogSourceResourceList":{ + "type":"list", + "member":{"shape":"AwsLogSourceResource"}, + "min":1 + }, + "AwsLogSourceVersion":{ + "type":"string", + "pattern":"^(latest|[0-9]\\.[0-9])$" + }, + "AwsPrincipal":{ + "type":"string", + "pattern":"^([0-9]{12}|[a-z0-9\\.\\-]*\\.(amazonaws|amazon)\\.com)$" + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "resourceName":{ + "shape":"String", + "documentation":"The resource name.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The resource type.
" + } + }, + "documentation":"Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateAwsLogSourceRequest":{ + "type":"structure", + "required":["sources"], + "members":{ + "sources":{ + "shape":"AwsLogSourceConfigurationList", + "documentation":"Specify the natively-supported Amazon Web Services service to add as a source in Security Lake.
" + } + } + }, + "CreateAwsLogSourceResponse":{ + "type":"structure", + "members":{ + "failed":{ + "shape":"AccountList", + "documentation":"Lists all accounts in which enabling a natively supported Amazon Web Service as a Security Lake source failed. The failure occurred as these accounts are not part of an organization.
" + } + } + }, + "CreateCustomLogSourceRequest":{ + "type":"structure", + "required":[ + "configuration", + "sourceName" + ], + "members":{ + "configuration":{ + "shape":"CustomLogSourceConfiguration", + "documentation":"The configuration for the third-party custom source.
" + }, + "eventClasses":{ + "shape":"OcsfEventClassList", + "documentation":"The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake. The supported event classes are:
ACCESS_ACTIVITY
FILE_ACTIVITY
KERNEL_ACTIVITY
KERNEL_EXTENSION
MEMORY_ACTIVITY
MODULE_ACTIVITY
PROCESS_ACTIVITY
REGISTRY_KEY_ACTIVITY
REGISTRY_VALUE_ACTIVITY
RESOURCE_ACTIVITY
SCHEDULED_JOB_ACTIVITY
SECURITY_FINDING
ACCOUNT_CHANGE
AUTHENTICATION
AUTHORIZATION
ENTITY_MANAGEMENT_AUDIT
DHCP_ACTIVITY
NETWORK_ACTIVITY
DNS_ACTIVITY
FTP_ACTIVITY
HTTP_ACTIVITY
RDP_ACTIVITY
SMB_ACTIVITY
SSH_ACTIVITY
CONFIG_STATE
INVENTORY_INFO
EMAIL_ACTIVITY
API_ACTIVITY
CLOUD_API
Specify the name for a third-party custom source. This must be a Regionally unique value.
" + }, + "sourceVersion":{ + "shape":"CustomLogSourceVersion", + "documentation":"Specify the source version for the third-party custom source, to limit log collection to a specific version of custom data source.
" + } + } + }, + "CreateCustomLogSourceResponse":{ + "type":"structure", + "members":{ + "source":{ + "shape":"CustomLogSourceResource", + "documentation":"The created third-party custom source.
" + } + } + }, + "CreateDataLakeExceptionSubscriptionRequest":{ + "type":"structure", + "required":[ + "notificationEndpoint", + "subscriptionProtocol" + ], + "members":{ + "exceptionTimeToLive":{ + "shape":"CreateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong", + "documentation":"The expiration period and time-to-live (TTL).
" + }, + "notificationEndpoint":{ + "shape":"SafeString", + "documentation":"The Amazon Web Services account where you want to receive exception notifications.
" + }, + "subscriptionProtocol":{ + "shape":"SubscriptionProtocol", + "documentation":"The subscription protocol to which exception notifications are posted.
" + } + } + }, + "CreateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong":{ + "type":"long", + "box":true, + "min":1 + }, + "CreateDataLakeExceptionSubscriptionResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateDataLakeOrganizationConfigurationRequest":{ + "type":"structure", + "members":{ + "autoEnableNewAccount":{ + "shape":"DataLakeAutoEnableNewAccountConfigurationList", + "documentation":"Enable Security Lake with the specified configuration settings, to begin collecting security data for new accounts in your organization.
" + } + } + }, + "CreateDataLakeOrganizationConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateDataLakeRequest":{ + "type":"structure", + "required":[ + "configurations", + "metaStoreManagerRoleArn" + ], + "members":{ + "configurations":{ + "shape":"DataLakeConfigurationList", + "documentation":"Specify the Region or Regions that will contribute data to the rollup region.
" + }, + "metaStoreManagerRoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) used to create and update the Glue table. This table contains partitions generated by the ingestion and normalization of Amazon Web Services log sources and custom sources.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"An array of objects, one for each tag to associate with the data lake configuration. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
" + } + } + }, + "CreateDataLakeResponse":{ + "type":"structure", + "members":{ + "dataLakes":{ + "shape":"DataLakeResourceList", + "documentation":"The created Security Lake configuration object.
" + } + } + }, + "CreateSubscriberNotificationRequest":{ + "type":"structure", + "required":[ + "configuration", + "subscriberId" + ], + "members":{ + "configuration":{ + "shape":"NotificationConfiguration", + "documentation":"Specify the configuration using which you want to create the subscriber notification.
" + }, + "subscriberId":{ + "shape":"UUID", + "documentation":"The subscriber ID for the notification subscription.
", + "location":"uri", + "locationName":"subscriberId" + } + } + }, + "CreateSubscriberNotificationResponse":{ + "type":"structure", + "members":{ + "subscriberEndpoint":{ + "shape":"SafeString", + "documentation":"The subscriber endpoint to which exception messages are posted.
" + } + } + }, + "CreateSubscriberRequest":{ + "type":"structure", + "required":[ + "sources", + "subscriberIdentity", + "subscriberName" + ], + "members":{ + "accessTypes":{ + "shape":"AccessTypeList", + "documentation":"The Amazon S3 or Lake Formation access type.
" + }, + "sources":{ + "shape":"LogSourceResourceList", + "documentation":"The supported Amazon Web Services from which logs and events are collected. Security Lake supports log and event collection for natively supported Amazon Web Services.
" + }, + "subscriberDescription":{ + "shape":"DescriptionString", + "documentation":"The description for your subscriber account in Security Lake.
" + }, + "subscriberIdentity":{ + "shape":"AwsIdentity", + "documentation":"The Amazon Web Services identity used to access your data.
" + }, + "subscriberName":{ + "shape":"CreateSubscriberRequestSubscriberNameString", + "documentation":"The name of your Security Lake subscriber account.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
" + } + } + }, + "CreateSubscriberRequestSubscriberNameString":{ + "type":"string", + "max":64, + "min":0 + }, + "CreateSubscriberResponse":{ + "type":"structure", + "members":{ + "subscriber":{ + "shape":"SubscriberResource", + "documentation":"Retrieve information about the subscriber created using the CreateSubscriber API.
The ARN of the Glue crawler.
" + }, + "databaseArn":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
The ARN of the Glue table.
" + } + }, + "documentation":"The attributes of a third-party custom source.
" + }, + "CustomLogSourceConfiguration":{ + "type":"structure", + "required":[ + "crawlerConfiguration", + "providerIdentity" + ], + "members":{ + "crawlerConfiguration":{ + "shape":"CustomLogSourceCrawlerConfiguration", + "documentation":"The configuration for the Glue Crawler for the third-party custom source.
" + }, + "providerIdentity":{ + "shape":"AwsIdentity", + "documentation":"The identity of the log provider for the third-party custom source.
" + } + }, + "documentation":"The configuration for the third-party custom source.
" + }, + "CustomLogSourceCrawlerConfiguration":{ + "type":"structure", + "required":["roleArn"], + "members":{ + "roleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be used by the Glue crawler. The recommended IAM policies are:
The managed policy AWSGlueServiceRole
A custom policy granting access to your Amazon S3 Data Lake
The configuration for the Glue Crawler for the third-party custom source.
" + }, + "CustomLogSourceName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[\\w\\-\\_\\:\\.]*$" + }, + "CustomLogSourceProvider":{ + "type":"structure", + "members":{ + "location":{ + "shape":"S3URI", + "documentation":"The location of the partition in the Amazon S3 bucket for Security Lake.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.
The details of the log provider for a third-party custom source.
" + }, + "CustomLogSourceResource":{ + "type":"structure", + "members":{ + "attributes":{ + "shape":"CustomLogSourceAttributes", + "documentation":"The attributes of a third-party custom source.
" + }, + "provider":{ + "shape":"CustomLogSourceProvider", + "documentation":"The details of the log provider for a third-party custom source.
" + }, + "sourceName":{ + "shape":"CustomLogSourceName", + "documentation":"The name for a third-party custom source. This must be a Regionally unique value.
" + }, + "sourceVersion":{ + "shape":"CustomLogSourceVersion", + "documentation":"The version for a third-party custom source. This must be a Regionally unique value.
" + } + }, + "documentation":"Amazon Security Lake can collect logs and events from third-party custom sources.
" + }, + "CustomLogSourceVersion":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^[A-Za-z0-9\\-\\.\\_]*$" + }, + "DataLakeAutoEnableNewAccountConfiguration":{ + "type":"structure", + "required":[ + "region", + "sources" + ], + "members":{ + "region":{ + "shape":"Region", + "documentation":"The Amazon Web Services Regions where Security Lake is automatically enabled.
" + }, + "sources":{ + "shape":"AwsLogSourceResourceList", + "documentation":"The Amazon Web Services sources that are automatically enabled in Security Lake.
" + } + }, + "documentation":"Automatically enable new organization accounts as member accounts from an Amazon Security Lake administrator account.
" + }, + "DataLakeAutoEnableNewAccountConfigurationList":{ + "type":"list", + "member":{"shape":"DataLakeAutoEnableNewAccountConfiguration"}, + "min":1 + }, + "DataLakeConfiguration":{ + "type":"structure", + "required":["region"], + "members":{ + "encryptionConfiguration":{ + "shape":"DataLakeEncryptionConfiguration", + "documentation":"Provides encryption details of Amazon Security Lake object.
" + }, + "lifecycleConfiguration":{ + "shape":"DataLakeLifecycleConfiguration", + "documentation":"Provides lifecycle details of Amazon Security Lake object.
" + }, + "region":{ + "shape":"Region", + "documentation":"The Amazon Web Services Regions where Security Lake is automatically enabled.
" + }, + "replicationConfiguration":{ + "shape":"DataLakeReplicationConfiguration", + "documentation":"Provides replication details of Amazon Security Lake object.
" + } + }, + "documentation":"Provides details of Amazon Security Lake object.
" + }, + "DataLakeConfigurationList":{ + "type":"list", + "member":{"shape":"DataLakeConfiguration"}, + "min":1 + }, + "DataLakeEncryptionConfiguration":{ + "type":"structure", + "members":{ + "kmsKeyId":{ + "shape":"String", + "documentation":"The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.
" + } + }, + "documentation":"Provides encryption details of Amazon Security Lake object.
" + }, + "DataLakeException":{ + "type":"structure", + "members":{ + "exception":{ + "shape":"SafeString", + "documentation":"The underlying exception of a Security Lake exception.
" + }, + "region":{ + "shape":"Region", + "documentation":"The Amazon Web Services Regions where the exception occurred.
" + }, + "remediation":{ + "shape":"SafeString", + "documentation":"List of all remediation steps for a Security Lake exception.
" + }, + "timestamp":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"This error can occur if you configure the wrong timestamp format, or if the subset of entries used for validation had errors or missing values.
" + } + }, + "documentation":"The details for an Amazon Security Lake exception.
" + }, + "DataLakeExceptionList":{ + "type":"list", + "member":{"shape":"DataLakeException"} + }, + "DataLakeLifecycleConfiguration":{ + "type":"structure", + "members":{ + "expiration":{ + "shape":"DataLakeLifecycleExpiration", + "documentation":"Provides data expiration details of Amazon Security Lake object.
" + }, + "transitions":{ + "shape":"DataLakeLifecycleTransitionList", + "documentation":"Provides data storage transition details of Amazon Security Lake object.
" + } + }, + "documentation":"Provides lifecycle details of Amazon Security Lake object.
" + }, + "DataLakeLifecycleExpiration":{ + "type":"structure", + "members":{ + "days":{ + "shape":"DataLakeLifecycleExpirationDaysInteger", + "documentation":"Number of days before data expires in the Amazon Security Lake object.
" + } + }, + "documentation":"Provide expiration lifecycle details of Amazon Security Lake object.
" + }, + "DataLakeLifecycleExpirationDaysInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "DataLakeLifecycleTransition":{ + "type":"structure", + "members":{ + "days":{ + "shape":"DataLakeLifecycleTransitionDaysInteger", + "documentation":"Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.
" + }, + "storageClass":{ + "shape":"DataLakeStorageClass", + "documentation":"The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.
" + } + }, + "documentation":"Provide transition lifecycle details of Amazon Security Lake object.
" + }, + "DataLakeLifecycleTransitionDaysInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "DataLakeLifecycleTransitionList":{ + "type":"list", + "member":{"shape":"DataLakeLifecycleTransition"} + }, + "DataLakeReplicationConfiguration":{ + "type":"structure", + "members":{ + "regions":{ + "shape":"RegionList", + "documentation":"Specifies one or more centralized rollup Regions. The Amazon Web Services Region specified in the region parameter of the CreateDataLake or UpdateDataLake operations contributes data to the rollup Region or Regions specified in this parameter.
Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Regions or within the same Region as the source bucket.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.
" + } + }, + "documentation":"Provides replication details for objects stored in the Amazon Security Lake data lake.
" + }, + "DataLakeResource":{ + "type":"structure", + "required":[ + "dataLakeArn", + "region" + ], + "members":{ + "createStatus":{ + "shape":"DataLakeStatus", + "documentation":"Retrieves the status of the configuration operation for an account in Amazon Security Lake.
" + }, + "dataLakeArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the Amazon Security Lake User Guide.
" + }, + "encryptionConfiguration":{ + "shape":"DataLakeEncryptionConfiguration", + "documentation":"Provides encryption details of Amazon Security Lake object.
" + }, + "lifecycleConfiguration":{ + "shape":"DataLakeLifecycleConfiguration", + "documentation":"Provides lifecycle details of Amazon Security Lake object.
" + }, + "region":{ + "shape":"Region", + "documentation":"The Amazon Web Services Regions where Security Lake is enabled.
" + }, + "replicationConfiguration":{ + "shape":"DataLakeReplicationConfiguration", + "documentation":"Provides replication details of Amazon Security Lake object.
" + }, + "s3BucketArn":{ + "shape":"S3BucketArn", + "documentation":"The ARN for the Amazon Security Lake Amazon S3 bucket.
" + }, + "updateStatus":{ + "shape":"DataLakeUpdateStatus", + "documentation":"The status of the last UpdateDataLake or DeleteDataLake API request.
Provides details of Amazon Security Lake object.
" + }, + "DataLakeResourceList":{ + "type":"list", + "member":{"shape":"DataLakeResource"} + }, + "DataLakeSource":{ + "type":"structure", + "members":{ + "account":{ + "shape":"String", + "documentation":"The ID of the Security Lake account for which logs are collected.
" + }, + "eventClasses":{ + "shape":"OcsfEventClassList", + "documentation":"The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake. The supported event classes are:
ACCESS_ACTIVITY
FILE_ACTIVITY
KERNEL_ACTIVITY
KERNEL_EXTENSION
MEMORY_ACTIVITY
MODULE_ACTIVITY
PROCESS_ACTIVITY
REGISTRY_KEY_ACTIVITY
REGISTRY_VALUE_ACTIVITY
RESOURCE_ACTIVITY
SCHEDULED_JOB_ACTIVITY
SECURITY_FINDING
ACCOUNT_CHANGE
AUTHENTICATION
AUTHORIZATION
ENTITY_MANAGEMENT_AUDIT
DHCP_ACTIVITY
NETWORK_ACTIVITY
DNS_ACTIVITY
FTP_ACTIVITY
HTTP_ACTIVITY
RDP_ACTIVITY
SMB_ACTIVITY
SSH_ACTIVITY
CONFIG_STATE
INVENTORY_INFO
EMAIL_ACTIVITY
API_ACTIVITY
CLOUD_API
The supported Amazon Web Services from which logs and events are collected. Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.
" + }, + "sourceStatuses":{ + "shape":"DataLakeSourceStatusList", + "documentation":"The log status for the Security Lake account.
" + } + }, + "documentation":"Amazon Security Lake collects logs and events from supported Amazon Web Services and custom sources. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
" + }, + "DataLakeSourceList":{ + "type":"list", + "member":{"shape":"DataLakeSource"} + }, + "DataLakeSourceStatus":{ + "type":"structure", + "members":{ + "resource":{ + "shape":"String", + "documentation":"Defines path the stored logs are available which has information on your systems, applications, and services.
" + }, + "status":{ + "shape":"SourceCollectionStatus", + "documentation":"The health status of services, including error codes and patterns.
" + } + }, + "documentation":"Retrieves the Logs status for the Amazon Security Lake account.
" + }, + "DataLakeSourceStatusList":{ + "type":"list", + "member":{"shape":"DataLakeSourceStatus"} + }, + "DataLakeStatus":{ + "type":"string", + "enum":[ + "INITIALIZED", + "PENDING", + "COMPLETED", + "FAILED" + ] + }, + "DataLakeStorageClass":{"type":"string"}, + "DataLakeUpdateException":{ + "type":"structure", + "members":{ + "code":{ + "shape":"String", + "documentation":"The reason code for the exception of the last UpdateDataLake or DeleteDataLake API request.
The reason for the exception of the last UpdateDataLakeor DeleteDataLake API request.
The details of the last UpdateDataLake or DeleteDataLake API request which failed.
The details of the last UpdateDataLakeor DeleteDataLake API request which failed.
The unique ID for the last UpdateDataLake or DeleteDataLake API request.
The status of the last UpdateDataLake or DeleteDataLake API request that was requested.
The status of the last UpdateDataLake or DeleteDataLake API request. This is set to Completed after the configuration is updated, or removed if deletion of the data lake is successful.
Specify the natively-supported Amazon Web Services service to remove as a source in Security Lake.
" + } + } + }, + "DeleteAwsLogSourceResponse":{ + "type":"structure", + "members":{ + "failed":{ + "shape":"AccountList", + "documentation":"Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.
" + } + } + }, + "DeleteCustomLogSourceRequest":{ + "type":"structure", + "required":["sourceName"], + "members":{ + "sourceName":{ + "shape":"CustomLogSourceName", + "documentation":"The source name of custom log source that you want to delete.
", + "location":"uri", + "locationName":"sourceName" + }, + "sourceVersion":{ + "shape":"CustomLogSourceVersion", + "documentation":"The source version for the third-party custom source. You can limit the custom source removal to the specified source version.
", + "location":"querystring", + "locationName":"sourceVersion" + } + } + }, + "DeleteCustomLogSourceResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteDataLakeExceptionSubscriptionRequest":{ + "type":"structure", + "members":{ + } + }, + "DeleteDataLakeExceptionSubscriptionResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteDataLakeOrganizationConfigurationRequest":{ + "type":"structure", + "members":{ + "autoEnableNewAccount":{ + "shape":"DataLakeAutoEnableNewAccountConfigurationList", + "documentation":"Turns off automatic enablement of Security Lake for member accounts that are added to an organization.
" + } + } + }, + "DeleteDataLakeOrganizationConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteDataLakeRequest":{ + "type":"structure", + "required":["regions"], + "members":{ + "regions":{ + "shape":"RegionList", + "documentation":"The list of Regions where Security Lake is enabled.
" + } + } + }, + "DeleteDataLakeResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteSubscriberNotificationRequest":{ + "type":"structure", + "required":["subscriberId"], + "members":{ + "subscriberId":{ + "shape":"UUID", + "documentation":"The ID of the Security Lake subscriber account.
", + "location":"uri", + "locationName":"subscriberId" + } + } + }, + "DeleteSubscriberNotificationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteSubscriberRequest":{ + "type":"structure", + "required":["subscriberId"], + "members":{ + "subscriberId":{ + "shape":"UUID", + "documentation":"A value created by Security Lake that uniquely identifies your DeleteSubscriber API request.
The expiration period and time-to-live (TTL).
" + }, + "notificationEndpoint":{ + "shape":"SafeString", + "documentation":"The Amazon Web Services account where you receive exception notifications.
" + }, + "subscriptionProtocol":{ + "shape":"SubscriptionProtocol", + "documentation":"The subscription protocol to which exception notifications are posted.
" + } + } + }, + "GetDataLakeOrganizationConfigurationRequest":{ + "type":"structure", + "members":{ + } + }, + "GetDataLakeOrganizationConfigurationResponse":{ + "type":"structure", + "members":{ + "autoEnableNewAccount":{ + "shape":"DataLakeAutoEnableNewAccountConfigurationList", + "documentation":"The configuration for new accounts.
" + } + } + }, + "GetDataLakeSourcesRequest":{ + "type":"structure", + "members":{ + "accounts":{ + "shape":"AccountList", + "documentation":"The Amazon Web Services account ID for which a static snapshot of the current Amazon Web Services Region, including enabled accounts and log sources, is retrieved.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum limit of accounts for which the static snapshot of the current Region, including enabled accounts and log sources, is retrieved.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
" + } + } + }, + "GetDataLakeSourcesResponse":{ + "type":"structure", + "members":{ + "dataLakeArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the Amazon Security Lake User Guide.
" + }, + "dataLakeSources":{ + "shape":"DataLakeSourceList", + "documentation":"The list of enabled accounts and enabled sources.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
" + } + } + }, + "GetSubscriberRequest":{ + "type":"structure", + "required":["subscriberId"], + "members":{ + "subscriberId":{ + "shape":"UUID", + "documentation":"A value created by Amazon Security Lake that uniquely identifies your GetSubscriber API request.
The subscriber information for the specified subscriber ID.
" + } + } + }, + "HttpMethod":{ + "type":"string", + "enum":[ + "POST", + "PUT" + ] + }, + "HttpsNotificationConfiguration":{ + "type":"structure", + "required":[ + "endpoint", + "targetRoleArn" + ], + "members":{ + "authorizationApiKeyName":{ + "shape":"String", + "documentation":"The key name for the notification subscription.
" + }, + "authorizationApiKeyValue":{ + "shape":"String", + "documentation":"The key value for the notification subscription.
" + }, + "endpoint":{ + "shape":"HttpsNotificationConfigurationEndpointString", + "documentation":"The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.
" + }, + "httpMethod":{ + "shape":"HttpMethod", + "documentation":"The HTTPS method used for the notification subscription.
" + }, + "targetRoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. For more information about ARNs and how to use them in policies, see Managing data access and Amazon Web Services Managed Policies in the Amazon Security Lake User Guide.
" + } + }, + "documentation":"The configurations for HTTPS subscriber notification.
" + }, + "HttpsNotificationConfigurationEndpointString":{ + "type":"string", + "pattern":"^https?://.+$" + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "ListDataLakeExceptionsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"List the maximum number of failures in Security Lake.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
" + }, + "regions":{ + "shape":"RegionList", + "documentation":"The Amazon Web Services Regions from which exceptions are retrieved.
" + } + } + }, + "ListDataLakeExceptionsResponse":{ + "type":"structure", + "members":{ + "exceptions":{ + "shape":"DataLakeExceptionList", + "documentation":"Lists the failures that cannot be retried in the current Region.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
" + } + } + }, + "ListDataLakesRequest":{ + "type":"structure", + "members":{ + "regions":{ + "shape":"RegionList", + "documentation":"The list of Regions where Security Lake is enabled.
", + "location":"querystring", + "locationName":"regions" + } + } + }, + "ListDataLakesResponse":{ + "type":"structure", + "members":{ + "dataLakes":{ + "shape":"DataLakeResourceList", + "documentation":"Retrieves the Security Lake configuration object.
" + } + } + }, + "ListLogSourcesRequest":{ + "type":"structure", + "members":{ + "accounts":{ + "shape":"AccountList", + "documentation":"The list of Amazon Web Services accounts for which log sources are displayed.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of accounts for which the log sources are displayed.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
" + }, + "regions":{ + "shape":"RegionList", + "documentation":"The list of Regions for which log sources are displayed.
" + }, + "sources":{ + "shape":"LogSourceResourceList", + "documentation":"The list of sources for which log sources are displayed.
" + } + } + }, + "ListLogSourcesResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
" + }, + "sources":{ + "shape":"LogSourceList", + "documentation":"The list of log sources in your organization that send data to the data lake.
" + } + } + }, + "ListSubscribersRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of accounts for which the configuration is displayed.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListSubscribersResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
" + }, + "subscribers":{ + "shape":"SubscriberResourceList", + "documentation":"The subscribers available for the specified Security Lake account ID.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Security Lake resource for which you want to retrieve the tags.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"An array of objects, one for each tag (key and value) that’s associated with the Amazon Security Lake resource.
" + } + } + }, + "LogSource":{ + "type":"structure", + "members":{ + "account":{ + "shape":"AwsAccountId", + "documentation":"Specify the account from which you want to collect logs.
" + }, + "region":{ + "shape":"Region", + "documentation":"Specify the Regions from which you want to collect logs.
" + }, + "sources":{ + "shape":"LogSourceResourceList", + "documentation":"Specify the sources from which you want to collect logs.
" + } + }, + "documentation":"Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services and custom sources.
" + }, + "LogSourceList":{ + "type":"list", + "member":{"shape":"LogSource"} + }, + "LogSourceResource":{ + "type":"structure", + "members":{ + "awsLogSource":{ + "shape":"AwsLogSourceResource", + "documentation":"Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.
" + }, + "customLogSource":{ + "shape":"CustomLogSourceResource", + "documentation":"Amazon Security Lake supports custom source types. For more information, see the Amazon Security Lake User Guide.
" + } + }, + "documentation":"The supported source types from which logs and events are collected in Amazon Security Lake. For a list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
", + "union":true + }, + "LogSourceResourceList":{ + "type":"list", + "member":{"shape":"LogSourceResource"} + }, + "Long":{ + "type":"long", + "box":true + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "NextToken":{ + "type":"string", + "max":2048, + "min":0 + }, + "NotificationConfiguration":{ + "type":"structure", + "members":{ + "httpsNotificationConfiguration":{ + "shape":"HttpsNotificationConfiguration", + "documentation":"The configurations for HTTPS subscriber notification.
" + }, + "sqsNotificationConfiguration":{ + "shape":"SqsNotificationConfiguration", + "documentation":"The configurations for SQS subscriber notification.
" + } + }, + "documentation":"Specify the configurations you want to use for subscriber notification to notify the subscriber when new data is written to the data lake for sources that the subscriber consumes in Security Lake.
", + "union":true + }, + "OcsfEventClass":{ + "type":"string", + "pattern":"^[A-Z\\_0-9]*$" + }, + "OcsfEventClassList":{ + "type":"list", + "member":{"shape":"OcsfEventClass"} + }, + "Region":{ + "type":"string", + "pattern":"^(us(-gov)?|af|ap|ca|eu|me|sa)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-\\d+$" + }, + "RegionList":{ + "type":"list", + "member":{"shape":"Region"} + }, + "RegisterDataLakeDelegatedAdministratorRequest":{ + "type":"structure", + "required":["accountId"], + "members":{ + "accountId":{ + "shape":"SafeString", + "documentation":"The Amazon Web Services account ID of the Security Lake delegated administrator.
" + } + } + }, + "RegisterDataLakeDelegatedAdministratorResponse":{ + "type":"structure", + "members":{ + } + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "resourceName":{ + "shape":"String", + "documentation":"The name of the resource that could not be found.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The type of the resource that could not be found.
" + } + }, + "documentation":"The resource could not be found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceShareArn":{"type":"string"}, + "ResourceShareName":{ + "type":"string", + "pattern":"^LakeFormation(?:-V[0-9]+)-([a-zA-Z0-9]+)-([\\\\\\w\\-_:/.@=+]*)$" + }, + "RoleArn":{ + "type":"string", + "pattern":"^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" + }, + "S3BucketArn":{"type":"string"}, + "S3URI":{ + "type":"string", + "documentation":"A complete S3 URI pointing to a valid S3 object.
", + "max":1024, + "min":0, + "pattern":"^s3[an]?://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/[^/].*)+$" + }, + "SafeString":{ + "type":"string", + "pattern":"^[\\\\\\w\\-_:/.@=+]*$" + }, + "SourceCollectionStatus":{ + "type":"string", + "enum":[ + "COLLECTING", + "MISCONFIGURED", + "NOT_COLLECTING" + ] + }, + "SqsNotificationConfiguration":{ + "type":"structure", + "members":{ + }, + "documentation":"The configurations for SQS subscriber notification.
" + }, + "String":{"type":"string"}, + "SubscriberResource":{ + "type":"structure", + "required":[ + "sources", + "subscriberArn", + "subscriberId", + "subscriberIdentity", + "subscriberName" + ], + "members":{ + "accessTypes":{ + "shape":"AccessTypeList", + "documentation":"You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.
Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION.
The date and time when the subscriber was created.
" + }, + "resourceShareArn":{ + "shape":"ResourceShareArn", + "documentation":"The Amazon Resource Name (ARN) which uniquely defines the Amazon Web Services RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.
This field is available only for Lake Formation subscribers created after March 8, 2023.
" + }, + "resourceShareName":{ + "shape":"ResourceShareName", + "documentation":"The name of the resource share.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) specifying the role of the subscriber.
" + }, + "s3BucketArn":{ + "shape":"S3BucketArn", + "documentation":"The ARN for the Amazon S3 bucket.
" + }, + "sources":{ + "shape":"LogSourceResourceList", + "documentation":"Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.
" + }, + "subscriberArn":{ + "shape":"AmazonResourceName", + "documentation":"The subscriber ARN of the Amazon Security Lake subscriber account.
" + }, + "subscriberDescription":{ + "shape":"SafeString", + "documentation":"The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriberId.
The subscriber endpoint to which exception messages are posted.
" + }, + "subscriberId":{ + "shape":"UUID", + "documentation":"The subscriber ID of the Amazon Security Lake subscriber account.
" + }, + "subscriberIdentity":{ + "shape":"AwsIdentity", + "documentation":"The Amazon Web Services identity used to access your data.
" + }, + "subscriberName":{ + "shape":"SafeString", + "documentation":"The name of your Amazon Security Lake subscriber account.
" + }, + "subscriberStatus":{ + "shape":"SubscriberStatus", + "documentation":"The subscriber status of the Amazon Security Lake subscriber account.
" + }, + "updatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date and time when the subscriber was last updated.
" + } + }, + "documentation":"Provides details about the Amazon Security Lake account subscription. Subscribers are notified of new objects for a source as the data is written to your Amazon S3 bucket for Security Lake.
" + }, + "SubscriberResourceList":{ + "type":"list", + "member":{"shape":"SubscriberResource"} + }, + "SubscriberStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "DEACTIVATED", + "PENDING", + "READY" + ] + }, + "SubscriptionProtocol":{ + "type":"string", + "pattern":"^[a-z\\-]*$" + }, + "SyntheticTimestamp_date_time":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "Tag":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"The name of the tag. This is a general label that acts as a category for a more specific tag value (value).
The value that’s associated with the specified tag key (key). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.
A tag is a label that you can define and associate with Amazon Web Services resources, including certain types of Amazon Security Lake resources. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. You can associate tags with the following types of Security Lake resources: subscribers, and the data lake configuration for your Amazon Web Services account in individual Amazon Web Services Regions.
A resource can have up to 50 tags. Each tag consists of a required tag key and an associated tag value. A tag key is a general label that acts as a category for a more specific tag value. Each tag key must be unique and it can have only one tag value. A tag value acts as a descriptor for a tag key. Tag keys and values are case sensitive. They can contain letters, numbers, spaces, or the following symbols: _ . : / = + @ -
For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":0 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Security Lake resource to add or update the tags for.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagList", + "documentation":"An array of objects, one for each tag (key and value) to associate with the Amazon Security Lake resource. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "quotaCode":{ + "shape":"String", + "documentation":"That the rate of requests to Security Lake is exceeding the request quotas for your Amazon Web Services account.
" + }, + "retryAfterSeconds":{ + "shape":"Integer", + "documentation":"Retry the request after the specified time.
", + "location":"header", + "locationName":"Retry-After" + }, + "serviceCode":{ + "shape":"String", + "documentation":"The code for the service in Service Quotas.
" + } + }, + "documentation":"The limit on the number of requests per second was exceeded.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":true} + }, + "UUID":{ + "type":"string", + "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Security Lake resource to remove one or more tags from.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"A list of one or more tag keys. For each value in the list, specify the tag key for a tag to remove from the Amazon Security Lake resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateDataLakeExceptionSubscriptionRequest":{ + "type":"structure", + "required":[ + "notificationEndpoint", + "subscriptionProtocol" + ], + "members":{ + "exceptionTimeToLive":{ + "shape":"UpdateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong", + "documentation":"The time-to-live (TTL) for the exception message to remain.
" + }, + "notificationEndpoint":{ + "shape":"SafeString", + "documentation":"The account that is subscribed to receive exception notifications.
" + }, + "subscriptionProtocol":{ + "shape":"SubscriptionProtocol", + "documentation":"The subscription protocol to which exception messages are posted.
" + } + } + }, + "UpdateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong":{ + "type":"long", + "box":true, + "min":1 + }, + "UpdateDataLakeExceptionSubscriptionResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateDataLakeRequest":{ + "type":"structure", + "required":["configurations"], + "members":{ + "configurations":{ + "shape":"DataLakeConfigurationList", + "documentation":"Specify the Region or Regions that will contribute data to the rollup region.
" + }, + "metaStoreManagerRoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) used to create and update the Glue table. This table contains partitions generated by the ingestion and normalization of Amazon Web Services log sources and custom sources.
" + } + } + }, + "UpdateDataLakeResponse":{ + "type":"structure", + "members":{ + "dataLakes":{ + "shape":"DataLakeResourceList", + "documentation":"The created Security Lake configuration object.
" + } + } + }, + "UpdateSubscriberNotificationRequest":{ + "type":"structure", + "required":[ + "configuration", + "subscriberId" + ], + "members":{ + "configuration":{ + "shape":"NotificationConfiguration", + "documentation":"The configuration for subscriber notification.
" + }, + "subscriberId":{ + "shape":"UUID", + "documentation":"The subscription ID for which the subscription notification is specified.
", + "location":"uri", + "locationName":"subscriberId" + } + } + }, + "UpdateSubscriberNotificationResponse":{ + "type":"structure", + "members":{ + "subscriberEndpoint":{ + "shape":"SafeString", + "documentation":"The subscriber endpoint to which exception messages are posted.
" + } + } + }, + "UpdateSubscriberRequest":{ + "type":"structure", + "required":["subscriberId"], + "members":{ + "sources":{ + "shape":"LogSourceResourceList", + "documentation":"The supported Amazon Web Services from which logs and events are collected. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
" + }, + "subscriberDescription":{ + "shape":"DescriptionString", + "documentation":"The description of the Security Lake account subscriber.
" + }, + "subscriberId":{ + "shape":"UUID", + "documentation":"A value created by Security Lake that uniquely identifies your subscription.
", + "location":"uri", + "locationName":"subscriberId" + }, + "subscriberIdentity":{ + "shape":"AwsIdentity", + "documentation":"The AWS identity used to access your data.
" + }, + "subscriberName":{ + "shape":"UpdateSubscriberRequestSubscriberNameString", + "documentation":"The name of the Security Lake account subscriber.
" + } + } + }, + "UpdateSubscriberRequestSubscriberNameString":{ + "type":"string", + "max":64, + "min":0, + "pattern":"^[\\\\\\w\\-_:/.@=+]*$" + }, + "UpdateSubscriberResponse":{ + "type":"structure", + "members":{ + "subscriber":{ + "shape":"SubscriberResource", + "documentation":"The updated subscriber information.
" + } + } + } + }, + "documentation":"Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to automatically centralize security data from cloud, on-premises, and custom sources into a data lake that's stored in your Amazon Web Services account. Amazon Web Services Organizations is an account management service that lets you consolidate multiple Amazon Web Services accounts into an organization that you create and centrally manage. With Organizations, you can create member accounts and invite existing accounts to join your organization. Security Lake helps you analyze security data for a more complete understanding of your security posture across the entire organization. It can also help you improve the protection of your workloads, applications, and data.
The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets, and you retain ownership over your data.
Amazon Security Lake integrates with CloudTrail, a service that provides a record of actions taken by a user, role, or an Amazon Web Services service. In Security Lake, CloudTrail captures API calls for Security Lake as events. The calls captured include calls from the Security Lake console and code calls to the Security Lake API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail you can determine the request that was made to Security Lake, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about Security Lake information in CloudTrail, see the Amazon Security Lake User Guide.
Security Lake automates the collection of security-related log and event data from integrated Amazon Web Services and third-party services. It also helps you manage the lifecycle of data with customizable retention and replication settings. Security Lake converts ingested data into Apache Parquet format and a standard open-source schema called the Open Cybersecurity Schema Framework (OCSF).
Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for incident response and security data analytics.
" +} diff --git a/testbed/boto__botocore/botocore/data/ssm-sap/2018-05-10/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/ssm-sap/2018-05-10/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..886227ea34ceefc32f696d7307bce0b9088b2306 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/ssm-sap/2018-05-10/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-sap-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-sap-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-sap.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-sap.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/support-app/2021-08-20/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/support-app/2021-08-20/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..99f5d478b8784b92877680a82240795f8771526c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/support-app/2021-08-20/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://supportapp-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://supportapp-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://supportapp.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://supportapp.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/support-app/2021-08-20/paginators-1.json b/testbed/boto__botocore/botocore/data/support-app/2021-08-20/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..ea142457a6a77d6e6a54942329f1199bc2f2a60c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/support-app/2021-08-20/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/testbed/boto__botocore/botocore/data/support-app/2021-08-20/service-2.json b/testbed/boto__botocore/botocore/data/support-app/2021-08-20/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..1315e4ff6a5cef08ecdc2d772ba3d450ba7365fc --- /dev/null +++ b/testbed/boto__botocore/botocore/data/support-app/2021-08-20/service-2.json @@ -0,0 +1,661 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-08-20", + "endpointPrefix":"supportapp", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"SupportApp", + "serviceFullName":"AWS Support App", + "serviceId":"Support App", + "signatureVersion":"v4", + "signingName":"supportapp", + "uid":"support-app-2021-08-20" + }, + "operations":{ + "CreateSlackChannelConfiguration":{ + "name":"CreateSlackChannelConfiguration", + "http":{ + "method":"POST", + "requestUri":"/control/create-slack-channel-configuration", + "responseCode":200 + }, + "input":{"shape":"CreateSlackChannelConfigurationRequest"}, + "output":{"shape":"CreateSlackChannelConfigurationResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Creates a Slack channel configuration for your Amazon Web Services account.
You can add up to 5 Slack workspaces for your account.
You can add up to 20 Slack channels for your account.
A Slack channel can have up to 100 Amazon Web Services accounts. This means that only 100 accounts can add the same Slack channel to the Amazon Web Services Support App. We recommend that you only add the accounts that you need to manage support cases for your organization. This can reduce the notifications about case updates that you receive in the Slack channel.
We recommend that you choose a private Slack channel so that only members in that channel have read and write access to your support cases. Anyone in your Slack channel can create, update, or resolve support cases for your account. Users require an invitation to join private channels.
Deletes an alias for an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.
" + }, + "DeleteSlackChannelConfiguration":{ + "name":"DeleteSlackChannelConfiguration", + "http":{ + "method":"POST", + "requestUri":"/control/delete-slack-channel-configuration", + "responseCode":200 + }, + "input":{"shape":"DeleteSlackChannelConfigurationRequest"}, + "output":{"shape":"DeleteSlackChannelConfigurationResult"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't delete your Slack channel.
" + }, + "DeleteSlackWorkspaceConfiguration":{ + "name":"DeleteSlackWorkspaceConfiguration", + "http":{ + "method":"POST", + "requestUri":"/control/delete-slack-workspace-configuration", + "responseCode":200 + }, + "input":{"shape":"DeleteSlackWorkspaceConfigurationRequest"}, + "output":{"shape":"DeleteSlackWorkspaceConfigurationResult"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes a Slack workspace configuration from your Amazon Web Services account. This operation doesn't delete your Slack workspace.
" + }, + "GetAccountAlias":{ + "name":"GetAccountAlias", + "http":{ + "method":"POST", + "requestUri":"/control/get-account-alias", + "responseCode":200 + }, + "input":{"shape":"GetAccountAliasRequest"}, + "output":{"shape":"GetAccountAliasResult"}, + "errors":[ + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves the alias from an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.
" + }, + "ListSlackChannelConfigurations":{ + "name":"ListSlackChannelConfigurations", + "http":{ + "method":"POST", + "requestUri":"/control/list-slack-channel-configurations", + "responseCode":200 + }, + "input":{"shape":"ListSlackChannelConfigurationsRequest"}, + "output":{"shape":"ListSlackChannelConfigurationsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists the Slack channel configurations for an Amazon Web Services account.
" + }, + "ListSlackWorkspaceConfigurations":{ + "name":"ListSlackWorkspaceConfigurations", + "http":{ + "method":"POST", + "requestUri":"/control/list-slack-workspace-configurations", + "responseCode":200 + }, + "input":{"shape":"ListSlackWorkspaceConfigurationsRequest"}, + "output":{"shape":"ListSlackWorkspaceConfigurationsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists the Slack workspace configurations for an Amazon Web Services account.
" + }, + "PutAccountAlias":{ + "name":"PutAccountAlias", + "http":{ + "method":"POST", + "requestUri":"/control/put-account-alias", + "responseCode":200 + }, + "input":{"shape":"PutAccountAliasRequest"}, + "output":{"shape":"PutAccountAliasResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Creates or updates an individual alias for each Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.
" + }, + "RegisterSlackWorkspaceForOrganization":{ + "name":"RegisterSlackWorkspaceForOrganization", + "http":{ + "method":"POST", + "requestUri":"/control/register-slack-workspace-for-organization", + "responseCode":200 + }, + "input":{"shape":"RegisterSlackWorkspaceForOrganizationRequest"}, + "output":{"shape":"RegisterSlackWorkspaceForOrganizationResult"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Registers a Slack workspace for your Amazon Web Services account. To call this API, your account must be part of an organization in Organizations.
If you're the management account and you want to register Slack workspaces for your organization, you must complete the following tasks:
Sign in to the Amazon Web Services Support Center and authorize the Slack workspaces where you want your organization to have access to. See Authorize a Slack workspace in the Amazon Web Services Support User Guide.
Call the RegisterSlackWorkspaceForOrganization API to authorize each Slack workspace for the organization.
After the management account authorizes the Slack workspace, member accounts can call this API to authorize the same Slack workspace for their individual accounts. Member accounts don't need to authorize the Slack workspace manually through the Amazon Web Services Support Center.
To use the Amazon Web Services Support App, each account must then complete the following tasks:
Create an Identity and Access Management (IAM) role with the required permission. For more information, see Managing access to the Amazon Web Services Support App.
Configure a Slack channel to use the Amazon Web Services Support App for support cases for that account. For more information, see Configuring a Slack channel.
Updates the configuration for a Slack channel, such as case update notifications.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"You don't have sufficient permission to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccountType":{ + "type":"string", + "enum":[ + "management", + "member" + ] + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"Your request has a conflict. For example, you might receive this error if you try the following:
Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.
Add a Slack channel configuration that already exists in your Amazon Web Services account.
Delete a Slack channel configuration for a live chat channel.
Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.
Call the RegisterSlackWorkspaceForOrganization API from an Amazon Web Services account that doesn't belong to an organization.
Call the RegisterSlackWorkspaceForOrganization API from a member account, but the management account hasn't registered that workspace yet for the organization.
The channel ID in Slack. This ID identifies a channel within a Slack workspace.
" + }, + "channelName":{ + "shape":"channelName", + "documentation":"The name of the Slack channel that you configure for the Amazon Web Services Support App.
" + }, + "channelRoleArn":{ + "shape":"roleArn", + "documentation":"The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.
" + }, + "notifyOnAddCorrespondenceToCase":{ + "shape":"booleanValue", + "documentation":"Whether you want to get notified when a support case has a new correspondence.
" + }, + "notifyOnCaseSeverity":{ + "shape":"NotificationSeverityLevel", + "documentation":"The case severity for a support case that you want to receive notifications.
If you specify high or all, you must specify true for at least one of the following parameters:
notifyOnAddCorrespondenceToCase
notifyOnCreateOrReopenCase
notifyOnResolveCase
If you specify none, the following parameters must be null or false:
notifyOnAddCorrespondenceToCase
notifyOnCreateOrReopenCase
notifyOnResolveCase
If you don't specify these parameters in your request, they default to false.
Whether you want to get notified when a support case is created or reopened.
" + }, + "notifyOnResolveCase":{ + "shape":"booleanValue", + "documentation":"Whether you want to get notified when a support case is resolved.
" + }, + "teamId":{ + "shape":"teamId", + "documentation":"The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.
The channel ID in Slack. This ID identifies a channel within a Slack workspace.
" + }, + "teamId":{ + "shape":"teamId", + "documentation":"The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.
The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.
An alias or short name for an Amazon Web Services account.
" + } + } + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"We can’t process your request right now because of a server issue. Try again later.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "ListSlackChannelConfigurationsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"paginationToken", + "documentation":"If the results of a search are large, the API only returns a portion of the results and includes a nextToken pagination token in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When the API returns the last set of results, the response doesn't include a pagination token value.
The point where pagination should resume when the response returns only partial results.
" + }, + "slackChannelConfigurations":{ + "shape":"slackChannelConfigurationList", + "documentation":"The configurations for a Slack channel.
" + } + } + }, + "ListSlackWorkspaceConfigurationsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"paginationToken", + "documentation":"If the results of a search are large, the API only returns a portion of the results and includes a nextToken pagination token in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When the API returns the last set of results, the response doesn't include a pagination token value.
The point where pagination should resume when the response returns only partial results.
" + }, + "slackWorkspaceConfigurations":{ + "shape":"SlackWorkspaceConfigurationList", + "documentation":"The configurations for a Slack workspace.
" + } + } + }, + "NotificationSeverityLevel":{ + "type":"string", + "enum":[ + "none", + "all", + "high" + ] + }, + "PutAccountAliasRequest":{ + "type":"structure", + "required":["accountAlias"], + "members":{ + "accountAlias":{ + "shape":"awsAccountAlias", + "documentation":"An alias or short name for an Amazon Web Services account.
" + } + } + }, + "PutAccountAliasResult":{ + "type":"structure", + "members":{ + } + }, + "RegisterSlackWorkspaceForOrganizationRequest":{ + "type":"structure", + "required":["teamId"], + "members":{ + "teamId":{ + "shape":"teamId", + "documentation":"The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG. Specify the Slack workspace that you want to use for your organization.
Whether the Amazon Web Services account is a management or member account that's part of an organization in Organizations.
" + }, + "teamId":{ + "shape":"teamId", + "documentation":"The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.
The name of the Slack workspace.
" + } + } + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"Your Service Quotas request exceeds the quota for the service. For example, your Service Quotas request to Amazon Web Services Support App might exceed the maximum number of workspaces or channels per account, or the maximum number of accounts per Slack channel.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SlackChannelConfiguration":{ + "type":"structure", + "required":[ + "channelId", + "teamId" + ], + "members":{ + "channelId":{ + "shape":"channelId", + "documentation":"The channel ID in Slack. This ID identifies a channel within a Slack workspace.
" + }, + "channelName":{ + "shape":"channelName", + "documentation":"The name of the Slack channel that you configured with the Amazon Web Services Support App for your Amazon Web Services account.
" + }, + "channelRoleArn":{ + "shape":"roleArn", + "documentation":"The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.
" + }, + "notifyOnAddCorrespondenceToCase":{ + "shape":"booleanValue", + "documentation":"Whether you want to get notified when a support case has a new correspondence.
" + }, + "notifyOnCaseSeverity":{ + "shape":"NotificationSeverityLevel", + "documentation":"The case severity for a support case that you want to receive notifications.
" + }, + "notifyOnCreateOrReopenCase":{ + "shape":"booleanValue", + "documentation":"Whether you want to get notified when a support case is created or reopened.
" + }, + "notifyOnResolveCase":{ + "shape":"booleanValue", + "documentation":"Whether you want to get notified when a support case is resolved.
" + }, + "teamId":{ + "shape":"teamId", + "documentation":"The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.
The configuration for a Slack channel that you added for your Amazon Web Services account.
" + }, + "SlackWorkspaceConfiguration":{ + "type":"structure", + "required":["teamId"], + "members":{ + "allowOrganizationMemberAccount":{ + "shape":"booleanValue", + "documentation":"Whether to allow member accounts to authorize Slack workspaces. Member accounts must be part of an organization in Organizations.
" + }, + "teamId":{ + "shape":"teamId", + "documentation":"The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.
The name of the Slack workspace.
" + } + }, + "documentation":"The configuration for a Slack workspace that you added to an Amazon Web Services account.
" + }, + "SlackWorkspaceConfigurationList":{ + "type":"list", + "member":{"shape":"SlackWorkspaceConfiguration"} + }, + "UpdateSlackChannelConfigurationRequest":{ + "type":"structure", + "required":[ + "channelId", + "teamId" + ], + "members":{ + "channelId":{ + "shape":"channelId", + "documentation":"The channel ID in Slack. This ID identifies a channel within a Slack workspace.
" + }, + "channelName":{ + "shape":"channelName", + "documentation":"The Slack channel name that you want to update.
" + }, + "channelRoleArn":{ + "shape":"roleArn", + "documentation":"The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.
" + }, + "notifyOnAddCorrespondenceToCase":{ + "shape":"booleanValue", + "documentation":"Whether you want to get notified when a support case has a new correspondence.
" + }, + "notifyOnCaseSeverity":{ + "shape":"NotificationSeverityLevel", + "documentation":"The case severity for a support case that you want to receive notifications.
If you specify high or all, at least one of the following parameters must be true:
notifyOnAddCorrespondenceToCase
notifyOnCreateOrReopenCase
notifyOnResolveCase
If you specify none, any of the following parameters that you specify in your request must be false:
notifyOnAddCorrespondenceToCase
notifyOnCreateOrReopenCase
notifyOnResolveCase
If you don't specify these parameters in your request, the Amazon Web Services Support App uses the current values by default.
Whether you want to get notified when a support case is created or reopened.
" + }, + "notifyOnResolveCase":{ + "shape":"booleanValue", + "documentation":"Whether you want to get notified when a support case is resolved.
" + }, + "teamId":{ + "shape":"teamId", + "documentation":"The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.
The channel ID in Slack. This ID identifies a channel within a Slack workspace.
" + }, + "channelName":{ + "shape":"channelName", + "documentation":"The name of the Slack channel that you configure for the Amazon Web Services Support App.
" + }, + "channelRoleArn":{ + "shape":"roleArn", + "documentation":"The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.
" + }, + "notifyOnAddCorrespondenceToCase":{ + "shape":"booleanValue", + "documentation":"Whether you want to get notified when a support case has a new correspondence.
" + }, + "notifyOnCaseSeverity":{ + "shape":"NotificationSeverityLevel", + "documentation":"The case severity for a support case that you want to receive notifications.
" + }, + "notifyOnCreateOrReopenCase":{ + "shape":"booleanValue", + "documentation":"Whether you want to get notified when a support case is created or reopened.
" + }, + "notifyOnResolveCase":{ + "shape":"booleanValue", + "documentation":"Whether you want to get notified when a support case is resolved.
" + }, + "teamId":{ + "shape":"teamId", + "documentation":"The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.
Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "awsAccountAlias":{ + "type":"string", + "max":30, + "min":1, + "pattern":"^[\\w\\- ]+$" + }, + "booleanValue":{ + "type":"boolean", + "box":true + }, + "channelId":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^\\S+$" + }, + "channelName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^.+$" + }, + "errorMessage":{"type":"string"}, + "paginationToken":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^\\S+$" + }, + "roleArn":{ + "type":"string", + "max":2048, + "min":31, + "pattern":"^arn:aws:iam::[0-9]{12}:role/(.+)$" + }, + "slackChannelConfigurationList":{ + "type":"list", + "member":{"shape":"SlackChannelConfiguration"} + }, + "teamId":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^\\S+$" + }, + "teamName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^.+$" + } + }, + "documentation":"You can use the Amazon Web Services Support App in Slack API to manage your support cases in Slack for your Amazon Web Services account. After you configure your Slack workspace and channel with the Amazon Web Services Support App, you can perform the following tasks directly in your Slack channel:
Create, search, update, and resolve your support cases
Request service quota increases for your account
Invite Amazon Web Services Support agents to your channel so that you can chat directly about your support cases
For more information about how to perform these actions in Slack, see the following documentation in the Amazon Web Services Support User Guide:
You can also use the Amazon Web Services Management Console instead of the Amazon Web Services Support App API to manage your Slack configurations. For more information, see Authorize a Slack workspace to enable the Amazon Web Services Support App.
You must have a Business or Enterprise Support plan to use the Amazon Web Services Support App API.
For more information about the Amazon Web Services Support App endpoints, see the Amazon Web Services Support App in Slack endpoints in the Amazon Web Services General Reference.
Cancels a network operation.
A network operation is any operation that is done to your network, such as network instance instantiation or termination.
" + }, + "CreateSolFunctionPackage":{ + "name":"CreateSolFunctionPackage", + "http":{ + "method":"POST", + "requestUri":"/sol/vnfpkgm/v1/vnf_packages", + "responseCode":201 + }, + "input":{"shape":"CreateSolFunctionPackageInput"}, + "output":{"shape":"CreateSolFunctionPackageOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a function package.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see Function packages in the Amazon Web Services Telco Network Builder User Guide.
Creating a function package is the first step for creating a network in AWS TNB. This request creates an empty container with an ID. The next step is to upload the actual CSAR zip file into that empty container. To upload function package content, see PutSolFunctionPackageContent.
" + }, + "CreateSolNetworkInstance":{ + "name":"CreateSolNetworkInstance", + "http":{ + "method":"POST", + "requestUri":"/sol/nslcm/v1/ns_instances", + "responseCode":201 + }, + "input":{"shape":"CreateSolNetworkInstanceInput"}, + "output":{"shape":"CreateSolNetworkInstanceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a network instance.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Creating a network instance is the third step after creating a network package. For more information about network instances, Network instances in the Amazon Web Services Telco Network Builder User Guide.
Once you create a network instance, you can instantiate it. To instantiate a network, see InstantiateSolNetworkInstance.
" + }, + "CreateSolNetworkPackage":{ + "name":"CreateSolNetworkPackage", + "http":{ + "method":"POST", + "requestUri":"/sol/nsd/v1/ns_descriptors", + "responseCode":201 + }, + "input":{"shape":"CreateSolNetworkPackageInput"}, + "output":{"shape":"CreateSolNetworkPackageOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a network package.
A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see Network instances in the Amazon Web Services Telco Network Builder User Guide.
A network package consists of a network service descriptor (NSD) file (required) and any additional files (optional), such as scripts specific to your needs. For example, if you have multiple function packages in your network package, you can use the NSD to define which network functions should run in certain VPCs, subnets, or EKS clusters.
This request creates an empty network package container with an ID. Once you create a network package, you can upload the network package content using PutSolNetworkPackageContent.
" + }, + "DeleteSolFunctionPackage":{ + "name":"DeleteSolFunctionPackage", + "http":{ + "method":"DELETE", + "requestUri":"/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}", + "responseCode":204 + }, + "input":{"shape":"DeleteSolFunctionPackageInput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a function package.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
To delete a function package, the package must be in a disabled state. To disable a function package, see UpdateSolFunctionPackage.
", + "idempotent":true + }, + "DeleteSolNetworkInstance":{ + "name":"DeleteSolNetworkInstance", + "http":{ + "method":"DELETE", + "requestUri":"/sol/nslcm/v1/ns_instances/{nsInstanceId}", + "responseCode":204 + }, + "input":{"shape":"DeleteSolNetworkInstanceInput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a network instance.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
To delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see TerminateSolNetworkInstance.
", + "idempotent":true + }, + "DeleteSolNetworkPackage":{ + "name":"DeleteSolNetworkPackage", + "http":{ + "method":"DELETE", + "requestUri":"/sol/nsd/v1/ns_descriptors/{nsdInfoId}", + "responseCode":204 + }, + "input":{"shape":"DeleteSolNetworkPackageInput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes network package.
A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
To delete a network package, the package must be in a disable state. To disable a network package, see UpdateSolNetworkPackage.
", + "idempotent":true + }, + "GetSolFunctionInstance":{ + "name":"GetSolFunctionInstance", + "http":{ + "method":"GET", + "requestUri":"/sol/vnflcm/v1/vnf_instances/{vnfInstanceId}", + "responseCode":200 + }, + "input":{"shape":"GetSolFunctionInstanceInput"}, + "output":{"shape":"GetSolFunctionInstanceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets the details of a network function instance, including the instantiation state and metadata from the function package descriptor in the network function package.
A network function instance is a function in a function package .
" + }, + "GetSolFunctionPackage":{ + "name":"GetSolFunctionPackage", + "http":{ + "method":"GET", + "requestUri":"/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}", + "responseCode":200 + }, + "input":{"shape":"GetSolFunctionPackageInput"}, + "output":{"shape":"GetSolFunctionPackageOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets the details of an individual function package, such as the operational state and whether the package is in use.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network..
" + }, + "GetSolFunctionPackageContent":{ + "name":"GetSolFunctionPackageContent", + "http":{ + "method":"GET", + "requestUri":"/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content", + "responseCode":200 + }, + "input":{"shape":"GetSolFunctionPackageContentInput"}, + "output":{"shape":"GetSolFunctionPackageContentOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets the contents of a function package.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
" + }, + "GetSolFunctionPackageDescriptor":{ + "name":"GetSolFunctionPackageDescriptor", + "http":{ + "method":"GET", + "requestUri":"/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd", + "responseCode":200 + }, + "input":{"shape":"GetSolFunctionPackageDescriptorInput"}, + "output":{"shape":"GetSolFunctionPackageDescriptorOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets a function package descriptor in a function package.
A function package descriptor is a .yaml file in a function package that uses the TOSCA standard to describe how the network function in the function package should run on your network.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
" + }, + "GetSolNetworkInstance":{ + "name":"GetSolNetworkInstance", + "http":{ + "method":"GET", + "requestUri":"/sol/nslcm/v1/ns_instances/{nsInstanceId}", + "responseCode":200 + }, + "input":{"shape":"GetSolNetworkInstanceInput"}, + "output":{"shape":"GetSolNetworkInstanceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets the details of the network instance.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
" + }, + "GetSolNetworkOperation":{ + "name":"GetSolNetworkOperation", + "http":{ + "method":"GET", + "requestUri":"/sol/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}", + "responseCode":200 + }, + "input":{"shape":"GetSolNetworkOperationInput"}, + "output":{"shape":"GetSolNetworkOperationOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks.
A network operation is any operation that is done to your network, such as network instance instantiation or termination.
" + }, + "GetSolNetworkPackage":{ + "name":"GetSolNetworkPackage", + "http":{ + "method":"GET", + "requestUri":"/sol/nsd/v1/ns_descriptors/{nsdInfoId}", + "responseCode":200 + }, + "input":{"shape":"GetSolNetworkPackageInput"}, + "output":{"shape":"GetSolNetworkPackageOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets the details of a network package.
A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
" + }, + "GetSolNetworkPackageContent":{ + "name":"GetSolNetworkPackageContent", + "http":{ + "method":"GET", + "requestUri":"/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content", + "responseCode":200 + }, + "input":{"shape":"GetSolNetworkPackageContentInput"}, + "output":{"shape":"GetSolNetworkPackageContentOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets the contents of a network package.
A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
" + }, + "GetSolNetworkPackageDescriptor":{ + "name":"GetSolNetworkPackageDescriptor", + "http":{ + "method":"GET", + "requestUri":"/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd", + "responseCode":200 + }, + "input":{"shape":"GetSolNetworkPackageDescriptorInput"}, + "output":{"shape":"GetSolNetworkPackageDescriptorOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Gets the content of the network service descriptor.
A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.
" + }, + "InstantiateSolNetworkInstance":{ + "name":"InstantiateSolNetworkInstance", + "http":{ + "method":"POST", + "requestUri":"/sol/nslcm/v1/ns_instances/{nsInstanceId}/instantiate", + "responseCode":201 + }, + "input":{"shape":"InstantiateSolNetworkInstanceInput"}, + "output":{"shape":"InstantiateSolNetworkInstanceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Instantiates a network instance.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
Before you can instantiate a network instance, you have to create a network instance. For more information, see CreateSolNetworkInstance.
" + }, + "ListSolFunctionInstances":{ + "name":"ListSolFunctionInstances", + "http":{ + "method":"GET", + "requestUri":"/sol/vnflcm/v1/vnf_instances", + "responseCode":200 + }, + "input":{"shape":"ListSolFunctionInstancesInput"}, + "output":{"shape":"ListSolFunctionInstancesOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists network function instances.
A network function instance is a function in a function package .
" + }, + "ListSolFunctionPackages":{ + "name":"ListSolFunctionPackages", + "http":{ + "method":"GET", + "requestUri":"/sol/vnfpkgm/v1/vnf_packages", + "responseCode":200 + }, + "input":{"shape":"ListSolFunctionPackagesInput"}, + "output":{"shape":"ListSolFunctionPackagesOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists information about function packages.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
" + }, + "ListSolNetworkInstances":{ + "name":"ListSolNetworkInstances", + "http":{ + "method":"GET", + "requestUri":"/sol/nslcm/v1/ns_instances", + "responseCode":200 + }, + "input":{"shape":"ListSolNetworkInstancesInput"}, + "output":{"shape":"ListSolNetworkInstancesOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists your network instances.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
" + }, + "ListSolNetworkOperations":{ + "name":"ListSolNetworkOperations", + "http":{ + "method":"GET", + "requestUri":"/sol/nslcm/v1/ns_lcm_op_occs", + "responseCode":200 + }, + "input":{"shape":"ListSolNetworkOperationsInput"}, + "output":{"shape":"ListSolNetworkOperationsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists details for a network operation, including when the operation started and the status of the operation.
A network operation is any operation that is done to your network, such as network instance instantiation or termination.
" + }, + "ListSolNetworkPackages":{ + "name":"ListSolNetworkPackages", + "http":{ + "method":"GET", + "requestUri":"/sol/nsd/v1/ns_descriptors", + "responseCode":200 + }, + "input":{"shape":"ListSolNetworkPackagesInput"}, + "output":{"shape":"ListSolNetworkPackagesOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists network packages.
A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists tags for AWS TNB resources.
" + }, + "PutSolFunctionPackageContent":{ + "name":"PutSolFunctionPackageContent", + "http":{ + "method":"PUT", + "requestUri":"/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content", + "responseCode":202 + }, + "input":{"shape":"PutSolFunctionPackageContentInput"}, + "output":{"shape":"PutSolFunctionPackageContentOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Uploads the contents of a function package.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
", + "idempotent":true + }, + "PutSolNetworkPackageContent":{ + "name":"PutSolNetworkPackageContent", + "http":{ + "method":"PUT", + "requestUri":"/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content", + "responseCode":200 + }, + "input":{"shape":"PutSolNetworkPackageContentInput"}, + "output":{"shape":"PutSolNetworkPackageContentOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Uploads the contents of a network package.
A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
", + "idempotent":true + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Tags an AWS TNB resource.
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
", + "idempotent":true + }, + "TerminateSolNetworkInstance":{ + "name":"TerminateSolNetworkInstance", + "http":{ + "method":"POST", + "requestUri":"/sol/nslcm/v1/ns_instances/{nsInstanceId}/terminate", + "responseCode":201 + }, + "input":{"shape":"TerminateSolNetworkInstanceInput"}, + "output":{"shape":"TerminateSolNetworkInstanceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Terminates a network instance.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
You must terminate a network instance before you can delete it.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Untags an AWS TNB resource.
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
", + "idempotent":true + }, + "UpdateSolFunctionPackage":{ + "name":"UpdateSolFunctionPackage", + "http":{ + "method":"PATCH", + "requestUri":"/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}", + "responseCode":200 + }, + "input":{"shape":"UpdateSolFunctionPackageInput"}, + "output":{"shape":"UpdateSolFunctionPackageOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates the operational state of function package.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
" + }, + "UpdateSolNetworkInstance":{ + "name":"UpdateSolNetworkInstance", + "http":{ + "method":"POST", + "requestUri":"/sol/nslcm/v1/ns_instances/{nsInstanceId}/update", + "responseCode":201 + }, + "input":{"shape":"UpdateSolNetworkInstanceInput"}, + "output":{"shape":"UpdateSolNetworkInstanceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Update a network instance.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
Choose the updateType parameter to target the necessary update of the network instance.
" + }, + "UpdateSolNetworkPackage":{ + "name":"UpdateSolNetworkPackage", + "http":{ + "method":"PATCH", + "requestUri":"/sol/nsd/v1/ns_descriptors/{nsdInfoId}", + "responseCode":200 + }, + "input":{"shape":"UpdateSolNetworkPackageInput"}, + "output":{"shape":"UpdateSolNetworkPackageOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates the operational state of a network package.
A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.
" + }, + "ValidateSolFunctionPackageContent":{ + "name":"ValidateSolFunctionPackageContent", + "http":{ + "method":"PUT", + "requestUri":"/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content/validate", + "responseCode":202 + }, + "input":{"shape":"ValidateSolFunctionPackageContentInput"}, + "output":{"shape":"ValidateSolFunctionPackageContentOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Validates function package content. This can be used as a dry run before uploading function package content with PutSolFunctionPackageContent.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
", + "idempotent":true + }, + "ValidateSolNetworkPackageContent":{ + "name":"ValidateSolNetworkPackageContent", + "http":{ + "method":"PUT", + "requestUri":"/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content/validate", + "responseCode":200 + }, + "input":{"shape":"ValidateSolNetworkPackageContentInput"}, + "output":{"shape":"ValidateSolNetworkPackageContentOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Validates network package content. This can be used as a dry run before uploading network package content with PutSolNetworkPackageContent.
A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
", + "idempotent":true + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Insufficient permissions to make request.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "Blob":{"type":"blob"}, + "Boolean":{ + "type":"boolean", + "box":true + }, + "CancelSolNetworkOperationInput":{ + "type":"structure", + "required":["nsLcmOpOccId"], + "members":{ + "nsLcmOpOccId":{ + "shape":"NsLcmOpOccId", + "documentation":"The identifier of the network operation.
", + "location":"uri", + "locationName":"nsLcmOpOccId" + } + } + }, + "CreateSolFunctionPackageInput":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "CreateSolFunctionPackageOutput":{ + "type":"structure", + "required":[ + "arn", + "id", + "onboardingState", + "operationalState", + "usageState" + ], + "members":{ + "arn":{ + "shape":"VnfPkgArn", + "documentation":"Function package ARN.
" + }, + "id":{ + "shape":"VnfPkgId", + "documentation":"ID of the function package.
" + }, + "onboardingState":{ + "shape":"OnboardingState", + "documentation":"Onboarding state of the function package.
" + }, + "operationalState":{ + "shape":"OperationalState", + "documentation":"Operational state of the function package.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + }, + "usageState":{ + "shape":"UsageState", + "documentation":"Usage state of the function package.
" + } + } + }, + "CreateSolNetworkInstanceInput":{ + "type":"structure", + "required":[ + "nsName", + "nsdInfoId" + ], + "members":{ + "nsDescription":{ + "shape":"CreateSolNetworkInstanceInputNsDescriptionString", + "documentation":"Network instance description.
" + }, + "nsName":{ + "shape":"CreateSolNetworkInstanceInputNsNameString", + "documentation":"Network instance name.
" + }, + "nsdInfoId":{ + "shape":"NsdInfoId", + "documentation":"ID for network service descriptor.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "CreateSolNetworkInstanceInputNsDescriptionString":{ + "type":"string", + "max":255, + "min":0 + }, + "CreateSolNetworkInstanceInputNsNameString":{ + "type":"string", + "max":100, + "min":1 + }, + "CreateSolNetworkInstanceOutput":{ + "type":"structure", + "required":[ + "arn", + "id", + "nsInstanceName", + "nsdInfoId" + ], + "members":{ + "arn":{ + "shape":"NsInstanceArn", + "documentation":"Network instance ARN.
" + }, + "id":{ + "shape":"NsInstanceId", + "documentation":"Network instance ID.
" + }, + "nsInstanceName":{ + "shape":"String", + "documentation":"Network instance name.
" + }, + "nsdInfoId":{ + "shape":"NsdInfoId", + "documentation":"Network service descriptor ID.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "CreateSolNetworkPackageInput":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "CreateSolNetworkPackageOutput":{ + "type":"structure", + "required":[ + "arn", + "id", + "nsdOnboardingState", + "nsdOperationalState", + "nsdUsageState" + ], + "members":{ + "arn":{ + "shape":"NsdInfoArn", + "documentation":"Network package ARN.
" + }, + "id":{ + "shape":"NsdInfoId", + "documentation":"ID of the network package.
" + }, + "nsdOnboardingState":{ + "shape":"NsdOnboardingState", + "documentation":"Onboarding state of the network service descriptor in the network package.
" + }, + "nsdOperationalState":{ + "shape":"NsdOperationalState", + "documentation":"Operational state of the network service descriptor in the network package.
" + }, + "nsdUsageState":{ + "shape":"NsdUsageState", + "documentation":"Usage state of the network service descriptor in the network package.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "DeleteSolFunctionPackageInput":{ + "type":"structure", + "required":["vnfPkgId"], + "members":{ + "vnfPkgId":{ + "shape":"VnfPkgId", + "documentation":"ID of the function package.
", + "location":"uri", + "locationName":"vnfPkgId" + } + } + }, + "DeleteSolNetworkInstanceInput":{ + "type":"structure", + "required":["nsInstanceId"], + "members":{ + "nsInstanceId":{ + "shape":"NsInstanceId", + "documentation":"Network instance ID.
", + "location":"uri", + "locationName":"nsInstanceId" + } + } + }, + "DeleteSolNetworkPackageInput":{ + "type":"structure", + "required":["nsdInfoId"], + "members":{ + "nsdInfoId":{ + "shape":"NsdInfoId", + "documentation":"ID of the network service descriptor in the network package.
", + "location":"uri", + "locationName":"nsdInfoId" + } + } + }, + "DescriptorContentType":{ + "type":"string", + "enum":["text/plain"] + }, + "Document":{ + "type":"structure", + "members":{ + }, + "document":true + }, + "ErrorCause":{ + "type":"string", + "max":200, + "min":1 + }, + "ErrorDetails":{ + "type":"string", + "max":10240, + "min":0 + }, + "ErrorInfo":{ + "type":"structure", + "members":{ + "cause":{ + "shape":"ErrorCause", + "documentation":"Error cause.
" + }, + "details":{ + "shape":"ErrorDetails", + "documentation":"Error details.
" + } + }, + "documentation":"Provides error information.
" + }, + "FunctionArtifactMeta":{ + "type":"structure", + "members":{ + "overrides":{ + "shape":"OverrideList", + "documentation":"Lists of function package overrides.
" + } + }, + "documentation":"Metadata for function package artifacts.
Artifacts are the contents of the package descriptor file and the state of the package.
" + }, + "GetSolFunctionInstanceInput":{ + "type":"structure", + "required":["vnfInstanceId"], + "members":{ + "vnfInstanceId":{ + "shape":"VnfInstanceId", + "documentation":"ID of the network function.
", + "location":"uri", + "locationName":"vnfInstanceId" + } + } + }, + "GetSolFunctionInstanceMetadata":{ + "type":"structure", + "required":[ + "createdAt", + "lastModified" + ], + "members":{ + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was created.
" + }, + "lastModified":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was last modified.
" + } + }, + "documentation":"The metadata of a network function instance.
A network function instance is a function in a function package .
" + }, + "GetSolFunctionInstanceOutput":{ + "type":"structure", + "required":[ + "arn", + "id", + "instantiationState", + "metadata", + "nsInstanceId", + "vnfPkgId", + "vnfdId" + ], + "members":{ + "arn":{ + "shape":"VnfInstanceArn", + "documentation":"Network function instance ARN.
" + }, + "id":{ + "shape":"VnfInstanceId", + "documentation":"Network function instance ID.
" + }, + "instantiatedVnfInfo":{"shape":"GetSolVnfInfo"}, + "instantiationState":{ + "shape":"VnfInstantiationState", + "documentation":"Network function instantiation state.
" + }, + "metadata":{"shape":"GetSolFunctionInstanceMetadata"}, + "nsInstanceId":{ + "shape":"NsInstanceId", + "documentation":"Network instance ID.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + }, + "vnfPkgId":{ + "shape":"VnfPkgId", + "documentation":"Function package ID.
" + }, + "vnfProductName":{ + "shape":"String", + "documentation":"Network function product name.
" + }, + "vnfProvider":{ + "shape":"String", + "documentation":"Network function provider.
" + }, + "vnfdId":{ + "shape":"VnfdId", + "documentation":"Function package descriptor ID.
" + }, + "vnfdVersion":{ + "shape":"String", + "documentation":"Function package descriptor version.
" + } + } + }, + "GetSolFunctionPackageContentInput":{ + "type":"structure", + "required":[ + "accept", + "vnfPkgId" + ], + "members":{ + "accept":{ + "shape":"PackageContentType", + "documentation":"The format of the package that you want to download from the function packages.
", + "location":"header", + "locationName":"Accept" + }, + "vnfPkgId":{ + "shape":"VnfPkgId", + "documentation":"ID of the function package.
", + "location":"uri", + "locationName":"vnfPkgId" + } + } + }, + "GetSolFunctionPackageContentOutput":{ + "type":"structure", + "members":{ + "contentType":{ + "shape":"PackageContentType", + "documentation":"Indicates the media type of the resource.
", + "location":"header", + "locationName":"Content-Type" + }, + "packageContent":{ + "shape":"Blob", + "documentation":"Contents of the function package.
" + } + }, + "payload":"packageContent" + }, + "GetSolFunctionPackageDescriptorInput":{ + "type":"structure", + "required":[ + "accept", + "vnfPkgId" + ], + "members":{ + "accept":{ + "shape":"DescriptorContentType", + "documentation":"Indicates which content types, expressed as MIME types, the client is able to understand.
", + "location":"header", + "locationName":"Accept" + }, + "vnfPkgId":{ + "shape":"VnfPkgId", + "documentation":"ID of the function package.
", + "location":"uri", + "locationName":"vnfPkgId" + } + } + }, + "GetSolFunctionPackageDescriptorOutput":{ + "type":"structure", + "members":{ + "contentType":{ + "shape":"DescriptorContentType", + "documentation":"Indicates the media type of the resource.
", + "location":"header", + "locationName":"Content-Type" + }, + "vnfd":{ + "shape":"Blob", + "documentation":"Contents of the function package descriptor.
" + } + }, + "payload":"vnfd" + }, + "GetSolFunctionPackageInput":{ + "type":"structure", + "required":["vnfPkgId"], + "members":{ + "vnfPkgId":{ + "shape":"VnfPkgId", + "documentation":"ID of the function package.
", + "location":"uri", + "locationName":"vnfPkgId" + } + } + }, + "GetSolFunctionPackageMetadata":{ + "type":"structure", + "required":[ + "createdAt", + "lastModified" + ], + "members":{ + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was created.
" + }, + "lastModified":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was last modified.
" + }, + "vnfd":{ + "shape":"FunctionArtifactMeta", + "documentation":"Metadata related to the function package descriptor of the function package.
" + } + }, + "documentation":"Metadata related to the function package.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
" + }, + "GetSolFunctionPackageOutput":{ + "type":"structure", + "required":[ + "arn", + "id", + "onboardingState", + "operationalState", + "usageState" + ], + "members":{ + "arn":{ + "shape":"VnfPkgArn", + "documentation":"Function package ARN.
" + }, + "id":{ + "shape":"VnfPkgId", + "documentation":"Function package ID.
" + }, + "metadata":{"shape":"GetSolFunctionPackageMetadata"}, + "onboardingState":{ + "shape":"OnboardingState", + "documentation":"Function package onboarding state.
" + }, + "operationalState":{ + "shape":"OperationalState", + "documentation":"Function package operational state.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + }, + "usageState":{ + "shape":"UsageState", + "documentation":"Function package usage state.
" + }, + "vnfProductName":{ + "shape":"String", + "documentation":"Network function product name.
" + }, + "vnfProvider":{ + "shape":"String", + "documentation":"Network function provider.
" + }, + "vnfdId":{ + "shape":"String", + "documentation":"Function package descriptor ID.
" + }, + "vnfdVersion":{ + "shape":"String", + "documentation":"Function package descriptor version.
" + } + } + }, + "GetSolInstantiatedVnfInfo":{ + "type":"structure", + "members":{ + "vnfState":{ + "shape":"VnfOperationalState", + "documentation":"State of the network function.
" + } + }, + "documentation":"Information about a network function.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
" + }, + "GetSolNetworkInstanceInput":{ + "type":"structure", + "required":["nsInstanceId"], + "members":{ + "nsInstanceId":{ + "shape":"NsInstanceId", + "documentation":"ID of the network instance.
", + "location":"uri", + "locationName":"nsInstanceId" + } + } + }, + "GetSolNetworkInstanceMetadata":{ + "type":"structure", + "required":[ + "createdAt", + "lastModified" + ], + "members":{ + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was created.
" + }, + "lastModified":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was last modified.
" + } + }, + "documentation":"The metadata of a network instance.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
" + }, + "GetSolNetworkInstanceOutput":{ + "type":"structure", + "required":[ + "arn", + "id", + "metadata", + "nsInstanceDescription", + "nsInstanceName", + "nsdId", + "nsdInfoId" + ], + "members":{ + "arn":{ + "shape":"NsInstanceArn", + "documentation":"Network instance ARN.
" + }, + "id":{ + "shape":"NsInstanceId", + "documentation":"Network instance ID.
" + }, + "lcmOpInfo":{"shape":"LcmOperationInfo"}, + "metadata":{"shape":"GetSolNetworkInstanceMetadata"}, + "nsInstanceDescription":{ + "shape":"String", + "documentation":"Network instance description.
" + }, + "nsInstanceName":{ + "shape":"String", + "documentation":"Network instance name.
" + }, + "nsState":{ + "shape":"NsState", + "documentation":"Network instance state.
" + }, + "nsdId":{ + "shape":"NsdId", + "documentation":"Network service descriptor ID.
" + }, + "nsdInfoId":{ + "shape":"NsdInfoId", + "documentation":"Network service descriptor info ID.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "GetSolNetworkOperationInput":{ + "type":"structure", + "required":["nsLcmOpOccId"], + "members":{ + "nsLcmOpOccId":{ + "shape":"NsLcmOpOccId", + "documentation":"The identifier of the network operation.
", + "location":"uri", + "locationName":"nsLcmOpOccId" + } + } + }, + "GetSolNetworkOperationMetadata":{ + "type":"structure", + "required":[ + "createdAt", + "lastModified" + ], + "members":{ + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was created.
" + }, + "instantiateMetadata":{ + "shape":"InstantiateMetadata", + "documentation":"Metadata related to the network operation occurrence for network instantiation. This is populated only if the lcmOperationType is INSTANTIATE.
The date that the resource was last modified.
" + }, + "modifyVnfInfoMetadata":{ + "shape":"ModifyVnfInfoMetadata", + "documentation":"Metadata related to the network operation occurrence for network function updates in a network instance. This is populated only if the lcmOperationType is UPDATE and the updateType is MODIFY_VNF_INFORMATION.
Metadata related to the network operation occurrence for network instance updates. This is populated only if the lcmOperationType is UPDATE and the updateType is UPDATE_NS.
Metadata related to a network operation occurrence.
A network operation is any operation that is done to your network, such as network instance instantiation or termination.
" + }, + "GetSolNetworkOperationOutput":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"NsLcmOpOccArn", + "documentation":"Network operation ARN.
" + }, + "error":{ + "shape":"ProblemDetails", + "documentation":"Error related to this specific network operation occurrence.
" + }, + "id":{ + "shape":"NsLcmOpOccId", + "documentation":"ID of this network operation occurrence.
" + }, + "lcmOperationType":{ + "shape":"LcmOperationType", + "documentation":"Type of the operation represented by this occurrence.
" + }, + "metadata":{ + "shape":"GetSolNetworkOperationMetadata", + "documentation":"Metadata of this network operation occurrence.
" + }, + "nsInstanceId":{ + "shape":"NsInstanceId", + "documentation":"ID of the network operation instance.
" + }, + "operationState":{ + "shape":"NsLcmOperationState", + "documentation":"The state of the network operation.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + }, + "tasks":{ + "shape":"GetSolNetworkOperationTasksList", + "documentation":"All tasks associated with this operation occurrence.
" + }, + "updateType":{ + "shape":"UpdateSolNetworkType", + "documentation":"Type of the update. Only present if the network operation lcmOperationType is UPDATE.
Context for the network operation task.
" + }, + "taskEndTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"Task end time.
" + }, + "taskErrorDetails":{ + "shape":"ErrorInfo", + "documentation":"Task error details.
" + }, + "taskName":{ + "shape":"String", + "documentation":"Task name.
" + }, + "taskStartTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"Task start time.
" + }, + "taskStatus":{ + "shape":"TaskStatus", + "documentation":"Task status.
" + } + }, + "documentation":"Gets the details of a network operation.
A network operation is any operation that is done to your network, such as network instance instantiation or termination.
" + }, + "GetSolNetworkOperationTasksList":{ + "type":"list", + "member":{"shape":"GetSolNetworkOperationTaskDetails"} + }, + "GetSolNetworkPackageContentInput":{ + "type":"structure", + "required":[ + "accept", + "nsdInfoId" + ], + "members":{ + "accept":{ + "shape":"PackageContentType", + "documentation":"The format of the package you want to download from the network package.
", + "location":"header", + "locationName":"Accept" + }, + "nsdInfoId":{ + "shape":"NsdInfoId", + "documentation":"ID of the network service descriptor in the network package.
", + "location":"uri", + "locationName":"nsdInfoId" + } + } + }, + "GetSolNetworkPackageContentOutput":{ + "type":"structure", + "members":{ + "contentType":{ + "shape":"PackageContentType", + "documentation":"Indicates the media type of the resource.
", + "location":"header", + "locationName":"Content-Type" + }, + "nsdContent":{ + "shape":"Blob", + "documentation":"Content of the network service descriptor in the network package.
" + } + }, + "payload":"nsdContent" + }, + "GetSolNetworkPackageDescriptorInput":{ + "type":"structure", + "required":["nsdInfoId"], + "members":{ + "nsdInfoId":{ + "shape":"NsdInfoId", + "documentation":"ID of the network service descriptor in the network package.
", + "location":"uri", + "locationName":"nsdInfoId" + } + } + }, + "GetSolNetworkPackageDescriptorOutput":{ + "type":"structure", + "members":{ + "contentType":{ + "shape":"DescriptorContentType", + "documentation":"Indicates the media type of the resource.
", + "location":"header", + "locationName":"Content-Type" + }, + "nsd":{ + "shape":"Blob", + "documentation":"Contents of the network service descriptor in the network package.
" + } + }, + "payload":"nsd" + }, + "GetSolNetworkPackageInput":{ + "type":"structure", + "required":["nsdInfoId"], + "members":{ + "nsdInfoId":{ + "shape":"NsdInfoId", + "documentation":"ID of the network service descriptor in the network package.
", + "location":"uri", + "locationName":"nsdInfoId" + } + } + }, + "GetSolNetworkPackageMetadata":{ + "type":"structure", + "required":[ + "createdAt", + "lastModified" + ], + "members":{ + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was created.
" + }, + "lastModified":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was last modified.
" + }, + "nsd":{ + "shape":"NetworkArtifactMeta", + "documentation":"Metadata related to the onboarded network service descriptor in the network package.
" + } + }, + "documentation":"Metadata associated with a network package.
A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
" + }, + "GetSolNetworkPackageOutput":{ + "type":"structure", + "required":[ + "arn", + "id", + "metadata", + "nsdId", + "nsdName", + "nsdOnboardingState", + "nsdOperationalState", + "nsdUsageState", + "nsdVersion", + "vnfPkgIds" + ], + "members":{ + "arn":{ + "shape":"NsdInfoArn", + "documentation":"Network package ARN.
" + }, + "id":{ + "shape":"NsdInfoId", + "documentation":"Network package ID.
" + }, + "metadata":{"shape":"GetSolNetworkPackageMetadata"}, + "nsdId":{ + "shape":"NsdId", + "documentation":"Network service descriptor ID.
" + }, + "nsdName":{ + "shape":"String", + "documentation":"Network service descriptor name.
" + }, + "nsdOnboardingState":{ + "shape":"NsdOnboardingState", + "documentation":"Network service descriptor onboarding state.
" + }, + "nsdOperationalState":{ + "shape":"NsdOperationalState", + "documentation":"Network service descriptor operational state.
" + }, + "nsdUsageState":{ + "shape":"NsdUsageState", + "documentation":"Network service descriptor usage state.
" + }, + "nsdVersion":{ + "shape":"String", + "documentation":"Network service descriptor version.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + }, + "vnfPkgIds":{ + "shape":"VnfPkgIdList", + "documentation":"Identifies the function package for the function package descriptor referenced by the onboarded network package.
" + } + } + }, + "GetSolVnfInfo":{ + "type":"structure", + "members":{ + "vnfState":{ + "shape":"VnfOperationalState", + "documentation":"State of the network function instance.
" + }, + "vnfcResourceInfo":{ + "shape":"GetSolVnfcResourceInfoList", + "documentation":"Compute info used by the network function instance.
" + } + }, + "documentation":"Information about the network function.
A network function instance is a function in a function package .
" + }, + "GetSolVnfcResourceInfo":{ + "type":"structure", + "members":{ + "metadata":{ + "shape":"GetSolVnfcResourceInfoMetadata", + "documentation":"The metadata of the network function compute.
" + } + }, + "documentation":"Details of resource associated with a network function.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
" + }, + "GetSolVnfcResourceInfoList":{ + "type":"list", + "member":{"shape":"GetSolVnfcResourceInfo"} + }, + "GetSolVnfcResourceInfoMetadata":{ + "type":"structure", + "members":{ + "cluster":{ + "shape":"String", + "documentation":"Information about the cluster.
" + }, + "helmChart":{ + "shape":"String", + "documentation":"Information about the helm chart.
" + }, + "nodeGroup":{ + "shape":"String", + "documentation":"Information about the node group.
" + } + }, + "documentation":"The metadata of a network function.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
" + }, + "InstantiateMetadata":{ + "type":"structure", + "required":["nsdInfoId"], + "members":{ + "additionalParamsForNs":{ + "shape":"Document", + "documentation":"The configurable properties used during instantiation.
" + }, + "nsdInfoId":{ + "shape":"NsdInfoId", + "documentation":"The network service descriptor used for instantiating the network instance.
" + } + }, + "documentation":"Metadata related to the configuration properties used during instantiation of the network instance.
" + }, + "InstantiateSolNetworkInstanceInput":{ + "type":"structure", + "required":["nsInstanceId"], + "members":{ + "additionalParamsForNs":{ + "shape":"Document", + "documentation":"Provides values for the configurable properties.
" + }, + "dryRun":{ + "shape":"Boolean", + "documentation":"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.
ID of the network instance.
", + "location":"uri", + "locationName":"nsInstanceId" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "InstantiateSolNetworkInstanceOutput":{ + "type":"structure", + "required":["nsLcmOpOccId"], + "members":{ + "nsLcmOpOccId":{ + "shape":"NsLcmOpOccId", + "documentation":"The identifier of the network operation.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Unexpected error occurred. Problem on the server.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "LcmOperationInfo":{ + "type":"structure", + "required":["nsLcmOpOccId"], + "members":{ + "nsLcmOpOccId":{ + "shape":"NsLcmOpOccId", + "documentation":"The identifier of the network operation.
" + } + }, + "documentation":"Lifecycle management operation details on the network instance.
Lifecycle management operations are deploy, update, or delete operations.
" + }, + "LcmOperationType":{ + "type":"string", + "enum":[ + "INSTANTIATE", + "UPDATE", + "TERMINATE" + ] + }, + "ListSolFunctionInstanceInfo":{ + "type":"structure", + "required":[ + "arn", + "id", + "instantiationState", + "metadata", + "nsInstanceId", + "vnfPkgId" + ], + "members":{ + "arn":{ + "shape":"VnfInstanceArn", + "documentation":"Network function instance ARN.
" + }, + "id":{ + "shape":"VnfInstanceId", + "documentation":"Network function instance ID.
" + }, + "instantiatedVnfInfo":{"shape":"GetSolInstantiatedVnfInfo"}, + "instantiationState":{ + "shape":"VnfInstantiationState", + "documentation":"Network function instance instantiation state.
" + }, + "metadata":{ + "shape":"ListSolFunctionInstanceMetadata", + "documentation":"Network function instance metadata.
" + }, + "nsInstanceId":{ + "shape":"NsInstanceId", + "documentation":"Network instance ID.
" + }, + "vnfPkgId":{ + "shape":"VnfPkgId", + "documentation":"Function package ID.
" + }, + "vnfPkgName":{ + "shape":"String", + "documentation":"Function package name.
" + } + }, + "documentation":"Lists information about a network function instance.
A network function instance is a function in a function package .
" + }, + "ListSolFunctionInstanceMetadata":{ + "type":"structure", + "required":[ + "createdAt", + "lastModified" + ], + "members":{ + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the network function instance was created.
" + }, + "lastModified":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the network function instance was last modified.
" + } + }, + "documentation":"Lists network function instance metadata.
A network function instance is a function in a function package .
" + }, + "ListSolFunctionInstanceResources":{ + "type":"list", + "member":{"shape":"ListSolFunctionInstanceInfo"} + }, + "ListSolFunctionInstancesInput":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListSolFunctionInstancesInputMaxResultsInteger", + "documentation":"The maximum number of results to include in the response.
", + "location":"querystring", + "locationName":"max_results" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token for the next page of results.
", + "location":"querystring", + "locationName":"nextpage_opaque_marker" + } + } + }, + "ListSolFunctionInstancesInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListSolFunctionInstancesOutput":{ + "type":"structure", + "members":{ + "functionInstances":{ + "shape":"ListSolFunctionInstanceResources", + "documentation":"Network function instances.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Function package ARN.
" + }, + "id":{ + "shape":"VnfPkgId", + "documentation":"ID of the function package.
" + }, + "metadata":{ + "shape":"ListSolFunctionPackageMetadata", + "documentation":"The metadata of the function package.
" + }, + "onboardingState":{ + "shape":"OnboardingState", + "documentation":"Onboarding state of the function package.
" + }, + "operationalState":{ + "shape":"OperationalState", + "documentation":"Operational state of the function package.
" + }, + "usageState":{ + "shape":"UsageState", + "documentation":"Usage state of the function package.
" + }, + "vnfProductName":{ + "shape":"String", + "documentation":"The product name for the network function.
" + }, + "vnfProvider":{ + "shape":"String", + "documentation":"Provider of the function package and the function package descriptor.
" + }, + "vnfdId":{ + "shape":"String", + "documentation":"Identifies the function package and the function package descriptor.
" + }, + "vnfdVersion":{ + "shape":"String", + "documentation":"Identifies the version of the function package descriptor.
" + } + }, + "documentation":"Information about a function package.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
" + }, + "ListSolFunctionPackageMetadata":{ + "type":"structure", + "required":[ + "createdAt", + "lastModified" + ], + "members":{ + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was created.
" + }, + "lastModified":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was last modified.
" + } + }, + "documentation":"Details for the function package metadata.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
" + }, + "ListSolFunctionPackageResources":{ + "type":"list", + "member":{"shape":"ListSolFunctionPackageInfo"} + }, + "ListSolFunctionPackagesInput":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListSolFunctionPackagesInputMaxResultsInteger", + "documentation":"The maximum number of results to include in the response.
", + "location":"querystring", + "locationName":"max_results" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token for the next page of results.
", + "location":"querystring", + "locationName":"nextpage_opaque_marker" + } + } + }, + "ListSolFunctionPackagesInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListSolFunctionPackagesOutput":{ + "type":"structure", + "required":["functionPackages"], + "members":{ + "functionPackages":{ + "shape":"ListSolFunctionPackageResources", + "documentation":"Function packages. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Network instance ARN.
" + }, + "id":{ + "shape":"NsInstanceId", + "documentation":"ID of the network instance.
" + }, + "metadata":{ + "shape":"ListSolNetworkInstanceMetadata", + "documentation":"The metadata of the network instance.
" + }, + "nsInstanceDescription":{ + "shape":"String", + "documentation":"Human-readable description of the network instance.
" + }, + "nsInstanceName":{ + "shape":"String", + "documentation":"Human-readable name of the network instance.
" + }, + "nsState":{ + "shape":"NsState", + "documentation":"The state of the network instance.
" + }, + "nsdId":{ + "shape":"NsdId", + "documentation":"ID of the network service descriptor in the network package.
" + }, + "nsdInfoId":{ + "shape":"NsdInfoId", + "documentation":"ID of the network service descriptor in the network package.
" + } + }, + "documentation":"Info about the specific network instance.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
" + }, + "ListSolNetworkInstanceMetadata":{ + "type":"structure", + "required":[ + "createdAt", + "lastModified" + ], + "members":{ + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was created.
" + }, + "lastModified":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was last modified.
" + } + }, + "documentation":"Metadata details for a network instance.
A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
" + }, + "ListSolNetworkInstanceResources":{ + "type":"list", + "member":{"shape":"ListSolNetworkInstanceInfo"} + }, + "ListSolNetworkInstancesInput":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListSolNetworkInstancesInputMaxResultsInteger", + "documentation":"The maximum number of results to include in the response.
", + "location":"querystring", + "locationName":"max_results" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token for the next page of results.
", + "location":"querystring", + "locationName":"nextpage_opaque_marker" + } + } + }, + "ListSolNetworkInstancesInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListSolNetworkInstancesOutput":{ + "type":"structure", + "members":{ + "networkInstances":{ + "shape":"ListSolNetworkInstanceResources", + "documentation":"Lists network instances.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Network operation ARN.
" + }, + "error":{ + "shape":"ProblemDetails", + "documentation":"Error related to this specific network operation.
" + }, + "id":{ + "shape":"NsLcmOpOccId", + "documentation":"ID of this network operation.
" + }, + "lcmOperationType":{ + "shape":"LcmOperationType", + "documentation":"Type of lifecycle management network operation.
" + }, + "metadata":{ + "shape":"ListSolNetworkOperationsMetadata", + "documentation":"Metadata related to this network operation.
" + }, + "nsInstanceId":{ + "shape":"NsInstanceId", + "documentation":"ID of the network instance related to this operation.
" + }, + "operationState":{ + "shape":"NsLcmOperationState", + "documentation":"The state of the network operation.
" + }, + "updateType":{ + "shape":"UpdateSolNetworkType", + "documentation":"Type of the update. Only present if the network operation lcmOperationType is UPDATE.
Information parameters for a network operation.
" + }, + "ListSolNetworkOperationsInput":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListSolNetworkOperationsInputMaxResultsInteger", + "documentation":"The maximum number of results to include in the response.
", + "location":"querystring", + "locationName":"max_results" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token for the next page of results.
", + "location":"querystring", + "locationName":"nextpage_opaque_marker" + }, + "nsInstanceId":{ + "shape":"NsInstanceId", + "documentation":"Network instance id filter, to retrieve network operations associated to a network instance.
", + "location":"querystring", + "locationName":"nsInstanceId" + } + } + }, + "ListSolNetworkOperationsInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListSolNetworkOperationsMetadata":{ + "type":"structure", + "required":[ + "createdAt", + "lastModified" + ], + "members":{ + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was created.
" + }, + "lastModified":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was last modified.
" + }, + "nsdInfoId":{ + "shape":"NsdInfoId", + "documentation":"The network service descriptor id used for the operation.
Only present if the updateType is UPDATE_NS.
The network function id used for the operation.
Only present if the updateType is MODIFY_VNF_INFO.
Metadata related to a network operation.
A network operation is any operation that is done to your network, such as network instance instantiation or termination.
" + }, + "ListSolNetworkOperationsOutput":{ + "type":"structure", + "members":{ + "networkOperations":{ + "shape":"ListSolNetworkOperationsResources", + "documentation":"Lists network operation occurrences. Lifecycle management operations are deploy, update, or delete operations.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Network package ARN.
" + }, + "id":{ + "shape":"NsdInfoId", + "documentation":"ID of the individual network package.
" + }, + "metadata":{ + "shape":"ListSolNetworkPackageMetadata", + "documentation":"The metadata of the network package.
" + }, + "nsdDesigner":{ + "shape":"String", + "documentation":"Designer of the onboarded network service descriptor in the network package.
" + }, + "nsdId":{ + "shape":"String", + "documentation":"ID of the network service descriptor on which the network package is based.
" + }, + "nsdInvariantId":{ + "shape":"String", + "documentation":"Identifies a network service descriptor in a version independent manner.
" + }, + "nsdName":{ + "shape":"String", + "documentation":"Name of the onboarded network service descriptor in the network package.
" + }, + "nsdOnboardingState":{ + "shape":"NsdOnboardingState", + "documentation":"Onboarding state of the network service descriptor in the network package.
" + }, + "nsdOperationalState":{ + "shape":"NsdOperationalState", + "documentation":"Operational state of the network service descriptor in the network package.
" + }, + "nsdUsageState":{ + "shape":"NsdUsageState", + "documentation":"Usage state of the network service descriptor in the network package.
" + }, + "nsdVersion":{ + "shape":"String", + "documentation":"Version of the onboarded network service descriptor in the network package.
" + }, + "vnfPkgIds":{ + "shape":"VnfPkgIdList", + "documentation":"Identifies the function package for the function package descriptor referenced by the onboarded network package.
" + } + }, + "documentation":"Details of a network package.
A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
" + }, + "ListSolNetworkPackageMetadata":{ + "type":"structure", + "required":[ + "createdAt", + "lastModified" + ], + "members":{ + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was created.
" + }, + "lastModified":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The date that the resource was last modified.
" + } + }, + "documentation":"Metadata related to a network package.
A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
" + }, + "ListSolNetworkPackageResources":{ + "type":"list", + "member":{"shape":"ListSolNetworkPackageInfo"} + }, + "ListSolNetworkPackagesInput":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListSolNetworkPackagesInputMaxResultsInteger", + "documentation":"The maximum number of results to include in the response.
", + "location":"querystring", + "locationName":"max_results" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token for the next page of results.
", + "location":"querystring", + "locationName":"nextpage_opaque_marker" + } + } + }, + "ListSolNetworkPackagesInputMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListSolNetworkPackagesOutput":{ + "type":"structure", + "required":["networkPackages"], + "members":{ + "networkPackages":{ + "shape":"ListSolNetworkPackageResources", + "documentation":"Network packages. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Resource ARN.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "ModifyVnfInfoMetadata":{ + "type":"structure", + "required":[ + "vnfConfigurableProperties", + "vnfInstanceId" + ], + "members":{ + "vnfConfigurableProperties":{ + "shape":"Document", + "documentation":"The configurable properties used during update of the network function instance.
" + }, + "vnfInstanceId":{ + "shape":"VnfInstanceId", + "documentation":"The network function instance that was updated in the network instance.
" + } + }, + "documentation":"Metadata related to the configuration properties used during update of a specific network function in a network instance.
" + }, + "NetworkArtifactMeta":{ + "type":"structure", + "members":{ + "overrides":{ + "shape":"OverrideList", + "documentation":"Lists network package overrides.
" + } + }, + "documentation":"Metadata for network package artifacts.
Artifacts are the contents of the package descriptor file and the state of the package.
" + }, + "NsInstanceArn":{ + "type":"string", + "pattern":"^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(network-instance/ni-[a-f0-9]{17})$" + }, + "NsInstanceId":{ + "type":"string", + "pattern":"^ni-[a-f0-9]{17}$" + }, + "NsLcmOpOccArn":{ + "type":"string", + "pattern":"^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(network-operation/no-[a-f0-9]{17})$" + }, + "NsLcmOpOccId":{ + "type":"string", + "pattern":"^no-[a-f0-9]{17}$" + }, + "NsLcmOperationState":{ + "type":"string", + "enum":[ + "PROCESSING", + "COMPLETED", + "FAILED", + "CANCELLING", + "CANCELLED" + ] + }, + "NsState":{ + "type":"string", + "enum":[ + "INSTANTIATED", + "NOT_INSTANTIATED", + "UPDATED", + "IMPAIRED", + "UPDATE_FAILED", + "STOPPED", + "DELETED", + "INSTANTIATE_IN_PROGRESS", + "INTENT_TO_UPDATE_IN_PROGRESS", + "UPDATE_IN_PROGRESS", + "TERMINATE_IN_PROGRESS" + ] + }, + "NsdId":{ + "type":"string", + "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + }, + "NsdInfoArn":{ + "type":"string", + "pattern":"^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(network-package/np-[a-f0-9]{17})$" + }, + "NsdInfoId":{ + "type":"string", + "pattern":"^np-[a-f0-9]{17}$" + }, + "NsdOnboardingState":{ + "type":"string", + "enum":[ + "CREATED", + "ONBOARDED", + "ERROR" + ] + }, + "NsdOperationalState":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "NsdUsageState":{ + "type":"string", + "enum":[ + "IN_USE", + "NOT_IN_USE" + ] + }, + "OnboardingState":{ + "type":"string", + "enum":[ + "CREATED", + "ONBOARDED", + "ERROR" + ] + }, + "OperationalState":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "OverrideList":{ + "type":"list", + "member":{"shape":"ToscaOverride"} + }, + "PackageContentType":{ + "type":"string", + "enum":["application/zip"] + }, + "PaginationToken":{"type":"string"}, + "ProblemDetails":{ + "type":"structure", + "required":["detail"], + "members":{ + "detail":{ + "shape":"String", + "documentation":"A human-readable explanation specific to this occurrence of the problem.
" + }, + "title":{ + "shape":"String", + "documentation":"A human-readable title of the problem type.
" + } + }, + "documentation":"Details related to problems with AWS TNB resources.
" + }, + "PutSolFunctionPackageContentInput":{ + "type":"structure", + "required":[ + "file", + "vnfPkgId" + ], + "members":{ + "contentType":{ + "shape":"PackageContentType", + "documentation":"Function package content type.
", + "location":"header", + "locationName":"Content-Type" + }, + "file":{ + "shape":"SensitiveBlob", + "documentation":"Function package file.
" + }, + "vnfPkgId":{ + "shape":"VnfPkgId", + "documentation":"Function package ID.
", + "location":"uri", + "locationName":"vnfPkgId" + } + }, + "payload":"file" + }, + "PutSolFunctionPackageContentMetadata":{ + "type":"structure", + "members":{ + "vnfd":{"shape":"FunctionArtifactMeta"} + }, + "documentation":"Update metadata in a function package.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
" + }, + "PutSolFunctionPackageContentOutput":{ + "type":"structure", + "required":[ + "id", + "metadata", + "vnfProductName", + "vnfProvider", + "vnfdId", + "vnfdVersion" + ], + "members":{ + "id":{ + "shape":"VnfPkgId", + "documentation":"Function package ID.
" + }, + "metadata":{ + "shape":"PutSolFunctionPackageContentMetadata", + "documentation":"Function package metadata.
" + }, + "vnfProductName":{ + "shape":"String", + "documentation":"Function product name.
" + }, + "vnfProvider":{ + "shape":"String", + "documentation":"Function provider.
" + }, + "vnfdId":{ + "shape":"VnfdId", + "documentation":"Function package descriptor ID.
" + }, + "vnfdVersion":{ + "shape":"String", + "documentation":"Function package descriptor version.
" + } + } + }, + "PutSolNetworkPackageContentInput":{ + "type":"structure", + "required":[ + "file", + "nsdInfoId" + ], + "members":{ + "contentType":{ + "shape":"PackageContentType", + "documentation":"Network package content type.
", + "location":"header", + "locationName":"Content-Type" + }, + "file":{ + "shape":"SensitiveBlob", + "documentation":"Network package file.
" + }, + "nsdInfoId":{ + "shape":"NsdInfoId", + "documentation":"Network service descriptor info ID.
", + "location":"uri", + "locationName":"nsdInfoId" + } + }, + "payload":"file" + }, + "PutSolNetworkPackageContentMetadata":{ + "type":"structure", + "members":{ + "nsd":{"shape":"NetworkArtifactMeta"} + }, + "documentation":"Update metadata in a network package.
A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
" + }, + "PutSolNetworkPackageContentOutput":{ + "type":"structure", + "required":[ + "arn", + "id", + "metadata", + "nsdId", + "nsdName", + "nsdVersion", + "vnfPkgIds" + ], + "members":{ + "arn":{ + "shape":"NsdInfoArn", + "documentation":"Network package ARN.
" + }, + "id":{ + "shape":"NsdInfoId", + "documentation":"Network package ID.
" + }, + "metadata":{ + "shape":"PutSolNetworkPackageContentMetadata", + "documentation":"Network package metadata.
" + }, + "nsdId":{ + "shape":"NsdId", + "documentation":"Network service descriptor ID.
" + }, + "nsdName":{ + "shape":"String", + "documentation":"Network service descriptor name.
" + }, + "nsdVersion":{ + "shape":"String", + "documentation":"Network service descriptor version.
" + }, + "vnfPkgIds":{ + "shape":"VnfPkgIdList", + "documentation":"Function package IDs.
" + } + } + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Request references a resource that doesn't exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SensitiveBlob":{ + "type":"blob", + "sensitive":true + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Service quotas have been exceeded.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"}, + "StringMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "SyntheticTimestamp_date_time":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "TNBResourceArn":{ + "type":"string", + "pattern":"^arn:aws:tnb:[a-z0-9-]+:[^:]*:.*$" + }, + "TagKey":{ + "type":"string", + "pattern":"^(?!aws:).{1,128}$" + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":0, + "sensitive":true + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"TNBResourceArn", + "documentation":"Resource ARN.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TaskStatus":{ + "type":"string", + "enum":[ + "SCHEDULED", + "STARTED", + "IN_PROGRESS", + "COMPLETED", + "ERROR", + "SKIPPED", + "CANCELLED" + ] + }, + "TerminateSolNetworkInstanceInput":{ + "type":"structure", + "required":["nsInstanceId"], + "members":{ + "nsInstanceId":{ + "shape":"NsInstanceId", + "documentation":"ID of the network instance.
", + "location":"uri", + "locationName":"nsInstanceId" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "TerminateSolNetworkInstanceOutput":{ + "type":"structure", + "members":{ + "nsLcmOpOccId":{ + "shape":"NsLcmOpOccId", + "documentation":"The identifier of the network operation.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Exception caused by throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "ToscaOverride":{ + "type":"structure", + "members":{ + "defaultValue":{ + "shape":"String", + "documentation":"Default value for the override.
" + }, + "name":{ + "shape":"String", + "documentation":"Name of the TOSCA override.
" + } + }, + "documentation":"Overrides of the TOSCA node.
" + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"TNBResourceArn", + "documentation":"Resource ARN.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeys", + "documentation":"Tag keys.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateNsMetadata":{ + "type":"structure", + "required":["nsdInfoId"], + "members":{ + "additionalParamsForNs":{ + "shape":"Document", + "documentation":"The configurable properties used during update.
" + }, + "nsdInfoId":{ + "shape":"NsdInfoId", + "documentation":"The network service descriptor used for updating the network instance.
" + } + }, + "documentation":"Metadata related to the configuration properties used during update of a network instance.
" + }, + "UpdateSolFunctionPackageInput":{ + "type":"structure", + "required":[ + "operationalState", + "vnfPkgId" + ], + "members":{ + "operationalState":{ + "shape":"OperationalState", + "documentation":"Operational state of the function package.
" + }, + "vnfPkgId":{ + "shape":"VnfPkgId", + "documentation":"ID of the function package.
", + "location":"uri", + "locationName":"vnfPkgId" + } + } + }, + "UpdateSolFunctionPackageOutput":{ + "type":"structure", + "required":["operationalState"], + "members":{ + "operationalState":{ + "shape":"OperationalState", + "documentation":"Operational state of the function package.
" + } + } + }, + "UpdateSolNetworkInstanceInput":{ + "type":"structure", + "required":[ + "nsInstanceId", + "updateType" + ], + "members":{ + "modifyVnfInfoData":{ + "shape":"UpdateSolNetworkModify", + "documentation":"Identifies the network function information parameters and/or the configurable properties of the network function to be modified.
Include this property only if the update type is MODIFY_VNF_INFORMATION.
ID of the network instance.
", + "location":"uri", + "locationName":"nsInstanceId" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
" + }, + "updateNs":{ + "shape":"UpdateSolNetworkServiceData", + "documentation":"Identifies the network service descriptor and the configurable properties of the descriptor, to be used for the update.
Include this property only if the update type is UPDATE_NS.
The type of update.
Use the MODIFY_VNF_INFORMATION update type, to update a specific network function configuration, in the network instance.
Use the UPDATE_NS update type, to update the network instance to a new network service descriptor.
The identifier of the network operation.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "UpdateSolNetworkModify":{ + "type":"structure", + "required":[ + "vnfConfigurableProperties", + "vnfInstanceId" + ], + "members":{ + "vnfConfigurableProperties":{ + "shape":"Document", + "documentation":"Provides values for the configurable properties declared in the function package descriptor.
" + }, + "vnfInstanceId":{ + "shape":"VnfInstanceId", + "documentation":"ID of the network function instance.
A network function instance is a function in a function package .
" + } + }, + "documentation":"Information parameters and/or the configurable properties for a network function.
A network function instance is a function in a function package .
" + }, + "UpdateSolNetworkPackageInput":{ + "type":"structure", + "required":[ + "nsdInfoId", + "nsdOperationalState" + ], + "members":{ + "nsdInfoId":{ + "shape":"NsdInfoId", + "documentation":"ID of the network service descriptor in the network package.
", + "location":"uri", + "locationName":"nsdInfoId" + }, + "nsdOperationalState":{ + "shape":"NsdOperationalState", + "documentation":"Operational state of the network service descriptor in the network package.
" + } + } + }, + "UpdateSolNetworkPackageOutput":{ + "type":"structure", + "required":["nsdOperationalState"], + "members":{ + "nsdOperationalState":{ + "shape":"NsdOperationalState", + "documentation":"Operational state of the network service descriptor in the network package.
" + } + } + }, + "UpdateSolNetworkServiceData":{ + "type":"structure", + "required":["nsdInfoId"], + "members":{ + "additionalParamsForNs":{ + "shape":"Document", + "documentation":"Values for the configurable properties declared in the network service descriptor.
" + }, + "nsdInfoId":{ + "shape":"NsdInfoId", + "documentation":"ID of the network service descriptor.
" + } + }, + "documentation":"Information parameters and/or the configurable properties for a network descriptor used for update.
" + }, + "UpdateSolNetworkType":{ + "type":"string", + "enum":[ + "MODIFY_VNF_INFORMATION", + "UPDATE_NS" + ] + }, + "UsageState":{ + "type":"string", + "enum":[ + "IN_USE", + "NOT_IN_USE" + ] + }, + "ValidateSolFunctionPackageContentInput":{ + "type":"structure", + "required":[ + "file", + "vnfPkgId" + ], + "members":{ + "contentType":{ + "shape":"PackageContentType", + "documentation":"Function package content type.
", + "location":"header", + "locationName":"Content-Type" + }, + "file":{ + "shape":"SensitiveBlob", + "documentation":"Function package file.
" + }, + "vnfPkgId":{ + "shape":"VnfPkgId", + "documentation":"Function package ID.
", + "location":"uri", + "locationName":"vnfPkgId" + } + }, + "payload":"file" + }, + "ValidateSolFunctionPackageContentMetadata":{ + "type":"structure", + "members":{ + "vnfd":{"shape":"FunctionArtifactMeta"} + }, + "documentation":"Validates function package content metadata.
A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
" + }, + "ValidateSolFunctionPackageContentOutput":{ + "type":"structure", + "required":[ + "id", + "metadata", + "vnfProductName", + "vnfProvider", + "vnfdId", + "vnfdVersion" + ], + "members":{ + "id":{ + "shape":"VnfPkgId", + "documentation":"Function package ID.
" + }, + "metadata":{ + "shape":"ValidateSolFunctionPackageContentMetadata", + "documentation":"Function package metadata.
" + }, + "vnfProductName":{ + "shape":"String", + "documentation":"Network function product name.
" + }, + "vnfProvider":{ + "shape":"String", + "documentation":"Network function provider.
" + }, + "vnfdId":{ + "shape":"VnfdId", + "documentation":"Function package descriptor ID.
" + }, + "vnfdVersion":{ + "shape":"String", + "documentation":"Function package descriptor version.
" + } + } + }, + "ValidateSolNetworkPackageContentInput":{ + "type":"structure", + "required":[ + "file", + "nsdInfoId" + ], + "members":{ + "contentType":{ + "shape":"PackageContentType", + "documentation":"Network package content type.
", + "location":"header", + "locationName":"Content-Type" + }, + "file":{ + "shape":"SensitiveBlob", + "documentation":"Network package file.
" + }, + "nsdInfoId":{ + "shape":"NsdInfoId", + "documentation":"Network service descriptor file.
", + "location":"uri", + "locationName":"nsdInfoId" + } + }, + "payload":"file" + }, + "ValidateSolNetworkPackageContentMetadata":{ + "type":"structure", + "members":{ + "nsd":{"shape":"NetworkArtifactMeta"} + }, + "documentation":"Validates network package content metadata.
A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
" + }, + "ValidateSolNetworkPackageContentOutput":{ + "type":"structure", + "required":[ + "arn", + "id", + "metadata", + "nsdId", + "nsdName", + "nsdVersion", + "vnfPkgIds" + ], + "members":{ + "arn":{ + "shape":"NsdInfoArn", + "documentation":"Network package ARN.
" + }, + "id":{ + "shape":"NsdInfoId", + "documentation":"Network package ID.
" + }, + "metadata":{ + "shape":"ValidateSolNetworkPackageContentMetadata", + "documentation":"Network package metadata.
" + }, + "nsdId":{ + "shape":"NsdId", + "documentation":"Network service descriptor ID.
" + }, + "nsdName":{ + "shape":"String", + "documentation":"Network service descriptor name.
" + }, + "nsdVersion":{ + "shape":"String", + "documentation":"Network service descriptor version.
" + }, + "vnfPkgIds":{ + "shape":"VnfPkgIdList", + "documentation":"Function package IDs.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Unable to process the request because the client provided input failed to satisfy request constraints.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "VnfInstanceArn":{ + "type":"string", + "pattern":"^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(function-instance/fi-[a-f0-9]{17})$" + }, + "VnfInstanceId":{ + "type":"string", + "pattern":"^fi-[a-f0-9]{17}$" + }, + "VnfInstantiationState":{ + "type":"string", + "enum":[ + "INSTANTIATED", + "NOT_INSTANTIATED" + ] + }, + "VnfOperationalState":{ + "type":"string", + "enum":[ + "STARTED", + "STOPPED" + ] + }, + "VnfPkgArn":{ + "type":"string", + "pattern":"^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(function-package/fp-[a-f0-9]{17})$" + }, + "VnfPkgId":{ + "type":"string", + "pattern":"^fp-[a-f0-9]{17}$" + }, + "VnfPkgIdList":{ + "type":"list", + "member":{"shape":"VnfPkgId"} + }, + "VnfdId":{ + "type":"string", + "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "documentation":"Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of your telecommunication network functions throughout planning, deployment, and post-deployment activities.
" +} diff --git a/testbed/boto__botocore/botocore/data/translate/2017-07-01/service-2.json b/testbed/boto__botocore/botocore/data/translate/2017-07-01/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..107941b20e0e35ca366639076d690159e6313002 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/translate/2017-07-01/service-2.json @@ -0,0 +1,1849 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-07-01", + "endpointPrefix":"translate", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Translate", + "serviceId":"Translate", + "signatureVersion":"v4", + "signingName":"translate", + "targetPrefix":"AWSShineFrontendService_20170701", + "uid":"translate-2017-07-01" + }, + "operations":{ + "CreateParallelData":{ + "name":"CreateParallelData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateParallelDataRequest"}, + "output":{"shape":"CreateParallelDataResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"TooManyTagsException"}, + {"shape":"ConflictException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a parallel data resource in Amazon Translate by importing an input file from Amazon S3. Parallel data files contain examples that show how you want segments of text to be translated. By adding parallel data, you can influence the style, tone, and word choice in your translation output.
" + }, + "DeleteParallelData":{ + "name":"DeleteParallelData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteParallelDataRequest"}, + "output":{"shape":"DeleteParallelDataResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes a parallel data resource in Amazon Translate.
" + }, + "DeleteTerminology":{ + "name":"DeleteTerminology", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTerminologyRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InternalServerException"} + ], + "documentation":"A synchronous action that deletes a custom terminology.
" + }, + "DescribeTextTranslationJob":{ + "name":"DescribeTextTranslationJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTextTranslationJobRequest"}, + "output":{"shape":"DescribeTextTranslationJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets the properties associated with an asynchronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.
" + }, + "GetParallelData":{ + "name":"GetParallelData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetParallelDataRequest"}, + "output":{"shape":"GetParallelDataResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Provides information about a parallel data resource.
" + }, + "GetTerminology":{ + "name":"GetTerminology", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTerminologyRequest"}, + "output":{"shape":"GetTerminologyResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves a custom terminology.
" + }, + "ImportTerminology":{ + "name":"ImportTerminology", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportTerminologyRequest"}, + "output":{"shape":"ImportTerminologyResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"TooManyTagsException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates or updates a custom terminology, depending on whether one already exists for the given terminology name. Importing a terminology with the same name as an existing one will merge the terminologies based on the chosen merge strategy. The only supported merge strategy is OVERWRITE, where the imported terminology overwrites the existing terminology of the same name.
If you import a terminology that overwrites an existing one, the new terminology takes up to 10 minutes to fully propagate. After that, translations have access to the new terminology.
" + }, + "ListLanguages":{ + "name":"ListLanguages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLanguagesRequest"}, + "output":{"shape":"ListLanguagesResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"UnsupportedDisplayLanguageCodeException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Provides a list of languages (RFC-5646 codes and names) that Amazon Translate supports.
" + }, + "ListParallelData":{ + "name":"ListParallelData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListParallelDataRequest"}, + "output":{"shape":"ListParallelDataResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Provides a list of your parallel data resources in Amazon Translate.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists all tags associated with a given Amazon Translate resource. For more information, see Tagging your resources.
" + }, + "ListTerminologies":{ + "name":"ListTerminologies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTerminologiesRequest"}, + "output":{"shape":"ListTerminologiesResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Provides a list of custom terminologies associated with your account.
" + }, + "ListTextTranslationJobs":{ + "name":"ListTextTranslationJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTextTranslationJobsRequest"}, + "output":{"shape":"ListTextTranslationJobsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidFilterException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets a list of the batch translation jobs that you have submitted.
" + }, + "StartTextTranslationJob":{ + "name":"StartTextTranslationJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartTextTranslationJobRequest"}, + "output":{"shape":"StartTextTranslationJobResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"UnsupportedLanguagePairException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Starts an asynchronous batch translation job. Use batch translation jobs to translate large volumes of text across multiple documents at once. For batch translation, you can input documents with different source languages (specify auto as the source language). You can specify one or more target languages. Batch translation translates each input document into each of the target languages. For more information, see Asynchronous batch processing.
Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.
" + }, + "StopTextTranslationJob":{ + "name":"StopTextTranslationJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopTextTranslationJobRequest"}, + "output":{"shape":"StopTextTranslationJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Stops an asynchronous batch translation job that is in progress.
If the job's state is IN_PROGRESS, the job will be marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state. Otherwise, the job is put into the STOPPED state.
Asynchronous batch translation jobs are started with the StartTextTranslationJob operation. You can use the DescribeTextTranslationJob or ListTextTranslationJobs operations to get a batch translation job's JobId.
Associates a specific tag with a resource. A tag is a key-value pair that adds as a metadata to a resource. For more information, see Tagging your resources.
" + }, + "TranslateDocument":{ + "name":"TranslateDocument", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TranslateDocumentRequest"}, + "output":{"shape":"TranslateDocumentResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"UnsupportedLanguagePairException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Translates the input document from the source language to the target language. This synchronous operation supports text, HTML, or Word documents as the input document. TranslateDocument supports translations from English to any supported language, and from any supported language to English. Therefore, specify either the source language code or the target language code as “en” (English).
If you set the Formality parameter, the request will fail if the target language does not support formality. For a list of target languages that support formality, see Setting formality.
Translates input text from the source language to the target language. For a list of available languages and language codes, see Supported languages.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Removes a specific tag associated with an Amazon Translate resource. For more information, see Tagging your resources.
" + }, + "UpdateParallelData":{ + "name":"UpdateParallelData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateParallelDataRequest"}, + "output":{"shape":"UpdateParallelDataResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates a previously created parallel data resource by importing a new input file from Amazon S3.
" + } + }, + "shapes":{ + "AppliedTerminology":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"The name of the custom terminology applied to the input text by Amazon Translate for the translated text response.
" + }, + "Terms":{ + "shape":"TermList", + "documentation":"The specific terms of the custom terminology applied to the input text by Amazon Translate for the translated text response. A maximum of 250 terms will be returned, and the specific terms applied will be the first 250 terms in the source text.
" + } + }, + "documentation":"The custom terminology applied to the input text by Amazon Translate for the translated text response. This is optional in the response and will only be present if you specified terminology input in the request. Currently, only one terminology can be applied per TranslateText request.
" + }, + "AppliedTerminologyList":{ + "type":"list", + "member":{"shape":"AppliedTerminology"} + }, + "BoundedLengthString":{ + "type":"string", + "max":10000, + "min":1, + "pattern":"[\\P{M}\\p{M}]{1,10000}" + }, + "Brevity":{ + "type":"string", + "enum":["ON"] + }, + "ClientTokenString":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9-]+$" + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"Another modification is being made. That modification must complete before you can make your change.
", + "exception":true + }, + "ConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"There was a conflict processing the request. Try your request again.
", + "exception":true + }, + "ContentType":{ + "type":"string", + "max":256, + "pattern":"^[-\\w.]+\\/[-\\w.+]+$" + }, + "CreateParallelDataRequest":{ + "type":"structure", + "required":[ + "Name", + "ParallelDataConfig", + "ClientToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique in the account and region.
" + }, + "Description":{ + "shape":"Description", + "documentation":"A custom description for the parallel data resource in Amazon Translate.
" + }, + "ParallelDataConfig":{ + "shape":"ParallelDataConfig", + "documentation":"Specifies the format and S3 location of the parallel data input file.
" + }, + "EncryptionKey":{"shape":"EncryptionKey"}, + "ClientToken":{ + "shape":"ClientTokenString", + "documentation":"A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.
", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"Tags to be associated with this resource. A tag is a key-value pair that adds metadata to a resource. Each tag key for the resource must be unique. For more information, see Tagging your resources.
" + } + } + }, + "CreateParallelDataResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"The custom name that you assigned to the parallel data resource.
" + }, + "Status":{ + "shape":"ParallelDataStatus", + "documentation":"The status of the parallel data resource. When the resource is ready for you to use, the status is ACTIVE.
The name of the parallel data resource that is being deleted.
" + } + } + }, + "DeleteParallelDataResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"The name of the parallel data resource that is being deleted.
" + }, + "Status":{ + "shape":"ParallelDataStatus", + "documentation":"The status of the parallel data deletion.
" + } + } + }, + "DeleteTerminologyRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"The name of the custom terminology being deleted.
" + } + } + }, + "DescribeTextTranslationJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"The identifier that Amazon Translate generated for the job. The StartTextTranslationJob operation returns this identifier in its response.
" + } + } + }, + "DescribeTextTranslationJobResponse":{ + "type":"structure", + "members":{ + "TextTranslationJobProperties":{ + "shape":"TextTranslationJobProperties", + "documentation":"An object that contains the properties associated with an asynchronous batch translation job.
" + } + } + }, + "Description":{ + "type":"string", + "max":256, + "pattern":"[\\P{M}\\p{M}]{0,256}" + }, + "DetectedLanguageLowConfidenceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "DetectedLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"The language code of the auto-detected language from Amazon Comprehend.
" + } + }, + "documentation":"The confidence that Amazon Comprehend accurately detected the source language is low. If a low confidence level is acceptable for your application, you can use the language in the exception to call Amazon Translate again. For more information, see the DetectDominantLanguage operation in the Amazon Comprehend Developer Guide.
", + "exception":true + }, + "Directionality":{ + "type":"string", + "enum":[ + "UNI", + "MULTI" + ] + }, + "DisplayLanguageCode":{ + "type":"string", + "enum":[ + "de", + "en", + "es", + "fr", + "it", + "ja", + "ko", + "pt", + "zh", + "zh-TW" + ] + }, + "Document":{ + "type":"structure", + "required":[ + "Content", + "ContentType" + ], + "members":{ + "Content":{ + "shape":"DocumentContent", + "documentation":"The Contentfield type is Binary large object (blob). This object contains the document content converted into base64-encoded binary data. If you use one of the AWS SDKs, the SDK performs the Base64-encoding on this field before sending the request.
Describes the format of the document. You can specify one of the following:
text/html - The input data consists of HTML content. Amazon Translate translates only the text in the HTML element.
text/plain - The input data consists of unformatted text. Amazon Translate translates every character in the content.
application/vnd.openxmlformats-officedocument.wordprocessingml.document - The input data consists of a Word document (.docx).
The content and content type of a document.
" + }, + "DocumentContent":{ + "type":"blob", + "max":102400, + "sensitive":true + }, + "EncryptionKey":{ + "type":"structure", + "required":[ + "Type", + "Id" + ], + "members":{ + "Type":{ + "shape":"EncryptionKeyType", + "documentation":"The type of encryption key used by Amazon Translate to encrypt this object.
" + }, + "Id":{ + "shape":"EncryptionKeyID", + "documentation":"The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
" + } + }, + "documentation":"The encryption key used to encrypt this object.
" + }, + "EncryptionKeyID":{ + "type":"string", + "max":400, + "min":1, + "pattern":"(arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\\d:)?(\\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))" + }, + "EncryptionKeyType":{ + "type":"string", + "enum":["KMS"] + }, + "Formality":{ + "type":"string", + "enum":[ + "FORMAL", + "INFORMAL" + ] + }, + "GetParallelDataRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"The name of the parallel data resource that is being retrieved.
" + } + } + }, + "GetParallelDataResponse":{ + "type":"structure", + "members":{ + "ParallelDataProperties":{ + "shape":"ParallelDataProperties", + "documentation":"The properties of the parallel data resource that is being retrieved.
" + }, + "DataLocation":{ + "shape":"ParallelDataDataLocation", + "documentation":"The Amazon S3 location of the most recent parallel data input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration.
Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.
CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.
Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.
The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a parallel data resource. The location is returned as a presigned URL to that has a 30-minute expiration.
" + }, + "LatestUpdateAttemptAuxiliaryDataLocation":{ + "shape":"ParallelDataDataLocation", + "documentation":"The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to update a parallel data resource. The location is returned as a presigned URL to that has a 30-minute expiration.
" + } + } + }, + "GetTerminologyRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"The name of the custom terminology being retrieved.
" + }, + "TerminologyDataFormat":{ + "shape":"TerminologyDataFormat", + "documentation":"The data format of the custom terminology being retrieved.
If you don't specify this parameter, Amazon Translate returns a file with the same format as the file that was imported to create the terminology.
If you specify this parameter when you retrieve a multi-directional terminology resource, you must specify the same format as the input file that was imported to create it. Otherwise, Amazon Translate throws an error.
" + } + } + }, + "GetTerminologyResponse":{ + "type":"structure", + "members":{ + "TerminologyProperties":{ + "shape":"TerminologyProperties", + "documentation":"The properties of the custom terminology being retrieved.
" + }, + "TerminologyDataLocation":{ + "shape":"TerminologyDataLocation", + "documentation":"The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration.
Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.
CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.
Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.
The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a terminology resource. The location is returned as a presigned URL to that has a 30-minute expiration.
" + } + } + }, + "IamRoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+" + }, + "ImportTerminologyRequest":{ + "type":"structure", + "required":[ + "Name", + "MergeStrategy", + "TerminologyData" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"The name of the custom terminology being imported.
" + }, + "MergeStrategy":{ + "shape":"MergeStrategy", + "documentation":"The merge strategy of the custom terminology being imported. Currently, only the OVERWRITE merge strategy is supported. In this case, the imported terminology will overwrite an existing terminology of the same name.
" + }, + "Description":{ + "shape":"Description", + "documentation":"The description of the custom terminology being imported.
" + }, + "TerminologyData":{ + "shape":"TerminologyData", + "documentation":"The terminology data for the custom terminology being imported.
" + }, + "EncryptionKey":{ + "shape":"EncryptionKey", + "documentation":"The encryption key for the custom terminology being imported.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"Tags to be associated with this resource. A tag is a key-value pair that adds metadata to a resource. Each tag key for the resource must be unique. For more information, see Tagging your resources.
" + } + } + }, + "ImportTerminologyResponse":{ + "type":"structure", + "members":{ + "TerminologyProperties":{ + "shape":"TerminologyProperties", + "documentation":"The properties of the custom terminology being imported.
" + }, + "AuxiliaryDataLocation":{ + "shape":"TerminologyDataLocation", + "documentation":"The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a terminology resource. The location is returned as a presigned URL to that has a 30 minute expiration.
" + } + } + }, + "InputDataConfig":{ + "type":"structure", + "required":[ + "S3Uri", + "ContentType" + ], + "members":{ + "S3Uri":{ + "shape":"S3Uri", + "documentation":"The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in the folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are calling.
" + }, + "ContentType":{ + "shape":"ContentType", + "documentation":"Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:
text/html: The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file.
text/plain: The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.
application/vnd.openxmlformats-officedocument.wordprocessingml.document: The input data consists of one or more Word documents (.docx).
application/vnd.openxmlformats-officedocument.presentationml.presentation: The input data consists of one or more PowerPoint Presentation files (.pptx).
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input data consists of one or more Excel Workbook files (.xlsx).
application/x-xliff+xml: The input data consists of one or more XML Localization Interchange File Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.
If you structure your input data as HTML, ensure that you set this parameter to text/html. By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain, your costs will cover the translation of every character.
The input configuration properties for requesting a batch translation job.
" + }, + "Integer":{"type":"integer"}, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"An internal server error occurred. Retry your request.
", + "exception":true, + "fault":true + }, + "InvalidFilterException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The filter specified for the operation is not valid. Specify a different filter.
", + "exception":true + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The value of the parameter is not valid. Review the value of the parameter you are using to correct it, and then retry your operation.
", + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.
", + "exception":true + }, + "JobDetails":{ + "type":"structure", + "members":{ + "TranslatedDocumentsCount":{ + "shape":"Integer", + "documentation":"The number of documents successfully processed during a translation job.
" + }, + "DocumentsWithErrorsCount":{ + "shape":"Integer", + "documentation":"The number of documents that could not be processed during a translation job.
" + }, + "InputDocumentsCount":{ + "shape":"Integer", + "documentation":"The number of documents used as input in a translation job.
" + } + }, + "documentation":"The number of documents successfully and unsuccessfully processed during a translation job.
" + }, + "JobId":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" + }, + "JobName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" + }, + "JobStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "IN_PROGRESS", + "COMPLETED", + "COMPLETED_WITH_ERROR", + "FAILED", + "STOP_REQUESTED", + "STOPPED" + ] + }, + "Language":{ + "type":"structure", + "required":[ + "LanguageName", + "LanguageCode" + ], + "members":{ + "LanguageName":{ + "shape":"LocalizedNameString", + "documentation":"Language name of the supported language.
" + }, + "LanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"Language code for the supported language.
" + } + }, + "documentation":"A supported language.
" + }, + "LanguageCodeString":{ + "type":"string", + "max":5, + "min":2 + }, + "LanguageCodeStringList":{ + "type":"list", + "member":{"shape":"LanguageCodeString"} + }, + "LanguagesList":{ + "type":"list", + "member":{"shape":"Language"} + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The specified limit has been exceeded. Review your request and retry it with a quantity below the stated limit.
", + "exception":true + }, + "ListLanguagesRequest":{ + "type":"structure", + "members":{ + "DisplayLanguageCode":{ + "shape":"DisplayLanguageCode", + "documentation":"The language code for the language to use to display the language names in the response. The language code is en by default.
Include the NextToken value to fetch the next group of supported languages.
" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"The maximum number of results to return in each response.
" + } + } + }, + "ListLanguagesResponse":{ + "type":"structure", + "members":{ + "Languages":{ + "shape":"LanguagesList", + "documentation":"The list of supported languages.
" + }, + "DisplayLanguageCode":{ + "shape":"DisplayLanguageCode", + "documentation":"The language code passed in with the request.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If the response does not include all remaining results, use the NextToken in the next request to fetch the next group of supported languages.
" + } + } + }, + "ListParallelDataRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"A string that specifies the next page of results to return in a paginated response.
" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"The maximum number of parallel data resources returned for each request.
" + } + } + }, + "ListParallelDataResponse":{ + "type":"structure", + "members":{ + "ParallelDataPropertiesList":{ + "shape":"ParallelDataPropertiesList", + "documentation":"The properties of the parallel data resources returned by this request.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the given Amazon Translate resource you are querying.
" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"Tags associated with the Amazon Translate resource being queried. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Translate. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
" + } + } + }, + "ListTerminologiesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"If the result of the request to ListTerminologies was truncated, include the NextToken to fetch the next group of custom terminologies.
" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"The maximum number of custom terminologies returned per list request.
" + } + } + }, + "ListTerminologiesResponse":{ + "type":"structure", + "members":{ + "TerminologyPropertiesList":{ + "shape":"TerminologyPropertiesList", + "documentation":"The properties list of the custom terminologies returned on the list request.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If the response to the ListTerminologies was truncated, the NextToken fetches the next group of custom terminologies.
" + } + } + }, + "ListTextTranslationJobsRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"TextTranslationJobFilter", + "documentation":"The parameters that specify which batch translation jobs to retrieve. Filters include job name, job status, and submission time. You can only set one filter at a time.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to request the next page of results.
" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"The maximum number of results to return in each page. The default value is 100.
" + } + } + }, + "ListTextTranslationJobsResponse":{ + "type":"structure", + "members":{ + "TextTranslationJobPropertiesList":{ + "shape":"TextTranslationJobPropertiesList", + "documentation":"A list containing the properties of each job that is returned.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The URI of the S3 folder that contains a translation job's output file. The folder must be in the same Region as the API endpoint that you are calling.
" + }, + "EncryptionKey":{"shape":"EncryptionKey"} + }, + "documentation":"The output configuration properties for a batch translation job.
" + }, + "ParallelDataArn":{ + "type":"string", + "max":512, + "min":1 + }, + "ParallelDataConfig":{ + "type":"structure", + "members":{ + "S3Uri":{ + "shape":"S3Uri", + "documentation":"The URI of the Amazon S3 folder that contains the parallel data input file. The folder must be in the same Region as the API endpoint you are calling.
" + }, + "Format":{ + "shape":"ParallelDataFormat", + "documentation":"The format of the parallel data input file.
" + } + }, + "documentation":"Specifies the format and S3 location of the parallel data input file.
" + }, + "ParallelDataDataLocation":{ + "type":"structure", + "required":[ + "RepositoryType", + "Location" + ], + "members":{ + "RepositoryType":{ + "shape":"String", + "documentation":"Describes the repository that contains the parallel data input file.
" + }, + "Location":{ + "shape":"String", + "documentation":"The Amazon S3 location of the parallel data input file. The location is returned as a presigned URL to that has a 30-minute expiration.
Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.
CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.
Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.
The location of the most recent parallel data input file that was successfully imported into Amazon Translate.
" + }, + "ParallelDataFormat":{ + "type":"string", + "enum":[ + "TSV", + "CSV", + "TMX" + ] + }, + "ParallelDataProperties":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"The custom name assigned to the parallel data resource.
" + }, + "Arn":{ + "shape":"ParallelDataArn", + "documentation":"The Amazon Resource Name (ARN) of the parallel data resource.
" + }, + "Description":{ + "shape":"Description", + "documentation":"The description assigned to the parallel data resource.
" + }, + "Status":{ + "shape":"ParallelDataStatus", + "documentation":"The status of the parallel data resource. When the parallel data is ready for you to use, the status is ACTIVE.
The source language of the translations in the parallel data file.
" + }, + "TargetLanguageCodes":{ + "shape":"LanguageCodeStringList", + "documentation":"The language codes for the target languages available in the parallel data file. All possible target languages are returned as an array.
" + }, + "ParallelDataConfig":{ + "shape":"ParallelDataConfig", + "documentation":"Specifies the format and S3 location of the parallel data input file.
" + }, + "Message":{ + "shape":"UnboundedLengthString", + "documentation":"Additional information from Amazon Translate about the parallel data resource.
" + }, + "ImportedDataSize":{ + "shape":"Long", + "documentation":"The number of UTF-8 characters that Amazon Translate imported from the parallel data input file. This number includes only the characters in your translation examples. It does not include characters that are used to format your file. For example, if you provided a Translation Memory Exchange (.tmx) file, this number does not include the tags.
" + }, + "ImportedRecordCount":{ + "shape":"Long", + "documentation":"The number of records successfully imported from the parallel data input file.
" + }, + "FailedRecordCount":{ + "shape":"Long", + "documentation":"The number of records unsuccessfully imported from the parallel data input file.
" + }, + "SkippedRecordCount":{ + "shape":"Long", + "documentation":"The number of items in the input file that Amazon Translate skipped when you created or updated the parallel data resource. For example, Amazon Translate skips empty records, empty target texts, and empty lines.
" + }, + "EncryptionKey":{"shape":"EncryptionKey"}, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The time at which the parallel data resource was created.
" + }, + "LastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"The time at which the parallel data resource was last updated.
" + }, + "LatestUpdateAttemptStatus":{ + "shape":"ParallelDataStatus", + "documentation":"The status of the most recent update attempt for the parallel data resource.
" + }, + "LatestUpdateAttemptAt":{ + "shape":"Timestamp", + "documentation":"The time that the most recent update was attempted.
" + } + }, + "documentation":"The properties of a parallel data resource.
" + }, + "ParallelDataPropertiesList":{ + "type":"list", + "member":{"shape":"ParallelDataProperties"} + }, + "ParallelDataStatus":{ + "type":"string", + "enum":[ + "CREATING", + "UPDATING", + "ACTIVE", + "DELETING", + "FAILED" + ] + }, + "Profanity":{ + "type":"string", + "enum":["MASK"] + }, + "ResourceArn":{ + "type":"string", + "max":512, + "min":1 + }, + "ResourceName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^([A-Za-z0-9-]_?)+$" + }, + "ResourceNameList":{ + "type":"list", + "member":{"shape":"ResourceName"} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request.
", + "exception":true + }, + "S3Uri":{ + "type":"string", + "max":1024, + "pattern":"s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?" + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The Amazon Translate service is temporarily unavailable. Wait a bit and then retry your request.
", + "exception":true, + "fault":true + }, + "StartTextTranslationJobRequest":{ + "type":"structure", + "required":[ + "InputDataConfig", + "OutputDataConfig", + "DataAccessRoleArn", + "SourceLanguageCode", + "TargetLanguageCodes", + "ClientToken" + ], + "members":{ + "JobName":{ + "shape":"JobName", + "documentation":"The name of the batch translation job to be performed.
" + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"Specifies the format and location of the input documents for the translation job.
" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"Specifies the S3 folder to which your job output will be saved.
" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more information, see Identity and access management .
" + }, + "SourceLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"The language code of the input language. Specify the language if all input documents share the same language. If you don't know the language of the source files, or your input documents contains different source languages, select auto. Amazon Translate auto detects the source language for each input document. For a list of supported language codes, see Supported languages.
The target languages of the translation job. Enter up to 10 language codes. Each input file is translated into each target language.
Each language code is 2 or 5 characters long. For a list of language codes, see Supported languages.
" + }, + "TerminologyNames":{ + "shape":"ResourceNameList", + "documentation":"The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.
This parameter accepts only one custom terminology resource.
If you specify multiple target languages for the job, translate uses the designated terminology for each requested target language that has an entry for the source term in the terminology file.
For a list of available custom terminology resources, use the ListTerminologies operation.
For more information, see Custom terminology.
" + }, + "ParallelDataNames":{ + "shape":"ResourceNameList", + "documentation":"The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. If you specify multiple target languages for the job, the parallel data file must include translations for all the target languages.
When you add parallel data to a translation job, you create an Active Custom Translation job.
This parameter accepts only one parallel data resource.
Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.
For a list of available parallel data resources, use the ListParallelData operation.
For more information, see Customizing your translations with parallel data.
" + }, + "ClientToken":{ + "shape":"ClientTokenString", + "documentation":"A unique identifier for the request. This token is generated for you when using the Amazon Translate SDK.
", + "idempotencyToken":true + }, + "Settings":{ + "shape":"TranslationSettings", + "documentation":"Settings to configure your translation output. You can configure the following options:
Brevity: not supported.
Formality: sets the formality level of the output text.
Profanity: masks profane words and phrases in your translation output.
The identifier generated for the job. To get the status of a job, use this ID with the DescribeTextTranslationJob operation.
" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"The status of the job. Possible values include:
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Translate is processing the job.
COMPLETED - The job was successfully completed and the output is available.
COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job's output.
FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob operation.
STOP_REQUESTED - The user who started the job has requested that it be stopped.
STOPPED - The job has been stopped.
The job ID of the job to be stopped.
" + } + } + }, + "StopTextTranslationJobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"The job ID of the stopped batch translation job.
" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"The status of the designated job. Upon successful completion, the job's status will be STOPPED.
The initial part of a key-value pair that forms a tag associated with a given resource.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The second part of a key-value pair that forms a tag associated with a given resource.
" + } + }, + "documentation":"A key-value pair that adds as a metadata to a resource used by Amazon Translate.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the given Amazon Translate resource to which you want to associate the tags.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"Tags being associated with a specific Amazon Translate resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TargetLanguageCodeStringList":{ + "type":"list", + "member":{"shape":"LanguageCodeString"}, + "min":1 + }, + "Term":{ + "type":"structure", + "members":{ + "SourceText":{ + "shape":"String", + "documentation":"The source text of the term being translated by the custom terminology.
" + }, + "TargetText":{ + "shape":"String", + "documentation":"The target text of the term being translated by the custom terminology.
" + } + }, + "documentation":"The term being translated by the custom terminology.
" + }, + "TermList":{ + "type":"list", + "member":{"shape":"Term"} + }, + "TerminologyArn":{ + "type":"string", + "max":512, + "min":1 + }, + "TerminologyData":{ + "type":"structure", + "required":[ + "File", + "Format" + ], + "members":{ + "File":{ + "shape":"TerminologyFile", + "documentation":"The file containing the custom terminology data. Your version of the AWS SDK performs a Base64-encoding on this field before sending a request to the AWS service. Users of the SDK should not perform Base64-encoding themselves.
" + }, + "Format":{ + "shape":"TerminologyDataFormat", + "documentation":"The data format of the custom terminology.
" + }, + "Directionality":{ + "shape":"Directionality", + "documentation":"The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).
The terminology resource has one source language (for example, the first column in a CSV file), and all of its other languages are target languages.
Any language in the terminology resource can be the source language or a target language. A single multi-directional terminology resource can be used for jobs that translate different language pairs. For example, if the terminology contains English and Spanish terms, it can be used for jobs that translate English to Spanish and Spanish to English.
When you create a custom terminology resource without specifying the directionality, it behaves as uni-directional terminology, although this parameter will have a null value.
" + } + }, + "documentation":"The data associated with the custom terminology. For information about the custom terminology file, see Creating a Custom Terminology.
" + }, + "TerminologyDataFormat":{ + "type":"string", + "enum":[ + "CSV", + "TMX", + "TSV" + ] + }, + "TerminologyDataLocation":{ + "type":"structure", + "required":[ + "RepositoryType", + "Location" + ], + "members":{ + "RepositoryType":{ + "shape":"String", + "documentation":"The repository type for the custom terminology data.
" + }, + "Location":{ + "shape":"String", + "documentation":"The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration .
Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.
CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.
Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.
The location of the custom terminology data.
" + }, + "TerminologyFile":{ + "type":"blob", + "max":10485760, + "sensitive":true + }, + "TerminologyProperties":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"The name of the custom terminology.
" + }, + "Description":{ + "shape":"Description", + "documentation":"The description of the custom terminology properties.
" + }, + "Arn":{ + "shape":"TerminologyArn", + "documentation":"The Amazon Resource Name (ARN) of the custom terminology.
" + }, + "SourceLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"The language code for the source text of the translation request for which the custom terminology is being used.
" + }, + "TargetLanguageCodes":{ + "shape":"LanguageCodeStringList", + "documentation":"The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.
" + }, + "EncryptionKey":{ + "shape":"EncryptionKey", + "documentation":"The encryption key for the custom terminology.
" + }, + "SizeBytes":{ + "shape":"Integer", + "documentation":"The size of the file used when importing a custom terminology.
" + }, + "TermCount":{ + "shape":"Integer", + "documentation":"The number of terms included in the custom terminology.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The time at which the custom terminology was created, based on the timestamp.
" + }, + "LastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"The time at which the custom terminology was last update, based on the timestamp.
" + }, + "Directionality":{ + "shape":"Directionality", + "documentation":"The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).
The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.
Any language in the terminology resource can be the source language.
Additional information from Amazon Translate about the terminology resource.
" + }, + "SkippedTermCount":{ + "shape":"Integer", + "documentation":"The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.
" + }, + "Format":{ + "shape":"TerminologyDataFormat", + "documentation":"The format of the custom terminology input file.
" + } + }, + "documentation":"The properties of the custom terminology.
" + }, + "TerminologyPropertiesList":{ + "type":"list", + "member":{"shape":"TerminologyProperties"} + }, + "TextSizeLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.
", + "exception":true + }, + "TextTranslationJobFilter":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"JobName", + "documentation":"Filters the list of jobs by name.
" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"Filters the list of jobs based by job status.
" + }, + "SubmittedBeforeTime":{ + "shape":"Timestamp", + "documentation":"Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
" + }, + "SubmittedAfterTime":{ + "shape":"Timestamp", + "documentation":"Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
" + } + }, + "documentation":"Provides information for filtering a list of translation jobs. For more information, see ListTextTranslationJobs.
" + }, + "TextTranslationJobProperties":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"The ID of the translation job.
" + }, + "JobName":{ + "shape":"JobName", + "documentation":"The user-defined name of the translation job.
" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"The status of the translation job.
" + }, + "JobDetails":{ + "shape":"JobDetails", + "documentation":"The number of documents successfully and unsuccessfully processed during the translation job.
" + }, + "SourceLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"The language code of the language of the source text. The language must be a language supported by Amazon Translate.
" + }, + "TargetLanguageCodes":{ + "shape":"TargetLanguageCodeStringList", + "documentation":"The language code of the language of the target text. The language must be a language supported by Amazon Translate.
" + }, + "TerminologyNames":{ + "shape":"ResourceNameList", + "documentation":"A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.
" + }, + "ParallelDataNames":{ + "shape":"ResourceNameList", + "documentation":"A list containing the names of the parallel data resources applied to the translation job.
" + }, + "Message":{ + "shape":"UnboundedLengthString", + "documentation":"An explanation of any errors that may have occurred during the translation job.
" + }, + "SubmittedTime":{ + "shape":"Timestamp", + "documentation":"The time at which the translation job was submitted.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The time at which the translation job ended.
" + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"The input configuration properties that were specified when the job was requested.
" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"The output configuration properties that were specified when the job was requested.
" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.
" + }, + "Settings":{ + "shape":"TranslationSettings", + "documentation":"Settings that modify the translation output.
" + } + }, + "documentation":"Provides information about a translation job.
" + }, + "TextTranslationJobPropertiesList":{ + "type":"list", + "member":{"shape":"TextTranslationJobProperties"} + }, + "Timestamp":{"type":"timestamp"}, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"You have made too many requests within a short period of time. Wait for a short time and then try your request again.
", + "exception":true + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "ResourceArn":{"shape":"ResourceArn"} + }, + "documentation":"You have added too many tags to this resource. The maximum is 50 tags.
", + "exception":true + }, + "TranslateDocumentRequest":{ + "type":"structure", + "required":[ + "Document", + "SourceLanguageCode", + "TargetLanguageCode" + ], + "members":{ + "Document":{ + "shape":"Document", + "documentation":"The content and content type for the document to be translated. The document size must not exceed 100 KB.
" + }, + "TerminologyNames":{ + "shape":"ResourceNameList", + "documentation":"The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.
Use the ListTerminologies operation to get the available terminology lists.
For more information about custom terminology lists, see Custom terminology.
" + }, + "SourceLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"The language code for the language of the source text. For a list of supported language codes, see Supported languages.
To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.
If you specify auto, you must send the TranslateDocument request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.
The language code requested for the translated document. For a list of supported language codes, see Supported languages.
" + }, + "Settings":{ + "shape":"TranslationSettings", + "documentation":"Settings to configure your translation output. You can configure the following options:
Brevity: not supported.
Formality: sets the formality level of the output text.
Profanity: masks profane words and phrases in your translation output.
The document containing the translated content. The document format matches the source document format.
" + }, + "SourceLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"The language code of the source document.
" + }, + "TargetLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"The language code of the translated document.
" + }, + "AppliedTerminologies":{ + "shape":"AppliedTerminologyList", + "documentation":"The names of the custom terminologies applied to the input text by Amazon Translate to produce the translated text document.
" + }, + "AppliedSettings":{"shape":"TranslationSettings"} + } + }, + "TranslateTextRequest":{ + "type":"structure", + "required":[ + "Text", + "SourceLanguageCode", + "TargetLanguageCode" + ], + "members":{ + "Text":{ + "shape":"BoundedLengthString", + "documentation":"The text to translate. The text string can be a maximum of 10,000 bytes long. Depending on your character set, this may be fewer than 10,000 characters.
" + }, + "TerminologyNames":{ + "shape":"ResourceNameList", + "documentation":"The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.
Use the ListTerminologies operation to get the available terminology lists.
For more information about custom terminology lists, see Custom terminology.
" + }, + "SourceLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"The language code for the language of the source text. For a list of language codes, see Supported languages.
To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.
If you specify auto, you must send the TranslateText request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.
The language code requested for the language of the target text. For a list of language codes, see Supported languages.
" + }, + "Settings":{ + "shape":"TranslationSettings", + "documentation":"Settings to configure your translation output. You can configure the following options:
Brevity: reduces the length of the translated output for most translations.
Formality: sets the formality level of the output text.
Profanity: masks profane words and phrases in your translation output.
The translated text.
" + }, + "SourceLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"The language code for the language of the source text.
" + }, + "TargetLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"The language code for the language of the target text.
" + }, + "AppliedTerminologies":{ + "shape":"AppliedTerminologyList", + "documentation":"The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.
" + }, + "AppliedSettings":{ + "shape":"TranslationSettings", + "documentation":"Optional settings that modify the translation output.
" + } + } + }, + "TranslatedDocument":{ + "type":"structure", + "required":["Content"], + "members":{ + "Content":{ + "shape":"TranslatedDocumentContent", + "documentation":"The document containing the translated content.
" + } + }, + "documentation":"The translated content.
" + }, + "TranslatedDocumentContent":{ + "type":"blob", + "sensitive":true + }, + "TranslatedTextString":{ + "type":"string", + "max":20000, + "pattern":"[\\P{M}\\p{M}]{0,20000}" + }, + "TranslationSettings":{ + "type":"structure", + "members":{ + "Formality":{ + "shape":"Formality", + "documentation":"You can specify the desired level of formality for translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.
If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported target language.
For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
" + }, + "Profanity":{ + "shape":"Profanity", + "documentation":"You can enable the profanity setting if you want to mask profane words and phrases in your translation output.
To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.
Amazon Translate doesn't detect profanity in all of its supported languages. For languages that don't support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
If you specify multiple target languages for the job, all the target languages must support profanity masking. If any of the target languages don't support profanity masking, the translation job won't mask profanity for any target language.
" + }, + "Brevity":{ + "shape":"Brevity", + "documentation":"When you turn on brevity, Amazon Translate reduces the length of the translation output for most translations (when compared with the same translation with brevity turned off). By default, brevity is turned off.
If you turn on brevity for a translation request with an unsupported language pair, the translation proceeds with the brevity setting turned off.
For the language pairs that brevity supports, see Using brevity in the Amazon Translate Developer Guide.
" + } + }, + "documentation":"Settings to configure your translation output. You can configure the following options:
Brevity: reduces the length of the translation output for most translations. Available for TranslateText only.
Formality: sets the formality level of the translation output.
Profanity: masks profane words and phrases in the translation output.
Language code passed in with the request.
" + } + }, + "documentation":"Requested display language code is not supported.
", + "exception":true + }, + "UnsupportedLanguagePairException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "SourceLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"The language code for the language of the input text.
" + }, + "TargetLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"The language code for the language of the translated text.
" + } + }, + "documentation":"Amazon Translate does not support translation from the language of the source text into the requested target language. For more information, see Supported languages.
", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the given Amazon Translate resource from which you want to remove the tags.
" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"The initial part of a key-value pair that forms a tag being removed from a given resource. Keys must be unique and cannot be duplicated for a particular resource.
" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateParallelDataRequest":{ + "type":"structure", + "required":[ + "Name", + "ParallelDataConfig", + "ClientToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"The name of the parallel data resource being updated.
" + }, + "Description":{ + "shape":"Description", + "documentation":"A custom description for the parallel data resource in Amazon Translate.
" + }, + "ParallelDataConfig":{ + "shape":"ParallelDataConfig", + "documentation":"Specifies the format and S3 location of the parallel data input file.
" + }, + "ClientToken":{ + "shape":"ClientTokenString", + "documentation":"A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.
", + "idempotencyToken":true + } + } + }, + "UpdateParallelDataResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"The name of the parallel data resource being updated.
" + }, + "Status":{ + "shape":"ParallelDataStatus", + "documentation":"The status of the parallel data resource that you are attempting to update. Your update request is accepted only if this status is either ACTIVE or FAILED.
The status of the parallel data update attempt. When the updated parallel data resource is ready for you to use, the status is ACTIVE.
The time that the most recent update was attempted.
" + } + } + } + }, + "documentation":"Provides translation of the input content from the source language to the target language.
" +} diff --git a/testbed/boto__botocore/botocore/data/trustedadvisor/2022-09-15/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/trustedadvisor/2022-09-15/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..879fbcde74cfc26bfba2b79c3adfa09d0fff0e7b --- /dev/null +++ b/testbed/boto__botocore/botocore/data/trustedadvisor/2022-09-15/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://trustedadvisor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://trustedadvisor-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://trustedadvisor.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://trustedadvisor.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/trustedadvisor/2022-09-15/paginators-1.json b/testbed/boto__botocore/botocore/data/trustedadvisor/2022-09-15/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..0ac4c7b0e358be3d3ca9544396dcb82707bc7b9c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/trustedadvisor/2022-09-15/paginators-1.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "ListChecks": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "checkSummaries" + }, + "ListOrganizationRecommendationAccounts": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "accountRecommendationLifecycleSummaries" + }, + "ListOrganizationRecommendationResources": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "organizationRecommendationResourceSummaries" + }, + "ListOrganizationRecommendations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "organizationRecommendationSummaries" + }, + "ListRecommendationResources": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "recommendationResourceSummaries" + }, + "ListRecommendations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "recommendationSummaries" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/trustedadvisor/2022-09-15/service-2.json b/testbed/boto__botocore/botocore/data/trustedadvisor/2022-09-15/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..5798e0eeb44158cd90e722ef628850324d0c6e35 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/trustedadvisor/2022-09-15/service-2.json @@ -0,0 +1,1744 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2022-09-15", + "endpointPrefix":"trustedadvisor", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"TrustedAdvisor Public API", + "serviceId":"TrustedAdvisor", + "signatureVersion":"v4", + "signingName":"trustedadvisor", + "uid":"trustedadvisor-2022-09-15" + }, + "operations":{ + "BatchUpdateRecommendationResourceExclusion":{ + "name":"BatchUpdateRecommendationResourceExclusion", + "http":{ + "method":"PUT", + "requestUri":"/v1/batch-update-recommendation-resource-exclusion", + "responseCode":200 + }, + "input":{"shape":"BatchUpdateRecommendationResourceExclusionRequest"}, + "output":{"shape":"BatchUpdateRecommendationResourceExclusionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Update one or more exclusion status for a list of recommendation resources
", + "idempotent":true + }, + "GetOrganizationRecommendation":{ + "name":"GetOrganizationRecommendation", + "http":{ + "method":"GET", + "requestUri":"/v1/organization-recommendations/{organizationRecommendationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetOrganizationRecommendationRequest"}, + "output":{"shape":"GetOrganizationRecommendationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get a specific recommendation within an AWS Organizations organization. This API supports only prioritized recommendations.
" + }, + "GetRecommendation":{ + "name":"GetRecommendation", + "http":{ + "method":"GET", + "requestUri":"/v1/recommendations/{recommendationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetRecommendationRequest"}, + "output":{"shape":"GetRecommendationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get a specific Recommendation
" + }, + "ListChecks":{ + "name":"ListChecks", + "http":{ + "method":"GET", + "requestUri":"/v1/checks", + "responseCode":200 + }, + "input":{"shape":"ListChecksRequest"}, + "output":{"shape":"ListChecksResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List a filterable set of Checks
" + }, + "ListOrganizationRecommendationAccounts":{ + "name":"ListOrganizationRecommendationAccounts", + "http":{ + "method":"GET", + "requestUri":"/v1/organization-recommendations/{organizationRecommendationIdentifier}/accounts", + "responseCode":200 + }, + "input":{"shape":"ListOrganizationRecommendationAccountsRequest"}, + "output":{"shape":"ListOrganizationRecommendationAccountsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Lists the accounts that own the resources for an organization aggregate recommendation. This API only supports prioritized recommendations.
" + }, + "ListOrganizationRecommendationResources":{ + "name":"ListOrganizationRecommendationResources", + "http":{ + "method":"GET", + "requestUri":"/v1/organization-recommendations/{organizationRecommendationIdentifier}/resources", + "responseCode":200 + }, + "input":{"shape":"ListOrganizationRecommendationResourcesRequest"}, + "output":{"shape":"ListOrganizationRecommendationResourcesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List Resources of a Recommendation within an Organization. This API only supports prioritized recommendations.
" + }, + "ListOrganizationRecommendations":{ + "name":"ListOrganizationRecommendations", + "http":{ + "method":"GET", + "requestUri":"/v1/organization-recommendations", + "responseCode":200 + }, + "input":{"shape":"ListOrganizationRecommendationsRequest"}, + "output":{"shape":"ListOrganizationRecommendationsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List a filterable set of Recommendations within an Organization. This API only supports prioritized recommendations.
" + }, + "ListRecommendationResources":{ + "name":"ListRecommendationResources", + "http":{ + "method":"GET", + "requestUri":"/v1/recommendations/{recommendationIdentifier}/resources", + "responseCode":200 + }, + "input":{"shape":"ListRecommendationResourcesRequest"}, + "output":{"shape":"ListRecommendationResourcesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List Resources of a Recommendation
" + }, + "ListRecommendations":{ + "name":"ListRecommendations", + "http":{ + "method":"GET", + "requestUri":"/v1/recommendations", + "responseCode":200 + }, + "input":{"shape":"ListRecommendationsRequest"}, + "output":{"shape":"ListRecommendationsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List a filterable set of Recommendations
" + }, + "UpdateOrganizationRecommendationLifecycle":{ + "name":"UpdateOrganizationRecommendationLifecycle", + "http":{ + "method":"PUT", + "requestUri":"/v1/organization-recommendations/{organizationRecommendationIdentifier}/lifecycle", + "responseCode":200 + }, + "input":{"shape":"UpdateOrganizationRecommendationLifecycleRequest"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Update the lifecycle of a Recommendation within an Organization. This API only supports prioritized recommendations.
", + "idempotent":true + }, + "UpdateRecommendationLifecycle":{ + "name":"UpdateRecommendationLifecycle", + "http":{ + "method":"PUT", + "requestUri":"/v1/recommendations/{recommendationIdentifier}/lifecycle", + "responseCode":200 + }, + "input":{"shape":"UpdateRecommendationLifecycleRequest"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Update the lifecyle of a Recommendation. This API only supports prioritized recommendations.
", + "idempotent":true + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Exception that access has been denied due to insufficient access
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccountId":{ + "type":"string", + "max":12, + "min":12, + "pattern":"^\\d+$" + }, + "AccountRecommendationArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:[\\w-]+:trustedadvisor::\\d{12}:recommendation\\/[\\w-]+$" + }, + "AccountRecommendationIdentifier":{ + "type":"string", + "max":200, + "min":20, + "pattern":"^arn:[\\w-]+:trustedadvisor::\\d{12}:recommendation\\/[\\w-]+$" + }, + "AccountRecommendationLifecycleSummary":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"AccountId", + "documentation":"The AWS account ID
" + }, + "accountRecommendationArn":{ + "shape":"AccountRecommendationArn", + "documentation":"The Recommendation ARN
" + }, + "lastUpdatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the Recommendation was last updated
" + }, + "lifecycleStage":{ + "shape":"RecommendationLifecycleStage", + "documentation":"The lifecycle stage from AWS Trusted Advisor Priority
" + }, + "updateReason":{ + "shape":"RecommendationUpdateReason", + "documentation":"Reason for the lifecycle stage change
" + }, + "updateReasonCode":{ + "shape":"UpdateRecommendationLifecycleStageReasonCode", + "documentation":"Reason code for the lifecycle state change
" + }, + "updatedOnBehalfOf":{ + "shape":"String", + "documentation":"The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority
" + }, + "updatedOnBehalfOfJobTitle":{ + "shape":"String", + "documentation":"The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority
" + } + }, + "documentation":"Summary of an AccountRecommendationLifecycle for an Organization Recommendation
" + }, + "AccountRecommendationLifecycleSummaryList":{ + "type":"list", + "member":{"shape":"AccountRecommendationLifecycleSummary"} + }, + "BatchUpdateRecommendationResourceExclusionRequest":{ + "type":"structure", + "required":["recommendationResourceExclusions"], + "members":{ + "recommendationResourceExclusions":{ + "shape":"RecommendationResourceExclusionList", + "documentation":"A list of recommendation resource ARNs and exclusion status to update
" + } + } + }, + "BatchUpdateRecommendationResourceExclusionResponse":{ + "type":"structure", + "required":["batchUpdateRecommendationResourceExclusionErrors"], + "members":{ + "batchUpdateRecommendationResourceExclusionErrors":{ + "shape":"UpdateRecommendationResourceExclusionErrorList", + "documentation":"A list of recommendation resource ARNs whose exclusion status failed to update, if any
" + } + } + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "CheckArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:[\\w-]+:trustedadvisor:::check\\/[\\w-]+$" + }, + "CheckIdentifier":{ + "type":"string", + "max":64, + "min":20, + "pattern":"^arn:[\\w-]+:trustedadvisor:::check\\/[\\w-]+$" + }, + "CheckSummary":{ + "type":"structure", + "required":[ + "arn", + "awsServices", + "description", + "id", + "metadata", + "name", + "pillars", + "source" + ], + "members":{ + "arn":{ + "shape":"CheckArn", + "documentation":"The ARN of the AWS Trusted Advisor Check
" + }, + "awsServices":{ + "shape":"RecommendationAwsServiceList", + "documentation":"The AWS Services that the Check applies to
" + }, + "description":{ + "shape":"String", + "documentation":"A description of what the AWS Trusted Advisor Check is monitoring
" + }, + "id":{ + "shape":"String", + "documentation":"The unique identifier of the AWS Trusted Advisor Check
" + }, + "metadata":{ + "shape":"StringMap", + "documentation":"The column headings for the metadata returned in the resource
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the AWS Trusted Advisor Check
" + }, + "pillars":{ + "shape":"RecommendationPillarList", + "documentation":"The Recommendation pillars that the AWS Trusted Advisor Check falls under
" + }, + "source":{ + "shape":"RecommendationSource", + "documentation":"The source of the Recommendation
" + } + }, + "documentation":"A summary of an AWS Trusted Advisor Check
" + }, + "CheckSummaryList":{ + "type":"list", + "member":{"shape":"CheckSummary"} + }, + "ConflictException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Exception that the request was denied due to conflictions in state
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "Double":{ + "type":"double", + "box":true + }, + "ExclusionStatus":{ + "type":"string", + "enum":[ + "excluded", + "included" + ] + }, + "GetOrganizationRecommendationRequest":{ + "type":"structure", + "required":["organizationRecommendationIdentifier"], + "members":{ + "organizationRecommendationIdentifier":{ + "shape":"OrganizationRecommendationIdentifier", + "documentation":"The Recommendation identifier
", + "location":"uri", + "locationName":"organizationRecommendationIdentifier" + } + } + }, + "GetOrganizationRecommendationResponse":{ + "type":"structure", + "members":{ + "organizationRecommendation":{ + "shape":"OrganizationRecommendation", + "documentation":"The Recommendation
" + } + } + }, + "GetRecommendationRequest":{ + "type":"structure", + "required":["recommendationIdentifier"], + "members":{ + "recommendationIdentifier":{ + "shape":"AccountRecommendationIdentifier", + "documentation":"The Recommendation identifier
", + "location":"uri", + "locationName":"recommendationIdentifier" + } + } + }, + "GetRecommendationResponse":{ + "type":"structure", + "members":{ + "recommendation":{ + "shape":"Recommendation", + "documentation":"The Recommendation
" + } + } + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Exception to notify that an unexpected internal error occurred during processing of the request
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "ListChecksRequest":{ + "type":"structure", + "members":{ + "awsService":{ + "shape":"RecommendationAwsService", + "documentation":"The aws service associated with the check
", + "location":"querystring", + "locationName":"awsService" + }, + "language":{ + "shape":"RecommendationLanguage", + "documentation":"The ISO 639-1 code for the language that you want your checks to appear in.
", + "location":"querystring", + "locationName":"language" + }, + "maxResults":{ + "shape":"ListChecksRequestMaxResultsInteger", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"ListChecksRequestNextTokenString", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + }, + "pillar":{ + "shape":"RecommendationPillar", + "documentation":"The pillar of the check
", + "location":"querystring", + "locationName":"pillar" + }, + "source":{ + "shape":"RecommendationSource", + "documentation":"The source of the check
", + "location":"querystring", + "locationName":"source" + } + } + }, + "ListChecksRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":200, + "min":1 + }, + "ListChecksRequestNextTokenString":{ + "type":"string", + "max":10000, + "min":4 + }, + "ListChecksResponse":{ + "type":"structure", + "required":["checkSummaries"], + "members":{ + "checkSummaries":{ + "shape":"CheckSummaryList", + "documentation":"The list of Checks
" + }, + "nextToken":{ + "shape":"ListChecksResponseNextTokenString", + "documentation":"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.
" + } + } + }, + "ListChecksResponseNextTokenString":{ + "type":"string", + "max":10000, + "min":4 + }, + "ListOrganizationRecommendationAccountsRequest":{ + "type":"structure", + "required":["organizationRecommendationIdentifier"], + "members":{ + "affectedAccountId":{ + "shape":"AccountId", + "documentation":"An account affected by this organization recommendation
", + "location":"querystring", + "locationName":"affectedAccountId" + }, + "maxResults":{ + "shape":"ListOrganizationRecommendationAccountsRequestMaxResultsInteger", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"ListOrganizationRecommendationAccountsRequestNextTokenString", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + }, + "organizationRecommendationIdentifier":{ + "shape":"OrganizationRecommendationIdentifier", + "documentation":"The Recommendation identifier
", + "location":"uri", + "locationName":"organizationRecommendationIdentifier" + } + } + }, + "ListOrganizationRecommendationAccountsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":200, + "min":1 + }, + "ListOrganizationRecommendationAccountsRequestNextTokenString":{ + "type":"string", + "max":10000, + "min":4 + }, + "ListOrganizationRecommendationAccountsResponse":{ + "type":"structure", + "required":["accountRecommendationLifecycleSummaries"], + "members":{ + "accountRecommendationLifecycleSummaries":{ + "shape":"AccountRecommendationLifecycleSummaryList", + "documentation":"The account recommendations lifecycles that are applicable to the Recommendation
" + }, + "nextToken":{ + "shape":"ListOrganizationRecommendationAccountsResponseNextTokenString", + "documentation":"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.
" + } + } + }, + "ListOrganizationRecommendationAccountsResponseNextTokenString":{ + "type":"string", + "max":10000, + "min":4 + }, + "ListOrganizationRecommendationResourcesRequest":{ + "type":"structure", + "required":["organizationRecommendationIdentifier"], + "members":{ + "affectedAccountId":{ + "shape":"AccountId", + "documentation":"An account affected by this organization recommendation
", + "location":"querystring", + "locationName":"affectedAccountId" + }, + "exclusionStatus":{ + "shape":"ExclusionStatus", + "documentation":"The exclusion status of the resource
", + "location":"querystring", + "locationName":"exclusionStatus" + }, + "maxResults":{ + "shape":"ListOrganizationRecommendationResourcesRequestMaxResultsInteger", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"ListOrganizationRecommendationResourcesRequestNextTokenString", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + }, + "organizationRecommendationIdentifier":{ + "shape":"OrganizationRecommendationIdentifier", + "documentation":"The AWS Organization organization's Recommendation identifier
", + "location":"uri", + "locationName":"organizationRecommendationIdentifier" + }, + "regionCode":{ + "shape":"String", + "documentation":"The AWS Region code of the resource
", + "location":"querystring", + "locationName":"regionCode" + }, + "status":{ + "shape":"ResourceStatus", + "documentation":"The status of the resource
", + "location":"querystring", + "locationName":"status" + } + } + }, + "ListOrganizationRecommendationResourcesRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":200, + "min":1 + }, + "ListOrganizationRecommendationResourcesRequestNextTokenString":{ + "type":"string", + "max":10000, + "min":4 + }, + "ListOrganizationRecommendationResourcesResponse":{ + "type":"structure", + "required":["organizationRecommendationResourceSummaries"], + "members":{ + "nextToken":{ + "shape":"ListOrganizationRecommendationResourcesResponseNextTokenString", + "documentation":"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.
" + }, + "organizationRecommendationResourceSummaries":{ + "shape":"OrganizationRecommendationResourceSummaryList", + "documentation":"A list of Recommendation Resources
" + } + } + }, + "ListOrganizationRecommendationResourcesResponseNextTokenString":{ + "type":"string", + "max":10000, + "min":4 + }, + "ListOrganizationRecommendationsRequest":{ + "type":"structure", + "members":{ + "afterLastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"After the last update of the Recommendation
", + "location":"querystring", + "locationName":"afterLastUpdatedAt" + }, + "awsService":{ + "shape":"RecommendationAwsService", + "documentation":"The aws service associated with the Recommendation
", + "location":"querystring", + "locationName":"awsService" + }, + "beforeLastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"Before the last update of the Recommendation
", + "location":"querystring", + "locationName":"beforeLastUpdatedAt" + }, + "checkIdentifier":{ + "shape":"CheckIdentifier", + "documentation":"The check identifier of the Recommendation
", + "location":"querystring", + "locationName":"checkIdentifier" + }, + "maxResults":{ + "shape":"ListOrganizationRecommendationsRequestMaxResultsInteger", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"ListOrganizationRecommendationsRequestNextTokenString", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + }, + "pillar":{ + "shape":"RecommendationPillar", + "documentation":"The pillar of the Recommendation
", + "location":"querystring", + "locationName":"pillar" + }, + "source":{ + "shape":"RecommendationSource", + "documentation":"The source of the Recommendation
", + "location":"querystring", + "locationName":"source" + }, + "status":{ + "shape":"RecommendationStatus", + "documentation":"The status of the Recommendation
", + "location":"querystring", + "locationName":"status" + }, + "type":{ + "shape":"RecommendationType", + "documentation":"The type of the Recommendation
", + "location":"querystring", + "locationName":"type" + } + } + }, + "ListOrganizationRecommendationsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":200, + "min":1 + }, + "ListOrganizationRecommendationsRequestNextTokenString":{ + "type":"string", + "max":10000, + "min":4 + }, + "ListOrganizationRecommendationsResponse":{ + "type":"structure", + "required":["organizationRecommendationSummaries"], + "members":{ + "nextToken":{ + "shape":"ListOrganizationRecommendationsResponseNextTokenString", + "documentation":"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.
" + }, + "organizationRecommendationSummaries":{ + "shape":"OrganizationRecommendationSummaryList", + "documentation":"The list of Recommendations
" + } + } + }, + "ListOrganizationRecommendationsResponseNextTokenString":{ + "type":"string", + "max":10000, + "min":4 + }, + "ListRecommendationResourcesRequest":{ + "type":"structure", + "required":["recommendationIdentifier"], + "members":{ + "exclusionStatus":{ + "shape":"ExclusionStatus", + "documentation":"The exclusion status of the resource
", + "location":"querystring", + "locationName":"exclusionStatus" + }, + "maxResults":{ + "shape":"ListRecommendationResourcesRequestMaxResultsInteger", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"ListRecommendationResourcesRequestNextTokenString", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + }, + "recommendationIdentifier":{ + "shape":"AccountRecommendationIdentifier", + "documentation":"The Recommendation identifier
", + "location":"uri", + "locationName":"recommendationIdentifier" + }, + "regionCode":{ + "shape":"String", + "documentation":"The AWS Region code of the resource
", + "location":"querystring", + "locationName":"regionCode" + }, + "status":{ + "shape":"ResourceStatus", + "documentation":"The status of the resource
", + "location":"querystring", + "locationName":"status" + } + } + }, + "ListRecommendationResourcesRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":200, + "min":1 + }, + "ListRecommendationResourcesRequestNextTokenString":{ + "type":"string", + "max":10000, + "min":4 + }, + "ListRecommendationResourcesResponse":{ + "type":"structure", + "required":["recommendationResourceSummaries"], + "members":{ + "nextToken":{ + "shape":"ListRecommendationResourcesResponseNextTokenString", + "documentation":"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.
" + }, + "recommendationResourceSummaries":{ + "shape":"RecommendationResourceSummaryList", + "documentation":"A list of Recommendation Resources
" + } + } + }, + "ListRecommendationResourcesResponseNextTokenString":{ + "type":"string", + "max":10000, + "min":4 + }, + "ListRecommendationsRequest":{ + "type":"structure", + "members":{ + "afterLastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"After the last update of the Recommendation
", + "location":"querystring", + "locationName":"afterLastUpdatedAt" + }, + "awsService":{ + "shape":"RecommendationAwsService", + "documentation":"The aws service associated with the Recommendation
", + "location":"querystring", + "locationName":"awsService" + }, + "beforeLastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"Before the last update of the Recommendation
", + "location":"querystring", + "locationName":"beforeLastUpdatedAt" + }, + "checkIdentifier":{ + "shape":"CheckIdentifier", + "documentation":"The check identifier of the Recommendation
", + "location":"querystring", + "locationName":"checkIdentifier" + }, + "maxResults":{ + "shape":"ListRecommendationsRequestMaxResultsInteger", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"ListRecommendationsRequestNextTokenString", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + }, + "pillar":{ + "shape":"RecommendationPillar", + "documentation":"The pillar of the Recommendation
", + "location":"querystring", + "locationName":"pillar" + }, + "source":{ + "shape":"RecommendationSource", + "documentation":"The source of the Recommendation
", + "location":"querystring", + "locationName":"source" + }, + "status":{ + "shape":"RecommendationStatus", + "documentation":"The status of the Recommendation
", + "location":"querystring", + "locationName":"status" + }, + "type":{ + "shape":"RecommendationType", + "documentation":"The type of the Recommendation
", + "location":"querystring", + "locationName":"type" + } + } + }, + "ListRecommendationsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":200, + "min":1 + }, + "ListRecommendationsRequestNextTokenString":{ + "type":"string", + "max":10000, + "min":4 + }, + "ListRecommendationsResponse":{ + "type":"structure", + "required":["recommendationSummaries"], + "members":{ + "nextToken":{ + "shape":"ListRecommendationsResponseNextTokenString", + "documentation":"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.
" + }, + "recommendationSummaries":{ + "shape":"RecommendationSummaryList", + "documentation":"The list of Recommendations
" + } + } + }, + "ListRecommendationsResponseNextTokenString":{ + "type":"string", + "max":10000, + "min":4 + }, + "Long":{ + "type":"long", + "box":true + }, + "OrganizationRecommendation":{ + "type":"structure", + "required":[ + "arn", + "description", + "id", + "name", + "pillars", + "resourcesAggregates", + "source", + "status", + "type" + ], + "members":{ + "arn":{ + "shape":"OrganizationRecommendationArn", + "documentation":"The ARN of the Recommendation
" + }, + "awsServices":{ + "shape":"RecommendationAwsServiceList", + "documentation":"The AWS Services that the Recommendation applies to
" + }, + "checkArn":{ + "shape":"String", + "documentation":"The AWS Trusted Advisor Check ARN that relates to the Recommendation
" + }, + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the Recommendation was created, if created by AWS Trusted Advisor Priority
" + }, + "createdBy":{ + "shape":"String", + "documentation":"The creator, if created by AWS Trusted Advisor Priority
" + }, + "description":{ + "shape":"String", + "documentation":"A description for AWS Trusted Advisor recommendations
" + }, + "id":{ + "shape":"String", + "documentation":"The ID which identifies where the Recommendation was produced
" + }, + "lastUpdatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the Recommendation was last updated
" + }, + "lifecycleStage":{ + "shape":"RecommendationLifecycleStage", + "documentation":"The lifecycle stage from AWS Trusted Advisor Priority
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the AWS Trusted Advisor Recommendation
" + }, + "pillarSpecificAggregates":{ + "shape":"RecommendationPillarSpecificAggregates", + "documentation":"The pillar aggregations for cost savings
" + }, + "pillars":{ + "shape":"RecommendationPillarList", + "documentation":"The Pillars that the Recommendation is optimizing
" + }, + "resolvedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the Recommendation was resolved
" + }, + "resourcesAggregates":{ + "shape":"RecommendationResourcesAggregates", + "documentation":"An aggregation of all resources
" + }, + "source":{ + "shape":"RecommendationSource", + "documentation":"The source of the Recommendation
" + }, + "status":{ + "shape":"RecommendationStatus", + "documentation":"The status of the Recommendation
" + }, + "type":{ + "shape":"RecommendationType", + "documentation":"Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority
" + }, + "updateReason":{ + "shape":"RecommendationUpdateReason", + "documentation":"Reason for the lifecycle stage change
" + }, + "updateReasonCode":{ + "shape":"UpdateRecommendationLifecycleStageReasonCode", + "documentation":"Reason code for the lifecycle state change
" + }, + "updatedOnBehalfOf":{ + "shape":"String", + "documentation":"The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority
" + }, + "updatedOnBehalfOfJobTitle":{ + "shape":"String", + "documentation":"The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority
" + } + }, + "documentation":"A Recommendation for accounts within an Organization
" + }, + "OrganizationRecommendationArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:[\\w-]+:trustedadvisor:::organization-recommendation\\/[\\w-]+$" + }, + "OrganizationRecommendationIdentifier":{ + "type":"string", + "max":200, + "min":20, + "pattern":"^arn:[\\w-]+:trustedadvisor:::organization-recommendation\\/[\\w-]+$" + }, + "OrganizationRecommendationResourceSummary":{ + "type":"structure", + "required":[ + "arn", + "awsResourceId", + "id", + "lastUpdatedAt", + "metadata", + "recommendationArn", + "regionCode", + "status" + ], + "members":{ + "accountId":{ + "shape":"AccountId", + "documentation":"The AWS account ID
" + }, + "arn":{ + "shape":"RecommendationResourceArn", + "documentation":"The ARN of the Recommendation Resource
" + }, + "awsResourceId":{ + "shape":"String", + "documentation":"The AWS resource identifier
" + }, + "exclusionStatus":{ + "shape":"ExclusionStatus", + "documentation":"The exclusion status of the Recommendation Resource
" + }, + "id":{ + "shape":"String", + "documentation":"The ID of the Recommendation Resource
" + }, + "lastUpdatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the Recommendation Resource was last updated
" + }, + "metadata":{ + "shape":"StringMap", + "documentation":"Metadata associated with the Recommendation Resource
" + }, + "recommendationArn":{ + "shape":"OrganizationRecommendationArn", + "documentation":"The Recommendation ARN
" + }, + "regionCode":{ + "shape":"RecommendationRegionCode", + "documentation":"The AWS Region code that the Recommendation Resource is in
" + }, + "status":{ + "shape":"ResourceStatus", + "documentation":"The current status of the Recommendation Resource
" + } + }, + "documentation":"Organization Recommendation Resource Summary
" + }, + "OrganizationRecommendationResourceSummaryList":{ + "type":"list", + "member":{"shape":"OrganizationRecommendationResourceSummary"} + }, + "OrganizationRecommendationSummary":{ + "type":"structure", + "required":[ + "arn", + "id", + "name", + "pillars", + "resourcesAggregates", + "source", + "status", + "type" + ], + "members":{ + "arn":{ + "shape":"OrganizationRecommendationArn", + "documentation":"The ARN of the Recommendation
" + }, + "awsServices":{ + "shape":"RecommendationAwsServiceList", + "documentation":"The AWS Services that the Recommendation applies to
" + }, + "checkArn":{ + "shape":"String", + "documentation":"The AWS Trusted Advisor Check ARN that relates to the Recommendation
" + }, + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the Recommendation was created, if created by AWS Trusted Advisor Priority
" + }, + "id":{ + "shape":"String", + "documentation":"The ID which identifies where the Recommendation was produced
" + }, + "lastUpdatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the Recommendation was last updated
" + }, + "lifecycleStage":{ + "shape":"RecommendationLifecycleStage", + "documentation":"The lifecycle stage from AWS Trusted Advisor Priority
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the AWS Trusted Advisor Recommendation
" + }, + "pillarSpecificAggregates":{ + "shape":"RecommendationPillarSpecificAggregates", + "documentation":"The pillar aggregations for cost savings
" + }, + "pillars":{ + "shape":"RecommendationPillarList", + "documentation":"The Pillars that the Recommendation is optimizing
" + }, + "resourcesAggregates":{ + "shape":"RecommendationResourcesAggregates", + "documentation":"An aggregation of all resources
" + }, + "source":{ + "shape":"RecommendationSource", + "documentation":"The source of the Recommendation
" + }, + "status":{ + "shape":"RecommendationStatus", + "documentation":"The status of the Recommendation
" + }, + "type":{ + "shape":"RecommendationType", + "documentation":"Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority
" + } + }, + "documentation":"Summary of recommendation for accounts within an Organization
" + }, + "OrganizationRecommendationSummaryList":{ + "type":"list", + "member":{"shape":"OrganizationRecommendationSummary"} + }, + "Recommendation":{ + "type":"structure", + "required":[ + "arn", + "description", + "id", + "name", + "pillars", + "resourcesAggregates", + "source", + "status", + "type" + ], + "members":{ + "arn":{ + "shape":"AccountRecommendationArn", + "documentation":"The ARN of the Recommendation
" + }, + "awsServices":{ + "shape":"RecommendationAwsServiceList", + "documentation":"The AWS Services that the Recommendation applies to
" + }, + "checkArn":{ + "shape":"String", + "documentation":"The AWS Trusted Advisor Check ARN that relates to the Recommendation
" + }, + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the Recommendation was created, if created by AWS Trusted Advisor Priority
" + }, + "createdBy":{ + "shape":"String", + "documentation":"The creator, if created by AWS Trusted Advisor Priority
" + }, + "description":{ + "shape":"String", + "documentation":"A description for AWS Trusted Advisor recommendations
" + }, + "id":{ + "shape":"String", + "documentation":"The ID which identifies where the Recommendation was produced
" + }, + "lastUpdatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the Recommendation was last updated
" + }, + "lifecycleStage":{ + "shape":"RecommendationLifecycleStage", + "documentation":"The lifecycle stage from AWS Trusted Advisor Priority
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the AWS Trusted Advisor Recommendation
" + }, + "pillarSpecificAggregates":{ + "shape":"RecommendationPillarSpecificAggregates", + "documentation":"The pillar aggregations for cost savings
" + }, + "pillars":{ + "shape":"RecommendationPillarList", + "documentation":"The Pillars that the Recommendation is optimizing
" + }, + "resolvedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the Recommendation was resolved
" + }, + "resourcesAggregates":{ + "shape":"RecommendationResourcesAggregates", + "documentation":"An aggregation of all resources
" + }, + "source":{ + "shape":"RecommendationSource", + "documentation":"The source of the Recommendation
" + }, + "status":{ + "shape":"RecommendationStatus", + "documentation":"The status of the Recommendation
" + }, + "type":{ + "shape":"RecommendationType", + "documentation":"Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority
" + }, + "updateReason":{ + "shape":"RecommendationUpdateReason", + "documentation":"Reason for the lifecycle stage change
" + }, + "updateReasonCode":{ + "shape":"UpdateRecommendationLifecycleStageReasonCode", + "documentation":"Reason code for the lifecycle state change
" + }, + "updatedOnBehalfOf":{ + "shape":"String", + "documentation":"The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority
" + }, + "updatedOnBehalfOfJobTitle":{ + "shape":"String", + "documentation":"The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority
" + } + }, + "documentation":"A Recommendation for an Account
" + }, + "RecommendationAwsService":{ + "type":"string", + "max":30, + "min":2 + }, + "RecommendationAwsServiceList":{ + "type":"list", + "member":{"shape":"RecommendationAwsService"} + }, + "RecommendationCostOptimizingAggregates":{ + "type":"structure", + "required":[ + "estimatedMonthlySavings", + "estimatedPercentMonthlySavings" + ], + "members":{ + "estimatedMonthlySavings":{ + "shape":"Double", + "documentation":"The estimated monthly savings
" + }, + "estimatedPercentMonthlySavings":{ + "shape":"Double", + "documentation":"The estimated percently monthly savings
" + } + }, + "documentation":"Cost optimizing aggregates for a Recommendation
" + }, + "RecommendationLanguage":{ + "type":"string", + "enum":[ + "en", + "ja", + "zh", + "fr", + "de", + "ko", + "zh_TW", + "it", + "es", + "pt_BR", + "id" + ] + }, + "RecommendationLifecycleStage":{ + "type":"string", + "enum":[ + "in_progress", + "pending_response", + "dismissed", + "resolved" + ] + }, + "RecommendationPillar":{ + "type":"string", + "enum":[ + "cost_optimizing", + "performance", + "security", + "service_limits", + "fault_tolerance", + "operational_excellence" + ] + }, + "RecommendationPillarList":{ + "type":"list", + "member":{"shape":"RecommendationPillar"} + }, + "RecommendationPillarSpecificAggregates":{ + "type":"structure", + "members":{ + "costOptimizing":{ + "shape":"RecommendationCostOptimizingAggregates", + "documentation":"Cost optimizing aggregates
" + } + }, + "documentation":"Recommendation pillar aggregates
" + }, + "RecommendationRegionCode":{ + "type":"string", + "max":20, + "min":9 + }, + "RecommendationResourceArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:[\\w-]+:trustedadvisor::\\d{12}:recommendation-resource\\/[\\w-]+\\/[\\w-]+$" + }, + "RecommendationResourceExclusion":{ + "type":"structure", + "required":[ + "arn", + "isExcluded" + ], + "members":{ + "arn":{ + "shape":"RecommendationResourceArn", + "documentation":"The ARN of the Recommendation Resource
" + }, + "isExcluded":{ + "shape":"Boolean", + "documentation":"The exclusion status
" + } + }, + "documentation":"The request entry for Recommendation Resource exclusion. Each entry is a combination of Recommendation Resource ARN and corresponding exclusion status
" + }, + "RecommendationResourceExclusionList":{ + "type":"list", + "member":{"shape":"RecommendationResourceExclusion"}, + "max":100, + "min":1 + }, + "RecommendationResourceSummary":{ + "type":"structure", + "required":[ + "arn", + "awsResourceId", + "id", + "lastUpdatedAt", + "metadata", + "recommendationArn", + "regionCode", + "status" + ], + "members":{ + "arn":{ + "shape":"RecommendationResourceArn", + "documentation":"The ARN of the Recommendation Resource
" + }, + "awsResourceId":{ + "shape":"String", + "documentation":"The AWS resource identifier
" + }, + "exclusionStatus":{ + "shape":"ExclusionStatus", + "documentation":"The exclusion status of the Recommendation Resource
" + }, + "id":{ + "shape":"String", + "documentation":"The ID of the Recommendation Resource
" + }, + "lastUpdatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the Recommendation Resource was last updated
" + }, + "metadata":{ + "shape":"StringMap", + "documentation":"Metadata associated with the Recommendation Resource
" + }, + "recommendationArn":{ + "shape":"AccountRecommendationArn", + "documentation":"The Recommendation ARN
" + }, + "regionCode":{ + "shape":"RecommendationRegionCode", + "documentation":"The AWS Region code that the Recommendation Resource is in
" + }, + "status":{ + "shape":"ResourceStatus", + "documentation":"The current status of the Recommendation Resource
" + } + }, + "documentation":"Summary of a Recommendation Resource
" + }, + "RecommendationResourceSummaryList":{ + "type":"list", + "member":{"shape":"RecommendationResourceSummary"} + }, + "RecommendationResourcesAggregates":{ + "type":"structure", + "required":[ + "errorCount", + "okCount", + "warningCount" + ], + "members":{ + "errorCount":{ + "shape":"Long", + "documentation":"The number of AWS resources that were flagged to have errors according to the Trusted Advisor check
" + }, + "okCount":{ + "shape":"Long", + "documentation":"The number of AWS resources that were flagged to be OK according to the Trusted Advisor check
" + }, + "warningCount":{ + "shape":"Long", + "documentation":"The number of AWS resources that were flagged to have warning according to the Trusted Advisor check
" + } + }, + "documentation":"Aggregation of Recommendation Resources
" + }, + "RecommendationSource":{ + "type":"string", + "enum":[ + "aws_config", + "compute_optimizer", + "cost_explorer", + "lse", + "manual", + "pse", + "rds", + "resilience", + "resilience_hub", + "security_hub", + "stir", + "ta_check", + "well_architected" + ] + }, + "RecommendationStatus":{ + "type":"string", + "enum":[ + "ok", + "warning", + "error" + ] + }, + "RecommendationSummary":{ + "type":"structure", + "required":[ + "arn", + "id", + "name", + "pillars", + "resourcesAggregates", + "source", + "status", + "type" + ], + "members":{ + "arn":{ + "shape":"AccountRecommendationArn", + "documentation":"The ARN of the Recommendation
" + }, + "awsServices":{ + "shape":"RecommendationAwsServiceList", + "documentation":"The AWS Services that the Recommendation applies to
" + }, + "checkArn":{ + "shape":"String", + "documentation":"The AWS Trusted Advisor Check ARN that relates to the Recommendation
" + }, + "createdAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the Recommendation was created, if created by AWS Trusted Advisor Priority
" + }, + "id":{ + "shape":"String", + "documentation":"The ID which identifies where the Recommendation was produced
" + }, + "lastUpdatedAt":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"When the Recommendation was last updated
" + }, + "lifecycleStage":{ + "shape":"RecommendationLifecycleStage", + "documentation":"The lifecycle stage from AWS Trusted Advisor Priority
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the AWS Trusted Advisor Recommendation
" + }, + "pillarSpecificAggregates":{ + "shape":"RecommendationPillarSpecificAggregates", + "documentation":"The pillar aggregations for cost savings
" + }, + "pillars":{ + "shape":"RecommendationPillarList", + "documentation":"The Pillars that the Recommendation is optimizing
" + }, + "resourcesAggregates":{ + "shape":"RecommendationResourcesAggregates", + "documentation":"An aggregation of all resources
" + }, + "source":{ + "shape":"RecommendationSource", + "documentation":"The source of the Recommendation
" + }, + "status":{ + "shape":"RecommendationStatus", + "documentation":"The status of the Recommendation
" + }, + "type":{ + "shape":"RecommendationType", + "documentation":"Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority
" + } + }, + "documentation":"Summary of Recommendation for an Account
" + }, + "RecommendationSummaryList":{ + "type":"list", + "member":{"shape":"RecommendationSummary"} + }, + "RecommendationType":{ + "type":"string", + "enum":[ + "standard", + "priority" + ] + }, + "RecommendationUpdateReason":{ + "type":"string", + "max":4096, + "min":10, + "pattern":"^[\\s\\S]*$", + "sensitive":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Exception that the requested resource has not been found
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceStatus":{ + "type":"string", + "enum":[ + "ok", + "warning", + "error" + ] + }, + "String":{"type":"string"}, + "StringMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "SyntheticTimestamp_date_time":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Exception to notify that requests are being throttled
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":true} + }, + "Timestamp":{"type":"timestamp"}, + "UpdateOrganizationRecommendationLifecycleRequest":{ + "type":"structure", + "required":[ + "lifecycleStage", + "organizationRecommendationIdentifier" + ], + "members":{ + "lifecycleStage":{ + "shape":"UpdateRecommendationLifecycleStage", + "documentation":"The new lifecycle stage
" + }, + "organizationRecommendationIdentifier":{ + "shape":"OrganizationRecommendationIdentifier", + "documentation":"The Recommendation identifier for AWS Trusted Advisor Priority recommendations
", + "location":"uri", + "locationName":"organizationRecommendationIdentifier" + }, + "updateReason":{ + "shape":"RecommendationUpdateReason", + "documentation":"Reason for the lifecycle stage change
" + }, + "updateReasonCode":{ + "shape":"UpdateRecommendationLifecycleStageReasonCode", + "documentation":"Reason code for the lifecycle state change
" + } + } + }, + "UpdateRecommendationLifecycleRequest":{ + "type":"structure", + "required":[ + "lifecycleStage", + "recommendationIdentifier" + ], + "members":{ + "lifecycleStage":{ + "shape":"UpdateRecommendationLifecycleStage", + "documentation":"The new lifecycle stage
" + }, + "recommendationIdentifier":{ + "shape":"AccountRecommendationIdentifier", + "documentation":"The Recommendation identifier for AWS Trusted Advisor Priority recommendations
", + "location":"uri", + "locationName":"recommendationIdentifier" + }, + "updateReason":{ + "shape":"RecommendationUpdateReason", + "documentation":"Reason for the lifecycle stage change
" + }, + "updateReasonCode":{ + "shape":"UpdateRecommendationLifecycleStageReasonCode", + "documentation":"Reason code for the lifecycle state change
" + } + } + }, + "UpdateRecommendationLifecycleStage":{ + "type":"string", + "enum":[ + "pending_response", + "in_progress", + "dismissed", + "resolved" + ] + }, + "UpdateRecommendationLifecycleStageReasonCode":{ + "type":"string", + "enum":[ + "non_critical_account", + "temporary_account", + "valid_business_case", + "other_methods_available", + "low_priority", + "not_applicable", + "other" + ] + }, + "UpdateRecommendationResourceExclusionError":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"RecommendationResourceArn", + "documentation":"The ARN of the Recommendation Resource
" + }, + "errorCode":{ + "shape":"String", + "documentation":"The error code
" + }, + "errorMessage":{ + "shape":"String", + "documentation":"The error message
" + } + }, + "documentation":"The error entry for Recommendation Resource exclusion. Each entry is a combination of Recommendation Resource ARN, error code and error message
" + }, + "UpdateRecommendationResourceExclusionErrorList":{ + "type":"list", + "member":{"shape":"UpdateRecommendationResourceExclusionError"} + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"Exception that the request failed to satisfy service constraints
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + }, + "documentation":"TrustedAdvisor Public API
" +} diff --git a/testbed/boto__botocore/botocore/data/waf-regional/2016-11-28/examples-1.json b/testbed/boto__botocore/botocore/data/waf-regional/2016-11-28/examples-1.json new file mode 100644 index 0000000000000000000000000000000000000000..eee5b6f4ff135a62424ba859ca701638529008a1 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/waf-regional/2016-11-28/examples-1.json @@ -0,0 +1,1017 @@ +{ + "version": "1.0", + "examples": { + "CreateIPSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MyIPSetFriendlyName" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "IPSet": { + "IPSetDescriptors": [ + { + "Type": "IPV4", + "Value": "192.0.2.44/32" + } + ], + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Name": "MyIPSetFriendlyName" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an IP match set named MyIPSetFriendlyName.", + "id": "createipset-1472501003122", + "title": "To create an IP set" + } + ], + "CreateRule": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "MetricName": "WAFByteHeaderRule", + "Name": "WAFByteHeaderRule" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Rule": { + "MetricName": "WAFByteHeaderRule", + "Name": "WAFByteHeaderRule", + "Predicates": [ + { + "DataId": "MyByteMatchSetID", + "Negated": false, + "Type": "ByteMatch" + } + ], + "RuleId": "WAFRule-1-Example" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a rule named WAFByteHeaderRule.", + "id": "createrule-1474072675555", + "title": "To create a rule" + } + ], + "CreateSizeConstraintSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MySampleSizeConstraintSet" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SizeConstraintSet": { + "Name": "MySampleSizeConstraintSet", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SizeConstraints": [ + { + "ComparisonOperator": "GT", + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "Size": 0, + "TextTransformation": "NONE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates size constraint set named MySampleSizeConstraintSet.", + "id": "createsizeconstraint-1474299140754", + "title": "To create a size constraint" + } + ], + "CreateSqlInjectionMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MySQLInjectionMatchSet" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SqlInjectionMatchSet": { + "Name": "MySQLInjectionMatchSet", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SqlInjectionMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a SQL injection match set named MySQLInjectionMatchSet.", + "id": "createsqlinjectionmatchset-1474492796105", + "title": "To create a SQL injection match set" + } + ], + "CreateWebACL": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "DefaultAction": { + "Type": "ALLOW" + }, + "MetricName": "CreateExample", + "Name": "CreateExample" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "WebACL": { + "DefaultAction": { + "Type": "ALLOW" + }, + "MetricName": "CreateExample", + "Name": "CreateExample", + "Rules": [ + { + "Action": { + "Type": "ALLOW" + }, + "Priority": 1, + "RuleId": "WAFRule-1-Example" + } + ], + "WebACLId": "example-46da-4444-5555-example" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a web ACL named CreateExample.", + "id": "createwebacl-1472061481310", + "title": "To create a web ACL" + } + ], + "CreateXssMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MySampleXssMatchSet" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "XssMatchSet": { + "Name": "MySampleXssMatchSet", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "XssMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an XSS match set named MySampleXssMatchSet.", + "id": "createxssmatchset-1474560868500", + "title": "To create an XSS match set" + } + ], + "DeleteByteMatchSet": [ + { + "input": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletebytematchset-1473367566229", + "title": "To delete a byte match set" + } + ], + "DeleteIPSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deleteipset-1472767434306", + "title": "To delete an IP set" + } + ], + "DeleteRule": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "RuleId": "WAFRule-1-Example" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a rule with the ID WAFRule-1-Example.", + "id": "deleterule-1474073108749", + "title": "To delete a rule" + } + ], + "DeleteSizeConstraintSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletesizeconstraintset-1474299857905", + "title": "To delete a size constraint set" + } + ], + "DeleteSqlInjectionMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletesqlinjectionmatchset-1474493373197", + "title": "To delete a SQL injection match set" + } + ], + "DeleteWebACL": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "WebACLId": "example-46da-4444-5555-example" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a web ACL with the ID example-46da-4444-5555-example.", + "id": "deletewebacl-1472767755931", + "title": "To delete a web ACL" + } + ], + "DeleteXssMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletexssmatchset-1474561302618", + "title": "To delete an XSS match set" + } + ], + "GetByteMatchSet": [ + { + "input": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ByteMatchSet": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", + "ByteMatchTuples": [ + { + "FieldToMatch": { + "Data": "referer", + "Type": "HEADER" + }, + "PositionalConstraint": "CONTAINS", + "TargetString": "badrefer1", + "TextTransformation": "NONE" + } + ], + "Name": "ByteMatchNameExample" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getbytematchset-1473273311532", + "title": "To get a byte match set" + } + ], + "GetChangeToken": [ + { + "input": { + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns a change token to use for a create, update or delete operation.", + "id": "get-change-token-example-1471635120794", + "title": "To get a change token" + } + ], + "GetChangeTokenStatus": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "output": { + "ChangeTokenStatus": "PENDING" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the status of a change token with the ID abcd12f2-46da-4fdb-b8d5-fbd4c466928f.", + "id": "getchangetokenstatus-1474658417107", + "title": "To get the change token status" + } + ], + "GetIPSet": [ + { + "input": { + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "IPSet": { + "IPSetDescriptors": [ + { + "Type": "IPV4", + "Value": "192.0.2.44/32" + } + ], + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Name": "MyIPSetFriendlyName" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getipset-1474658688675", + "title": "To get an IP set" + } + ], + "GetRule": [ + { + "input": { + "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "Rule": { + "MetricName": "WAFByteHeaderRule", + "Name": "WAFByteHeaderRule", + "Predicates": [ + { + "DataId": "MyByteMatchSetID", + "Negated": false, + "Type": "ByteMatch" + } + ], + "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getrule-1474659238790", + "title": "To get a rule" + } + ], + "GetSampledRequests": [ + { + "input": { + "MaxItems": 100, + "RuleId": "WAFRule-1-Example", + "TimeWindow": { + "EndTime": "2016-09-27T15:50Z", + "StartTime": "2016-09-27T15:50Z" + }, + "WebAclId": "createwebacl-1472061481310" + }, + "output": { + "PopulationSize": 50, + "SampledRequests": [ + { + "Action": "BLOCK", + "Request": { + "ClientIP": "192.0.2.44", + "Country": "US", + "HTTPVersion": "HTTP/1.1", + "Headers": [ + { + "Name": "User-Agent", + "Value": "BadBot " + } + ], + "Method": "HEAD" + }, + "Timestamp": "2016-09-27T14:55Z", + "Weight": 1 + } + ], + "TimeWindow": { + "EndTime": "2016-09-27T15:50Z", + "StartTime": "2016-09-27T14:50Z" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns detailed information about 100 requests --a sample-- that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received between the time period 2016-09-27T15:50Z to 2016-09-27T15:50Z.", + "id": "getsampledrequests-1474927997195", + "title": "To get a sampled requests" + } + ], + "GetSizeConstraintSet": [ + { + "input": { + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "SizeConstraintSet": { + "Name": "MySampleSizeConstraintSet", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SizeConstraints": [ + { + "ComparisonOperator": "GT", + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "Size": 0, + "TextTransformation": "NONE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a size constraint match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getsizeconstraintset-1475005422493", + "title": "To get a size constraint set" + } + ], + "GetSqlInjectionMatchSet": [ + { + "input": { + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "SqlInjectionMatchSet": { + "Name": "MySQLInjectionMatchSet", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SqlInjectionMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getsqlinjectionmatchset-1475005940137", + "title": "To get a SQL injection match set" + } + ], + "GetWebACL": [ + { + "input": { + "WebACLId": "createwebacl-1472061481310" + }, + "output": { + "WebACL": { + "DefaultAction": { + "Type": "ALLOW" + }, + "MetricName": "CreateExample", + "Name": "CreateExample", + "Rules": [ + { + "Action": { + "Type": "ALLOW" + }, + "Priority": 1, + "RuleId": "WAFRule-1-Example" + } + ], + "WebACLId": "createwebacl-1472061481310" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a web ACL with the ID createwebacl-1472061481310.", + "id": "getwebacl-1475006348525", + "title": "To get a web ACL" + } + ], + "GetXssMatchSet": [ + { + "input": { + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "XssMatchSet": { + "Name": "MySampleXssMatchSet", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "XssMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getxssmatchset-1475187879017", + "title": "To get an XSS match set" + } + ], + "ListIPSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "IPSets": [ + { + "IPSetId": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MyIPSetFriendlyName" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 IP match sets.", + "id": "listipsets-1472235676229", + "title": "To list IP sets" + } + ], + "ListRules": [ + { + "input": { + "Limit": 100 + }, + "output": { + "Rules": [ + { + "Name": "WAFByteHeaderRule", + "RuleId": "WAFRule-1-Example" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 rules.", + "id": "listrules-1475258406433", + "title": "To list rules" + } + ], + "ListSizeConstraintSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "SizeConstraintSets": [ + { + "Name": "MySampleSizeConstraintSet", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 size contraint match sets.", + "id": "listsizeconstraintsets-1474300067597", + "title": "To list a size constraint sets" + } + ], + "ListSqlInjectionMatchSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "SqlInjectionMatchSets": [ + { + "Name": "MySQLInjectionMatchSet", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 SQL injection match sets.", + "id": "listsqlinjectionmatchset-1474493560103", + "title": "To list SQL injection match sets" + } + ], + "ListWebACLs": [ + { + "input": { + "Limit": 100 + }, + "output": { + "WebACLs": [ + { + "Name": "WebACLexample", + "WebACLId": "webacl-1472061481310" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 web ACLs.", + "id": "listwebacls-1475258732691", + "title": "To list Web ACLs" + } + ], + "ListXssMatchSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "XssMatchSets": [ + { + "Name": "MySampleXssMatchSet", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 XSS match sets.", + "id": "listxssmatchsets-1474561481168", + "title": "To list XSS match sets" + } + ], + "UpdateByteMatchSet": [ + { + "input": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Updates": [ + { + "Action": "DELETE", + "ByteMatchTuple": { + "FieldToMatch": { + "Data": "referer", + "Type": "HEADER" + }, + "PositionalConstraint": "CONTAINS", + "TargetString": "badrefer1", + "TextTransformation": "NONE" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a ByteMatchTuple object (filters) in an byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatebytematchset-1475259074558", + "title": "To update a byte match set" + } + ], + "UpdateIPSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "IPSetDescriptor": { + "Type": "IPV4", + "Value": "192.0.2.44/32" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an IPSetDescriptor object in an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updateipset-1475259733625", + "title": "To update an IP set" + } + ], + "UpdateRule": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "Predicate": { + "DataId": "MyByteMatchSetID", + "Negated": false, + "Type": "ByteMatch" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a Predicate object in a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updaterule-1475260064720", + "title": "To update a rule" + } + ], + "UpdateSizeConstraintSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "SizeConstraint": { + "ComparisonOperator": "GT", + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "Size": 0, + "TextTransformation": "NONE" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a SizeConstraint object (filters) in a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatesizeconstraintset-1475531697891", + "title": "To update a size constraint set" + } + ], + "UpdateSqlInjectionMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "SqlInjectionMatchTuple": { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a SqlInjectionMatchTuple object (filters) in a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatesqlinjectionmatchset-1475532094686", + "title": "To update a SQL injection match set" + } + ], + "UpdateWebACL": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "DefaultAction": { + "Type": "ALLOW" + }, + "Updates": [ + { + "Action": "DELETE", + "ActivatedRule": { + "Action": { + "Type": "ALLOW" + }, + "Priority": 1, + "RuleId": "WAFRule-1-Example" + } + } + ], + "WebACLId": "webacl-1472061481310" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an ActivatedRule object in a WebACL with the ID webacl-1472061481310.", + "id": "updatewebacl-1475533627385", + "title": "To update a Web ACL" + } + ], + "UpdateXssMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Updates": [ + { + "Action": "DELETE", + "XssMatchTuple": { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + } + ], + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an XssMatchTuple object (filters) in an XssMatchSet with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatexssmatchset-1475534098881", + "title": "To update an XSS match set" + } + ] + } +} diff --git a/testbed/boto__botocore/botocore/data/wafv2/2019-07-29/examples-1.json b/testbed/boto__botocore/botocore/data/wafv2/2019-07-29/examples-1.json new file mode 100644 index 0000000000000000000000000000000000000000..0ea7e3b0bbe917eb027880396ac01509becd1fa0 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/wafv2/2019-07-29/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/testbed/boto__botocore/botocore/data/wafv2/2019-07-29/service-2.json b/testbed/boto__botocore/botocore/data/wafv2/2019-07-29/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..3d705697c163a7f65398b60e352e7ebeff0a0089 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/wafv2/2019-07-29/service-2.json @@ -0,0 +1,6539 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2019-07-29", + "endpointPrefix":"wafv2", + "jsonVersion":"1.1", + "protocol":"json", + "protocols":["json"], + "serviceAbbreviation":"WAFV2", + "serviceFullName":"AWS WAFV2", + "serviceId":"WAFV2", + "signatureVersion":"v4", + "targetPrefix":"AWSWAF_20190729", + "uid":"wafv2-2019-07-29", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "AssociateWebACL":{ + "name":"AssociateWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateWebACLRequest"}, + "output":{"shape":"AssociateWebACLResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFUnavailableEntityException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution in the Amazon CloudFront Developer Guide.
Required permissions for customer-managed IAM policies
This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the WAF Developer Guide.
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.
Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
" + }, + "CreateAPIKey":{ + "name":"CreateAPIKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAPIKeyRequest"}, + "output":{"shape":"CreateAPIKeyResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"Creates an API key that contains a set of token domains.
API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.
You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration.
" + }, + "CreateIPSet":{ + "name":"CreateIPSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateIPSetRequest"}, + "output":{"shape":"CreateIPSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFDuplicateItemException"}, + {"shape":"WAFOptimisticLockException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.
" + }, + "CreateRegexPatternSet":{ + "name":"CreateRegexPatternSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRegexPatternSetRequest"}, + "output":{"shape":"CreateRegexPatternSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFDuplicateItemException"}, + {"shape":"WAFOptimisticLockException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.
" + }, + "CreateRuleGroup":{ + "name":"CreateRuleGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRuleGroupRequest"}, + "output":{"shape":"CreateRuleGroupResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFDuplicateItemException"}, + {"shape":"WAFOptimisticLockException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFUnavailableEntityException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFSubscriptionNotFoundException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Creates a RuleGroup per the specifications provided.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
" + }, + "CreateWebACL":{ + "name":"CreateWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWebACLRequest"}, + "output":{"shape":"CreateWebACLResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFDuplicateItemException"}, + {"shape":"WAFOptimisticLockException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFInvalidResourceException"}, + {"shape":"WAFUnavailableEntityException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFSubscriptionNotFoundException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFConfigurationWarningException"}, + {"shape":"WAFExpiredManagedRuleGroupVersionException"} + ], + "documentation":"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 resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
" + }, + "DeleteAPIKey":{ + "name":"DeleteAPIKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAPIKeyRequest"}, + "output":{"shape":"DeleteAPIKeyResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFOptimisticLockException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Deletes the specified API key.
After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions.
" + }, + "DeleteFirewallManagerRuleGroups":{ + "name":"DeleteFirewallManagerRuleGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFirewallManagerRuleGroupsRequest"}, + "output":{"shape":"DeleteFirewallManagerRuleGroupsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFOptimisticLockException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.
You can only use this if ManagedByFirewallManager is false in the specified WebACL.
Deletes the specified IPSet.
" + }, + "DeleteLoggingConfiguration":{ + "name":"DeleteLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLoggingConfigurationRequest"}, + "output":{"shape":"DeleteLoggingConfigurationResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFOptimisticLockException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Deletes the LoggingConfiguration from the specified web ACL.
" + }, + "DeletePermissionPolicy":{ + "name":"DeletePermissionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePermissionPolicyRequest"}, + "output":{"shape":"DeletePermissionPolicyResponse"}, + "errors":[ + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"} + ], + "documentation":"Permanently deletes an IAM policy from the specified rule group.
You must be the owner of the rule group to perform this operation.
" + }, + "DeleteRegexPatternSet":{ + "name":"DeleteRegexPatternSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRegexPatternSetRequest"}, + "output":{"shape":"DeleteRegexPatternSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFOptimisticLockException"}, + {"shape":"WAFAssociatedItemException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Deletes the specified RegexPatternSet.
" + }, + "DeleteRuleGroup":{ + "name":"DeleteRuleGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRuleGroupRequest"}, + "output":{"shape":"DeleteRuleGroupResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFOptimisticLockException"}, + {"shape":"WAFAssociatedItemException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Deletes the specified RuleGroup.
" + }, + "DeleteWebACL":{ + "name":"DeleteWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWebACLRequest"}, + "output":{"shape":"DeleteWebACLResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFOptimisticLockException"}, + {"shape":"WAFAssociatedItemException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Deletes the specified WebACL.
You can only use this if ManagedByFirewallManager is false in the specified WebACL.
Before deleting any web ACL, first disassociate it from all resources.
To retrieve a list of the resources that are associated with a web ACL, use the following calls:
For regional resources, call ListResourcesForWebACL.
For Amazon CloudFront distributions, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference.
To disassociate a resource from a web ACL, use the following calls:
For regional resources, call DisassociateWebACL.
For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.
Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.
" + }, + "DescribeManagedProductsByVendor":{ + "name":"DescribeManagedProductsByVendor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeManagedProductsByVendorRequest"}, + "output":{"shape":"DescribeManagedProductsByVendorResponse"}, + "errors":[ + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"} + ], + "documentation":"Provides high-level information for the managed rule groups owned by a specific vendor.
" + }, + "DescribeManagedRuleGroup":{ + "name":"DescribeManagedRuleGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeManagedRuleGroupRequest"}, + "output":{"shape":"DescribeManagedRuleGroupResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidResourceException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFExpiredManagedRuleGroupVersionException"} + ], + "documentation":"Provides high-level information for a managed rule group, including descriptions of the rules.
" + }, + "DisassociateWebACL":{ + "name":"DisassociateWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateWebACLRequest"}, + "output":{"shape":"DisassociateWebACLResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.
Required permissions for customer-managed IAM policies
This call requires permissions that are specific to the protected resource type. For details, see Permissions for DisassociateWebACL in the WAF Developer Guide.
" + }, + "GenerateMobileSdkReleaseUrl":{ + "name":"GenerateMobileSdkReleaseUrl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GenerateMobileSdkReleaseUrlRequest"}, + "output":{"shape":"GenerateMobileSdkReleaseUrlResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Generates a presigned download URL for the specified release of the mobile SDK.
The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.
" + }, + "GetDecryptedAPIKey":{ + "name":"GetDecryptedAPIKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDecryptedAPIKeyRequest"}, + "output":{"shape":"GetDecryptedAPIKeyResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidResourceException"} + ], + "documentation":"Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.
API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.
" + }, + "GetIPSet":{ + "name":"GetIPSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIPSetRequest"}, + "output":{"shape":"GetIPSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Retrieves the specified IPSet.
" + }, + "GetLoggingConfiguration":{ + "name":"GetLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLoggingConfigurationRequest"}, + "output":{"shape":"GetLoggingConfigurationResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Returns the LoggingConfiguration for the specified web ACL.
" + }, + "GetManagedRuleSet":{ + "name":"GetManagedRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetManagedRuleSetRequest"}, + "output":{"shape":"GetManagedRuleSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Retrieves the specified managed rule set.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
Retrieves information for the specified mobile SDK release, including release notes and tags.
The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.
" + }, + "GetPermissionPolicy":{ + "name":"GetPermissionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPermissionPolicyRequest"}, + "output":{"shape":"GetPermissionPolicyResponse"}, + "errors":[ + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"} + ], + "documentation":"Returns the IAM policy that is attached to the specified rule group.
You must be the owner of the rule group to perform this operation.
" + }, + "GetRateBasedStatementManagedKeys":{ + "name":"GetRateBasedStatementManagedKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRateBasedStatementManagedKeysRequest"}, + "output":{"shape":"GetRateBasedStatementManagedKeysResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFUnsupportedAggregateKeyTypeException"} + ], + "documentation":"Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address.
The maximum number of addresses that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.
For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name.
WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.
" + }, + "GetRegexPatternSet":{ + "name":"GetRegexPatternSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRegexPatternSetRequest"}, + "output":{"shape":"GetRegexPatternSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Retrieves the specified RegexPatternSet.
" + }, + "GetRuleGroup":{ + "name":"GetRuleGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRuleGroupRequest"}, + "output":{"shape":"GetRuleGroupResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Retrieves the specified RuleGroup.
" + }, + "GetSampledRequests":{ + "name":"GetSampledRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSampledRequestsRequest"}, + "output":{"shape":"GetSampledRequestsResponse"}, + "errors":[ + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"} + ], + "documentation":"Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.
GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which WAF selected the requests in the sample.
Retrieves the specified WebACL.
" + }, + "GetWebACLForResource":{ + "name":"GetWebACLForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetWebACLForResourceRequest"}, + "output":{"shape":"GetWebACLForResourceResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFUnavailableEntityException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Retrieves the WebACL for the specified resource.
This call uses GetWebACL, to verify that your account has permission to access the retrieved web ACL. If you get an error that indicates that your account isn't authorized to perform wafv2:GetWebACL on the resource, that error won't be included in your CloudTrail event history.
For Amazon CloudFront, don't use this call. Instead, call the CloudFront action GetDistributionConfig. For information, see GetDistributionConfig in the Amazon CloudFront API Reference.
Required permissions for customer-managed IAM policies
This call requires permissions that are specific to the protected resource type. For details, see Permissions for GetWebACLForResource in the WAF Developer Guide.
" + }, + "ListAPIKeys":{ + "name":"ListAPIKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAPIKeysRequest"}, + "output":{"shape":"ListAPIKeysResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidResourceException"} + ], + "documentation":"Retrieves a list of the API keys that you've defined for the specified scope.
API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.
" + }, + "ListAvailableManagedRuleGroupVersions":{ + "name":"ListAvailableManagedRuleGroupVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAvailableManagedRuleGroupVersionsRequest"}, + "output":{"shape":"ListAvailableManagedRuleGroupVersionsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Returns a list of the available versions for the specified managed rule group.
" + }, + "ListAvailableManagedRuleGroups":{ + "name":"ListAvailableManagedRuleGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAvailableManagedRuleGroupsRequest"}, + "output":{"shape":"ListAvailableManagedRuleGroupsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to.
" + }, + "ListIPSets":{ + "name":"ListIPSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListIPSetsRequest"}, + "output":{"shape":"ListIPSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Retrieves an array of IPSetSummary objects for the IP sets that you manage.
" + }, + "ListLoggingConfigurations":{ + "name":"ListLoggingConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLoggingConfigurationsRequest"}, + "output":{"shape":"ListLoggingConfigurationsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Retrieves an array of your LoggingConfiguration objects.
" + }, + "ListManagedRuleSets":{ + "name":"ListManagedRuleSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListManagedRuleSetsRequest"}, + "output":{"shape":"ListManagedRuleSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Retrieves the managed rule sets that you own.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
Retrieves a list of the available releases for the mobile SDK and the specified device platform.
The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.
" + }, + "ListRegexPatternSets":{ + "name":"ListRegexPatternSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRegexPatternSetsRequest"}, + "output":{"shape":"ListRegexPatternSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
" + }, + "ListResourcesForWebACL":{ + "name":"ListResourcesForWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourcesForWebACLRequest"}, + "output":{"shape":"ListResourcesForWebACLResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL.
For Amazon CloudFront, don't use this call. Instead, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference.
Required permissions for customer-managed IAM policies
This call requires permissions that are specific to the protected resource type. For details, see Permissions for ListResourcesForWebACL in the WAF Developer Guide.
" + }, + "ListRuleGroups":{ + "name":"ListRuleGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRuleGroupsRequest"}, + "output":{"shape":"ListRuleGroupsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
" + }, + "ListWebACLs":{ + "name":"ListWebACLs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWebACLsRequest"}, + "output":{"shape":"ListWebACLsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
" + }, + "PutLoggingConfiguration":{ + "name":"PutLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutLoggingConfigurationRequest"}, + "output":{"shape":"PutLoggingConfigurationResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFOptimisticLockException"}, + {"shape":"WAFServiceLinkedRoleErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFLogDestinationPermissionIssueException"} + ], + "documentation":"Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.
This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call.
To modify an existing logging configuration, do the following:
Retrieve it by calling GetLoggingConfiguration
Update its settings as needed
Provide the complete logging configuration specification to this call
You can define one logging destination per web ACL.
You can access information about the traffic that WAF inspects using the following steps:
Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.
The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.
For configuration requirements and pricing information for each destination type, see Logging web ACL traffic in the WAF Developer Guide.
Associate your logging destination to your web ACL using a PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
For additional information about web ACL logging, see Logging web ACL traffic information in the WAF Developer Guide.
" + }, + "PutManagedRuleSetVersions":{ + "name":"PutManagedRuleSetVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutManagedRuleSetVersionsRequest"}, + "output":{"shape":"PutManagedRuleSetVersionsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFOptimisticLockException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using.
To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.
" + }, + "PutPermissionPolicy":{ + "name":"PutPermissionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutPermissionPolicyRequest"}, + "output":{"shape":"PutPermissionPolicyResponse"}, + "errors":[ + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidPermissionPolicyException"} + ], + "documentation":"Use this to share a rule group with other accounts.
This action attaches an IAM policy to the specified resource. You must be the owner of the rule group to perform this operation.
This action is subject to the following restrictions:
You can attach only one policy with each PutPermissionPolicy request.
The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same Region.
The user making the request must be the owner of the rule group.
If a rule group has been shared with your account, you can access it through the call GetRuleGroup, and you can reference it in CreateWebACL and UpdateWebACL. Rule groups that are shared with you don't appear in your WAF console rule groups listing.
Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be \"customer\" and the tag value might be \"companyA.\" You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.
" + }, + "UpdateIPSet":{ + "name":"UpdateIPSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateIPSetRequest"}, + "output":{"shape":"UpdateIPSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFDuplicateItemException"}, + {"shape":"WAFOptimisticLockException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Updates the specified IPSet.
This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.
To modify an IP set, do the following:
Retrieve it by calling GetIPSet
Update its settings as needed
Provide the complete IP set specification to this call
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas 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.
Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
Updates the specified RegexPatternSet.
This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.
To modify a regex pattern set, do the following:
Retrieve it by calling GetRegexPatternSet
Update its settings as needed
Provide the complete regex pattern set specification to this call
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take 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.
Updates the specified RuleGroup.
This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.
To modify a rule group, do the following:
Retrieve it by calling GetRuleGroup
Update its settings as needed
Provide the complete rule group specification to this call
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
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.
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 resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an 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.
The token domains that are defined in this API key.
" + }, + "APIKey":{ + "shape":"APIKey", + "documentation":"The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
" + }, + "CreationTimestamp":{ + "shape":"Timestamp", + "documentation":"The date and time that the key was created.
" + }, + "Version":{ + "shape":"APIKeyVersion", + "documentation":"Internal value used by WAF to manage the key.
" + } + }, + "documentation":"Information for a single API key.
API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.
" + }, + "APIKeyTokenDomains":{ + "type":"list", + "member":{"shape":"TokenDomain"}, + "min":1 + }, + "APIKeyVersion":{ + "type":"integer", + "min":0 + }, + "AWSManagedRulesACFPRuleSet":{ + "type":"structure", + "required":[ + "CreationPath", + "RegistrationPagePath", + "RequestInspection" + ], + "members":{ + "CreationPath":{ + "shape":"CreationPathString", + "documentation":"The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept POST requests.
For example, for the URL https://example.com/web/newaccount, you would provide the path /web/newaccount. Account creation page paths that start with the path that you provide are considered a match. For example /web/newaccount matches the account creation paths /web/newaccount, /web/newaccount/, /web/newaccountPage, and /web/newaccount/thisPage, but doesn't match the path /home/web/newaccount or /website/newaccount.
The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.
This page must accept GET text/html requests.
For example, for the URL https://example.com/web/registration, you would provide the path /web/registration. Registration page paths that start with the path that you provide are considered a match. For example /web/registration matches the registration paths /web/registration, /web/registration/, /web/registrationPage, and /web/registration/thisPage, but doesn't match the path /home/web/registration or /website/registration.
The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
" + }, + "ResponseInspection":{ + "shape":"ResponseInspection", + "documentation":"The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.
" + }, + "EnableRegexInPath":{ + "shape":"Boolean", + "documentation":"Allow the use of regular expressions in the registration page path and the account creation path.
" + } + }, + "documentation":"Details for your use of the account creation fraud prevention managed rule group, AWSManagedRulesACFPRuleSet. This configuration is used in ManagedRuleGroupConfig.
The path of the login endpoint for your application. For example, for the URL https://example.com/web/login, you would provide the path /web/login. Login paths that start with the path that you provide are considered a match. For example /web/login matches the login paths /web/login, /web/login/, /web/loginPage, and /web/login/thisPage, but doesn't match the login path /home/web/login or /website/login.
The rule group inspects only HTTP POST requests to your specified login endpoint.
The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
" + }, + "ResponseInspection":{ + "shape":"ResponseInspection", + "documentation":"The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.
" + }, + "EnableRegexInPath":{ + "shape":"Boolean", + "documentation":"Allow the use of regular expressions in the login page path.
" + } + }, + "documentation":"Details for your use of the account takeover prevention managed rule group, AWSManagedRulesATPRuleSet. This configuration is used in ManagedRuleGroupConfig.
The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control rule group in the WAF Developer Guide.
" + }, + "EnableMachineLearning":{ + "shape":"EnableMachineLearning", + "documentation":"Applies only to the targeted inspection level.
Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and TGT_ML_CoordinatedActivityMedium, which inspect for anomalous behavior that might indicate distributed, coordinated bot activity.
For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the WAF Developer Guide.
Default: TRUE
Details for your use of the Bot Control managed rule group, AWSManagedRulesBotControlRuleSet. This configuration is used in ManagedRuleGroupConfig.
The action setting that a log record must contain in order to meet the condition. This is the action that WAF applied to the web request.
For rule groups, this is either the configured rule action setting, or if you've applied a rule action override to the rule, it's the override action. The value EXCLUDED_AS_COUNT matches on excluded rules and also on rules that have a rule action override of Count.
A single action condition for a Condition in a logging filter.
" + }, + "ActionValue":{ + "type":"string", + "enum":[ + "ALLOW", + "BLOCK", + "COUNT", + "CAPTCHA", + "CHALLENGE", + "EXCLUDED_AS_COUNT" + ] + }, + "AddressField":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"FieldIdentifier", + "documentation":"The name of a single primary address field.
How you specify the address fields depends on the request inspection payload type.
For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload { \"form\": { \"primaryaddressline1\": \"THE_ADDRESS1\", \"primaryaddressline2\": \"THE_ADDRESS2\", \"primaryaddressline3\": \"THE_ADDRESS3\" } }, the address field idenfiers are /form/primaryaddressline1, /form/primaryaddressline2, and /form/primaryaddressline3.
For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named primaryaddressline1, primaryaddressline2, and primaryaddressline3, the address fields identifiers are primaryaddressline1, primaryaddressline2, and primaryaddressline3.
The name of a field in the request payload that contains part or all of your customer's primary physical address.
This data type is used in the RequestInspectionACFP data type.
Inspect all of the elements that WAF has parsed and extracted from the web request component that you've identified in your FieldToMatch specifications.
This is used in the FieldToMatch specification for some web request component types.
JSON specification: \"All\": {}
Inspect all query arguments of the web request.
This is used in the FieldToMatch specification for some web request component types.
JSON specification: \"AllQueryArguments\": {}
Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
" + } + }, + "documentation":"Specifies that WAF should allow the request and optionally defines additional custom handling for the request.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
" + }, + "AndStatement":{ + "type":"structure", + "required":["Statements"], + "members":{ + "Statements":{ + "shape":"Statements", + "documentation":"The statements to combine with AND logic. You can use any statements that can be nested.
" + } + }, + "documentation":"A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
" + }, + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"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
Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
Example JSON: { \"API_GATEWAY\": \"KB_48\", \"APP_RUNNER_SERVICE\": \"KB_32\" }
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
" + } + }, + "documentation":"Specifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
" + }, + "BlockAction":{ + "type":"structure", + "members":{ + "CustomResponse":{ + "shape":"CustomResponse", + "documentation":"Defines a custom response for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
" + } + }, + "documentation":"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.
" + }, + "Body":{ + "type":"structure", + "members":{ + "OversizeHandling":{ + "shape":"OversizeHandling", + "documentation":"What WAF should do if the body is larger than WAF can inspect.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
The options for oversize handling are the following:
CONTINUE - Inspect the available body contents normally, according to the rule inspection criteria.
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE
Inspect the body of the web request. The body immediately follows the request headers.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
" + }, + "BodyParsingFallbackBehavior":{ + "type":"string", + "enum":[ + "MATCH", + "NO_MATCH", + "EVALUATE_AS_STRING" + ] + }, + "Boolean":{"type":"boolean"}, + "ByteMatchStatement":{ + "type":"structure", + "required":[ + "SearchString", + "FieldToMatch", + "TextTransformations", + "PositionalConstraint" + ], + "members":{ + "SearchString":{ + "shape":"SearchString", + "documentation":"A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 200 bytes.
Valid values depend on the component that you specify for inspection in FieldToMatch:
Method: The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request.
UriPath: The value that you want WAF to search for in the URI path, for example, /images/daily-ad.jpg.
JA3Fingerprint: Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY.
You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.
HeaderOrder: The list of header names to match for. WAF creates a string that contains the ordered list of header names, from the headers in the web request, and then matches against that string.
If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of SearchString.
If you're using the CLI or one of the Amazon Web Services SDKs
The value that you want WAF to search for. The SDK automatically base64 encodes the value.
" + }, + "FieldToMatch":{ + "shape":"FieldToMatch", + "documentation":"The part of the web request that you want WAF to inspect.
" + }, + "TextTransformations":{ + "shape":"TextTransformations", + "documentation":"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.
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.
A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.
" + }, + "CapacityUnit":{ + "type":"long", + "min":1 + }, + "CaptchaAction":{ + "type":"structure", + "members":{ + "CustomRequestHandling":{ + "shape":"CustomRequestHandling", + "documentation":"Defines custom handling for the web request, used when the CAPTCHA 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.
" + } + }, + "documentation":"Specifies that WAF should run a CAPTCHA check against the request:
If the request includes a valid, unexpired CAPTCHA token, WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to proceed to the next rule, similar to a CountAction.
If the request doesn't include a valid, unexpired token, WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.
WAF generates a response that it sends back to the client, which includes the following:
The header x-amzn-waf-action with a value of captcha.
The HTTP status code 405 Method Not Allowed.
If the request contains an Accept header with a value of text/html, the response includes a CAPTCHA JavaScript page interstitial.
You can configure the expiration time in the CaptchaConfig ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.
This action option is available for rules. It isn't available for web ACL default actions.
" + }, + "CaptchaConfig":{ + "type":"structure", + "members":{ + "ImmunityTimeProperty":{ + "shape":"ImmunityTimeProperty", + "documentation":"Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle.
Specifies how WAF should handle CAPTCHA evaluations. This is available at the web ACL level and in each rule.
The HTTP response code indicating the status of the CAPTCHA token in the web request. If the token is missing, invalid, or expired, this code is 405 Method Not Allowed.
The time that the CAPTCHA was last solved for the supplied token.
The reason for failure, populated when the evaluation of the token fails.
" + } + }, + "documentation":"The result from the inspection of the web request for a valid CAPTCHA token.
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.
" + } + }, + "documentation":"Specifies that WAF should run a Challenge check against the request to verify that the request is coming from a legitimate client session:
If the request includes a valid, unexpired challenge token, WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to proceed to the next rule, similar to a CountAction.
If the request doesn't include a valid, unexpired challenge token, WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.
WAF then generates a challenge response that it sends back to the client, which includes the following:
The header x-amzn-waf-action with a value of challenge.
The HTTP status code 202 Request Accepted.
If the request contains an Accept header with a value of text/html, the response includes a JavaScript page interstitial with a challenge script.
Challenges run silent browser interrogations in the background, and don't generally affect the end user experience.
A challenge enforces token acquisition using an interstitial JavaScript challenge that inspects the client session for legitimate behavior. The challenge blocks bots or at least increases the cost of operating sophisticated bots.
After the client session successfully responds to the challenge, it receives a new token from WAF, which the challenge script uses to resubmit the original request.
You can configure the expiration time in the ChallengeConfig ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.
This action option is available for rules. It isn't available for web ACL default actions.
" + }, + "ChallengeConfig":{ + "type":"structure", + "members":{ + "ImmunityTimeProperty":{ + "shape":"ImmunityTimeProperty", + "documentation":"Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.
" + } + }, + "documentation":"Specifies how WAF should handle Challenge evaluations. This is available at the web ACL level and in each rule.
The HTTP response code indicating the status of the challenge token in the web request. If the token is missing, invalid, or expired, this code is 202 Request Accepted.
The time that the challenge was last solved for the supplied token.
" + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"The reason for failure, populated when the evaluation of the token fails.
" + } + }, + "documentation":"The result from the inspection of the web request for a valid challenge token.
" + }, + "CheckCapacityRequest":{ + "type":"structure", + "required":[ + "Scope", + "Rules" + ], + "members":{ + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
An array of Rule that you're configuring to use in a rule group or web ACL.
" + } + } + }, + "CheckCapacityResponse":{ + "type":"structure", + "members":{ + "Capacity":{ + "shape":"ConsumedCapacity", + "documentation":"The capacity required by the rules and scope.
" + } + } + }, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "EQ", + "NE", + "LE", + "LT", + "GE", + "GT" + ] + }, + "Condition":{ + "type":"structure", + "members":{ + "ActionCondition":{ + "shape":"ActionCondition", + "documentation":"A single action condition. This is the action setting that a log record must contain in order to meet the condition.
" + }, + "LabelNameCondition":{ + "shape":"LabelNameCondition", + "documentation":"A single label name condition. This is the fully qualified label name that a log record must contain in order to meet the condition. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.
" + } + }, + "documentation":"A single match condition for a Filter.
" + }, + "Conditions":{ + "type":"list", + "member":{"shape":"Condition"}, + "min":1 + }, + "ConsumedCapacity":{ + "type":"long", + "min":0 + }, + "CookieMatchPattern":{ + "type":"structure", + "members":{ + "All":{ + "shape":"All", + "documentation":"Inspect all cookies.
" + }, + "IncludedCookies":{ + "shape":"CookieNames", + "documentation":"Inspect only the cookies that have a key that matches one of the strings specified here.
" + }, + "ExcludedCookies":{ + "shape":"CookieNames", + "documentation":"Inspect only the cookies whose keys don't match any of the strings specified here.
" + } + }, + "documentation":"The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.
Example JSON: \"MatchPattern\": { \"IncludedCookies\": [ \"session-id-time\", \"session-id\" ] }
The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.
Example JSON: \"MatchPattern\": { \"IncludedCookies\": [ \"session-id-time\", \"session-id\" ] }
The parts of the cookies to inspect with the rule inspection criteria. If you specify ALL, WAF inspects both keys and values.
All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values.
What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.
The options for oversize handling are the following:
CONTINUE - Inspect the available cookies normally, according to the rule inspection criteria.
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
Inspect the cookies in the web request. You can specify the parts of the cookies to inspect and you can narrow the set of cookies to inspect by including or excluding specific keys.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
Example JSON: \"Cookies\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\", \"OversizeHandling\": \"MATCH\" }
Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
" + } + }, + "documentation":"Specifies that WAF should count the request. Optionally defines additional custom handling for the request.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
" + }, + "Country":{"type":"string"}, + "CountryCode":{ + "type":"string", + "enum":[ + "AF", + "AX", + "AL", + "DZ", + "AS", + "AD", + "AO", + "AI", + "AQ", + "AG", + "AR", + "AM", + "AW", + "AU", + "AT", + "AZ", + "BS", + "BH", + "BD", + "BB", + "BY", + "BE", + "BZ", + "BJ", + "BM", + "BT", + "BO", + "BQ", + "BA", + "BW", + "BV", + "BR", + "IO", + "BN", + "BG", + "BF", + "BI", + "KH", + "CM", + "CA", + "CV", + "KY", + "CF", + "TD", + "CL", + "CN", + "CX", + "CC", + "CO", + "KM", + "CG", + "CD", + "CK", + "CR", + "CI", + "HR", + "CU", + "CW", + "CY", + "CZ", + "DK", + "DJ", + "DM", + "DO", + "EC", + "EG", + "SV", + "GQ", + "ER", + "EE", + "ET", + "FK", + "FO", + "FJ", + "FI", + "FR", + "GF", + "PF", + "TF", + "GA", + "GM", + "GE", + "DE", + "GH", + "GI", + "GR", + "GL", + "GD", + "GP", + "GU", + "GT", + "GG", + "GN", + "GW", + "GY", + "HT", + "HM", + "VA", + "HN", + "HK", + "HU", + "IS", + "IN", + "ID", + "IR", + "IQ", + "IE", + "IM", + "IL", + "IT", + "JM", + "JP", + "JE", + "JO", + "KZ", + "KE", + "KI", + "KP", + "KR", + "KW", + "KG", + "LA", + "LV", + "LB", + "LS", + "LR", + "LY", + "LI", + "LT", + "LU", + "MO", + "MK", + "MG", + "MW", + "MY", + "MV", + "ML", + "MT", + "MH", + "MQ", + "MR", + "MU", + "YT", + "MX", + "FM", + "MD", + "MC", + "MN", + "ME", + "MS", + "MA", + "MZ", + "MM", + "NA", + "NR", + "NP", + "NL", + "NC", + "NZ", + "NI", + "NE", + "NG", + "NU", + "NF", + "MP", + "NO", + "OM", + "PK", + "PW", + "PS", + "PA", + "PG", + "PY", + "PE", + "PH", + "PN", + "PL", + "PT", + "PR", + "QA", + "RE", + "RO", + "RU", + "RW", + "BL", + "SH", + "KN", + "LC", + "MF", + "PM", + "VC", + "WS", + "SM", + "ST", + "SA", + "SN", + "RS", + "SC", + "SL", + "SG", + "SX", + "SK", + "SI", + "SB", + "SO", + "ZA", + "GS", + "SS", + "ES", + "LK", + "SD", + "SR", + "SJ", + "SZ", + "SE", + "CH", + "SY", + "TW", + "TJ", + "TZ", + "TH", + "TL", + "TG", + "TK", + "TO", + "TT", + "TN", + "TR", + "TM", + "TC", + "TV", + "UG", + "UA", + "AE", + "GB", + "US", + "UM", + "UY", + "UZ", + "VU", + "VE", + "VN", + "VG", + "VI", + "WF", + "EH", + "YE", + "ZM", + "ZW", + "XK" + ] + }, + "CountryCodes":{ + "type":"list", + "member":{"shape":"CountryCode"}, + "min":1 + }, + "CreateAPIKeyRequest":{ + "type":"structure", + "required":[ + "Scope", + "TokenDomains" + ], + "members":{ + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
The client application domains that you want to use this API key for.
Example JSON: \"TokenDomains\": [\"abc.com\", \"store.abc.com\"]
Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.
The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
" + } + } + }, + "CreateIPSetRequest":{ + "type":"structure", + "required":[ + "Name", + "Scope", + "IPAddressVersion", + "Addresses" + ], + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"The name of the IP set. You cannot change the name of an IPSet after you create it.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A description of the IP set that helps with identification.
" + }, + "IPAddressVersion":{ + "shape":"IPAddressVersion", + "documentation":"The version of the IP addresses, either IPV4 or IPV6.
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses specifications:
Empty array: \"Addresses\": []
Array with one address: \"Addresses\": [\"192.0.2.44/32\"]
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]
INVALID specification: \"Addresses\": [\"\"] INVALID
An array of key:value pairs to associate with the resource.
" + } + } + }, + "CreateIPSetResponse":{ + "type":"structure", + "members":{ + "Summary":{ + "shape":"IPSetSummary", + "documentation":"High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.
The name of the set. You cannot change the name after you create the set.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A description of the set that helps with identification.
" + }, + "RegularExpressionList":{ + "shape":"RegularExpressionList", + "documentation":"Array of regular expression strings.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of key:value pairs to associate with the resource.
" + } + } + }, + "CreateRegexPatternSetResponse":{ + "type":"structure", + "members":{ + "Summary":{ + "shape":"RegexPatternSetSummary", + "documentation":"High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.
The name of the rule group. You cannot change the name of a rule group after you create it.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
" + }, + "Description":{ + "shape":"EntityDescription", + "documentation":"A description of the rule group that helps with identification.
" + }, + "Rules":{ + "shape":"Rules", + "documentation":"The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
" + }, + "VisibilityConfig":{ + "shape":"VisibilityConfig", + "documentation":"Defines and enables Amazon CloudWatch metrics and web request sample collection.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of key:value pairs to associate with the resource.
" + }, + "CustomResponseBodies":{ + "shape":"CustomResponseBodies", + "documentation":"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.
" + } + } + }, + "CreateRuleGroupResponse":{ + "type":"structure", + "members":{ + "Summary":{ + "shape":"RuleGroupSummary", + "documentation":"High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.
The name of the web ACL. You cannot change the name of a web ACL after you create it.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
The action to perform if none of the Rules contained in the WebACL match.
A description of the web ACL that helps with identification.
" + }, + "Rules":{ + "shape":"Rules", + "documentation":"The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
" + }, + "VisibilityConfig":{ + "shape":"VisibilityConfig", + "documentation":"Defines and enables Amazon CloudWatch metrics and web request sample collection.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of key:value pairs to associate with the resource.
" + }, + "CustomResponseBodies":{ + "shape":"CustomResponseBodies", + "documentation":"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 web ACL, and then use them in the rules and default actions that you define in the web ACL.
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.
" + }, + "CaptchaConfig":{ + "shape":"CaptchaConfig", + "documentation":"Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.
Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }
Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.
Specifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
" + } + } + }, + "CreateWebACLResponse":{ + "type":"structure", + "members":{ + "Summary":{ + "shape":"WebACLSummary", + "documentation":"High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.
The name of the custom header.
For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf-, to avoid confusion with the headers that are already in the request. For example, for the header name sample, WAF inserts the header x-amzn-waf-sample.
The value of the custom header.
" + } + }, + "documentation":"A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling.
" + }, + "CustomHTTPHeaderName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9._$-]+$" + }, + "CustomHTTPHeaderValue":{ + "type":"string", + "max":255, + "min":1, + "pattern":".*" + }, + "CustomHTTPHeaders":{ + "type":"list", + "member":{"shape":"CustomHTTPHeader"}, + "min":1 + }, + "CustomRequestHandling":{ + "type":"structure", + "required":["InsertHeaders"], + "members":{ + "InsertHeaders":{ + "shape":"CustomHTTPHeaders", + "documentation":"The HTTP headers to insert into the request. Duplicate header names are not allowed.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
" + } + }, + "documentation":"Custom request handling behavior that inserts custom headers into a web request. You can add custom request handling for WAF to use when the rule action doesn't block the request. For example, CaptchaAction for requests with valid t okens, and AllowAction.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
" + }, + "CustomResponse":{ + "type":"structure", + "required":["ResponseCode"], + "members":{ + "ResponseCode":{ + "shape":"ResponseStatusCode", + "documentation":"The HTTP status code to return to the client.
For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.
" + }, + "CustomResponseBodyKey":{ + "shape":"EntityName", + "documentation":"References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.
The HTTP headers to use in the response. You can specify any header name except for content-type. Duplicate header names are not allowed.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
" + } + }, + "documentation":"A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to BlockAction.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
" + }, + "CustomResponseBodies":{ + "type":"map", + "key":{"shape":"EntityName"}, + "value":{"shape":"CustomResponseBody"}, + "min":1 + }, + "CustomResponseBody":{ + "type":"structure", + "required":[ + "ContentType", + "Content" + ], + "members":{ + "ContentType":{ + "shape":"ResponseContentType", + "documentation":"The type of content in the payload that you are defining in the Content string.
The payload of the custom response.
You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the ContentType setting.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
" + } + }, + "documentation":"The response body to use in a custom response to a web request. This is referenced by key from CustomResponse CustomResponseBodyKey.
Specifies that WAF should block requests by default.
" + }, + "Allow":{ + "shape":"AllowAction", + "documentation":"Specifies that WAF should allow requests by default.
" + } + }, + "documentation":"In a WebACL, this is the action that you want WAF to perform when a web request doesn't match any of the rules in the WebACL. The default action must be a terminating action.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
The encrypted API key that you want to delete.
" + } + } + }, + "DeleteAPIKeyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteFirewallManagerRuleGroupsRequest":{ + "type":"structure", + "required":[ + "WebACLArn", + "WebACLLockToken" + ], + "members":{ + "WebACLArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the web ACL.
" + }, + "WebACLLockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The name of the IP set. You cannot change the name of an IPSet after you create it.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.
" + }, + "LogType":{ + "shape":"LogType", + "documentation":"Used to distinguish between various logging options. Currently, there is one option.
Default: WAF_LOGS
The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.
The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.
Default: CUSTOMER
The Amazon Resource Name (ARN) of the rule group from which you want to delete the policy.
You must be the owner of the rule group to perform this operation.
" + } + } + }, + "DeletePermissionPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteRegexPatternSetRequest":{ + "type":"structure", + "required":[ + "Name", + "Scope", + "Id", + "LockToken" + ], + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"The name of the set. You cannot change the name after you create the set.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The name of the rule group. You cannot change the name of a rule group after you create it.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The name of the web ACL. You cannot change the name of a web ACL after you create it.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
High-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.
" + } + } + }, + "DescribeManagedProductsByVendorRequest":{ + "type":"structure", + "required":[ + "VendorName", + "Scope" + ], + "members":{ + "VendorName":{ + "shape":"VendorName", + "documentation":"The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
High-level information for the managed rule groups owned by the specified vendor.
" + } + } + }, + "DescribeManagedRuleGroupRequest":{ + "type":"structure", + "required":[ + "VendorName", + "Name", + "Scope" + ], + "members":{ + "VendorName":{ + "shape":"VendorName", + "documentation":"The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
" + }, + "Name":{ + "shape":"EntityName", + "documentation":"The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't provide this, WAF uses the vendor's default version.
" + } + } + }, + "DescribeManagedRuleGroupResponse":{ + "type":"structure", + "members":{ + "VersionName":{ + "shape":"VersionKeyString", + "documentation":"The managed rule group's version.
" + }, + "SnsTopicArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.
" + }, + "Capacity":{ + "shape":"CapacityUnit", + "documentation":"The web ACL capacity units (WCUs) required for this rule group.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
" + }, + "Rules":{ + "shape":"RuleSummaries", + "documentation":"" + }, + "LabelNamespace":{ + "shape":"LabelName", + "documentation":"The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>:
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.
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.
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
The name of the email field.
How you specify this depends on the request inspection payload type.
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload { \"form\": { \"email\": \"THE_EMAIL\" } }, the email field specification is /form/email.
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named email1, the email field specification is email1.
The name of the field in the request payload that contains your customer's email.
This data type is used in the RequestInspectionACFP data type.
The name of the rule whose action you want to override to Count.
Specifies a single rule in a rule group whose action you want to override to Count.
Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.
Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }
Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }
Inspect all query arguments.
" + }, + "UriPath":{ + "shape":"UriPath", + "documentation":"Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
For information about how to handle oversized request bodies, see the Body object configuration.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
" + }, + "JsonBody":{ + "shape":"JsonBody", + "documentation":"Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
For information about how to handle oversized request bodies, see the JsonBody object configuration.
Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.
Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.
Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.
Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.
Inspect a string containing the list of the request's header names, ordered as they appear in the web request that WAF receives for inspection. WAF generates the string and then uses that as the field to match component in its inspection. WAF separates the header names in the string using colons and no added spaces, for example host:user-agent:accept:authorization:referer.
Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY.
You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.
Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
" + } + }, + "documentation":"Specifies a web request component to be used in a rule match statement or in a logging configuration.
In a rule statement, this is the part of the web request that you want WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of the web request, create a separate rule statement for each component.
Example JSON for a QueryString field to match:
\"FieldToMatch\": { \"QueryString\": {} }
Example JSON for a Method field to match specification:
\"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }
In a logging configuration, this is used in the RedactedFields property to specify a field to redact from the logging records. For this use case, note the following:
Even though all FieldToMatch settings are available, the only valid settings for field redaction are UriPath, QueryString, SingleHeader, and Method.
In this documentation, the descriptions of the individual fields talk about specifying the web request component to inspect, but for field redaction, you are specifying the component type to redact from the logs.
If you have request sampling enabled, the redacted fields configuration for logging has no impact on sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
How to handle logs that satisfy the filter's conditions and requirement.
" + }, + "Requirement":{ + "shape":"FilterRequirement", + "documentation":"Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.
" + }, + "Conditions":{ + "shape":"Conditions", + "documentation":"Match conditions for the filter.
" + } + }, + "documentation":"A single logging filter, used in LoggingFilter.
" + }, + "FilterBehavior":{ + "type":"string", + "enum":[ + "KEEP", + "DROP" + ] + }, + "FilterRequirement":{ + "type":"string", + "enum":[ + "MEETS_ALL", + "MEETS_ANY" + ] + }, + "Filters":{ + "type":"list", + "member":{"shape":"Filter"}, + "min":1 + }, + "FirewallManagerRuleGroup":{ + "type":"structure", + "required":[ + "Name", + "Priority", + "FirewallManagerStatement", + "OverrideAction", + "VisibilityConfig" + ], + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"The name of the rule group. You cannot change the name of a rule group after you create it.
" + }, + "Priority":{ + "shape":"RulePriority", + "documentation":"If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to be consecutive, but they must all be different.
" + }, + "FirewallManagerStatement":{ + "shape":"FirewallManagerStatement", + "documentation":"The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
" + }, + "OverrideAction":{ + "shape":"OverrideAction", + "documentation":"The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.
Defines and enables Amazon CloudWatch metrics and web request sample collection.
" + } + }, + "documentation":"A rule group that's defined for an Firewall Manager WAF policy.
" + }, + "FirewallManagerRuleGroups":{ + "type":"list", + "member":{"shape":"FirewallManagerRuleGroup"} + }, + "FirewallManagerStatement":{ + "type":"structure", + "members":{ + "ManagedRuleGroupStatement":{ + "shape":"ManagedRuleGroupStatement", + "documentation":"A statement used by Firewall Manager to run the rules that are defined in a managed rule group. This is managed by Firewall Manager for an Firewall Manager WAF policy.
" + }, + "RuleGroupReferenceStatement":{ + "shape":"RuleGroupReferenceStatement", + "documentation":"A statement used by Firewall Manager to run the rules that are defined in a rule group. This is managed by Firewall Manager for an Firewall Manager WAF policy.
" + } + }, + "documentation":"The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a single rule group reference.
" + }, + "ForwardedIPConfig":{ + "type":"structure", + "required":[ + "HeaderName", + "FallbackBehavior" + ], + "members":{ + "HeaderName":{ + "shape":"ForwardedIPHeaderName", + "documentation":"The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.
WAF only evaluates the first IP address found in the specified HTTP header.
" + }, + "ForwardedIPHeaderName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9-]+$" + }, + "ForwardedIPPosition":{ + "type":"string", + "enum":[ + "FIRST", + "LAST", + "ANY" + ] + }, + "GenerateMobileSdkReleaseUrlRequest":{ + "type":"structure", + "required":[ + "Platform", + "ReleaseVersion" + ], + "members":{ + "Platform":{ + "shape":"Platform", + "documentation":"The device platform.
" + }, + "ReleaseVersion":{ + "shape":"VersionKeyString", + "documentation":"The release version. For the latest available version, specify LATEST.
The presigned download URL for the specified SDK release.
" + } + } + }, + "GeoMatchStatement":{ + "type":"structure", + "members":{ + "CountryCodes":{ + "shape":"CountryCodes", + "documentation":"An array of two-character country codes that you want to match against, for example, [ \"US\", \"CN\" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.
When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
" + }, + "ForwardedIPConfig":{ + "shape":"ForwardedIPConfig", + "documentation":"The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.
To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the CountryCodes array.
Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.
If you use the web request origin, the label formats are awswaf:clientip:geo:region:<ISO country code>-<ISO region code> and awswaf:clientip:geo:country:<ISO country code>.
If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code> and awswaf:forwardedip:geo:country:<ISO country code>.
For additional details, see Geographic match rule statement in the WAF Developer Guide.
" + }, + "GetDecryptedAPIKeyRequest":{ + "type":"structure", + "required":[ + "Scope", + "APIKey" + ], + "members":{ + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
The encrypted API key.
" + } + } + }, + "GetDecryptedAPIKeyResponse":{ + "type":"structure", + "members":{ + "TokenDomains":{ + "shape":"TokenDomains", + "documentation":"The token domains that are defined in this API key.
" + }, + "CreationTimestamp":{ + "shape":"Timestamp", + "documentation":"The date and time that the key was created.
" + } + } + }, + "GetIPSetRequest":{ + "type":"structure", + "required":[ + "Name", + "Scope", + "Id" + ], + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"The name of the IP set. You cannot change the name of an IPSet after you create it.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + } + } + }, + "GetIPSetResponse":{ + "type":"structure", + "members":{ + "IPSet":{ + "shape":"IPSet", + "documentation":"" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.
" + }, + "LogType":{ + "shape":"LogType", + "documentation":"Used to distinguish between various logging options. Currently, there is one option.
Default: WAF_LOGS
The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.
The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.
Default: CUSTOMER
The LoggingConfiguration for the specified web ACL.
" + } + } + }, + "GetManagedRuleSetRequest":{ + "type":"structure", + "required":[ + "Name", + "Scope", + "Id" + ], + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.
The managed rule set that you requested.
" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The device platform.
" + }, + "ReleaseVersion":{ + "shape":"VersionKeyString", + "documentation":"The release version. For the latest available version, specify LATEST.
Information for a specified SDK release, including release notes and tags.
" + } + } + }, + "GetPermissionPolicyRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the rule group for which you want to get the policy.
" + } + } + }, + "GetPermissionPolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"PolicyString", + "documentation":"The IAM policy that is attached to the specified rule group.
" + } + } + }, + "GetRateBasedStatementManagedKeysRequest":{ + "type":"structure", + "required":[ + "Scope", + "WebACLName", + "WebACLId", + "RuleName" + ], + "members":{ + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
The name of the web ACL. You cannot change the name of a web ACL after you create it.
" + }, + "WebACLId":{ + "shape":"EntityId", + "documentation":"The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "RuleGroupRuleName":{ + "shape":"EntityName", + "documentation":"The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group.
" + }, + "RuleName":{ + "shape":"EntityName", + "documentation":"The name of the rate-based rule to get the keys for. If you have the rule defined inside a rule group that you're using in your web ACL, also provide the name of the rule group reference statement in the request parameter RuleGroupRuleName.
The keys that are of Internet Protocol version 4 (IPv4).
" + }, + "ManagedKeysIPV6":{ + "shape":"RateBasedStatementManagedKeysIPSet", + "documentation":"The keys that are of Internet Protocol version 6 (IPv6).
" + } + } + }, + "GetRegexPatternSetRequest":{ + "type":"structure", + "required":[ + "Name", + "Scope", + "Id" + ], + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"The name of the set. You cannot change the name after you create the set.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + } + } + }, + "GetRegexPatternSetResponse":{ + "type":"structure", + "members":{ + "RegexPatternSet":{ + "shape":"RegexPatternSet", + "documentation":"" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The name of the rule group. You cannot change the name of a rule group after you create it.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "ARN":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the entity.
" + } + } + }, + "GetRuleGroupResponse":{ + "type":"structure", + "members":{ + "RuleGroup":{ + "shape":"RuleGroup", + "documentation":"" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.
The metric name assigned to the Rule or RuleGroup dimension for which you want a sample of requests.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of 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. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.
The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.
A complex type that contains detailed information about each of the requests in the sample.
" + }, + "PopulationSize":{ + "shape":"PopulationSize", + "documentation":"The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your Amazon Web Services resource received during the specified time range.
Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your Amazon Web Services resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.
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
The web ACL that is associated with the resource. If there is no associated resource, WAF returns a null web ACL.
" + } + } + }, + "GetWebACLRequest":{ + "type":"structure", + "required":[ + "Name", + "Scope", + "Id" + ], + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"The name of the web ACL. You cannot change the name of a web ACL after you create it.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + } + } + }, + "GetWebACLResponse":{ + "type":"structure", + "members":{ + "WebACL":{ + "shape":"WebACL", + "documentation":"The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one.
" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
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.
The name of the HTTP header.
" + }, + "Value":{ + "shape":"HeaderValue", + "documentation":"The value of the HTTP header.
" + } + }, + "documentation":"Part of the response from GetSampledRequests. This is a complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests.
The IP address that the request originated from. If the web ACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:
c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request
x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request
The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.
" + }, + "URI":{ + "shape":"URIString", + "documentation":"The URI path of the request, which identifies the resource, for example, /images/daily-ad.jpg.
The HTTP method specified in the sampled web request.
" + }, + "HTTPVersion":{ + "shape":"HTTPVersion", + "documentation":"The HTTP version specified in the sampled web request, for example, HTTP/1.1.
A complex type that contains the name and value for each header in the sampled web request.
" + } + }, + "documentation":"Part of the response from GetSampledRequests. This is a complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests.
Inspect all headers.
" + }, + "IncludedHeaders":{ + "shape":"HeaderNames", + "documentation":"Inspect only the headers that have a key that matches one of the strings specified here.
" + }, + "ExcludedHeaders":{ + "shape":"HeaderNames", + "documentation":"Inspect only the headers whose keys don't match any of the strings specified here.
" + } + }, + "documentation":"The filter to use to identify the subset of headers to inspect in a web request.
You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.
Example JSON: \"MatchPattern\": { \"ExcludedHeaders\": [ \"KeyToExclude1\", \"KeyToExclude2\" ] }
What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
The options for oversize handling are the following:
CONTINUE - Inspect the available headers normally, according to the rule inspection criteria.
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
Inspect a string containing the list of the request's header names, ordered as they appear in the web request that WAF receives for inspection. WAF generates the string and then uses that as the field to match component in its inspection. WAF separates the header names in the string using colons and no added spaces, for example host:user-agent:accept:authorization:referer.
The filter to use to identify the subset of headers to inspect in a web request.
You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.
Example JSON: \"MatchPattern\": { \"ExcludedHeaders\": [ \"KeyToExclude1\", \"KeyToExclude2\" ] }
The parts of the headers to match with the rule inspection criteria. If you specify ALL, WAF inspects both keys and values.
All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values.
What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
The options for oversize handling are the following:
CONTINUE - Inspect the available headers normally, according to the rule inspection criteria.
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
Inspect all headers in the web request. You can specify the parts of the headers to inspect and you can narrow the set of headers to inspect by including or excluding specific keys.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
If you want to inspect just the value of a single header, use the SingleHeader FieldToMatch setting instead.
Example JSON: \"Headers\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\", \"OversizeHandling\": \"MATCH\" }
The name of the IP set. You cannot change the name of an IPSet after you create it.
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "ARN":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the entity.
" + }, + "Description":{ + "shape":"EntityDescription", + "documentation":"A description of the IP set that helps with identification.
" + }, + "IPAddressVersion":{ + "shape":"IPAddressVersion", + "documentation":"The version of the IP addresses, either IPV4 or IPV6.
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses specifications:
Empty array: \"Addresses\": []
Array with one address: \"Addresses\": [\"192.0.2.44/32\"]
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]
INVALID specification: \"Addresses\": [\"\"] INVALID
Contains zero or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.
The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.
The options for this setting are the following:
FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
LAST - Inspect the last IP address in the list of IP addresses in the header.
ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.
" + }, + "IPSetReferenceStatement":{ + "type":"structure", + "required":["ARN"], + "members":{ + "ARN":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the IPSet that this statement references.
" + }, + "IPSetForwardedIPConfig":{ + "shape":"IPSetForwardedIPConfig", + "documentation":"The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
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.
" + }, + "IPSetSummaries":{ + "type":"list", + "member":{"shape":"IPSetSummary"} + }, + "IPSetSummary":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"The name of the IP set. You cannot change the name of an IPSet after you create it.
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "Description":{ + "shape":"EntityDescription", + "documentation":"A description of the IP set that helps with identification.
" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The Amazon Resource Name (ARN) of the entity.
" + } + }, + "documentation":"High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.
The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default setting is 300.
For the Challenge action, the minimum setting is 300.
" + } + }, + "documentation":"Used for CAPTCHA and challenge token settings. Determines how long a CAPTCHA or challenge timestamp remains valid after WAF updates it for a successful CAPTCHA or challenge response.
The match status to assign to the web request if the request doesn't have a JA3 fingerprint.
You can specify the following fallback behaviors:
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY.
You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.
Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
" + }, + "JsonBody":{ + "type":"structure", + "required":[ + "MatchPattern", + "MatchScope" + ], + "members":{ + "MatchPattern":{ + "shape":"JsonMatchPattern", + "documentation":"The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.
" + }, + "MatchScope":{ + "shape":"JsonMatchScope", + "documentation":"The parts of the JSON to match against using the MatchPattern. If you specify ALL, WAF matches against keys and values.
All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values.
What WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.
What WAF should do if the body is larger than WAF can inspect.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
The options for oversize handling are the following:
CONTINUE - Inspect the available body contents normally, according to the rule inspection criteria.
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE
Inspect the body of the web request as JSON. The body immediately follows the request headers.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON that result from the matches that you indicate.
Example JSON: \"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\" }
For additional information about this request component option, see JSON body in the WAF Developer Guide.
" + }, + "JsonMatchPattern":{ + "type":"structure", + "members":{ + "All":{ + "shape":"All", + "documentation":"Match all of the elements. See also MatchScope in JsonBody.
You must specify either this setting or the IncludedPaths setting, but not both.
Match only the specified include paths. See also MatchScope in JsonBody.
Provide the include paths using JSON Pointer syntax. For example, \"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
You must specify either this setting or the All setting, but not both.
Don't use this option to include all paths. Instead, use the All setting.
The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.
The label string.
" + } + }, + "documentation":"A single label container. This is used as an element of a label array in multiple contexts, for example, in RuleLabels inside a Rule and in Labels inside a SampledHTTPRequest.
Specify whether you want to match using the label name or just the namespace.
" + }, + "Key":{ + "shape":"LabelMatchKey", + "documentation":"The string to match against. The setting you provide for this depends on the match statement's Scope setting:
If the Scope indicates LABEL, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name.
If the Scope indicates NAMESPACE, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.
Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name.
A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.
The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.
" + }, + "LabelName":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^[0-9A-Za-z_\\-:]+$" + }, + "LabelNameCondition":{ + "type":"structure", + "required":["LabelName"], + "members":{ + "LabelName":{ + "shape":"LabelName", + "documentation":"The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.
" + } + }, + "documentation":"A single label name condition for a Condition in a logging filter.
" + }, + "LabelNamespace":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^[0-9A-Za-z_\\-:]+:$" + }, + "LabelSummaries":{ + "type":"list", + "member":{"shape":"LabelSummary"} + }, + "LabelSummary":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"LabelName", + "documentation":"An individual label specification.
" + } + }, + "documentation":"List of labels used by one or more of the rules of a RuleGroup. This summary object is used for the following rule group lists:
AvailableLabels - Labels that rules add to matching requests. These labels are defined in the RuleLabels for a Rule.
ConsumedLabels - Labels that rules match against. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The array of key summaries. If you specified a Limit in your request, this might not be the full list.
The CAPTCHA application integration URL, for use in your JavaScript implementation.
" + } + } + }, + "ListAvailableManagedRuleGroupVersionsRequest":{ + "type":"structure", + "required":[ + "VendorName", + "Name", + "Scope" + ], + "members":{ + "VendorName":{ + "shape":"VendorName", + "documentation":"The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
" + }, + "Name":{ + "shape":"EntityName", + "documentation":"The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The versions that are currently available for the specified managed rule group. If you specified a Limit in your request, this might not be the full list.
The name of the version that's currently set as the default.
" + } + } + }, + "ListAvailableManagedRuleGroupsRequest":{ + "type":"structure", + "required":["Scope"], + "members":{ + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Array of managed rule groups that you can use. If you specified a Limit in your request, this might not be the full list.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Array of IPSets. If you specified a Limit in your request, this might not be the full list.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.
The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.
Default: CUSTOMER
Array of logging configurations. If you specified a Limit in your request, this might not be the full list.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Your managed rule sets. If you specified a Limit in your request, this might not be the full list.
The device platform to retrieve the list for.
" + }, + "NextMarker":{ + "shape":"NextMarker", + "documentation":"When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
The high level information for the available SDK releases. If you specified a Limit in your request, this might not be the full list.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Array of regex pattern sets. If you specified a Limit in your request, this might not be the full list.
The Amazon Resource Name (ARN) of the web ACL.
" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
If you don't provide a resource type, the call uses the resource type APPLICATION_LOAD_BALANCER.
Default: APPLICATION_LOAD_BALANCER
The array of Amazon Resource Names (ARNs) of the associated resources.
" + } + } + }, + "ListRuleGroupsRequest":{ + "type":"structure", + "required":["Scope"], + "members":{ + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Array of rule groups. If you specified a Limit in your request, this might not be the full list.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
The Amazon Resource Name (ARN) of the resource.
" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The collection of tagging definitions for the resource. If you specified a Limit in your request, this might not be the full list.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Array of web ACLs. If you specified a Limit in your request, this might not be the full list.
The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.
The logging destination configuration that you want to associate with the web ACL.
You can associate one logging destination to a web ACL.
The parts of the request that you want to keep out of the logs.
For example, if you redact the SingleHeader field, the HEADER field in the logs will be REDACTED for all rules that use the SingleHeader FieldToMatch setting.
Redaction applies only to the component that's specified in the rule's FieldToMatch setting, so the SingleHeader redaction doesn't apply to rules that use the Headers FieldToMatch.
You can specify only the following fields for redaction: UriPath, QueryString, SingleHeader, and Method.
This setting has no impact on request sampling. With request sampling, the only way to exclude fields is by disabling sampling in the web ACL visibility configuration.
Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.
" + }, + "LoggingFilter":{ + "shape":"LoggingFilter", + "documentation":"Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.
" + }, + "LogType":{ + "shape":"LogType", + "documentation":"Used to distinguish between various logging options. Currently, there is one option.
Default: WAF_LOGS
The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.
The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.
Default: CUSTOMER
Defines an association between logging destinations and a web ACL resource, for logging from WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you can specify filters so that you log only a subset of the logging records.
You can define one logging destination per web ACL.
You can access information about the traffic that WAF inspects using the following steps:
Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.
The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.
For configuration requirements and pricing information for each destination type, see Logging web ACL traffic in the WAF Developer Guide.
Associate your logging destination to your web ACL using a PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
For additional information about web ACL logging, see Logging web ACL traffic information in the WAF Developer Guide.
" + }, + "LoggingConfigurations":{ + "type":"list", + "member":{"shape":"LoggingConfiguration"} + }, + "LoggingFilter":{ + "type":"structure", + "required":[ + "Filters", + "DefaultBehavior" + ], + "members":{ + "Filters":{ + "shape":"Filters", + "documentation":"The filters that you want to apply to the logs.
" + }, + "DefaultBehavior":{ + "shape":"FilterBehavior", + "documentation":"Default handling for logs that don't match any of the specified filtering conditions.
" + } + }, + "documentation":"Filtering that specifies which web requests are kept in the logs and which are dropped, defined for a web ACL's LoggingConfiguration.
You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.
" + }, + "LoginPathString":{ + "type":"string", + "max":256, + "min":1, + "pattern":".*\\S.*" + }, + "ManagedProductDescriptor":{ + "type":"structure", + "members":{ + "VendorName":{ + "shape":"VendorName", + "documentation":"The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
" + }, + "ManagedRuleSetName":{ + "shape":"EntityName", + "documentation":"The name of the managed rule group. For example, AWSManagedRulesAnonymousIpList or AWSManagedRulesATPRuleSet.
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "ProductLink":{ + "shape":"ProductLink", + "documentation":"For Amazon Web Services Marketplace managed rule groups only, the link to the rule group product page.
" + }, + "ProductTitle":{ + "shape":"ProductTitle", + "documentation":"The display name for the managed rule group. For example, Anonymous IP list or Account takeover prevention.
A short description of the managed rule group.
" + }, + "SnsTopicArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.
" + }, + "IsVersioningSupported":{ + "shape":"Boolean", + "documentation":"Indicates whether the rule group is versioned.
" + }, + "IsAdvancedManagedRuleSet":{ + "shape":"Boolean", + "documentation":"Indicates whether the rule group provides an advanced set of protections, such as the the Amazon Web Services Managed Rules rule groups that are used for WAF intelligent threat mitigation.
" + } + }, + "documentation":"The properties of a managed product, such as an Amazon Web Services Managed Rules rule group or an Amazon Web Services Marketplace managed rule group.
" + }, + "ManagedProductDescriptors":{ + "type":"list", + "member":{"shape":"ManagedProductDescriptor"} + }, + "ManagedRuleGroupConfig":{ + "type":"structure", + "members":{ + "LoginPath":{ + "shape":"LoginPathString", + "documentation":"Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.
Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.
Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.
Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.
Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.
" + }, + "AWSManagedRulesATPRuleSet":{ + "shape":"AWSManagedRulesATPRuleSet", + "documentation":"Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.
This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.
For information about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group and WAF Fraud Control account takeover prevention (ATP) in the WAF Developer Guide.
" + }, + "AWSManagedRulesACFPRuleSet":{ + "shape":"AWSManagedRulesACFPRuleSet", + "documentation":"Additional configuration for using the account creation fraud prevention (ACFP) managed rule group, AWSManagedRulesACFPRuleSet. Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests.
For information about using the ACFP managed rule group, see WAF Fraud Control account creation fraud prevention (ACFP) rule group and WAF Fraud Control account creation fraud prevention (ACFP) in the WAF Developer Guide.
" + } + }, + "documentation":"Additional information that's used by a managed rule group. Many managed rule groups don't require this.
The rule groups used for intelligent threat mitigation require additional configuration:
Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number fields.
Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover prevention managed rule group. The configuration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password.
Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.
For example specifications, see the examples section of CreateWebACL.
" + }, + "ManagedRuleGroupConfigs":{ + "type":"list", + "member":{"shape":"ManagedRuleGroupConfig"} + }, + "ManagedRuleGroupStatement":{ + "type":"structure", + "required":[ + "VendorName", + "Name" + ], + "members":{ + "VendorName":{ + "shape":"VendorName", + "documentation":"The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
" + }, + "Name":{ + "shape":"EntityName", + "documentation":"The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
" + }, + "Version":{ + "shape":"VersionKeyString", + "documentation":"The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
" + }, + "ExcludedRules":{ + "shape":"ExcludedRules", + "documentation":"Rules in the referenced rule group whose actions are set to Count.
Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.
An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
" + }, + "ManagedRuleGroupConfigs":{ + "shape":"ManagedRuleGroupConfigs", + "documentation":"Additional information that's used by a managed rule group. Many managed rule groups don't require this.
The rule groups used for intelligent threat mitigation require additional configuration:
Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number fields.
Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover prevention managed rule group. The configuration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password.
Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.
Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.
You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. You cannot use a managed rule group inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you define in a web ACL.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.
The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
" + }, + "Name":{ + "shape":"EntityName", + "documentation":"The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
" + }, + "VersioningSupported":{ + "shape":"Boolean", + "documentation":"Indicates whether the managed rule group is versioned. If it is, you can retrieve the versions list by calling ListAvailableManagedRuleGroupVersions.
" + }, + "Description":{ + "shape":"EntityDescription", + "documentation":"The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Amazon Web Services Marketplace seller who manages it.
" + } + }, + "documentation":"High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups. To use any Amazon Web Services Marketplace managed rule group, first subscribe to the rule group through Amazon Web Services Marketplace.
" + }, + "ManagedRuleGroupVersion":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"VersionKeyString", + "documentation":"The version name.
" + }, + "LastUpdateTimestamp":{ + "shape":"Timestamp", + "documentation":"The date and time that the managed rule group owner updated the rule group version information.
" + } + }, + "documentation":"Describes a single version of a managed rule group.
" + }, + "ManagedRuleGroupVersions":{ + "type":"list", + "member":{"shape":"ManagedRuleGroupVersion"} + }, + "ManagedRuleSet":{ + "type":"structure", + "required":[ + "Name", + "Id", + "ARN" + ], + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
" + }, + "Id":{ + "shape":"EntityId", + "documentation":"A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.
The Amazon Resource Name (ARN) of the entity.
" + }, + "Description":{ + "shape":"EntityDescription", + "documentation":"A description of the set that helps with identification.
" + }, + "PublishedVersions":{ + "shape":"PublishedVersions", + "documentation":"The versions of this managed rule set that are available for use by customers.
" + }, + "RecommendedVersion":{ + "shape":"VersionKeyString", + "documentation":"The version that you would like your customers to use.
" + }, + "LabelNamespace":{ + "shape":"LabelName", + "documentation":"The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>:
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
A set of rules that is managed by Amazon Web Services and Amazon Web Services Marketplace sellers to provide versioned managed rule groups for customers of WAF.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
" + }, + "Id":{ + "shape":"EntityId", + "documentation":"A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.
A description of the set that helps with identification.
" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The Amazon Resource Name (ARN) of the entity.
" + }, + "LabelNamespace":{ + "shape":"LabelName", + "documentation":"The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>:
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
High-level information for a managed rule set.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
The Amazon Resource Name (ARN) of the vendor rule group that's used to define the published version of your managed rule group.
" + }, + "Capacity":{ + "shape":"CapacityUnit", + "documentation":"The web ACL capacity units (WCUs) required for this rule group.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
" + }, + "ForecastedLifetime":{ + "shape":"TimeWindowDay", + "documentation":"The amount of time you expect this version of your managed rule group to last, in days.
" + }, + "PublishTimestamp":{ + "shape":"Timestamp", + "documentation":"The time that you first published this version.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".
" + }, + "LastUpdateTimestamp":{ + "shape":"Timestamp", + "documentation":"The last time that you updated this version.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".
" + }, + "ExpiryTimestamp":{ + "shape":"Timestamp", + "documentation":"The time that this version is set to expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".
" + } + }, + "documentation":"Information for a single version of a managed rule set.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
Inspect the HTTP method of the web request. The method indicates the type of operation that the request is asking the origin to perform.
This is used in the FieldToMatch specification for some web request component types.
JSON specification: \"Method\": {}
The release version.
" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of the release.
" + }, + "ReleaseNotes":{ + "shape":"ReleaseNotes", + "documentation":"Notes describing the release.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"Tags that are associated with the release.
" + } + }, + "documentation":"Information for a release of the mobile SDK, including release notes and tags.
The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.
" + }, + "NextMarker":{ + "type":"string", + "max":256, + "min":1, + "pattern":".*\\S.*" + }, + "NoneAction":{ + "type":"structure", + "members":{ + }, + "documentation":"Specifies that WAF should do nothing. This is used for the OverrideAction setting on a Rule when the rule uses a rule group reference statement.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
JSON specification: \"None\": {}
The statement to negate. You can use any statement that can be nested.
" + } + }, + "documentation":"A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.
The statements to combine with OR logic. You can use any statements that can be nested.
" + } + }, + "documentation":"A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.
Override the rule group evaluation result to count only.
This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.
Don't override the rule group evaluation result. This is the most common setting.
" + } + }, + "documentation":"The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.
The name of the password field.
How you specify this depends on the request inspection payload type.
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload { \"form\": { \"password\": \"THE_PASSWORD\" } }, the password field specification is /form/password.
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named password1, the password field specification is password1.
The name of the field in the request payload that contains your customer's password.
This data type is used in the RequestInspection and RequestInspectionACFP data types.
The name of a single primary phone number field.
How you specify the phone number fields depends on the request inspection payload type.
For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload { \"form\": { \"primaryphoneline1\": \"THE_PHONE1\", \"primaryphoneline2\": \"THE_PHONE2\", \"primaryphoneline3\": \"THE_PHONE3\" } }, the phone number field identifiers are /form/primaryphoneline1, /form/primaryphoneline2, and /form/primaryphoneline3.
For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named primaryphoneline1, primaryphoneline2, and primaryphoneline3, the phone number field identifiers are primaryphoneline1, primaryphoneline2, and primaryphoneline3.
The name of a field in the request payload that contains part or all of your customer's primary phone number.
This data type is used in the RequestInspectionACFP data type.
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The version of the named managed rule group that you'd like your customers to choose, from among your version offerings.
" + }, + "VersionsToPublish":{ + "shape":"VersionsToPublish", + "documentation":"The versions of the named managed rule group that you want to offer to your customers.
" + } + } + }, + "PutManagedRuleSetVersionsResponse":{ + "type":"structure", + "members":{ + "NextLockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
" + }, + "Policy":{ + "shape":"PolicyString", + "documentation":"The policy to attach to the specified rule group.
The policy specifications must conform to the following:
The policy must be composed using IAM Policy version 2012-10-17.
The policy must include specifications for Effect, Action, and Principal.
Effect must specify Allow.
Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. WAF rejects any extra actions or wildcard actions in the policy.
The policy must not include a Resource parameter.
For more information, see IAM Policies.
" + } + } + }, + "PutPermissionPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "QueryString":{ + "type":"structure", + "members":{ + }, + "documentation":"Inspect the query string of the web request. This is the part of a URL that appears after a ? character, if any.
This is used in the FieldToMatch specification for some web request component types.
JSON specification: \"QueryString\": {}
The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. If the rate-based statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.
Examples:
If you aggregate on just the IP address, this is the limit on requests from any single IP address.
If you aggregate on the HTTP method and the query argument name \"city\", then this is the limit on requests for any single method, city pair.
The amount of time, in seconds, that WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60, 120, 300, and 600.
This setting doesn't determine how often WAF checks the rate, but how far back it looks each time it checks. WAF checks the rate about every 10 seconds.
Default: 300 (5 minutes)
Setting that indicates how to aggregate the request counts.
Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.
CONSTANT - Count and limit the requests that match the rate-based rule's scope-down statement. With this option, the counted requests aren't further aggregated. The scope-down statement is the only specification used. When the count of all requests that satisfy the scope-down statement goes over the limit, WAF applies the rule action to all requests that satisfy the scope-down statement.
With this option, you must configure the ScopeDownStatement property.
CUSTOM_KEYS - Aggregate the request counts using one or more web request components as the aggregate keys.
With this option, you must specify the aggregate keys in the CustomKeys property.
To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate key type to IP or FORWARDED_IP.
FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header.
With this option, you must specify the header to use in the ForwardedIPConfig property.
To aggregate on a combination of the forwarded IP address with other aggregate keys, use CUSTOM_KEYS.
IP - Aggregate the request counts on the IP address from the web request origin.
To aggregate on a combination of the IP address with other aggregate keys, use CUSTOM_KEYS.
An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate-based rule only tracks and rate limits requests that match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
" + }, + "ForwardedIPConfig":{ + "shape":"ForwardedIPConfig", + "documentation":"The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
This is required if you specify a forwarded IP in the rule's aggregate key settings.
" + }, + "CustomKeys":{ + "shape":"RateBasedStatementCustomKeys", + "documentation":"Specifies the aggregate keys to use in a rate-base rule.
" + } + }, + "documentation":"A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.
If you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.
You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.
Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.
For example, assume the rule evaluates web requests with the following IP address and HTTP method values:
IP address 10.1.1.1, HTTP method POST
IP address 10.1.1.1, HTTP method GET
IP address 127.0.0.0, HTTP method POST
IP address 10.1.1.1, HTTP method GET
The rule would create different aggregation instances according to your aggregation criteria, for example:
If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1: count 3
IP address 127.0.0.0: count 1
If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:
HTTP method POST: count 2
HTTP method GET: count 2
If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1, HTTP method POST: count 1
IP address 10.1.1.1, HTTP method GET: count 2
IP address 127.0.0.0, HTTP method POST: count 1
For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.
You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.
For additional information about the options, see Rate limiting web requests using rate-based rules in the WAF Developer Guide.
If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available for other aggregation configurations.
WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.
" + }, + "RateBasedStatementAggregateKeyType":{ + "type":"string", + "enum":[ + "IP", + "FORWARDED_IP", + "CUSTOM_KEYS", + "CONSTANT" + ] + }, + "RateBasedStatementCustomKey":{ + "type":"structure", + "members":{ + "Header":{ + "shape":"RateLimitHeader", + "documentation":"Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.
" + }, + "Cookie":{ + "shape":"RateLimitCookie", + "documentation":"Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.
" + }, + "QueryArgument":{ + "shape":"RateLimitQueryArgument", + "documentation":"Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.
" + }, + "QueryString":{ + "shape":"RateLimitQueryString", + "documentation":"Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.
" + }, + "HTTPMethod":{ + "shape":"RateLimitHTTPMethod", + "documentation":"Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.
" + }, + "ForwardedIP":{ + "shape":"RateLimitForwardedIP", + "documentation":"Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType.
With this option, you must specify the header to use in the rate-based rule's ForwardedIPConfig property.
Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying IP in your rate-based statement's AggregateKeyType.
Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.
This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.
For information about label namespaces and names, see Label syntax and naming requirements in the WAF Developer Guide.
" + }, + "UriPath":{ + "shape":"RateLimitUriPath", + "documentation":"Use the request's URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.
" + } + }, + "documentation":"Specifies a single custom aggregate key for a rate-base rule.
Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.
The version of the IP addresses, either IPV4 or IPV6.
The IP addresses that are currently blocked.
" + } + }, + "documentation":"The set of IP addresses that are currently blocked for a RateBasedStatement. This is only available for rate-based rules that aggregate on just the IP address, with the AggregateKeyType set to IP or FORWARDED_IP.
A rate-based rule applies its rule action to requests from IP addresses that are in the rule's managed keys list and that match the rule's scope-down statement. When a rule has no scope-down statement, it applies the action to all requests from the IP addresses that are in the list. The rule applies its rule action to rate limit the matching requests. The action is usually Block but it can be any valid rule action except for Allow.
The maximum number of IP addresses that can be rate limited by a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, WAF limits those with the highest rates.
" + }, + "RateLimit":{ + "type":"long", + "max":2000000000, + "min":10 + }, + "RateLimitCookie":{ + "type":"structure", + "required":[ + "Name", + "TextTransformations" + ], + "members":{ + "Name":{ + "shape":"FieldToMatchData", + "documentation":"The name of the cookie to use.
" + }, + "TextTransformations":{ + "shape":"TextTransformations", + "documentation":"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.
Specifies a cookie as an aggregate key for a rate-based rule. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.
" + }, + "RateLimitForwardedIP":{ + "type":"structure", + "members":{ + }, + "documentation":"Specifies the first IP address in an HTTP header as an aggregate key for a rate-based rule. Each distinct forwarded IP address contributes to the aggregation instance.
This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement. When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType.
This data type supports using the forwarded IP address in the web request aggregation for a rate-based rule, in RateBasedStatementCustomKey. The JSON specification for using the forwarded IP address doesn't explicitly use this data type.
JSON specification: \"ForwardedIP\": {}
When you use this specification, you must also configure the forwarded IP address in the rate-based statement's ForwardedIPConfig.
Specifies the request's HTTP method as an aggregate key for a rate-based rule. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.
JSON specification: \"RateLimitHTTPMethod\": {}
The name of the header to use.
" + }, + "TextTransformations":{ + "shape":"TextTransformations", + "documentation":"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.
Specifies a header as an aggregate key for a rate-based rule. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.
" + }, + "RateLimitIP":{ + "type":"structure", + "members":{ + }, + "documentation":"Specifies the IP address in the web request as an aggregate key for a rate-based rule. Each distinct IP address contributes to the aggregation instance.
This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement. To use this in the custom key settings, you must specify at least one other key to use, along with the IP address. To aggregate on only the IP address, in your rate-based statement's AggregateKeyType, specify IP.
JSON specification: \"RateLimitIP\": {}
The namespace to use for aggregation.
" + } + }, + "documentation":"Specifies a label namespace to use as an aggregate key for a rate-based rule. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.
This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.
For information about label namespaces and names, see Label syntax and naming requirements in the WAF Developer Guide.
" + }, + "RateLimitQueryArgument":{ + "type":"structure", + "required":[ + "Name", + "TextTransformations" + ], + "members":{ + "Name":{ + "shape":"FieldToMatchData", + "documentation":"The name of the query argument to use.
" + }, + "TextTransformations":{ + "shape":"TextTransformations", + "documentation":"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.
Specifies a query argument in the request as an aggregate key for a rate-based rule. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.
" + }, + "RateLimitQueryString":{ + "type":"structure", + "required":["TextTransformations"], + "members":{ + "TextTransformations":{ + "shape":"TextTransformations", + "documentation":"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.
Specifies the request's query string as an aggregate key for a rate-based rule. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.
" + }, + "RateLimitUriPath":{ + "type":"structure", + "required":["TextTransformations"], + "members":{ + "TextTransformations":{ + "shape":"TextTransformations", + "documentation":"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.
Specifies the request's URI path as an aggregate key for a rate-based rule. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.
" + }, + "RedactedFields":{ + "type":"list", + "member":{"shape":"FieldToMatch"}, + "max":100 + }, + "Regex":{ + "type":"structure", + "members":{ + "RegexString":{ + "shape":"RegexPatternString", + "documentation":"The string representing the regular expression.
" + } + }, + "documentation":"A single regular expression. This is used in a RegexPatternSet.
" + }, + "RegexMatchStatement":{ + "type":"structure", + "required":[ + "RegexString", + "FieldToMatch", + "TextTransformations" + ], + "members":{ + "RegexString":{ + "shape":"RegexPatternString", + "documentation":"The string representing the regular expression.
" + }, + "FieldToMatch":{ + "shape":"FieldToMatch", + "documentation":"The part of the web request that you want WAF to inspect.
" + }, + "TextTransformations":{ + "shape":"TextTransformations", + "documentation":"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.
A rule statement used to search web request components for a match against a single regular expression.
" + }, + "RegexPatternSet":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"The name of the set. You cannot change the name after you create the set.
" + }, + "Id":{ + "shape":"EntityId", + "documentation":"A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "ARN":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the entity.
" + }, + "Description":{ + "shape":"EntityDescription", + "documentation":"A description of the set that helps with identification.
" + }, + "RegularExpressionList":{ + "shape":"RegularExpressionList", + "documentation":"The regular expression patterns in the set.
" + } + }, + "documentation":"Contains one or more regular expressions.
WAF assigns an ARN to each RegexPatternSet that you create. To use a set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
" + }, + "FieldToMatch":{ + "shape":"FieldToMatch", + "documentation":"The part of the web request that you want WAF to inspect.
" + }, + "TextTransformations":{ + "shape":"TextTransformations", + "documentation":"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.
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
Each regex pattern set rule statement references a regex pattern 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.
" + }, + "RegexPatternSetSummaries":{ + "type":"list", + "member":{"shape":"RegexPatternSetSummary"} + }, + "RegexPatternSetSummary":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"The name of the data type instance. You cannot change the name after you create the instance.
" + }, + "Id":{ + "shape":"EntityId", + "documentation":"A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "Description":{ + "shape":"EntityDescription", + "documentation":"A description of the set that helps with identification.
" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The Amazon Resource Name (ARN) of the entity.
" + } + }, + "documentation":"High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.
The release version.
" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of the release.
" + } + }, + "documentation":"High level information for an SDK release.
" + }, + "RequestBody":{ + "type":"map", + "key":{"shape":"AssociatedResourceType"}, + "value":{"shape":"RequestBodyAssociatedResourceTypeConfig"} + }, + "RequestBodyAssociatedResourceTypeConfig":{ + "type":"structure", + "required":["DefaultSizeInspectionLimit"], + "members":{ + "DefaultSizeInspectionLimit":{ + "shape":"SizeInspectionLimit", + "documentation":"Specifies the maximum size of the web request body component that an associated CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resource should send to WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.
Default: 16 KB (16,384 bytes)
Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
Example JSON: { \"API_GATEWAY\": \"KB_48\", \"APP_RUNNER_SERVICE\": \"KB_32\" }
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
This is used in the AssociationConfig of the web ACL.
The payload type for your login endpoint, either JSON or form encoded.
" + }, + "UsernameField":{ + "shape":"UsernameField", + "documentation":"The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload { \"form\": { \"username\": \"THE_USERNAME\" } }, the username field specification is /form/username.
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named username1, the username field specification is username1
The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload { \"form\": { \"password\": \"THE_PASSWORD\" } }, the password field specification is /form/password.
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named password1, the password field specification is password1.
The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
This is part of the AWSManagedRulesATPRuleSet configuration in ManagedRuleGroupConfig.
In these settings, you specify how your application accepts login attempts by providing the request payload type and the names of the fields within the request body where the username and password are provided.
" + }, + "RequestInspectionACFP":{ + "type":"structure", + "required":["PayloadType"], + "members":{ + "PayloadType":{ + "shape":"PayloadType", + "documentation":"The payload type for your account creation endpoint, either JSON or form encoded.
" + }, + "UsernameField":{ + "shape":"UsernameField", + "documentation":"The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload { \"form\": { \"username\": \"THE_USERNAME\" } }, the username field specification is /form/username.
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named username1, the username field specification is username1
The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload { \"form\": { \"password\": \"THE_PASSWORD\" } }, the password field specification is /form/password.
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named password1, the password field specification is password1.
The name of the field in the request payload that contains your customer's email.
How you specify this depends on the request inspection payload type.
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload { \"form\": { \"email\": \"THE_EMAIL\" } }, the email field specification is /form/email.
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named email1, the email field specification is email1.
The names of the fields in the request payload that contain your customer's primary phone number.
Order the phone number fields in the array exactly as they are ordered in the request payload.
How you specify the phone number fields depends on the request inspection payload type.
For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload { \"form\": { \"primaryphoneline1\": \"THE_PHONE1\", \"primaryphoneline2\": \"THE_PHONE2\", \"primaryphoneline3\": \"THE_PHONE3\" } }, the phone number field identifiers are /form/primaryphoneline1, /form/primaryphoneline2, and /form/primaryphoneline3.
For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named primaryphoneline1, primaryphoneline2, and primaryphoneline3, the phone number field identifiers are primaryphoneline1, primaryphoneline2, and primaryphoneline3.
The names of the fields in the request payload that contain your customer's primary physical address.
Order the address fields in the array exactly as they are ordered in the request payload.
How you specify the address fields depends on the request inspection payload type.
For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload { \"form\": { \"primaryaddressline1\": \"THE_ADDRESS1\", \"primaryaddressline2\": \"THE_ADDRESS2\", \"primaryaddressline3\": \"THE_ADDRESS3\" } }, the address field idenfiers are /form/primaryaddressline1, /form/primaryaddressline2, and /form/primaryaddressline3.
For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named primaryaddressline1, primaryaddressline2, and primaryaddressline3, the address fields identifiers are primaryaddressline1, primaryaddressline2, and primaryaddressline3.
The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
This is part of the AWSManagedRulesACFPRuleSet configuration in ManagedRuleGroupConfig.
In these settings, you specify how your application accepts account creation attempts by providing the request payload type and the names of the fields within the request body where the username, password, email, and primary address and phone number fields are provided.
" + }, + "ResourceArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":".*\\S.*" + }, + "ResourceArns":{ + "type":"list", + "member":{"shape":"ResourceArn"} + }, + "ResourceType":{ + "type":"string", + "enum":[ + "APPLICATION_LOAD_BALANCER", + "API_GATEWAY", + "APPSYNC", + "COGNITO_USER_POOL", + "APP_RUNNER_SERVICE", + "VERIFIED_ACCESS_INSTANCE" + ] + }, + "ResponseCode":{"type":"integer"}, + "ResponseContent":{ + "type":"string", + "max":10240, + "min":1, + "pattern":"[\\s\\S]*" + }, + "ResponseContentType":{ + "type":"string", + "enum":[ + "TEXT_PLAIN", + "TEXT_HTML", + "APPLICATION_JSON" + ] + }, + "ResponseInspection":{ + "type":"structure", + "members":{ + "StatusCode":{ + "shape":"ResponseInspectionStatusCode", + "documentation":"Configures inspection of the response status code for success and failure indicators.
" + }, + "Header":{ + "shape":"ResponseInspectionHeader", + "documentation":"Configures inspection of the response header for success and failure indicators.
" + }, + "BodyContains":{ + "shape":"ResponseInspectionBodyContains", + "documentation":"Configures inspection of the response body for success and failure indicators. WAF can inspect the first 65,536 bytes (64 KB) of the response body.
" + }, + "Json":{ + "shape":"ResponseInspectionJson", + "documentation":"Configures inspection of the response JSON for success and failure indicators. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
" + } + }, + "documentation":"The criteria for inspecting responses to login requests and account creation requests, used by the ATP and ACFP rule groups to track login and account creation success and failure rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The rule groups evaluates the responses that your protected resources send back to client login and account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses with too much suspicious activity in a short amount of time.
This is part of the AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet configurations in ManagedRuleGroupConfig.
Enable response inspection by configuring exactly one component of the response to inspect, for example, Header or StatusCode. You can't configure more than one component for inspection. If you don't configure any of the response inspection options, response inspection is disabled.
Strings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON examples: \"SuccessStrings\": [ \"Login successful\" ] and \"SuccessStrings\": [ \"Account creation successful\", \"Welcome to our site!\" ]
Strings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON example: \"FailureStrings\": [ \"Request failed\" ]
Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The name of the header to match against. The name must be an exact match, including case.
JSON example: \"Name\": [ \"RequestResult\" ]
Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples: \"SuccessValues\": [ \"LoginPassed\", \"Successful login\" ] and \"SuccessValues\": [ \"AccountCreated\", \"Successful account creation\" ]
Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples: \"FailureValues\": [ \"LoginFailed\", \"Failed login\" ] and \"FailureValues\": [ \"AccountCreationFailed\" ]
Configures inspection of the response header. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.
JSON examples: \"Identifier\": [ \"/login/success\" ] and \"Identifier\": [ \"/sign-up/success\" ]
Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example: \"SuccessValues\": [ \"True\", \"Succeeded\" ]
Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example: \"FailureValues\": [ \"False\", \"Failed\" ]
Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example: \"SuccessCodes\": [ 200, 201 ]
Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example: \"FailureCodes\": [ 400, 404 ]
Configures inspection of the response status code. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The name of the rule.
If you change the name of a Rule after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule's VisibilityConfig settings. WAF doesn't automatically update the metric name when you update the rule name.
If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
" + }, + "Action":{ + "shape":"RuleAction", + "documentation":"The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.
This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.
You must specify either this Action setting or the rule OverrideAction setting, but not both:
If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.
If the rule statement references a rule group, use the override action setting and not this action setting.
The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.
Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.
For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
Separate each component of the label with a colon.
Each namespace or name can have up to 128 characters.
You can specify up to 5 namespaces in a label.
Don't use the following reserved words in your label specification: aws, waf, managed, rulegroup, webacl, regexpatternset, or ipset.
For example, myLabelName or nameSpace1:nameSpace2:myLabelName.
Defines and enables Amazon CloudWatch metrics and web request sample collection.
If you change the name of a Rule after you create it and you want the rule's metric name to reflect the change, update the metric name as well. WAF doesn't automatically update the metric name.
Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.
Specifies how WAF should handle Challenge evaluations. If you don't specify this, WAF uses the challenge configuration that's defined for the web ACL.
A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to manage in some way. Each rule includes one top-level Statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
" + }, + "RuleAction":{ + "type":"structure", + "members":{ + "Block":{ + "shape":"BlockAction", + "documentation":"Instructs WAF to block the web request.
" + }, + "Allow":{ + "shape":"AllowAction", + "documentation":"Instructs WAF to allow the web request.
" + }, + "Count":{ + "shape":"CountAction", + "documentation":"Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
" + }, + "Captcha":{ + "shape":"CaptchaAction", + "documentation":"Instructs WAF to run a CAPTCHA check against the web request.
Instructs WAF to run a Challenge check against the web request.
The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.
" + }, + "RuleActionOverride":{ + "type":"structure", + "required":[ + "Name", + "ActionToUse" + ], + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"The name of the rule to override.
" + }, + "ActionToUse":{ + "shape":"RuleAction", + "documentation":"The override action to use, in place of the configured action of the rule in the rule group.
" + } + }, + "documentation":"Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.
You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.
The name of the rule group. You cannot change the name of a rule group after you create it.
" + }, + "Id":{ + "shape":"EntityId", + "documentation":"A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "Capacity":{ + "shape":"CapacityUnit", + "documentation":"The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
" + }, + "ARN":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the entity.
" + }, + "Description":{ + "shape":"EntityDescription", + "documentation":"A description of the rule group that helps with identification.
" + }, + "Rules":{ + "shape":"Rules", + "documentation":"The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
" + }, + "VisibilityConfig":{ + "shape":"VisibilityConfig", + "documentation":"Defines and enables Amazon CloudWatch metrics and web request sample collection.
" + }, + "LabelNamespace":{ + "shape":"LabelName", + "documentation":"The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
The syntax for the label namespace prefix for your rule groups is the following:
awswaf:<account ID>:rulegroup:<rule group name>:
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
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.
" + }, + "AvailableLabels":{ + "shape":"LabelSummaries", + "documentation":"The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.
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.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
" + }, + "RuleGroupReferenceStatement":{ + "type":"structure", + "required":["ARN"], + "members":{ + "ARN":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the entity.
" + }, + "ExcludedRules":{ + "shape":"ExcludedRules", + "documentation":"Rules in the referenced rule group whose actions are set to Count.
Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.
Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.
You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.
The name of the data type instance. You cannot change the name after you create the instance.
" + }, + "Id":{ + "shape":"EntityId", + "documentation":"A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "Description":{ + "shape":"EntityDescription", + "documentation":"A description of the rule group that helps with identification.
" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The Amazon Resource Name (ARN) of the entity.
" + } + }, + "documentation":"High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.
The name of the rule.
" + }, + "Action":{ + "shape":"RuleAction", + "documentation":"The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.
" + } + }, + "documentation":"High-level information about a Rule, returned by operations like DescribeManagedRuleGroup. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.
A complex type that contains detailed information about the request.
" + }, + "Weight":{ + "shape":"SampleWeight", + "documentation":"A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1.
The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).
" + }, + "Action":{ + "shape":"Action", + "documentation":"The action that WAF applied to the request.
" + }, + "RuleNameWithinRuleGroup":{ + "shape":"EntityName", + "documentation":"The name of the Rule that the request matched. For managed rule groups, the format for this name is <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the format for this name is <rule group name>#<rule name>. If the rule is not in a rule group, this field is absent.
Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
" + }, + "ResponseCodeSent":{ + "shape":"ResponseStatusCode", + "documentation":"The response code that was sent for the request.
" + }, + "Labels":{ + "shape":"Labels", + "documentation":"Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
The CAPTCHA response for the request.
The Challenge response for the request.
Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.
Represents a single sampled web request. The response from GetSampledRequests includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains an array of SampledHTTPRequest objects.
The name of the query header to inspect.
" + } + }, + "documentation":"Inspect one of the headers in the web request, identified by name, for example, User-Agent or Referer. The name isn't case sensitive.
You can filter and inspect all headers with the FieldToMatch setting Headers.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }
The name of the query argument to inspect.
" + } + }, + "documentation":"Inspect one query argument in the web request, identified by name, for example UserName or SalesRegion. The name isn't case sensitive.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }
The part of the web request that you want WAF to inspect.
" + }, + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"The operator to use to compare the request part to the size setting.
" + }, + "Size":{ + "shape":"Size", + "documentation":"The size, in byte, to compare to the request part, after any transformations.
" + }, + "TextTransformations":{ + "shape":"TextTransformations", + "documentation":"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.
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure WAF to inspect the request body, WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see Body and JsonBody settings for the FieldToMatch data type.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
The part of the web request that you want WAF to inspect.
" + }, + "TextTransformations":{ + "shape":"TextTransformations", + "documentation":"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.
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
A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.
" + }, + "Statement":{ + "type":"structure", + "members":{ + "ByteMatchStatement":{ + "shape":"ByteMatchStatement", + "documentation":"A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.
" + }, + "SqliMatchStatement":{ + "shape":"SqliMatchStatement", + "documentation":"A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.
" + }, + "XssMatchStatement":{ + "shape":"XssMatchStatement", + "documentation":"A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.
" + }, + "SizeConstraintStatement":{ + "shape":"SizeConstraintStatement", + "documentation":"A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure WAF to inspect the request body, WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see Body and JsonBody settings for the FieldToMatch data type.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.
To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the CountryCodes array.
Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.
If you use the web request origin, the label formats are awswaf:clientip:geo:region:<ISO country code>-<ISO region code> and awswaf:clientip:geo:country:<ISO country code>.
If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code> and awswaf:forwardedip:geo:country:<ISO country code>.
For additional details, see Geographic match rule statement in the WAF Developer Guide.
" + }, + "RuleGroupReferenceStatement":{ + "shape":"RuleGroupReferenceStatement", + "documentation":"A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.
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.
" + }, + "RegexPatternSetReferenceStatement":{ + "shape":"RegexPatternSetReferenceStatement", + "documentation":"A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
Each regex pattern set rule statement references a regex pattern 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.
" + }, + "RateBasedStatement":{ + "shape":"RateBasedStatement", + "documentation":"A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.
If you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.
You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.
Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.
For example, assume the rule evaluates web requests with the following IP address and HTTP method values:
IP address 10.1.1.1, HTTP method POST
IP address 10.1.1.1, HTTP method GET
IP address 127.0.0.0, HTTP method POST
IP address 10.1.1.1, HTTP method GET
The rule would create different aggregation instances according to your aggregation criteria, for example:
If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1: count 3
IP address 127.0.0.0: count 1
If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:
HTTP method POST: count 2
HTTP method GET: count 2
If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1, HTTP method POST: count 1
IP address 10.1.1.1, HTTP method GET: count 2
IP address 127.0.0.0, HTTP method POST: count 1
For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.
You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.
For additional information about the options, see Rate limiting web requests using rate-based rules in the WAF Developer Guide.
If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available for other aggregation configurations.
WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.
" + }, + "AndStatement":{ + "shape":"AndStatement", + "documentation":"A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.
A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.
A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. You cannot use a managed rule group inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you define in a web ACL.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.
A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.
The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.
" + }, + "RegexMatchStatement":{ + "shape":"RegexMatchStatement", + "documentation":"A rule statement used to search web request components for a match against a single regular expression.
" + } + }, + "documentation":"The processing guidance for a Rule, used by WAF to determine whether a web request matches the rule.
For example specifications, see the examples section of CreateWebACL.
" + }, + "Statements":{ + "type":"list", + "member":{"shape":"Statement"} + }, + "String":{"type":"string"}, + "SuccessCode":{ + "type":"integer", + "max":999, + "min":0 + }, + "SuccessValue":{ + "type":"string", + "max":100, + "min":1, + "pattern":".*\\S.*" + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.
" + } + }, + "documentation":"A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
" + }, + "TagInfoForResource":{ + "type":"structure", + "members":{ + "ResourceARN":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the resource.
" + }, + "TagList":{ + "shape":"TagList", + "documentation":"The array of Tag objects defined for the resource.
" + } + }, + "documentation":"The collection of tagging definitions for an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the resource.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of key:value pairs to associate with the resource.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TextTransformation":{ + "type":"structure", + "required":[ + "Priority", + "Type" + ], + "members":{ + "Priority":{ + "shape":"TextTransformationPriority", + "documentation":"Sets the relative processing order for multiple transformations. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
" + }, + "Type":{ + "shape":"TextTransformationType", + "documentation":"For detailed descriptions of each of the transformation types, see Text transformations in the WAF Developer Guide.
" + } + }, + "documentation":"Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
" + }, + "TextTransformationPriority":{ + "type":"integer", + "min":0 + }, + "TextTransformationType":{ + "type":"string", + "enum":[ + "NONE", + "COMPRESS_WHITE_SPACE", + "HTML_ENTITY_DECODE", + "LOWERCASE", + "CMD_LINE", + "URL_DECODE", + "BASE64_DECODE", + "HEX_DECODE", + "MD5", + "REPLACE_COMMENTS", + "ESCAPE_SEQ_DECODE", + "SQL_HEX_DECODE", + "CSS_DECODE", + "JS_DECODE", + "NORMALIZE_PATH", + "NORMALIZE_PATH_WIN", + "REMOVE_NULLS", + "REPLACE_NULLS", + "BASE64_DECODE_EXT", + "URL_DECODE_UNI", + "UTF8_TO_UNICODE" + ] + }, + "TextTransformations":{ + "type":"list", + "member":{"shape":"TextTransformation"}, + "min":1 + }, + "TimeWindow":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"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.
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.
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.
The Amazon Resource Name (ARN) of the resource.
" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"An array of keys identifying the tags to disassociate from the resource.
" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateIPSetRequest":{ + "type":"structure", + "required":[ + "Name", + "Scope", + "Id", + "Addresses", + "LockToken" + ], + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"The name of the IP set. You cannot change the name of an IPSet after you create it.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "Description":{ + "shape":"EntityDescription", + "documentation":"A description of the IP set that helps with identification.
" + }, + "Addresses":{ + "shape":"IPAddresses", + "documentation":"Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses specifications:
Empty array: \"Addresses\": []
Array with one address: \"Addresses\": [\"192.0.2.44/32\"]
Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]
INVALID specification: \"Addresses\": [\"\"] INVALID
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The version that you want to remove from your list of offerings for the named managed rule group.
" + }, + "ExpiryTimestamp":{ + "shape":"Timestamp", + "documentation":"The time that you want the version to expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".
" + } + } + }, + "UpdateManagedRuleSetVersionExpiryDateResponse":{ + "type":"structure", + "members":{ + "ExpiringVersion":{ + "shape":"VersionKeyString", + "documentation":"The version that is set to expire.
" + }, + "ExpiryTimestamp":{ + "shape":"Timestamp", + "documentation":"The time that the version will expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".
" + }, + "NextLockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The name of the set. You cannot change the name after you create the set.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "Description":{ + "shape":"EntityDescription", + "documentation":"A description of the set that helps with identification.
" + }, + "RegularExpressionList":{ + "shape":"RegularExpressionList", + "documentation":"" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.
The name of the rule group. You cannot change the name of a rule group after you create it.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "Description":{ + "shape":"EntityDescription", + "documentation":"A description of the rule group that helps with identification.
" + }, + "Rules":{ + "shape":"Rules", + "documentation":"The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
" + }, + "VisibilityConfig":{ + "shape":"VisibilityConfig", + "documentation":"Defines and enables Amazon CloudWatch metrics and web request sample collection.
" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
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.
" + } + } + }, + "UpdateRuleGroupResponse":{ + "type":"structure", + "members":{ + "NextLockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.
The name of the web ACL. You cannot change the name of a web ACL after you create it.
" + }, + "Scope":{ + "shape":"Scope", + "documentation":"Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "DefaultAction":{ + "shape":"DefaultAction", + "documentation":"The action to perform if none of the Rules contained in the WebACL match.
A description of the web ACL that helps with identification.
" + }, + "Rules":{ + "shape":"Rules", + "documentation":"The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
" + }, + "VisibilityConfig":{ + "shape":"VisibilityConfig", + "documentation":"Defines and enables Amazon CloudWatch metrics and web request sample collection.
" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
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 web ACL, and then use them in the rules and default actions that you define in the web ACL.
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.
" + }, + "CaptchaConfig":{ + "shape":"CaptchaConfig", + "documentation":"Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.
Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }
Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.
Specifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
" + } + } + }, + "UpdateWebACLResponse":{ + "type":"structure", + "members":{ + "NextLockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.
Inspect the path component of the URI of the web request. This is the part of the web request that identifies a resource. For example, /images/daily-ad.jpg.
This is used in the FieldToMatch specification for some web request component types.
JSON specification: \"UriPath\": {}
The name of the username field.
How you specify this depends on the request inspection payload type.
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload { \"form\": { \"username\": \"THE_USERNAME\" } }, the username field specification is /form/username.
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named username1, the username field specification is username1
The name of the field in the request payload that contains your customer's username.
This data type is used in the RequestInspection and RequestInspectionACFP data types.
The Amazon Resource Name (ARN) of the vendor's rule group that's used in the published managed rule group version.
" + }, + "ForecastedLifetime":{ + "shape":"TimeWindowDay", + "documentation":"The amount of time the vendor expects this version of the managed rule group to last, in days.
" + } + }, + "documentation":"A version of the named managed rule group, that the rule group's vendor publishes for use by customers.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.
For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the WAF Developer Guide.
" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names that are reserved for WAF, for example All and Default_Action.
Defines and enables Amazon CloudWatch metrics and web request sample collection.
" + }, + "WAFAssociatedItemException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
", + "exception":true + }, + "WAFConfigurationWarningException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"The operation failed because you are inspecting the web request body, headers, or cookies without specifying how to handle oversize components. Rules that inspect the body must either provide an OversizeHandling configuration or they must be preceded by a SizeConstraintStatement that blocks the body content from being too large. Rules that inspect the headers or cookies must provide an OversizeHandling configuration.
Provide the handling configuration and retry your operation.
Alternately, you can suppress this warning by adding the following tag to the resource that you provide to this operation: Tag (key:WAF:OversizeFieldsHandlingConstraintOptOut, value:true).
WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
", + "exception":true + }, + "WAFExpiredManagedRuleGroupVersionException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions.
", + "exception":true + }, + "WAFInternalErrorException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
", + "exception":true, + "fault":true + }, + "WAFInvalidOperationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"The operation isn't valid.
", + "exception":true + }, + "WAFInvalidParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "Field":{ + "shape":"ParameterExceptionField", + "documentation":"The settings where the invalid parameter was found.
" + }, + "Parameter":{ + "shape":"ParameterExceptionParameter", + "documentation":"The invalid parameter that resulted in the exception.
" + }, + "Reason":{ + "shape":"ErrorReason", + "documentation":"Additional information about the exception.
" + } + }, + "documentation":"The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
The operation failed because the specified policy isn't in the proper format.
The policy specifications must conform to the following:
The policy must be composed using IAM Policy version 2012-10-17.
The policy must include specifications for Effect, Action, and Principal.
Effect must specify Allow.
Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. WAF rejects any extra actions or wildcard actions in the policy.
The policy must not include a Resource parameter.
For more information, see IAM Policies.
", + "exception":true + }, + "WAFInvalidResourceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
", + "exception":true + }, + "WAFLimitsExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "SourceType":{ + "shape":"SourceType", + "documentation":"Source type for the exception.
" + } + }, + "documentation":"WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
The operation failed because you don't have the permissions that your logging configuration requires. For information, see Logging web ACL traffic information in the WAF Developer Guide.
", + "exception":true + }, + "WAFNonexistentItemException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
", + "exception":true + }, + "WAFOptimisticLockException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
", + "exception":true + }, + "WAFServiceLinkedRoleErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a call to DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.
You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
", + "exception":true + }, + "WAFTagOperationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"An error occurred during the tagging operation. Retry your request.
", + "exception":true + }, + "WAFTagOperationInternalErrorException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
", + "exception":true, + "fault":true + }, + "WAFUnavailableEntityException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
", + "exception":true + }, + "WAFUnsupportedAggregateKeyTypeException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"The rule that you've named doesn't aggregate solely on the IP address or solely on the forwarded IP address. This call is only available for rate-based rules with an AggregateKeyType setting of IP or FORWARDED_IP.
The name of the web ACL. You cannot change the name of a web ACL after you create it.
" + }, + "Id":{ + "shape":"EntityId", + "documentation":"A unique identifier for the WebACL. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL.
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
" + }, + "DefaultAction":{ + "shape":"DefaultAction", + "documentation":"The action to perform if none of the Rules contained in the WebACL match.
A description of the web ACL that helps with identification.
" + }, + "Rules":{ + "shape":"Rules", + "documentation":"The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
" + }, + "VisibilityConfig":{ + "shape":"VisibilityConfig", + "documentation":"Defines and enables Amazon CloudWatch metrics and web request sample collection.
" + }, + "Capacity":{ + "shape":"ConsumedCapacity", + "documentation":"The web ACL capacity units (WCUs) currently being used by this web ACL.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
" + }, + "PreProcessFirewallManagerRuleGroups":{ + "shape":"FirewallManagerRuleGroups", + "documentation":"The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
" + }, + "PostProcessFirewallManagerRuleGroups":{ + "shape":"FirewallManagerRuleGroups", + "documentation":"The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
" + }, + "ManagedByFirewallManager":{ + "shape":"Boolean", + "documentation":"Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.
" + }, + "LabelNamespace":{ + "shape":"LabelName", + "documentation":"The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
The syntax for the label namespace prefix for a web ACL is the following:
awswaf:<account ID>:webacl:<web ACL name>:
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
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 web ACL, and then use them in the rules and default actions that you define in the web ACL.
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.
" + }, + "CaptchaConfig":{ + "shape":"CaptchaConfig", + "documentation":"Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.
Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
" + }, + "AssociationConfig":{ + "shape":"AssociationConfig", + "documentation":"Specifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
" + } + }, + "documentation":"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 resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
" + }, + "WebACLSummaries":{ + "type":"list", + "member":{"shape":"WebACLSummary"} + }, + "WebACLSummary":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"The name of the web ACL. You cannot change the name of a web ACL after you create it.
" + }, + "Id":{ + "shape":"EntityId", + "documentation":"The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "Description":{ + "shape":"EntityDescription", + "documentation":"A description of the web ACL that helps with identification.
" + }, + "LockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
The Amazon Resource Name (ARN) of the entity.
" + } + }, + "documentation":"High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.
The part of the web request that you want WAF to inspect.
" + }, + "TextTransformations":{ + "shape":"TextTransformations", + "documentation":"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.
A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.
" + } + }, + "documentation":"This is the latest version of the WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like \"V2\" or \"v2\", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.
If you used WAF prior to this release, you can't use this WAFV2 API to access any WAF resources that you created before. You can access your old rules, web ACLs, and other WAF resources only through the WAF Classic APIs. The WAF Classic APIs have retained the prior names, endpoints, and namespaces.
For information, including how to migrate your WAF resources to this version, see the WAF Developer Guide.
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, or Amazon Web Services Verified Access instance. WAF also lets you control access to your content, to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code (Forbidden), or with a custom response.
This API guide is for developers who need detailed information about WAF API actions, data types, and errors. For detailed information about WAF features and guidance for configuring and using WAF, see the WAF Developer Guide.
You can make calls using the endpoints listed in WAF endpoints and quotas.
For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
For Amazon CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
We currently provide two versions of the WAF API: this API and the prior versions, the classic WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:
You use one API for both global and regional applications. Where you need to distinguish the scope, you specify a Scope parameter and set it to CLOUDFRONT or REGIONAL.
You can define a web ACL or rule group with a single call, and update it with a single call. You define all rule specifications in JSON format, and pass them to your rule group or web ACL calls.
The limits WAF places on the use of rules more closely reflects the cost of running each type of rule. Rule groups include capacity settings, so you know the maximum cost of a rule group when you use it.
Associate a lens to a workload.
Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated with a workload.
Disclaimer
By accessing and/or applying custom lenses created by another Amazon Web Services user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the Amazon Web Services Customer Agreement.
Associate a profile with a workload.
" + }, + "CreateLensShare":{ + "name":"CreateLensShare", + "http":{ + "method":"POST", + "requestUri":"/lenses/{LensAlias}/shares" + }, + "input":{"shape":"CreateLensShareInput"}, + "output":{"shape":"CreateLensShareOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Create a lens share.
The owner of a lens can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared.
Shared access to a lens is not removed until the lens invitation is deleted.
If you share a lens with an organization or OU, all accounts in the organization or OU are granted access to the lens.
For more information, see Sharing a custom lens in the Well-Architected Tool User Guide.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
Create a new lens version.
A lens can have up to 100 versions.
Use this operation to publish a new lens version after you have imported a lens. The LensAlias is used to identify the lens to be published. The owner of a lens can share the lens with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a lens can delete it.
Create a milestone for an existing workload.
" + }, + "CreateProfile":{ + "name":"CreateProfile", + "http":{ + "method":"POST", + "requestUri":"/profiles" + }, + "input":{"shape":"CreateProfileInput"}, + "output":{"shape":"CreateProfileOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Create a profile.
" + }, + "CreateProfileShare":{ + "name":"CreateProfileShare", + "http":{ + "method":"POST", + "requestUri":"/profiles/{ProfileArn}/shares" + }, + "input":{"shape":"CreateProfileShareInput"}, + "output":{"shape":"CreateProfileShareOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Create a profile share.
" + }, + "CreateReviewTemplate":{ + "name":"CreateReviewTemplate", + "http":{ + "method":"POST", + "requestUri":"/reviewTemplates" + }, + "input":{"shape":"CreateReviewTemplateInput"}, + "output":{"shape":"CreateReviewTemplateOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Create a review template.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
Create a review template share.
The owner of a review template can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region.
Shared access to a review template is not removed until the review template share invitation is deleted.
If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template.
Disclaimer
By sharing your review template with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your review template available to those other accounts.
Create a new workload.
The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.
For more information, see Defining a Workload in the Well-Architected Tool User Guide.
Either AwsRegions, NonAwsRegions, or both must be specified when creating a workload.
You also must specify ReviewOwner, even though the parameter is listed as not being required in the following section.
When creating a workload using a review template, you must have the following IAM permissions:
wellarchitected:GetReviewTemplate
wellarchitected:GetReviewTemplateAnswer
wellarchitected:ListReviewTemplateAnswers
wellarchitected:GetReviewTemplateLensReview
Create a workload share.
The owner of a workload can share it with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.
If you share a workload with an organization or OU, all accounts in the organization or OU are granted access to the workload.
For more information, see Sharing a workload in the Well-Architected Tool User Guide.
" + }, + "DeleteLens":{ + "name":"DeleteLens", + "http":{ + "method":"DELETE", + "requestUri":"/lenses/{LensAlias}" + }, + "input":{"shape":"DeleteLensInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Delete an existing lens.
Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
Delete a lens share.
After the lens share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
Delete a profile.
Disclaimer
By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account.
Delete a profile share.
" + }, + "DeleteReviewTemplate":{ + "name":"DeleteReviewTemplate", + "http":{ + "method":"DELETE", + "requestUri":"/reviewTemplates/{TemplateArn}" + }, + "input":{"shape":"DeleteReviewTemplateInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Delete a review template.
Only the owner of a review template can delete it.
After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.
" + }, + "DeleteTemplateShare":{ + "name":"DeleteTemplateShare", + "http":{ + "method":"DELETE", + "requestUri":"/templates/shares/{TemplateArn}/{ShareId}" + }, + "input":{"shape":"DeleteTemplateShareInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Delete a review template share.
After the review template share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.
" + }, + "DeleteWorkload":{ + "name":"DeleteWorkload", + "http":{ + "method":"DELETE", + "requestUri":"/workloads/{WorkloadId}" + }, + "input":{"shape":"DeleteWorkloadInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Delete an existing workload.
" + }, + "DeleteWorkloadShare":{ + "name":"DeleteWorkloadShare", + "http":{ + "method":"DELETE", + "requestUri":"/workloads/{WorkloadId}/shares/{ShareId}" + }, + "input":{"shape":"DeleteWorkloadShareInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Delete a workload share.
" + }, + "DisassociateLenses":{ + "name":"DisassociateLenses", + "http":{ + "method":"PATCH", + "requestUri":"/workloads/{WorkloadId}/disassociateLenses" + }, + "input":{"shape":"DisassociateLensesInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Disassociate a lens from a workload.
Up to 10 lenses can be disassociated from a workload in a single API operation.
The Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be removed from a workload.
Disassociate a profile from a workload.
" + }, + "ExportLens":{ + "name":"ExportLens", + "http":{ + "method":"GET", + "requestUri":"/lenses/{LensAlias}/export" + }, + "input":{"shape":"ExportLensInput"}, + "output":{"shape":"ExportLensOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Export an existing lens.
Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be exported.
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
Get the answer to a specific question in a workload review.
" + }, + "GetConsolidatedReport":{ + "name":"GetConsolidatedReport", + "http":{ + "method":"GET", + "requestUri":"/consolidatedReport" + }, + "input":{"shape":"GetConsolidatedReportInput"}, + "output":{"shape":"GetConsolidatedReportOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"} + ], + "documentation":"Get a consolidated report of your workloads.
You can optionally choose to include workloads that have been shared with you.
" + }, + "GetGlobalSettings":{ + "name":"GetGlobalSettings", + "http":{ + "method":"GET", + "requestUri":"/global-settings" + }, + "output":{"shape":"GetGlobalSettingsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Global settings for all workloads.
" + }, + "GetLens":{ + "name":"GetLens", + "http":{ + "method":"GET", + "requestUri":"/lenses/{LensAlias}" + }, + "input":{"shape":"GetLensInput"}, + "output":{"shape":"GetLensOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get an existing lens.
" + }, + "GetLensReview":{ + "name":"GetLensReview", + "http":{ + "method":"GET", + "requestUri":"/workloads/{WorkloadId}/lensReviews/{LensAlias}" + }, + "input":{"shape":"GetLensReviewInput"}, + "output":{"shape":"GetLensReviewOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get lens review.
" + }, + "GetLensReviewReport":{ + "name":"GetLensReviewReport", + "http":{ + "method":"GET", + "requestUri":"/workloads/{WorkloadId}/lensReviews/{LensAlias}/report" + }, + "input":{"shape":"GetLensReviewReportInput"}, + "output":{"shape":"GetLensReviewReportOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get lens review report.
" + }, + "GetLensVersionDifference":{ + "name":"GetLensVersionDifference", + "http":{ + "method":"GET", + "requestUri":"/lenses/{LensAlias}/versionDifference" + }, + "input":{"shape":"GetLensVersionDifferenceInput"}, + "output":{"shape":"GetLensVersionDifferenceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get lens version differences.
" + }, + "GetMilestone":{ + "name":"GetMilestone", + "http":{ + "method":"GET", + "requestUri":"/workloads/{WorkloadId}/milestones/{MilestoneNumber}" + }, + "input":{"shape":"GetMilestoneInput"}, + "output":{"shape":"GetMilestoneOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get a milestone for an existing workload.
" + }, + "GetProfile":{ + "name":"GetProfile", + "http":{ + "method":"GET", + "requestUri":"/profiles/{ProfileArn}" + }, + "input":{"shape":"GetProfileInput"}, + "output":{"shape":"GetProfileOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get profile information.
" + }, + "GetProfileTemplate":{ + "name":"GetProfileTemplate", + "http":{ + "method":"GET", + "requestUri":"/profileTemplate" + }, + "input":{"shape":"GetProfileTemplateInput"}, + "output":{"shape":"GetProfileTemplateOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get profile template.
" + }, + "GetReviewTemplate":{ + "name":"GetReviewTemplate", + "http":{ + "method":"GET", + "requestUri":"/reviewTemplates/{TemplateArn}" + }, + "input":{"shape":"GetReviewTemplateInput"}, + "output":{"shape":"GetReviewTemplateOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get review template.
" + }, + "GetReviewTemplateAnswer":{ + "name":"GetReviewTemplateAnswer", + "http":{ + "method":"GET", + "requestUri":"/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId}" + }, + "input":{"shape":"GetReviewTemplateAnswerInput"}, + "output":{"shape":"GetReviewTemplateAnswerOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get review template answer.
" + }, + "GetReviewTemplateLensReview":{ + "name":"GetReviewTemplateLensReview", + "http":{ + "method":"GET", + "requestUri":"/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}" + }, + "input":{"shape":"GetReviewTemplateLensReviewInput"}, + "output":{"shape":"GetReviewTemplateLensReviewOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get a lens review associated with a review template.
" + }, + "GetWorkload":{ + "name":"GetWorkload", + "http":{ + "method":"GET", + "requestUri":"/workloads/{WorkloadId}" + }, + "input":{"shape":"GetWorkloadInput"}, + "output":{"shape":"GetWorkloadOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Get an existing workload.
" + }, + "ImportLens":{ + "name":"ImportLens", + "http":{ + "method":"PUT", + "requestUri":"/importLens" + }, + "input":{"shape":"ImportLensInput"}, + "output":{"shape":"ImportLensOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Import a new custom lens or update an existing custom lens.
To update an existing custom lens, specify its ARN as the LensAlias. If no ARN is specified, a new custom lens is created.
The new or updated lens will have a status of DRAFT. The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with CreateLensVersion.
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.
A custom lens cannot exceed 500 KB in size.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
List of answers for a particular workload and lens.
" + }, + "ListCheckDetails":{ + "name":"ListCheckDetails", + "http":{ + "method":"POST", + "requestUri":"/workloads/{WorkloadId}/checks" + }, + "input":{"shape":"ListCheckDetailsInput"}, + "output":{"shape":"ListCheckDetailsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List of Trusted Advisor check details by account related to the workload.
" + }, + "ListCheckSummaries":{ + "name":"ListCheckSummaries", + "http":{ + "method":"POST", + "requestUri":"/workloads/{WorkloadId}/checkSummaries" + }, + "input":{"shape":"ListCheckSummariesInput"}, + "output":{"shape":"ListCheckSummariesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List of Trusted Advisor checks summarized for all accounts related to the workload.
" + }, + "ListLensReviewImprovements":{ + "name":"ListLensReviewImprovements", + "http":{ + "method":"GET", + "requestUri":"/workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements" + }, + "input":{"shape":"ListLensReviewImprovementsInput"}, + "output":{"shape":"ListLensReviewImprovementsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List the improvements of a particular lens review.
" + }, + "ListLensReviews":{ + "name":"ListLensReviews", + "http":{ + "method":"GET", + "requestUri":"/workloads/{WorkloadId}/lensReviews" + }, + "input":{"shape":"ListLensReviewsInput"}, + "output":{"shape":"ListLensReviewsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List lens reviews for a particular workload.
" + }, + "ListLensShares":{ + "name":"ListLensShares", + "http":{ + "method":"GET", + "requestUri":"/lenses/{LensAlias}/shares" + }, + "input":{"shape":"ListLensSharesInput"}, + "output":{"shape":"ListLensSharesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List the lens shares associated with the lens.
" + }, + "ListLenses":{ + "name":"ListLenses", + "http":{ + "method":"GET", + "requestUri":"/lenses" + }, + "input":{"shape":"ListLensesInput"}, + "output":{"shape":"ListLensesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List the available lenses.
" + }, + "ListMilestones":{ + "name":"ListMilestones", + "http":{ + "method":"POST", + "requestUri":"/workloads/{WorkloadId}/milestonesSummaries" + }, + "input":{"shape":"ListMilestonesInput"}, + "output":{"shape":"ListMilestonesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List all milestones for an existing workload.
" + }, + "ListNotifications":{ + "name":"ListNotifications", + "http":{ + "method":"POST", + "requestUri":"/notifications" + }, + "input":{"shape":"ListNotificationsInput"}, + "output":{"shape":"ListNotificationsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List lens notifications.
" + }, + "ListProfileNotifications":{ + "name":"ListProfileNotifications", + "http":{ + "method":"GET", + "requestUri":"/profileNotifications/" + }, + "input":{"shape":"ListProfileNotificationsInput"}, + "output":{"shape":"ListProfileNotificationsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List profile notifications.
" + }, + "ListProfileShares":{ + "name":"ListProfileShares", + "http":{ + "method":"GET", + "requestUri":"/profiles/{ProfileArn}/shares" + }, + "input":{"shape":"ListProfileSharesInput"}, + "output":{"shape":"ListProfileSharesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List profile shares.
" + }, + "ListProfiles":{ + "name":"ListProfiles", + "http":{ + "method":"GET", + "requestUri":"/profileSummaries" + }, + "input":{"shape":"ListProfilesInput"}, + "output":{"shape":"ListProfilesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List profiles.
" + }, + "ListReviewTemplateAnswers":{ + "name":"ListReviewTemplateAnswers", + "http":{ + "method":"GET", + "requestUri":"/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers" + }, + "input":{"shape":"ListReviewTemplateAnswersInput"}, + "output":{"shape":"ListReviewTemplateAnswersOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List the answers of a review template.
" + }, + "ListReviewTemplates":{ + "name":"ListReviewTemplates", + "http":{ + "method":"GET", + "requestUri":"/reviewTemplates" + }, + "input":{"shape":"ListReviewTemplatesInput"}, + "output":{"shape":"ListReviewTemplatesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List review templates.
" + }, + "ListShareInvitations":{ + "name":"ListShareInvitations", + "http":{ + "method":"GET", + "requestUri":"/shareInvitations" + }, + "input":{"shape":"ListShareInvitationsInput"}, + "output":{"shape":"ListShareInvitationsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List the share invitations.
WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType.
List the tags for a resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
List review template shares.
" + }, + "ListWorkloadShares":{ + "name":"ListWorkloadShares", + "http":{ + "method":"GET", + "requestUri":"/workloads/{WorkloadId}/shares" + }, + "input":{"shape":"ListWorkloadSharesInput"}, + "output":{"shape":"ListWorkloadSharesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List the workload shares associated with the workload.
" + }, + "ListWorkloads":{ + "name":"ListWorkloads", + "http":{ + "method":"POST", + "requestUri":"/workloadsSummaries" + }, + "input":{"shape":"ListWorkloadsInput"}, + "output":{"shape":"ListWorkloadsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Paginated list of workloads.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{WorkloadArn}" + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Adds one or more tags to the specified resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
Deletes specified tags from a resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
To specify multiple tags, use separate tagKeys parameters, for example:
DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
Update the answer to a specific question in a workload review.
" + }, + "UpdateGlobalSettings":{ + "name":"UpdateGlobalSettings", + "http":{ + "method":"PATCH", + "requestUri":"/global-settings" + }, + "input":{"shape":"UpdateGlobalSettingsInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
" + }, + "UpdateIntegration":{ + "name":"UpdateIntegration", + "http":{ + "method":"POST", + "requestUri":"/workloads/{WorkloadId}/updateIntegration" + }, + "input":{"shape":"UpdateIntegrationInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Update integration features.
" + }, + "UpdateLensReview":{ + "name":"UpdateLensReview", + "http":{ + "method":"PATCH", + "requestUri":"/workloads/{WorkloadId}/lensReviews/{LensAlias}" + }, + "input":{"shape":"UpdateLensReviewInput"}, + "output":{"shape":"UpdateLensReviewOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Update lens review for a particular workload.
" + }, + "UpdateProfile":{ + "name":"UpdateProfile", + "http":{ + "method":"PATCH", + "requestUri":"/profiles/{ProfileArn}" + }, + "input":{"shape":"UpdateProfileInput"}, + "output":{"shape":"UpdateProfileOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Update a profile.
" + }, + "UpdateReviewTemplate":{ + "name":"UpdateReviewTemplate", + "http":{ + "method":"PATCH", + "requestUri":"/reviewTemplates/{TemplateArn}" + }, + "input":{"shape":"UpdateReviewTemplateInput"}, + "output":{"shape":"UpdateReviewTemplateOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Update a review template.
" + }, + "UpdateReviewTemplateAnswer":{ + "name":"UpdateReviewTemplateAnswer", + "http":{ + "method":"PATCH", + "requestUri":"/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId}" + }, + "input":{"shape":"UpdateReviewTemplateAnswerInput"}, + "output":{"shape":"UpdateReviewTemplateAnswerOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Update a review template answer.
" + }, + "UpdateReviewTemplateLensReview":{ + "name":"UpdateReviewTemplateLensReview", + "http":{ + "method":"PATCH", + "requestUri":"/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}" + }, + "input":{"shape":"UpdateReviewTemplateLensReviewInput"}, + "output":{"shape":"UpdateReviewTemplateLensReviewOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Update a lens review associated with a review template.
" + }, + "UpdateShareInvitation":{ + "name":"UpdateShareInvitation", + "http":{ + "method":"PATCH", + "requestUri":"/shareInvitations/{ShareInvitationId}" + }, + "input":{"shape":"UpdateShareInvitationInput"}, + "output":{"shape":"UpdateShareInvitationOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Update a workload or custom lens share invitation.
This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.
Update an existing workload.
" + }, + "UpdateWorkloadShare":{ + "name":"UpdateWorkloadShare", + "http":{ + "method":"PATCH", + "requestUri":"/workloads/{WorkloadId}/shares/{ShareId}" + }, + "input":{"shape":"UpdateWorkloadShareInput"}, + "output":{"shape":"UpdateWorkloadShareOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Update a workload share.
" + }, + "UpgradeLensReview":{ + "name":"UpgradeLensReview", + "http":{ + "method":"PUT", + "requestUri":"/workloads/{WorkloadId}/lensReviews/{LensAlias}/upgrade" + }, + "input":{"shape":"UpgradeLensReviewInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Upgrade lens review for a particular workload.
" + }, + "UpgradeProfileVersion":{ + "name":"UpgradeProfileVersion", + "http":{ + "method":"PUT", + "requestUri":"/workloads/{WorkloadId}/profiles/{ProfileArn}/upgrade" + }, + "input":{"shape":"UpgradeProfileVersionInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Upgrade a profile.
" + }, + "UpgradeReviewTemplateLensReview":{ + "name":"UpgradeReviewTemplateLensReview", + "http":{ + "method":"PUT", + "requestUri":"/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/upgrade" + }, + "input":{"shape":"UpgradeReviewTemplateLensReviewInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Upgrade the lens review of a review template.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"User does not have sufficient access to perform this action.
", + "error":{"httpStatusCode":403}, + "exception":true + }, + "AccountJiraConfigurationInput":{ + "type":"structure", + "members":{ + "IssueManagementStatus":{ + "shape":"AccountJiraIssueManagementStatus", + "documentation":"Account-level: Jira issue management status.
" + }, + "IssueManagementType":{ + "shape":"IssueManagementType", + "documentation":"Account-level: Jira issue management type.
" + }, + "JiraProjectKey":{ + "shape":"JiraProjectKey", + "documentation":"Account-level: Jira project key to sync workloads to.
" + }, + "IntegrationStatus":{ + "shape":"IntegrationStatusInput", + "documentation":"Account-level: Configuration status of the Jira integration.
" + } + }, + "documentation":"Account-level: Input for the Jira configuration.
" + }, + "AccountJiraConfigurationOutput":{ + "type":"structure", + "members":{ + "IntegrationStatus":{ + "shape":"IntegrationStatus", + "documentation":"Account-level: Configuration status of the Jira integration.
" + }, + "IssueManagementStatus":{ + "shape":"AccountJiraIssueManagementStatus", + "documentation":"Account-level: Jira issue management status.
" + }, + "IssueManagementType":{ + "shape":"IssueManagementType", + "documentation":"Account-level: Jira issue management type.
" + }, + "Subdomain":{ + "shape":"Subdomain", + "documentation":"Account-level: Jira subdomain URL.
" + }, + "JiraProjectKey":{ + "shape":"JiraProjectKey", + "documentation":"Account-level: Jira project key to sync workloads to.
" + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"Account-level: Status message on configuration of the Jira integration.
" + } + }, + "documentation":"Account-level: Output configuration of the Jira integration.
" + }, + "AccountJiraIssueManagementStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "AccountSummary":{ + "type":"map", + "key":{"shape":"CheckStatus"}, + "value":{"shape":"CheckStatusCount"}, + "documentation":"Account summary for a Well-Architected best practice in relation to Trusted Advisor checks.
" + }, + "AdditionalResourceType":{ + "type":"string", + "enum":[ + "HELPFUL_RESOURCE", + "IMPROVEMENT_PLAN" + ] + }, + "AdditionalResources":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"AdditionalResourceType", + "documentation":"Type of additional resource for a custom lens.
" + }, + "Content":{ + "shape":"Urls", + "documentation":"The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.
" + } + }, + "documentation":"The choice level additional resources for a custom lens.
This field does not apply to Amazon Web Services official lenses.
" + }, + "AdditionalResourcesList":{ + "type":"list", + "member":{"shape":"AdditionalResources"} + }, + "Answer":{ + "type":"structure", + "members":{ + "QuestionId":{"shape":"QuestionId"}, + "PillarId":{"shape":"PillarId"}, + "QuestionTitle":{"shape":"QuestionTitle"}, + "QuestionDescription":{"shape":"QuestionDescription"}, + "ImprovementPlanUrl":{"shape":"ImprovementPlanUrl"}, + "HelpfulResourceUrl":{"shape":"HelpfulResourceUrl"}, + "HelpfulResourceDisplayText":{ + "shape":"DisplayText", + "documentation":"The helpful resource text to be displayed for a custom lens.
This field does not apply to Amazon Web Services official lenses.
" + }, + "Choices":{"shape":"Choices"}, + "SelectedChoices":{"shape":"SelectedChoices"}, + "ChoiceAnswers":{ + "shape":"ChoiceAnswers", + "documentation":"A list of selected choices to a question in your workload.
" + }, + "IsApplicable":{"shape":"IsApplicable"}, + "Risk":{"shape":"Risk"}, + "Notes":{"shape":"Notes"}, + "Reason":{ + "shape":"AnswerReason", + "documentation":"The reason why the question is not applicable to your workload.
" + }, + "JiraConfiguration":{ + "shape":"JiraConfiguration", + "documentation":"Configuration of the Jira integration.
" + } + }, + "documentation":"An answer of the question.
" + }, + "AnswerReason":{ + "type":"string", + "enum":[ + "OUT_OF_SCOPE", + "BUSINESS_PRIORITIES", + "ARCHITECTURE_CONSTRAINTS", + "OTHER", + "NONE" + ] + }, + "AnswerSummaries":{ + "type":"list", + "member":{"shape":"AnswerSummary"}, + "documentation":"List of answer summaries of lens review in a workload.
" + }, + "AnswerSummary":{ + "type":"structure", + "members":{ + "QuestionId":{"shape":"QuestionId"}, + "PillarId":{"shape":"PillarId"}, + "QuestionTitle":{"shape":"QuestionTitle"}, + "Choices":{"shape":"Choices"}, + "SelectedChoices":{"shape":"SelectedChoices"}, + "ChoiceAnswerSummaries":{ + "shape":"ChoiceAnswerSummaries", + "documentation":"A list of selected choices to a question in your workload.
" + }, + "IsApplicable":{"shape":"IsApplicable"}, + "Risk":{"shape":"Risk"}, + "Reason":{ + "shape":"AnswerReason", + "documentation":"The reason why a choice is non-applicable to a question in your workload.
" + }, + "QuestionType":{ + "shape":"QuestionType", + "documentation":"The type of the question.
" + }, + "JiraConfiguration":{ + "shape":"JiraConfiguration", + "documentation":"Configuration of the Jira integration.
" + } + }, + "documentation":"An answer summary of a lens review in a workload.
" + }, + "ApplicationArn":{ + "type":"string", + "max":2084, + "pattern":"arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/applications/[a-z0-9]+" + }, + "AssociateLensesInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "LensAliases" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "LensAliases":{"shape":"LensAliases"} + }, + "documentation":"Input to associate lens reviews.
" + }, + "AssociateProfilesInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "ProfileArns" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "ProfileArns":{ + "shape":"ProfileArns", + "documentation":"The list of profile ARNs to associate with the workload.
" + } + } + }, + "AwsAccountId":{ + "type":"string", + "documentation":"An Amazon Web Services account ID.
", + "max":12, + "min":12, + "pattern":"[0-9]{12}" + }, + "AwsRegion":{ + "type":"string", + "documentation":"An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1.
The Base64-encoded string representation of a lens review report.
This data can be used to create a PDF file.
Only returned by GetConsolidatedReport when PDF format is requested.
A best practice, or question choice, that has been identified as a risk in this question.
" + }, + "BestPractices":{ + "type":"list", + "member":{"shape":"BestPractice"} + }, + "CheckDescription":{"type":"string"}, + "CheckDetail":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"CheckId", + "documentation":"Trusted Advisor check ID.
" + }, + "Name":{ + "shape":"CheckName", + "documentation":"Trusted Advisor check name.
" + }, + "Description":{ + "shape":"CheckDescription", + "documentation":"Trusted Advisor check description.
" + }, + "Provider":{ + "shape":"CheckProvider", + "documentation":"Provider of the check related to the best practice.
" + }, + "LensArn":{ + "shape":"LensArn", + "documentation":"Well-Architected Lens ARN associated to the check.
" + }, + "PillarId":{"shape":"PillarId"}, + "QuestionId":{"shape":"QuestionId"}, + "ChoiceId":{"shape":"ChoiceId"}, + "Status":{ + "shape":"CheckStatus", + "documentation":"Status associated to the check.
" + }, + "AccountId":{"shape":"AwsAccountId"}, + "FlaggedResources":{ + "shape":"FlaggedResources", + "documentation":"Count of flagged resources associated to the check.
" + }, + "Reason":{ + "shape":"CheckFailureReason", + "documentation":"Reason associated to the check.
" + }, + "UpdatedAt":{"shape":"Timestamp"} + }, + "documentation":"Account details for a Well-Architected best practice in relation to Trusted Advisor checks.
" + }, + "CheckDetails":{ + "type":"list", + "member":{"shape":"CheckDetail"} + }, + "CheckFailureReason":{ + "type":"string", + "enum":[ + "ASSUME_ROLE_ERROR", + "ACCESS_DENIED", + "UNKNOWN_ERROR", + "PREMIUM_SUPPORT_REQUIRED" + ] + }, + "CheckId":{"type":"string"}, + "CheckName":{"type":"string"}, + "CheckProvider":{ + "type":"string", + "enum":["TRUSTED_ADVISOR"] + }, + "CheckStatus":{ + "type":"string", + "enum":[ + "OKAY", + "WARNING", + "ERROR", + "NOT_AVAILABLE", + "FETCH_FAILED" + ] + }, + "CheckStatusCount":{ + "type":"integer", + "max":101, + "min":1 + }, + "CheckSummaries":{ + "type":"list", + "member":{"shape":"CheckSummary"} + }, + "CheckSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"CheckId", + "documentation":"Trusted Advisor check ID.
" + }, + "Name":{ + "shape":"CheckName", + "documentation":"Trusted Advisor check name.
" + }, + "Provider":{ + "shape":"CheckProvider", + "documentation":"Provider of the check related to the best practice.
" + }, + "Description":{ + "shape":"CheckDescription", + "documentation":"Trusted Advisor check description.
" + }, + "UpdatedAt":{"shape":"Timestamp"}, + "LensArn":{ + "shape":"LensArn", + "documentation":"Well-Architected Lens ARN associated to the check.
" + }, + "PillarId":{"shape":"PillarId"}, + "QuestionId":{"shape":"QuestionId"}, + "ChoiceId":{"shape":"ChoiceId"}, + "Status":{ + "shape":"CheckStatus", + "documentation":"Status associated to the check.
" + }, + "AccountSummary":{ + "shape":"AccountSummary", + "documentation":"Account summary associated to the check.
" + } + }, + "documentation":"Trusted Advisor check summary.
" + }, + "Choice":{ + "type":"structure", + "members":{ + "ChoiceId":{"shape":"ChoiceId"}, + "Title":{"shape":"ChoiceTitle"}, + "Description":{"shape":"ChoiceDescription"}, + "HelpfulResource":{ + "shape":"ChoiceContent", + "documentation":"The helpful resource (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one helpful resource.
" + }, + "ImprovementPlan":{ + "shape":"ChoiceContent", + "documentation":"The improvement plan (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one improvement plan.
" + }, + "AdditionalResources":{ + "shape":"AdditionalResourcesList", + "documentation":"The additional resources for a choice in a custom lens.
A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.
A choice available to answer question.
" + }, + "ChoiceAnswer":{ + "type":"structure", + "members":{ + "ChoiceId":{"shape":"ChoiceId"}, + "Status":{ + "shape":"ChoiceStatus", + "documentation":"The status of a choice.
" + }, + "Reason":{ + "shape":"ChoiceReason", + "documentation":"The reason why a choice is non-applicable to a question in your workload.
" + }, + "Notes":{ + "shape":"ChoiceNotes", + "documentation":"The notes associated with a choice.
" + } + }, + "documentation":"A choice that has been answered on a question in your workload.
" + }, + "ChoiceAnswerSummaries":{ + "type":"list", + "member":{"shape":"ChoiceAnswerSummary"} + }, + "ChoiceAnswerSummary":{ + "type":"structure", + "members":{ + "ChoiceId":{"shape":"ChoiceId"}, + "Status":{ + "shape":"ChoiceStatus", + "documentation":"The status of a choice.
" + }, + "Reason":{ + "shape":"ChoiceReason", + "documentation":"The reason why a choice is non-applicable to a question in your workload.
" + } + }, + "documentation":"A choice summary that has been answered on a question in your workload.
" + }, + "ChoiceAnswers":{ + "type":"list", + "member":{"shape":"ChoiceAnswer"} + }, + "ChoiceContent":{ + "type":"structure", + "members":{ + "DisplayText":{ + "shape":"ChoiceContentDisplayText", + "documentation":"The display text for the choice content.
" + }, + "Url":{ + "shape":"ChoiceContentUrl", + "documentation":"The URL for the choice content.
" + } + }, + "documentation":"The choice content.
" + }, + "ChoiceContentDisplayText":{ + "type":"string", + "max":1024, + "min":1 + }, + "ChoiceContentUrl":{ + "type":"string", + "max":1024, + "min":1 + }, + "ChoiceDescription":{ + "type":"string", + "documentation":"The description of a choice.
", + "max":1024, + "min":1 + }, + "ChoiceId":{ + "type":"string", + "documentation":"The ID of a choice.
", + "max":64, + "min":1 + }, + "ChoiceImprovementPlan":{ + "type":"structure", + "members":{ + "ChoiceId":{"shape":"ChoiceId"}, + "DisplayText":{ + "shape":"DisplayText", + "documentation":"The display text for the improvement plan.
" + }, + "ImprovementPlanUrl":{"shape":"ImprovementPlanUrl"} + }, + "documentation":"The choice level improvement plan.
" + }, + "ChoiceImprovementPlans":{ + "type":"list", + "member":{"shape":"ChoiceImprovementPlan"} + }, + "ChoiceNotes":{ + "type":"string", + "max":250 + }, + "ChoiceReason":{ + "type":"string", + "enum":[ + "OUT_OF_SCOPE", + "BUSINESS_PRIORITIES", + "ARCHITECTURE_CONSTRAINTS", + "OTHER", + "NONE" + ] + }, + "ChoiceStatus":{ + "type":"string", + "enum":[ + "SELECTED", + "NOT_APPLICABLE", + "UNSELECTED" + ] + }, + "ChoiceTitle":{ + "type":"string", + "documentation":"The title of a choice.
", + "max":512, + "min":1 + }, + "ChoiceUpdate":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"ChoiceStatus", + "documentation":"The status of a choice.
" + }, + "Reason":{ + "shape":"ChoiceReason", + "documentation":"The reason why a choice is non-applicable to a question in your workload.
" + }, + "Notes":{ + "shape":"ChoiceNotes", + "documentation":"The notes associated with a choice.
" + } + }, + "documentation":"A list of choices to be updated.
" + }, + "ChoiceUpdates":{ + "type":"map", + "key":{"shape":"ChoiceId"}, + "value":{"shape":"ChoiceUpdate"} + }, + "Choices":{ + "type":"list", + "member":{"shape":"Choice"}, + "documentation":"List of choices available for a question.
" + }, + "ClientRequestToken":{ + "type":"string", + "documentation":"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.
The resource has already been processed, was deleted, or is too large.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ConsolidatedReportMetric":{ + "type":"structure", + "members":{ + "MetricType":{ + "shape":"MetricType", + "documentation":"The metric type of a metric in the consolidated report. Currently only WORKLOAD metric types are supported.
" + }, + "RiskCounts":{"shape":"RiskCounts"}, + "WorkloadId":{"shape":"WorkloadId"}, + "WorkloadName":{"shape":"WorkloadName"}, + "WorkloadArn":{"shape":"WorkloadArn"}, + "UpdatedAt":{"shape":"Timestamp"}, + "Lenses":{ + "shape":"LensMetrics", + "documentation":"The metrics for the lenses in the workload.
" + }, + "LensesAppliedCount":{ + "shape":"LensesAppliedCount", + "documentation":"The total number of lenses applied to the workload.
" + } + }, + "documentation":"A metric that contributes to the consolidated report.
" + }, + "ConsolidatedReportMetrics":{ + "type":"list", + "member":{"shape":"ConsolidatedReportMetric"} + }, + "Count":{ + "type":"integer", + "documentation":"A non-negative integer that denotes how many.
", + "min":0 + }, + "CreateLensShareInput":{ + "type":"structure", + "required":[ + "LensAlias", + "SharedWith", + "ClientRequestToken" + ], + "members":{ + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "SharedWith":{"shape":"SharedWith"}, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + } + } + }, + "CreateLensShareOutput":{ + "type":"structure", + "members":{ + "ShareId":{"shape":"ShareId"} + } + }, + "CreateLensVersionInput":{ + "type":"structure", + "required":[ + "LensAlias", + "LensVersion", + "ClientRequestToken" + ], + "members":{ + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "LensVersion":{ + "shape":"LensVersion", + "documentation":"The version of the lens being created.
" + }, + "IsMajorVersion":{ + "shape":"IsMajorVersion", + "documentation":"Set to true if this new major lens version.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + } + } + }, + "CreateLensVersionOutput":{ + "type":"structure", + "members":{ + "LensArn":{ + "shape":"LensArn", + "documentation":"The ARN for the lens.
" + }, + "LensVersion":{ + "shape":"LensVersion", + "documentation":"The version of the lens.
" + } + } + }, + "CreateMilestoneInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "MilestoneName", + "ClientRequestToken" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "MilestoneName":{"shape":"MilestoneName"}, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + } + }, + "documentation":"Input for milestone creation.
" + }, + "CreateMilestoneOutput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "MilestoneNumber":{"shape":"MilestoneNumber"} + }, + "documentation":"Output of a create milestone call.
" + }, + "CreateProfileInput":{ + "type":"structure", + "required":[ + "ProfileName", + "ProfileDescription", + "ProfileQuestions", + "ClientRequestToken" + ], + "members":{ + "ProfileName":{ + "shape":"ProfileName", + "documentation":"Name of the profile.
" + }, + "ProfileDescription":{ + "shape":"ProfileDescription", + "documentation":"The profile description.
" + }, + "ProfileQuestions":{ + "shape":"ProfileQuestionUpdates", + "documentation":"The profile questions.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The tags assigned to the profile.
" + } + } + }, + "CreateProfileOutput":{ + "type":"structure", + "members":{ + "ProfileArn":{ + "shape":"ProfileArn", + "documentation":"The profile ARN.
" + }, + "ProfileVersion":{ + "shape":"ProfileVersion", + "documentation":"Version of the profile.
" + } + } + }, + "CreateProfileShareInput":{ + "type":"structure", + "required":[ + "ProfileArn", + "SharedWith", + "ClientRequestToken" + ], + "members":{ + "ProfileArn":{ + "shape":"ProfileArn", + "documentation":"The profile ARN.
", + "location":"uri", + "locationName":"ProfileArn" + }, + "SharedWith":{"shape":"SharedWith"}, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + } + } + }, + "CreateProfileShareOutput":{ + "type":"structure", + "members":{ + "ShareId":{"shape":"ShareId"}, + "ProfileArn":{ + "shape":"ProfileArn", + "documentation":"The profile ARN.
" + } + } + }, + "CreateReviewTemplateInput":{ + "type":"structure", + "required":[ + "TemplateName", + "Description", + "Lenses", + "ClientRequestToken" + ], + "members":{ + "TemplateName":{ + "shape":"TemplateName", + "documentation":"Name of the review template.
" + }, + "Description":{ + "shape":"TemplateDescription", + "documentation":"The review template description.
" + }, + "Lenses":{ + "shape":"ReviewTemplateLenses", + "documentation":"Lenses applied to the review template.
" + }, + "Notes":{"shape":"Notes"}, + "Tags":{ + "shape":"TagMap", + "documentation":"The tags assigned to the review template.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + } + } + }, + "CreateReviewTemplateOutput":{ + "type":"structure", + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
" + } + } + }, + "CreateTemplateShareInput":{ + "type":"structure", + "required":[ + "TemplateArn", + "SharedWith", + "ClientRequestToken" + ], + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
", + "location":"uri", + "locationName":"TemplateArn" + }, + "SharedWith":{"shape":"SharedWith"}, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + } + } + }, + "CreateTemplateShareOutput":{ + "type":"structure", + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
" + }, + "ShareId":{"shape":"ShareId"} + } + }, + "CreateWorkloadInput":{ + "type":"structure", + "required":[ + "WorkloadName", + "Description", + "Environment", + "Lenses", + "ClientRequestToken" + ], + "members":{ + "WorkloadName":{"shape":"WorkloadName"}, + "Description":{"shape":"WorkloadDescription"}, + "Environment":{"shape":"WorkloadEnvironment"}, + "AccountIds":{"shape":"WorkloadAccountIds"}, + "AwsRegions":{"shape":"WorkloadAwsRegions"}, + "NonAwsRegions":{"shape":"WorkloadNonAwsRegions"}, + "PillarPriorities":{"shape":"WorkloadPillarPriorities"}, + "ArchitecturalDesign":{"shape":"WorkloadArchitecturalDesign"}, + "ReviewOwner":{"shape":"WorkloadReviewOwner"}, + "IndustryType":{"shape":"WorkloadIndustryType"}, + "Industry":{"shape":"WorkloadIndustry"}, + "Lenses":{"shape":"WorkloadLenses"}, + "Notes":{"shape":"Notes"}, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The tags to be associated with the workload.
" + }, + "DiscoveryConfig":{ + "shape":"WorkloadDiscoveryConfig", + "documentation":"Well-Architected discovery configuration settings associated to the workload.
" + }, + "Applications":{ + "shape":"WorkloadApplications", + "documentation":"List of AppRegistry application ARNs associated to the workload.
" + }, + "ProfileArns":{ + "shape":"WorkloadProfileArns", + "documentation":"The list of profile ARNs associated with the workload.
" + }, + "ReviewTemplateArns":{ + "shape":"ReviewTemplateArns", + "documentation":"The list of review template ARNs to associate with the workload.
" + }, + "JiraConfiguration":{ + "shape":"WorkloadJiraConfigurationInput", + "documentation":"Jira configuration settings when creating a workload.
" + } + }, + "documentation":"Input for workload creation.
" + }, + "CreateWorkloadOutput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "WorkloadArn":{"shape":"WorkloadArn"} + }, + "documentation":"Output of a create workload call.
" + }, + "CreateWorkloadShareInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "SharedWith", + "PermissionType", + "ClientRequestToken" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "SharedWith":{"shape":"SharedWith"}, + "PermissionType":{"shape":"PermissionType"}, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + } + }, + "documentation":"Input for Create Workload Share
" + }, + "CreateWorkloadShareOutput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "ShareId":{"shape":"ShareId"} + }, + "documentation":"Input for Create Workload Share
" + }, + "DefinitionType":{ + "type":"string", + "enum":[ + "WORKLOAD_METADATA", + "APP_REGISTRY" + ] + }, + "DeleteLensInput":{ + "type":"structure", + "required":[ + "LensAlias", + "ClientRequestToken", + "LensStatus" + ], + "members":{ + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true, + "location":"querystring", + "locationName":"ClientRequestToken" + }, + "LensStatus":{ + "shape":"LensStatusType", + "documentation":"The status of the lens to be deleted.
", + "location":"querystring", + "locationName":"LensStatus" + } + } + }, + "DeleteLensShareInput":{ + "type":"structure", + "required":[ + "ShareId", + "LensAlias", + "ClientRequestToken" + ], + "members":{ + "ShareId":{ + "shape":"ShareId", + "location":"uri", + "locationName":"ShareId" + }, + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true, + "location":"querystring", + "locationName":"ClientRequestToken" + } + } + }, + "DeleteProfileInput":{ + "type":"structure", + "required":[ + "ProfileArn", + "ClientRequestToken" + ], + "members":{ + "ProfileArn":{ + "shape":"ProfileArn", + "documentation":"The profile ARN.
", + "location":"uri", + "locationName":"ProfileArn" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true, + "location":"querystring", + "locationName":"ClientRequestToken" + } + } + }, + "DeleteProfileShareInput":{ + "type":"structure", + "required":[ + "ShareId", + "ProfileArn", + "ClientRequestToken" + ], + "members":{ + "ShareId":{ + "shape":"ShareId", + "location":"uri", + "locationName":"ShareId" + }, + "ProfileArn":{ + "shape":"ProfileArn", + "documentation":"The profile ARN.
", + "location":"uri", + "locationName":"ProfileArn" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true, + "location":"querystring", + "locationName":"ClientRequestToken" + } + } + }, + "DeleteReviewTemplateInput":{ + "type":"structure", + "required":[ + "TemplateArn", + "ClientRequestToken" + ], + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
", + "location":"uri", + "locationName":"TemplateArn" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true, + "location":"querystring", + "locationName":"ClientRequestToken" + } + } + }, + "DeleteTemplateShareInput":{ + "type":"structure", + "required":[ + "ShareId", + "TemplateArn", + "ClientRequestToken" + ], + "members":{ + "ShareId":{ + "shape":"ShareId", + "location":"uri", + "locationName":"ShareId" + }, + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
", + "location":"uri", + "locationName":"TemplateArn" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true, + "location":"querystring", + "locationName":"ClientRequestToken" + } + } + }, + "DeleteWorkloadInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "ClientRequestToken" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true, + "location":"querystring", + "locationName":"ClientRequestToken" + } + }, + "documentation":"Input for workload deletion.
" + }, + "DeleteWorkloadShareInput":{ + "type":"structure", + "required":[ + "ShareId", + "WorkloadId", + "ClientRequestToken" + ], + "members":{ + "ShareId":{ + "shape":"ShareId", + "location":"uri", + "locationName":"ShareId" + }, + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true, + "location":"querystring", + "locationName":"ClientRequestToken" + } + }, + "documentation":"Input for Delete Workload Share
" + }, + "DifferenceStatus":{ + "type":"string", + "enum":[ + "UPDATED", + "NEW", + "DELETED" + ] + }, + "DisassociateLensesInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "LensAliases" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "LensAliases":{"shape":"LensAliases"} + }, + "documentation":"Input to disassociate lens reviews.
" + }, + "DisassociateProfilesInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "ProfileArns" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "ProfileArns":{ + "shape":"ProfileArns", + "documentation":"The list of profile ARNs to disassociate from the workload.
" + } + } + }, + "DiscoveryIntegrationStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "DisplayText":{ + "type":"string", + "max":64, + "min":1 + }, + "ExceptionMessage":{ + "type":"string", + "documentation":"Description of the error.
" + }, + "ExceptionResourceId":{ + "type":"string", + "documentation":"Identifier of the resource affected.
" + }, + "ExceptionResourceType":{ + "type":"string", + "documentation":"Type of the resource affected.
" + }, + "ExportLensInput":{ + "type":"structure", + "required":["LensAlias"], + "members":{ + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "LensVersion":{ + "shape":"LensVersion", + "documentation":"The lens version to be exported.
", + "location":"querystring", + "locationName":"LensVersion" + } + } + }, + "ExportLensOutput":{ + "type":"structure", + "members":{ + "LensJSON":{ + "shape":"LensJSON", + "documentation":"The JSON representation of a lens.
" + } + } + }, + "FlaggedResources":{ + "type":"integer", + "max":9999, + "min":1 + }, + "GetAnswerInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "LensAlias", + "QuestionId" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "QuestionId":{ + "shape":"QuestionId", + "location":"uri", + "locationName":"QuestionId" + }, + "MilestoneNumber":{ + "shape":"MilestoneNumber", + "location":"querystring", + "locationName":"MilestoneNumber" + } + }, + "documentation":"Input to get answer.
" + }, + "GetAnswerOutput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "MilestoneNumber":{"shape":"MilestoneNumber"}, + "LensAlias":{"shape":"LensAlias"}, + "LensArn":{ + "shape":"LensArn", + "documentation":"The ARN for the lens.
" + }, + "Answer":{"shape":"Answer"} + }, + "documentation":"Output of a get answer call.
" + }, + "GetConsolidatedReportInput":{ + "type":"structure", + "required":["Format"], + "members":{ + "Format":{ + "shape":"ReportFormat", + "documentation":"The format of the consolidated report.
For PDF, Base64String is returned. For JSON, Metrics is returned.
Set to true to have shared resources included in the report.
The maximum number of results to return for this request.
", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "GetConsolidatedReportMaxResults":{ + "type":"integer", + "max":15, + "min":1 + }, + "GetConsolidatedReportOutput":{ + "type":"structure", + "members":{ + "Metrics":{ + "shape":"ConsolidatedReportMetrics", + "documentation":"The metrics that make up the consolidated report.
Only returned when JSON format is requested.
Amazon Web Services Organizations sharing status.
" + }, + "DiscoveryIntegrationStatus":{ + "shape":"DiscoveryIntegrationStatus", + "documentation":"Discovery integration status.
" + }, + "JiraConfiguration":{ + "shape":"AccountJiraConfigurationOutput", + "documentation":"Jira configuration status.
" + } + } + }, + "GetLensInput":{ + "type":"structure", + "required":["LensAlias"], + "members":{ + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "LensVersion":{ + "shape":"LensVersion", + "documentation":"The lens version to be retrieved.
", + "location":"querystring", + "locationName":"LensVersion" + } + } + }, + "GetLensOutput":{ + "type":"structure", + "members":{ + "Lens":{ + "shape":"Lens", + "documentation":"A lens return object.
" + } + } + }, + "GetLensReviewInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "LensAlias" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "MilestoneNumber":{ + "shape":"MilestoneNumber", + "location":"querystring", + "locationName":"MilestoneNumber" + } + }, + "documentation":"Input to get lens review.
" + }, + "GetLensReviewOutput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "MilestoneNumber":{"shape":"MilestoneNumber"}, + "LensReview":{"shape":"LensReview"} + }, + "documentation":"Output of a get lens review call.
" + }, + "GetLensReviewReportInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "LensAlias" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "MilestoneNumber":{ + "shape":"MilestoneNumber", + "location":"querystring", + "locationName":"MilestoneNumber" + } + }, + "documentation":"Input to get lens review report.
" + }, + "GetLensReviewReportOutput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "MilestoneNumber":{"shape":"MilestoneNumber"}, + "LensReviewReport":{"shape":"LensReviewReport"} + }, + "documentation":"Output of a get lens review report call.
" + }, + "GetLensVersionDifferenceInput":{ + "type":"structure", + "required":["LensAlias"], + "members":{ + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "BaseLensVersion":{ + "shape":"LensVersion", + "documentation":"The base version of the lens.
", + "location":"querystring", + "locationName":"BaseLensVersion" + }, + "TargetLensVersion":{ + "shape":"LensVersion", + "documentation":"The lens version to target a difference for.
", + "location":"querystring", + "locationName":"TargetLensVersion" + } + } + }, + "GetLensVersionDifferenceOutput":{ + "type":"structure", + "members":{ + "LensAlias":{"shape":"LensAlias"}, + "LensArn":{ + "shape":"LensArn", + "documentation":"The ARN for the lens.
" + }, + "BaseLensVersion":{ + "shape":"LensVersion", + "documentation":"The base version of the lens.
" + }, + "TargetLensVersion":{ + "shape":"LensVersion", + "documentation":"The target lens version for the lens.
" + }, + "LatestLensVersion":{ + "shape":"LensVersion", + "documentation":"The latest version of the lens.
" + }, + "VersionDifferences":{"shape":"VersionDifferences"} + } + }, + "GetMilestoneInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "MilestoneNumber" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "MilestoneNumber":{ + "shape":"MilestoneNumber", + "location":"uri", + "locationName":"MilestoneNumber" + } + }, + "documentation":"Input to get a milestone.
" + }, + "GetMilestoneOutput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "Milestone":{"shape":"Milestone"} + }, + "documentation":"Output of a get milestone call.
" + }, + "GetProfileInput":{ + "type":"structure", + "required":["ProfileArn"], + "members":{ + "ProfileArn":{ + "shape":"ProfileArn", + "documentation":"The profile ARN.
", + "location":"uri", + "locationName":"ProfileArn" + }, + "ProfileVersion":{ + "shape":"ProfileVersion", + "documentation":"The profile version.
", + "location":"querystring", + "locationName":"ProfileVersion" + } + } + }, + "GetProfileOutput":{ + "type":"structure", + "members":{ + "Profile":{ + "shape":"Profile", + "documentation":"The profile.
" + } + } + }, + "GetProfileTemplateInput":{ + "type":"structure", + "members":{ + } + }, + "GetProfileTemplateOutput":{ + "type":"structure", + "members":{ + "ProfileTemplate":{ + "shape":"ProfileTemplate", + "documentation":"The profile template.
" + } + } + }, + "GetReviewTemplateAnswerInput":{ + "type":"structure", + "required":[ + "TemplateArn", + "LensAlias", + "QuestionId" + ], + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
", + "location":"uri", + "locationName":"TemplateArn" + }, + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "QuestionId":{ + "shape":"QuestionId", + "location":"uri", + "locationName":"QuestionId" + } + } + }, + "GetReviewTemplateAnswerOutput":{ + "type":"structure", + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
" + }, + "LensAlias":{"shape":"LensAlias"}, + "Answer":{ + "shape":"ReviewTemplateAnswer", + "documentation":"An answer of the question.
" + } + } + }, + "GetReviewTemplateInput":{ + "type":"structure", + "required":["TemplateArn"], + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
", + "location":"uri", + "locationName":"TemplateArn" + } + } + }, + "GetReviewTemplateLensReviewInput":{ + "type":"structure", + "required":[ + "TemplateArn", + "LensAlias" + ], + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
", + "location":"uri", + "locationName":"TemplateArn" + }, + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + } + } + }, + "GetReviewTemplateLensReviewOutput":{ + "type":"structure", + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
" + }, + "LensReview":{ + "shape":"ReviewTemplateLensReview", + "documentation":"A lens review of a question.
" + } + } + }, + "GetReviewTemplateOutput":{ + "type":"structure", + "members":{ + "ReviewTemplate":{ + "shape":"ReviewTemplate", + "documentation":"The review template.
" + } + } + }, + "GetWorkloadInput":{ + "type":"structure", + "required":["WorkloadId"], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + } + }, + "documentation":"Input to get a workload.
" + }, + "GetWorkloadOutput":{ + "type":"structure", + "members":{ + "Workload":{"shape":"Workload"} + }, + "documentation":"Output of a get workload call.
" + }, + "HelpfulResourceUrl":{ + "type":"string", + "documentation":"The helpful resource URL.
For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.
For custom lenses, this is the helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question.
The JSON representation of a lens.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagMap", + "documentation":"Tags to associate to a lens.
" + } + } + }, + "ImportLensOutput":{ + "type":"structure", + "members":{ + "LensArn":{ + "shape":"LensArn", + "documentation":"The ARN for the lens that was created or updated.
" + }, + "Status":{ + "shape":"ImportLensStatus", + "documentation":"The status of the imported lens.
" + } + } + }, + "ImportLensStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "COMPLETE", + "ERROR" + ] + }, + "ImprovementPlanUrl":{ + "type":"string", + "documentation":"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.
", + "max":2048, + "min":1 + }, + "ImprovementSummaries":{ + "type":"list", + "member":{"shape":"ImprovementSummary"}, + "documentation":"List of improvement summaries of lens review in a workload.
" + }, + "ImprovementSummary":{ + "type":"structure", + "members":{ + "QuestionId":{"shape":"QuestionId"}, + "PillarId":{"shape":"PillarId"}, + "QuestionTitle":{"shape":"QuestionTitle"}, + "Risk":{"shape":"Risk"}, + "ImprovementPlanUrl":{"shape":"ImprovementPlanUrl"}, + "ImprovementPlans":{ + "shape":"ChoiceImprovementPlans", + "documentation":"The improvement plan details.
" + }, + "JiraConfiguration":{ + "shape":"JiraConfiguration", + "documentation":"Configuration of the Jira integration.
" + } + }, + "documentation":"An improvement summary of a lens review in a workload.
" + }, + "IncludeSharedResources":{"type":"boolean"}, + "IntegratingService":{ + "type":"string", + "enum":["JIRA"] + }, + "IntegrationStatus":{ + "type":"string", + "enum":[ + "CONFIGURED", + "NOT_CONFIGURED" + ] + }, + "IntegrationStatusInput":{ + "type":"string", + "enum":["NOT_CONFIGURED"] + }, + "InternalServerException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"There is a problem with the Well-Architected Tool API service.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "IsApplicable":{ + "type":"boolean", + "documentation":"Defines whether this question is applicable to a lens review.
" + }, + "IsMajorVersion":{"type":"boolean"}, + "IsReviewOwnerUpdateAcknowledged":{"type":"boolean"}, + "IssueManagementType":{ + "type":"string", + "enum":[ + "AUTO", + "MANUAL" + ] + }, + "JiraConfiguration":{ + "type":"structure", + "members":{ + "JiraIssueUrl":{ + "shape":"JiraIssueUrl", + "documentation":"The URL of the associated Jira issue.
" + }, + "LastSyncedTime":{"shape":"Timestamp"} + }, + "documentation":"Configuration of the Jira integration.
" + }, + "JiraIssueUrl":{ + "type":"string", + "max":2048, + "min":1 + }, + "JiraProjectKey":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[A-Z][A-Z0-9_]*$" + }, + "JiraSelectedQuestionConfiguration":{ + "type":"structure", + "members":{ + "SelectedPillars":{ + "shape":"SelectedPillars", + "documentation":"Selected pillars in the workload.
" + } + }, + "documentation":"Selected questions in the workload.
" + }, + "Lens":{ + "type":"structure", + "members":{ + "LensArn":{ + "shape":"LensArn", + "documentation":"The ARN of a lens.
" + }, + "LensVersion":{ + "shape":"LensVersion", + "documentation":"The version of a lens.
" + }, + "Name":{"shape":"LensName"}, + "Description":{"shape":"LensDescription"}, + "Owner":{ + "shape":"LensOwner", + "documentation":"The Amazon Web Services account ID that owns the lens.
" + }, + "ShareInvitationId":{ + "shape":"ShareInvitationId", + "documentation":"The ID assigned to the share invitation.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The tags assigned to the lens.
" + } + }, + "documentation":"A lens return object.
" + }, + "LensAlias":{ + "type":"string", + "documentation":"The alias of the lens.
For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.
Each lens is identified by its LensSummary$LensAlias.
", + "max":128, + "min":1 + }, + "LensAliases":{ + "type":"list", + "member":{"shape":"LensAlias"}, + "documentation":"List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.
Identify a lens using its LensSummary$LensAlias.
", + "min":1 + }, + "LensArn":{"type":"string"}, + "LensDescription":{ + "type":"string", + "documentation":"The description of the lens.
", + "max":1024, + "min":1 + }, + "LensJSON":{ + "type":"string", + "max":500000, + "min":2 + }, + "LensMetric":{ + "type":"structure", + "members":{ + "LensArn":{ + "shape":"LensArn", + "documentation":"The lens ARN.
" + }, + "Pillars":{ + "shape":"PillarMetrics", + "documentation":"The metrics for the pillars in a lens.
" + }, + "RiskCounts":{"shape":"RiskCounts"} + }, + "documentation":"A metric for a particular lens in a workload.
" + }, + "LensMetrics":{ + "type":"list", + "member":{"shape":"LensMetric"} + }, + "LensName":{ + "type":"string", + "documentation":"The full name of the lens.
", + "max":128, + "min":1 + }, + "LensNamePrefix":{ + "type":"string", + "max":100 + }, + "LensOwner":{"type":"string"}, + "LensReview":{ + "type":"structure", + "members":{ + "LensAlias":{"shape":"LensAlias"}, + "LensArn":{ + "shape":"LensArn", + "documentation":"The ARN for the lens.
" + }, + "LensVersion":{ + "shape":"LensVersion", + "documentation":"The version of the lens.
" + }, + "LensName":{"shape":"LensName"}, + "LensStatus":{ + "shape":"LensStatus", + "documentation":"The status of the lens.
" + }, + "PillarReviewSummaries":{"shape":"PillarReviewSummaries"}, + "JiraConfiguration":{ + "shape":"JiraSelectedQuestionConfiguration", + "documentation":"Jira configuration status of the Lens review.
" + }, + "UpdatedAt":{"shape":"Timestamp"}, + "Notes":{"shape":"Notes"}, + "RiskCounts":{"shape":"RiskCounts"}, + "NextToken":{"shape":"NextToken"}, + "Profiles":{ + "shape":"WorkloadProfiles", + "documentation":"The profiles associated with the workload.
" + }, + "PrioritizedRiskCounts":{"shape":"RiskCounts"} + }, + "documentation":"A lens review of a question.
" + }, + "LensReviewReport":{ + "type":"structure", + "members":{ + "LensAlias":{"shape":"LensAlias"}, + "LensArn":{ + "shape":"LensArn", + "documentation":"The ARN for the lens.
" + }, + "Base64String":{"shape":"Base64String"} + }, + "documentation":"A report of a lens review.
" + }, + "LensReviewSummaries":{ + "type":"list", + "member":{"shape":"LensReviewSummary"}, + "documentation":"List of lens summaries of lens reviews of a workload.
" + }, + "LensReviewSummary":{ + "type":"structure", + "members":{ + "LensAlias":{"shape":"LensAlias"}, + "LensArn":{ + "shape":"LensArn", + "documentation":"The ARN for the lens.
" + }, + "LensVersion":{ + "shape":"LensVersion", + "documentation":"The version of the lens.
" + }, + "LensName":{"shape":"LensName"}, + "LensStatus":{ + "shape":"LensStatus", + "documentation":"The status of the lens.
" + }, + "UpdatedAt":{"shape":"Timestamp"}, + "RiskCounts":{"shape":"RiskCounts"}, + "Profiles":{ + "shape":"WorkloadProfiles", + "documentation":"The profiles associated with the workload.
" + }, + "PrioritizedRiskCounts":{"shape":"RiskCounts"} + }, + "documentation":"A lens review summary of a workload.
" + }, + "LensShareSummaries":{ + "type":"list", + "member":{"shape":"LensShareSummary"} + }, + "LensShareSummary":{ + "type":"structure", + "members":{ + "ShareId":{"shape":"ShareId"}, + "SharedWith":{"shape":"SharedWith"}, + "Status":{"shape":"ShareStatus"}, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"Optional message to compliment the Status field.
" + } + }, + "documentation":"A lens share summary return object.
" + }, + "LensStatus":{ + "type":"string", + "enum":[ + "CURRENT", + "NOT_CURRENT", + "DEPRECATED", + "DELETED", + "UNSHARED" + ] + }, + "LensStatusType":{ + "type":"string", + "enum":[ + "ALL", + "DRAFT", + "PUBLISHED" + ] + }, + "LensSummaries":{ + "type":"list", + "member":{"shape":"LensSummary"}, + "documentation":"List of lens summaries of available lenses.
" + }, + "LensSummary":{ + "type":"structure", + "members":{ + "LensArn":{ + "shape":"LensArn", + "documentation":"The ARN of the lens.
" + }, + "LensAlias":{"shape":"LensAlias"}, + "LensName":{"shape":"LensName"}, + "LensType":{ + "shape":"LensType", + "documentation":"The type of the lens.
" + }, + "Description":{"shape":"LensDescription"}, + "CreatedAt":{"shape":"Timestamp"}, + "UpdatedAt":{"shape":"Timestamp"}, + "LensVersion":{ + "shape":"LensVersion", + "documentation":"The version of the lens.
" + }, + "Owner":{"shape":"AwsAccountId"}, + "LensStatus":{ + "shape":"LensStatus", + "documentation":"The status of the lens.
" + } + }, + "documentation":"A lens summary of a lens.
" + }, + "LensType":{ + "type":"string", + "enum":[ + "AWS_OFFICIAL", + "CUSTOM_SHARED", + "CUSTOM_SELF" + ] + }, + "LensUpgradeSummary":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "WorkloadName":{"shape":"WorkloadName"}, + "LensAlias":{"shape":"LensAlias"}, + "LensArn":{ + "shape":"LensArn", + "documentation":"The ARN for the lens.
" + }, + "CurrentLensVersion":{ + "shape":"LensVersion", + "documentation":"The current version of the lens.
" + }, + "LatestLensVersion":{ + "shape":"LensVersion", + "documentation":"The latest version of the lens.
" + }, + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":" ResourceArn of the lens being upgraded
Lens upgrade summary return object.
" + }, + "LensVersion":{ + "type":"string", + "max":32, + "min":1 + }, + "LensesAppliedCount":{ + "type":"integer", + "min":0 + }, + "ListAnswersInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "LensAlias" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "PillarId":{ + "shape":"PillarId", + "location":"querystring", + "locationName":"PillarId" + }, + "MilestoneNumber":{ + "shape":"MilestoneNumber", + "location":"querystring", + "locationName":"MilestoneNumber" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"ListAnswersMaxResults", + "documentation":"The maximum number of results to return for this request.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "QuestionPriority":{ + "shape":"QuestionPriority", + "documentation":"The priority of the question.
", + "location":"querystring", + "locationName":"QuestionPriority" + } + }, + "documentation":"Input to list answers.
" + }, + "ListAnswersMaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "ListAnswersOutput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "MilestoneNumber":{"shape":"MilestoneNumber"}, + "LensAlias":{"shape":"LensAlias"}, + "LensArn":{ + "shape":"LensArn", + "documentation":"The ARN for the lens.
" + }, + "AnswerSummaries":{"shape":"AnswerSummaries"}, + "NextToken":{"shape":"NextToken"} + }, + "documentation":"Output of a list answers call.
" + }, + "ListCheckDetailsInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "LensArn", + "PillarId", + "QuestionId", + "ChoiceId" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"}, + "LensArn":{ + "shape":"LensArn", + "documentation":"Well-Architected Lens ARN.
" + }, + "PillarId":{"shape":"PillarId"}, + "QuestionId":{"shape":"QuestionId"}, + "ChoiceId":{"shape":"ChoiceId"} + } + }, + "ListCheckDetailsOutput":{ + "type":"structure", + "members":{ + "CheckDetails":{ + "shape":"CheckDetails", + "documentation":"The details about the Trusted Advisor checks related to the Well-Architected best practice.
" + }, + "NextToken":{"shape":"NextToken"} + } + }, + "ListCheckSummariesInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "LensArn", + "PillarId", + "QuestionId", + "ChoiceId" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"}, + "LensArn":{ + "shape":"LensArn", + "documentation":"Well-Architected Lens ARN.
" + }, + "PillarId":{"shape":"PillarId"}, + "QuestionId":{"shape":"QuestionId"}, + "ChoiceId":{"shape":"ChoiceId"} + } + }, + "ListCheckSummariesOutput":{ + "type":"structure", + "members":{ + "CheckSummaries":{ + "shape":"CheckSummaries", + "documentation":"List of Trusted Advisor summaries related to the Well-Architected best practice.
" + }, + "NextToken":{"shape":"NextToken"} + } + }, + "ListLensReviewImprovementsInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "LensAlias" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "PillarId":{ + "shape":"PillarId", + "location":"querystring", + "locationName":"PillarId" + }, + "MilestoneNumber":{ + "shape":"MilestoneNumber", + "location":"querystring", + "locationName":"MilestoneNumber" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"ListLensReviewImprovementsMaxResults", + "documentation":"The maximum number of results to return for this request.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "QuestionPriority":{ + "shape":"QuestionPriority", + "documentation":"The priority of the question.
", + "location":"querystring", + "locationName":"QuestionPriority" + } + }, + "documentation":"Input to list lens review improvements.
" + }, + "ListLensReviewImprovementsMaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "ListLensReviewImprovementsOutput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "MilestoneNumber":{"shape":"MilestoneNumber"}, + "LensAlias":{"shape":"LensAlias"}, + "LensArn":{ + "shape":"LensArn", + "documentation":"The ARN for the lens.
" + }, + "ImprovementSummaries":{"shape":"ImprovementSummaries"}, + "NextToken":{"shape":"NextToken"} + }, + "documentation":"Output of a list lens review improvements call.
" + }, + "ListLensReviewsInput":{ + "type":"structure", + "required":["WorkloadId"], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "MilestoneNumber":{ + "shape":"MilestoneNumber", + "location":"querystring", + "locationName":"MilestoneNumber" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"MaxResults" + } + }, + "documentation":"Input to list lens reviews.
" + }, + "ListLensReviewsOutput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "MilestoneNumber":{"shape":"MilestoneNumber"}, + "LensReviewSummaries":{"shape":"LensReviewSummaries"}, + "NextToken":{"shape":"NextToken"} + }, + "documentation":"Output of a list lens reviews call.
" + }, + "ListLensSharesInput":{ + "type":"structure", + "required":["LensAlias"], + "members":{ + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "SharedWithPrefix":{ + "shape":"SharedWithPrefix", + "documentation":"The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the lens is shared.
", + "location":"querystring", + "locationName":"SharedWithPrefix" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"ListWorkloadSharesMaxResults", + "documentation":"The maximum number of results to return for this request.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "Status":{ + "shape":"ShareStatus", + "location":"querystring", + "locationName":"Status" + } + } + }, + "ListLensSharesOutput":{ + "type":"structure", + "members":{ + "LensShareSummaries":{ + "shape":"LensShareSummaries", + "documentation":"A list of lens share summaries.
" + }, + "NextToken":{"shape":"NextToken"} + } + }, + "ListLensesInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"MaxResults" + }, + "LensType":{ + "shape":"LensType", + "documentation":"The type of lenses to be returned.
", + "location":"querystring", + "locationName":"LensType" + }, + "LensStatus":{ + "shape":"LensStatusType", + "documentation":"The status of lenses to be returned.
", + "location":"querystring", + "locationName":"LensStatus" + }, + "LensName":{ + "shape":"LensName", + "location":"querystring", + "locationName":"LensName" + } + }, + "documentation":"Input to list lenses.
" + }, + "ListLensesOutput":{ + "type":"structure", + "members":{ + "LensSummaries":{"shape":"LensSummaries"}, + "NextToken":{"shape":"NextToken"} + }, + "documentation":"Output of a list lenses call.
" + }, + "ListMilestonesInput":{ + "type":"structure", + "required":["WorkloadId"], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"} + }, + "documentation":"Input to list all milestones for a workload.
" + }, + "ListMilestonesOutput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "MilestoneSummaries":{"shape":"MilestoneSummaries"}, + "NextToken":{"shape":"NextToken"} + }, + "documentation":"Output of a list milestones call.
" + }, + "ListNotificationsInput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{ + "shape":"ListNotificationsMaxResults", + "documentation":"The maximum number of results to return for this request.
" + }, + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"The ARN for the related resource for the notification.
Only one of WorkloadID or ResourceARN should be specified.
List of lens notification summaries in a workload.
" + }, + "NextToken":{"shape":"NextToken"} + } + }, + "ListProfileNotificationsInput":{ + "type":"structure", + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"querystring", + "locationName":"WorkloadId" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "ListProfileNotificationsOutput":{ + "type":"structure", + "members":{ + "NotificationSummaries":{ + "shape":"ProfileNotificationSummaries", + "documentation":"Notification summaries.
" + }, + "NextToken":{"shape":"NextToken"} + } + }, + "ListProfileSharesInput":{ + "type":"structure", + "required":["ProfileArn"], + "members":{ + "ProfileArn":{ + "shape":"ProfileArn", + "documentation":"The profile ARN.
", + "location":"uri", + "locationName":"ProfileArn" + }, + "SharedWithPrefix":{ + "shape":"SharedWithPrefix", + "documentation":"The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.
", + "location":"querystring", + "locationName":"SharedWithPrefix" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"ListProfileSharesMaxResults", + "documentation":"The maximum number of results to return for this request.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "Status":{ + "shape":"ShareStatus", + "location":"querystring", + "locationName":"Status" + } + } + }, + "ListProfileSharesMaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "ListProfileSharesOutput":{ + "type":"structure", + "members":{ + "ProfileShareSummaries":{ + "shape":"ProfileShareSummaries", + "documentation":"Profile share summaries.
" + }, + "NextToken":{"shape":"NextToken"} + } + }, + "ListProfilesInput":{ + "type":"structure", + "members":{ + "ProfileNamePrefix":{ + "shape":"ProfileNamePrefix", + "documentation":"An optional string added to the beginning of each profile name returned in the results.
", + "location":"querystring", + "locationName":"ProfileNamePrefix" + }, + "ProfileOwnerType":{ + "shape":"ProfileOwnerType", + "documentation":"Profile owner type.
", + "location":"querystring", + "locationName":"ProfileOwnerType" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "ListProfilesOutput":{ + "type":"structure", + "members":{ + "ProfileSummaries":{ + "shape":"ProfileSummaries", + "documentation":"Profile summaries.
" + }, + "NextToken":{"shape":"NextToken"} + } + }, + "ListReviewTemplateAnswersInput":{ + "type":"structure", + "required":[ + "TemplateArn", + "LensAlias" + ], + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The ARN of the review template.
", + "location":"uri", + "locationName":"TemplateArn" + }, + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "PillarId":{ + "shape":"PillarId", + "location":"querystring", + "locationName":"PillarId" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"ListReviewTemplateAnswersMaxResults", + "documentation":"The maximum number of results to return for this request.
", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "ListReviewTemplateAnswersMaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "ListReviewTemplateAnswersOutput":{ + "type":"structure", + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The ARN of the review template.
" + }, + "LensAlias":{"shape":"LensAlias"}, + "AnswerSummaries":{ + "shape":"ReviewTemplateAnswerSummaries", + "documentation":"List of answer summaries of a lens review in a review template.
" + }, + "NextToken":{"shape":"NextToken"} + } + }, + "ListReviewTemplatesInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "ListReviewTemplatesOutput":{ + "type":"structure", + "members":{ + "ReviewTemplates":{ + "shape":"ReviewTemplates", + "documentation":"List of review templates.
" + }, + "NextToken":{"shape":"NextToken"} + } + }, + "ListShareInvitationsInput":{ + "type":"structure", + "members":{ + "WorkloadNamePrefix":{ + "shape":"WorkloadNamePrefix", + "location":"querystring", + "locationName":"WorkloadNamePrefix" + }, + "LensNamePrefix":{ + "shape":"LensNamePrefix", + "documentation":"An optional string added to the beginning of each lens name returned in the results.
", + "location":"querystring", + "locationName":"LensNamePrefix" + }, + "ShareResourceType":{ + "shape":"ShareResourceType", + "documentation":"The type of share invitations to be returned.
", + "location":"querystring", + "locationName":"ShareResourceType" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"ListShareInvitationsMaxResults", + "documentation":"The maximum number of results to return for this request.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "ProfileNamePrefix":{ + "shape":"ProfileNamePrefix", + "documentation":"An optional string added to the beginning of each profile name returned in the results.
", + "location":"querystring", + "locationName":"ProfileNamePrefix" + }, + "TemplateNamePrefix":{ + "shape":"TemplateNamePrefix", + "documentation":"An optional string added to the beginning of each review template name returned in the results.
", + "location":"querystring", + "locationName":"TemplateNamePrefix" + } + }, + "documentation":"Input for List Share Invitations
" + }, + "ListShareInvitationsMaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "ListShareInvitationsOutput":{ + "type":"structure", + "members":{ + "ShareInvitationSummaries":{ + "shape":"ShareInvitationSummaries", + "documentation":"List of share invitation summaries in a workload.
" + }, + "NextToken":{"shape":"NextToken"} + }, + "documentation":"Input for List Share Invitations
" + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["WorkloadArn"], + "members":{ + "WorkloadArn":{ + "shape":"WorkloadArn", + "location":"uri", + "locationName":"WorkloadArn" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"The tags for the resource.
" + } + } + }, + "ListTemplateSharesInput":{ + "type":"structure", + "required":["TemplateArn"], + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
", + "location":"uri", + "locationName":"TemplateArn" + }, + "SharedWithPrefix":{ + "shape":"SharedWithPrefix", + "documentation":"The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.
", + "location":"querystring", + "locationName":"SharedWithPrefix" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"ListTemplateSharesMaxResults", + "documentation":"The maximum number of results to return for this request.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "Status":{ + "shape":"ShareStatus", + "location":"querystring", + "locationName":"Status" + } + } + }, + "ListTemplateSharesMaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "ListTemplateSharesOutput":{ + "type":"structure", + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
" + }, + "TemplateShareSummaries":{ + "shape":"TemplateShareSummaries", + "documentation":"A review template share summary return object.
" + }, + "NextToken":{"shape":"NextToken"} + } + }, + "ListWorkloadSharesInput":{ + "type":"structure", + "required":["WorkloadId"], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "SharedWithPrefix":{ + "shape":"SharedWithPrefix", + "documentation":"The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload is shared.
", + "location":"querystring", + "locationName":"SharedWithPrefix" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"ListWorkloadSharesMaxResults", + "documentation":"The maximum number of results to return for this request.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "Status":{ + "shape":"ShareStatus", + "location":"querystring", + "locationName":"Status" + } + }, + "documentation":"Input for List Workload Share
" + }, + "ListWorkloadSharesMaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "ListWorkloadSharesOutput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "WorkloadShareSummaries":{"shape":"WorkloadShareSummaries"}, + "NextToken":{"shape":"NextToken"} + }, + "documentation":"Input for List Workload Share
" + }, + "ListWorkloadsInput":{ + "type":"structure", + "members":{ + "WorkloadNamePrefix":{"shape":"WorkloadNamePrefix"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{ + "shape":"ListWorkloadsMaxResults", + "documentation":"The maximum number of results to return for this request.
" + } + }, + "documentation":"Input to list all workloads.
" + }, + "ListWorkloadsMaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "ListWorkloadsOutput":{ + "type":"structure", + "members":{ + "WorkloadSummaries":{"shape":"WorkloadSummaries"}, + "NextToken":{"shape":"NextToken"} + }, + "documentation":"Output of a list workloads call.
" + }, + "MaxResults":{ + "type":"integer", + "documentation":"The maximum number of results to return for this request.
", + "max":50, + "min":1 + }, + "MaxSelectedProfileChoices":{ + "type":"integer", + "min":0 + }, + "MetricType":{ + "type":"string", + "enum":["WORKLOAD"] + }, + "Milestone":{ + "type":"structure", + "members":{ + "MilestoneNumber":{"shape":"MilestoneNumber"}, + "MilestoneName":{"shape":"MilestoneName"}, + "RecordedAt":{"shape":"Timestamp"}, + "Workload":{"shape":"Workload"} + }, + "documentation":"A milestone return object.
" + }, + "MilestoneName":{ + "type":"string", + "documentation":"The name of the milestone in a workload.
Milestone names must be unique within a workload.
", + "max":100, + "min":3 + }, + "MilestoneNumber":{ + "type":"integer", + "documentation":"The milestone number.
A workload can have a maximum of 100 milestones.
", + "max":100, + "min":1 + }, + "MilestoneSummaries":{ + "type":"list", + "member":{"shape":"MilestoneSummary"}, + "documentation":"A list of milestone summaries.
" + }, + "MilestoneSummary":{ + "type":"structure", + "members":{ + "MilestoneNumber":{"shape":"MilestoneNumber"}, + "MilestoneName":{"shape":"MilestoneName"}, + "RecordedAt":{"shape":"Timestamp"}, + "WorkloadSummary":{"shape":"WorkloadSummary"} + }, + "documentation":"A milestone summary return object.
" + }, + "MinSelectedProfileChoices":{ + "type":"integer", + "min":0 + }, + "NextToken":{ + "type":"string", + "documentation":"The token to use to retrieve the next set of results.
" + }, + "Notes":{ + "type":"string", + "documentation":"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.
", + "max":2084 + }, + "NotificationSummaries":{ + "type":"list", + "member":{"shape":"NotificationSummary"} + }, + "NotificationSummary":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"NotificationType", + "documentation":"The type of notification.
" + }, + "LensUpgradeSummary":{ + "shape":"LensUpgradeSummary", + "documentation":"Summary of lens upgrade.
" + } + }, + "documentation":"A notification summary return object.
" + }, + "NotificationType":{ + "type":"string", + "enum":[ + "LENS_VERSION_UPGRADED", + "LENS_VERSION_DEPRECATED" + ] + }, + "OrganizationSharingStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "PermissionType":{ + "type":"string", + "documentation":"Permission granted on a share request.
", + "enum":[ + "READONLY", + "CONTRIBUTOR" + ] + }, + "PillarDifference":{ + "type":"structure", + "members":{ + "PillarId":{"shape":"PillarId"}, + "PillarName":{"shape":"PillarName"}, + "DifferenceStatus":{ + "shape":"DifferenceStatus", + "documentation":"Indicates the type of change to the pillar.
" + }, + "QuestionDifferences":{ + "shape":"QuestionDifferences", + "documentation":"List of question differences.
" + } + }, + "documentation":"A pillar difference return object.
" + }, + "PillarDifferences":{ + "type":"list", + "member":{"shape":"PillarDifference"} + }, + "PillarId":{ + "type":"string", + "documentation":"The ID used to identify a pillar, for example, security.
A pillar is identified by its PillarReviewSummary$PillarId.
", + "max":64, + "min":1 + }, + "PillarMetric":{ + "type":"structure", + "members":{ + "PillarId":{"shape":"PillarId"}, + "RiskCounts":{"shape":"RiskCounts"}, + "Questions":{ + "shape":"QuestionMetrics", + "documentation":"The questions that have been identified as risks in the pillar.
" + } + }, + "documentation":"A metric for a particular pillar in a lens.
" + }, + "PillarMetrics":{ + "type":"list", + "member":{"shape":"PillarMetric"} + }, + "PillarName":{ + "type":"string", + "documentation":"The name of the pillar.
", + "max":128, + "min":1 + }, + "PillarNotes":{ + "type":"map", + "key":{"shape":"PillarId"}, + "value":{"shape":"Notes"}, + "documentation":"List of pillar notes of a lens review in a workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
" + }, + "PillarReviewSummaries":{ + "type":"list", + "member":{"shape":"PillarReviewSummary"}, + "documentation":"List of pillar review summaries of lens review in a workload.
" + }, + "PillarReviewSummary":{ + "type":"structure", + "members":{ + "PillarId":{"shape":"PillarId"}, + "PillarName":{"shape":"PillarName"}, + "Notes":{"shape":"Notes"}, + "RiskCounts":{"shape":"RiskCounts"}, + "PrioritizedRiskCounts":{"shape":"RiskCounts"} + }, + "documentation":"A pillar review summary of a lens review.
" + }, + "Profile":{ + "type":"structure", + "members":{ + "ProfileArn":{ + "shape":"ProfileArn", + "documentation":"The profile ARN.
" + }, + "ProfileVersion":{ + "shape":"ProfileVersion", + "documentation":"The profile version.
" + }, + "ProfileName":{ + "shape":"ProfileName", + "documentation":"The profile name.
" + }, + "ProfileDescription":{ + "shape":"ProfileDescription", + "documentation":"The profile description.
" + }, + "ProfileQuestions":{ + "shape":"ProfileQuestions", + "documentation":"Profile questions.
" + }, + "Owner":{"shape":"AwsAccountId"}, + "CreatedAt":{"shape":"Timestamp"}, + "UpdatedAt":{"shape":"Timestamp"}, + "ShareInvitationId":{ + "shape":"ShareInvitationId", + "documentation":"The ID assigned to the share invitation.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The tags assigned to the profile.
" + } + }, + "documentation":"A profile.
" + }, + "ProfileArn":{ + "type":"string", + "max":2084, + "pattern":"arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:profile/[a-z0-9]+" + }, + "ProfileArns":{ + "type":"list", + "member":{"shape":"ProfileArn"}, + "min":1 + }, + "ProfileChoice":{ + "type":"structure", + "members":{ + "ChoiceId":{"shape":"ChoiceId"}, + "ChoiceTitle":{"shape":"ChoiceTitle"}, + "ChoiceDescription":{"shape":"ChoiceDescription"} + }, + "documentation":"The profile choice.
" + }, + "ProfileDescription":{ + "type":"string", + "max":100, + "min":3 + }, + "ProfileName":{ + "type":"string", + "max":100, + "min":3 + }, + "ProfileNamePrefix":{ + "type":"string", + "max":100 + }, + "ProfileNotificationSummaries":{ + "type":"list", + "member":{"shape":"ProfileNotificationSummary"} + }, + "ProfileNotificationSummary":{ + "type":"structure", + "members":{ + "CurrentProfileVersion":{ + "shape":"ProfileVersion", + "documentation":"The current profile version.
" + }, + "LatestProfileVersion":{ + "shape":"ProfileVersion", + "documentation":"The latest profile version.
" + }, + "Type":{ + "shape":"ProfileNotificationType", + "documentation":"Type of notification.
" + }, + "ProfileArn":{ + "shape":"ProfileArn", + "documentation":"The profile ARN.
" + }, + "ProfileName":{ + "shape":"ProfileName", + "documentation":"The profile name.
" + }, + "WorkloadId":{"shape":"WorkloadId"}, + "WorkloadName":{"shape":"WorkloadName"} + }, + "documentation":"The profile notification summary.
" + }, + "ProfileNotificationType":{ + "type":"string", + "enum":[ + "PROFILE_ANSWERS_UPDATED", + "PROFILE_DELETED" + ] + }, + "ProfileOwnerType":{ + "type":"string", + "enum":[ + "SELF", + "SHARED" + ] + }, + "ProfileQuestion":{ + "type":"structure", + "members":{ + "QuestionId":{"shape":"QuestionId"}, + "QuestionTitle":{"shape":"QuestionTitle"}, + "QuestionDescription":{"shape":"QuestionDescription"}, + "QuestionChoices":{ + "shape":"ProfileQuestionChoices", + "documentation":"The question choices.
" + }, + "SelectedChoiceIds":{ + "shape":"SelectedChoiceIds", + "documentation":"The selected choices.
" + }, + "MinSelectedChoices":{ + "shape":"MinSelectedProfileChoices", + "documentation":"The minimum number of selected choices.
" + }, + "MaxSelectedChoices":{ + "shape":"MaxSelectedProfileChoices", + "documentation":"The maximum number of selected choices.
" + } + }, + "documentation":"A profile question.
" + }, + "ProfileQuestionChoices":{ + "type":"list", + "member":{"shape":"ProfileChoice"} + }, + "ProfileQuestionUpdate":{ + "type":"structure", + "members":{ + "QuestionId":{"shape":"QuestionId"}, + "SelectedChoiceIds":{ + "shape":"SelectedProfileChoiceIds", + "documentation":"The selected choices.
" + } + }, + "documentation":"An update to a profile question.
" + }, + "ProfileQuestionUpdates":{ + "type":"list", + "member":{"shape":"ProfileQuestionUpdate"} + }, + "ProfileQuestions":{ + "type":"list", + "member":{"shape":"ProfileQuestion"} + }, + "ProfileShareSummaries":{ + "type":"list", + "member":{"shape":"ProfileShareSummary"} + }, + "ProfileShareSummary":{ + "type":"structure", + "members":{ + "ShareId":{"shape":"ShareId"}, + "SharedWith":{"shape":"SharedWith"}, + "Status":{"shape":"ShareStatus"}, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"Profile share invitation status message.
" + } + }, + "documentation":"Summary of a profile share.
" + }, + "ProfileSummaries":{ + "type":"list", + "member":{"shape":"ProfileSummary"} + }, + "ProfileSummary":{ + "type":"structure", + "members":{ + "ProfileArn":{ + "shape":"ProfileArn", + "documentation":"The profile ARN.
" + }, + "ProfileVersion":{ + "shape":"ProfileVersion", + "documentation":"The profile version.
" + }, + "ProfileName":{ + "shape":"ProfileName", + "documentation":"The profile name.
" + }, + "ProfileDescription":{ + "shape":"ProfileDescription", + "documentation":"The profile description.
" + }, + "Owner":{"shape":"AwsAccountId"}, + "CreatedAt":{"shape":"Timestamp"}, + "UpdatedAt":{"shape":"Timestamp"} + }, + "documentation":"Summary of a profile.
" + }, + "ProfileTemplate":{ + "type":"structure", + "members":{ + "TemplateName":{ + "shape":"ProfileName", + "documentation":"The name of the profile template.
" + }, + "TemplateQuestions":{ + "shape":"TemplateQuestions", + "documentation":"Profile template questions.
" + }, + "CreatedAt":{"shape":"Timestamp"}, + "UpdatedAt":{"shape":"Timestamp"} + }, + "documentation":"The profile template.
" + }, + "ProfileTemplateChoice":{ + "type":"structure", + "members":{ + "ChoiceId":{"shape":"ChoiceId"}, + "ChoiceTitle":{"shape":"ChoiceTitle"}, + "ChoiceDescription":{"shape":"ChoiceDescription"} + }, + "documentation":"A profile template choice.
" + }, + "ProfileTemplateQuestion":{ + "type":"structure", + "members":{ + "QuestionId":{"shape":"QuestionId"}, + "QuestionTitle":{"shape":"QuestionTitle"}, + "QuestionDescription":{"shape":"QuestionDescription"}, + "QuestionChoices":{ + "shape":"ProfileTemplateQuestionChoices", + "documentation":"The question choices.
" + }, + "MinSelectedChoices":{ + "shape":"MinSelectedProfileChoices", + "documentation":"The minimum number of choices selected.
" + }, + "MaxSelectedChoices":{ + "shape":"MaxSelectedProfileChoices", + "documentation":"The maximum number of choices selected.
" + } + }, + "documentation":"A profile template question.
" + }, + "ProfileTemplateQuestionChoices":{ + "type":"list", + "member":{"shape":"ProfileTemplateChoice"} + }, + "ProfileVersion":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^[A-Za-z0-9-]+$" + }, + "Question":{ + "type":"string", + "enum":[ + "UNANSWERED", + "ANSWERED" + ] + }, + "QuestionCounts":{ + "type":"map", + "key":{"shape":"Question"}, + "value":{"shape":"Count"} + }, + "QuestionDescription":{ + "type":"string", + "documentation":"The description of the question.
", + "max":1024, + "min":1 + }, + "QuestionDifference":{ + "type":"structure", + "members":{ + "QuestionId":{"shape":"QuestionId"}, + "QuestionTitle":{"shape":"QuestionTitle"}, + "DifferenceStatus":{ + "shape":"DifferenceStatus", + "documentation":"Indicates the type of change to the question.
" + } + }, + "documentation":"A question difference return object.
" + }, + "QuestionDifferences":{ + "type":"list", + "member":{"shape":"QuestionDifference"} + }, + "QuestionId":{ + "type":"string", + "documentation":"The ID of the question.
", + "max":128, + "min":1 + }, + "QuestionMetric":{ + "type":"structure", + "members":{ + "QuestionId":{"shape":"QuestionId"}, + "Risk":{"shape":"Risk"}, + "BestPractices":{ + "shape":"BestPractices", + "documentation":"The best practices, or choices, that have been identified as contributing to risk in a question.
" + } + }, + "documentation":"A metric for a particular question in the pillar.
" + }, + "QuestionMetrics":{ + "type":"list", + "member":{"shape":"QuestionMetric"} + }, + "QuestionPriority":{ + "type":"string", + "enum":[ + "PRIORITIZED", + "NONE" + ] + }, + "QuestionTitle":{ + "type":"string", + "documentation":"The title of the question.
", + "max":512, + "min":1 + }, + "QuestionType":{ + "type":"string", + "enum":[ + "PRIORITIZED", + "NON_PRIORITIZED" + ] + }, + "QuotaCode":{ + "type":"string", + "documentation":"Service Quotas requirement to identify originating quota.
" + }, + "ReportFormat":{ + "type":"string", + "enum":[ + "PDF", + "JSON" + ] + }, + "ResourceArn":{ + "type":"string", + "max":250, + "min":50, + "pattern":"arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(-gov|-iso([a-z])?)?-[a-z]+-\\d:\\d{12}:(review-template)/[a-f0-9]{32}" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "Message", + "ResourceId", + "ResourceType" + ], + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "ResourceId":{"shape":"ExceptionResourceId"}, + "ResourceType":{"shape":"ExceptionResourceType"} + }, + "documentation":"The requested resource was not found.
", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ReviewTemplate":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"TemplateDescription", + "documentation":"The review template description.
" + }, + "Lenses":{ + "shape":"ReviewTemplateLenses", + "documentation":"The lenses applied to the review template.
" + }, + "Notes":{"shape":"Notes"}, + "QuestionCounts":{ + "shape":"QuestionCounts", + "documentation":"A count of how many total questions are answered and unanswered in the review template.
" + }, + "Owner":{"shape":"AwsAccountId"}, + "UpdatedAt":{"shape":"Timestamp"}, + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
" + }, + "TemplateName":{ + "shape":"TemplateName", + "documentation":"The name of the review template.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The tags assigned to the review template.
" + }, + "UpdateStatus":{ + "shape":"ReviewTemplateUpdateStatus", + "documentation":"The latest status of a review template.
" + }, + "ShareInvitationId":{ + "shape":"ShareInvitationId", + "documentation":"The ID assigned to the template share invitation.
" + } + }, + "documentation":"A review template.
" + }, + "ReviewTemplateAnswer":{ + "type":"structure", + "members":{ + "QuestionId":{"shape":"QuestionId"}, + "PillarId":{"shape":"PillarId"}, + "QuestionTitle":{"shape":"QuestionTitle"}, + "QuestionDescription":{"shape":"QuestionDescription"}, + "ImprovementPlanUrl":{"shape":"ImprovementPlanUrl"}, + "HelpfulResourceUrl":{"shape":"HelpfulResourceUrl"}, + "HelpfulResourceDisplayText":{ + "shape":"DisplayText", + "documentation":"The helpful resource text to be displayed for a custom lens.
This field does not apply to Amazon Web Services official lenses.
A list of selected choices to a question in your review template.
" + }, + "IsApplicable":{"shape":"IsApplicable"}, + "AnswerStatus":{ + "shape":"ReviewTemplateAnswerStatus", + "documentation":"The status of whether or not this question has been answered.
" + }, + "Notes":{"shape":"Notes"}, + "Reason":{ + "shape":"AnswerReason", + "documentation":"The reason why the question is not applicable to your review template.
" + } + }, + "documentation":"An answer of the question.
" + }, + "ReviewTemplateAnswerStatus":{ + "type":"string", + "enum":[ + "UNANSWERED", + "ANSWERED" + ] + }, + "ReviewTemplateAnswerSummaries":{ + "type":"list", + "member":{"shape":"ReviewTemplateAnswerSummary"} + }, + "ReviewTemplateAnswerSummary":{ + "type":"structure", + "members":{ + "QuestionId":{"shape":"QuestionId"}, + "PillarId":{"shape":"PillarId"}, + "QuestionTitle":{"shape":"QuestionTitle"}, + "Choices":{"shape":"Choices"}, + "SelectedChoices":{"shape":"SelectedChoices"}, + "ChoiceAnswerSummaries":{ + "shape":"ChoiceAnswerSummaries", + "documentation":"A list of selected choices to a question in the review template.
" + }, + "IsApplicable":{"shape":"IsApplicable"}, + "AnswerStatus":{ + "shape":"ReviewTemplateAnswerStatus", + "documentation":"The status of whether or not this question has been answered.
" + }, + "Reason":{ + "shape":"AnswerReason", + "documentation":"The reason why a choice is not-applicable to a question in the review template.
" + }, + "QuestionType":{ + "shape":"QuestionType", + "documentation":"The type of question.
" + } + }, + "documentation":"The summary of review template answers.
" + }, + "ReviewTemplateArns":{ + "type":"list", + "member":{"shape":"TemplateArn"}, + "max":1 + }, + "ReviewTemplateLensAliases":{ + "type":"list", + "member":{"shape":"LensAlias"}, + "max":10, + "min":1 + }, + "ReviewTemplateLensReview":{ + "type":"structure", + "members":{ + "LensAlias":{"shape":"LensAlias"}, + "LensArn":{ + "shape":"LensArn", + "documentation":"The lens ARN.
" + }, + "LensVersion":{ + "shape":"LensVersion", + "documentation":"The version of the lens.
" + }, + "LensName":{"shape":"LensName"}, + "LensStatus":{ + "shape":"LensStatus", + "documentation":"The status of the lens.
" + }, + "PillarReviewSummaries":{ + "shape":"ReviewTemplatePillarReviewSummaries", + "documentation":"Pillar review summaries of a lens review.
" + }, + "UpdatedAt":{"shape":"Timestamp"}, + "Notes":{"shape":"Notes"}, + "QuestionCounts":{ + "shape":"QuestionCounts", + "documentation":"A count of how many questions are answered and unanswered in the lens review.
" + }, + "NextToken":{"shape":"NextToken"} + }, + "documentation":"The lens review of a review template.
" + }, + "ReviewTemplateLenses":{ + "type":"list", + "member":{"shape":"LensAlias"} + }, + "ReviewTemplatePillarReviewSummaries":{ + "type":"list", + "member":{"shape":"ReviewTemplatePillarReviewSummary"} + }, + "ReviewTemplatePillarReviewSummary":{ + "type":"structure", + "members":{ + "PillarId":{"shape":"PillarId"}, + "PillarName":{"shape":"PillarName"}, + "Notes":{"shape":"Notes"}, + "QuestionCounts":{ + "shape":"QuestionCounts", + "documentation":"A count of how many questions are answered and unanswered in the requested pillar of the lens review.
" + } + }, + "documentation":"Summary of a review template.
" + }, + "ReviewTemplateSummary":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"TemplateDescription", + "documentation":"Description of the review template.
" + }, + "Lenses":{ + "shape":"ReviewTemplateLenses", + "documentation":"Lenses associated with the review template.
" + }, + "Owner":{"shape":"AwsAccountId"}, + "UpdatedAt":{"shape":"Timestamp"}, + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
" + }, + "TemplateName":{ + "shape":"TemplateName", + "documentation":"The name of the review template.
" + }, + "UpdateStatus":{ + "shape":"ReviewTemplateUpdateStatus", + "documentation":"The latest status of a review template.
" + } + }, + "documentation":"Summary of a review template.
" + }, + "ReviewTemplateUpdateStatus":{ + "type":"string", + "enum":[ + "CURRENT", + "LENS_NOT_CURRENT" + ] + }, + "ReviewTemplates":{ + "type":"list", + "member":{"shape":"ReviewTemplateSummary"} + }, + "Risk":{ + "type":"string", + "documentation":"The risk for a given workload, lens review, pillar, or question.
", + "enum":[ + "UNANSWERED", + "HIGH", + "MEDIUM", + "NONE", + "NOT_APPLICABLE" + ] + }, + "RiskCounts":{ + "type":"map", + "key":{"shape":"Risk"}, + "value":{"shape":"Count"}, + "documentation":"A map from risk names to the count of how many questions have that rating.
" + }, + "SelectedChoiceIds":{ + "type":"list", + "member":{"shape":"ChoiceId"} + }, + "SelectedChoices":{ + "type":"list", + "member":{"shape":"ChoiceId"}, + "documentation":"List of selected choice IDs in a question answer.
The values entered replace the previously selected choices.
" + }, + "SelectedPillar":{ + "type":"structure", + "members":{ + "PillarId":{"shape":"PillarId"}, + "SelectedQuestionIds":{ + "shape":"SelectedQuestionIds", + "documentation":"Selected question IDs in the selected pillar.
" + } + }, + "documentation":"The selected pillar.
" + }, + "SelectedPillars":{ + "type":"list", + "member":{"shape":"SelectedPillar"} + }, + "SelectedProfileChoiceIds":{ + "type":"list", + "member":{"shape":"ChoiceId"} + }, + "SelectedQuestionId":{"type":"string"}, + "SelectedQuestionIds":{ + "type":"list", + "member":{"shape":"SelectedQuestionId"} + }, + "ServiceCode":{ + "type":"string", + "documentation":"Service Quotas requirement to identify originating service.
" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "Message", + "QuotaCode", + "ServiceCode" + ], + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "ResourceId":{"shape":"ExceptionResourceId"}, + "ResourceType":{"shape":"ExceptionResourceType"}, + "QuotaCode":{"shape":"QuotaCode"}, + "ServiceCode":{"shape":"ServiceCode"} + }, + "documentation":"The user has reached their resource quota.
", + "error":{"httpStatusCode":402}, + "exception":true + }, + "ShareId":{ + "type":"string", + "documentation":"The ID associated with the share.
", + "pattern":"[0-9a-f]{32}" + }, + "ShareInvitation":{ + "type":"structure", + "members":{ + "ShareInvitationId":{ + "shape":"ShareInvitationId", + "documentation":"The ID assigned to the share invitation.
" + }, + "ShareResourceType":{ + "shape":"ShareResourceType", + "documentation":"The resource type of the share invitation.
" + }, + "WorkloadId":{"shape":"WorkloadId"}, + "LensAlias":{"shape":"LensAlias"}, + "LensArn":{ + "shape":"LensArn", + "documentation":"The ARN for the lens.
" + }, + "ProfileArn":{ + "shape":"ProfileArn", + "documentation":"The profile ARN.
" + }, + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
" + } + }, + "documentation":"The share invitation.
" + }, + "ShareInvitationAction":{ + "type":"string", + "documentation":"Share invitation action taken by contributor.
", + "enum":[ + "ACCEPT", + "REJECT" + ] + }, + "ShareInvitationId":{ + "type":"string", + "pattern":"[0-9a-f]{32}" + }, + "ShareInvitationSummaries":{ + "type":"list", + "member":{"shape":"ShareInvitationSummary"} + }, + "ShareInvitationSummary":{ + "type":"structure", + "members":{ + "ShareInvitationId":{ + "shape":"ShareInvitationId", + "documentation":"The ID assigned to the share invitation.
" + }, + "SharedBy":{"shape":"AwsAccountId"}, + "SharedWith":{"shape":"SharedWith"}, + "PermissionType":{"shape":"PermissionType"}, + "ShareResourceType":{ + "shape":"ShareResourceType", + "documentation":"The resource type of the share invitation.
" + }, + "WorkloadName":{"shape":"WorkloadName"}, + "WorkloadId":{"shape":"WorkloadId"}, + "LensName":{"shape":"LensName"}, + "LensArn":{ + "shape":"LensArn", + "documentation":"The ARN for the lens.
" + }, + "ProfileName":{ + "shape":"ProfileName", + "documentation":"The profile name.
" + }, + "ProfileArn":{ + "shape":"ProfileArn", + "documentation":"The profile ARN.
" + }, + "TemplateName":{ + "shape":"TemplateName", + "documentation":"The name of the review template.
" + }, + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
" + } + }, + "documentation":"A share invitation summary return object.
" + }, + "ShareResourceType":{ + "type":"string", + "enum":[ + "WORKLOAD", + "LENS", + "PROFILE", + "TEMPLATE" + ] + }, + "ShareStatus":{ + "type":"string", + "documentation":"The status of the share request.
", + "enum":[ + "ACCEPTED", + "REJECTED", + "PENDING", + "REVOKED", + "EXPIRED", + "ASSOCIATING", + "ASSOCIATED", + "FAILED" + ] + }, + "SharedWith":{ + "type":"string", + "documentation":"The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.
", + "max":2048, + "min":12 + }, + "SharedWithPrefix":{ + "type":"string", + "max":100 + }, + "StatusMessage":{ + "type":"string", + "max":512, + "min":1 + }, + "Subdomain":{ + "type":"string", + "max":100, + "min":1 + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":1 + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "WorkloadArn", + "Tags" + ], + "members":{ + "WorkloadArn":{ + "shape":"WorkloadArn", + "location":"uri", + "locationName":"WorkloadArn" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The tags for the resource.
" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TemplateArn":{ + "type":"string", + "max":250, + "min":50, + "pattern":"arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(-gov|-iso([a-z])?)?-[a-z]+-\\d:\\d{12}:(review-template)/[a-f0-9]{32}" + }, + "TemplateDescription":{ + "type":"string", + "max":250, + "min":3, + "pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" + }, + "TemplateName":{ + "type":"string", + "max":100, + "min":3, + "pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" + }, + "TemplateNamePrefix":{ + "type":"string", + "max":100, + "pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" + }, + "TemplateQuestions":{ + "type":"list", + "member":{"shape":"ProfileTemplateQuestion"} + }, + "TemplateShareSummaries":{ + "type":"list", + "member":{"shape":"TemplateShareSummary"} + }, + "TemplateShareSummary":{ + "type":"structure", + "members":{ + "ShareId":{"shape":"ShareId"}, + "SharedWith":{"shape":"SharedWith"}, + "Status":{"shape":"ShareStatus"}, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"Review template share invitation status message.
" + } + }, + "documentation":"Summary of a review template share.
" + }, + "ThrottlingException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "QuotaCode":{"shape":"QuotaCode"}, + "ServiceCode":{"shape":"ServiceCode"} + }, + "documentation":"Request was denied due to request throttling.
", + "error":{"httpStatusCode":429}, + "exception":true + }, + "Timestamp":{ + "type":"timestamp", + "documentation":"The date and time recorded.
" + }, + "TrustedAdvisorIntegrationStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "WorkloadArn", + "TagKeys" + ], + "members":{ + "WorkloadArn":{ + "shape":"WorkloadArn", + "location":"uri", + "locationName":"WorkloadArn" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateAnswerInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "LensAlias", + "QuestionId" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "QuestionId":{ + "shape":"QuestionId", + "location":"uri", + "locationName":"QuestionId" + }, + "SelectedChoices":{"shape":"SelectedChoices"}, + "ChoiceUpdates":{ + "shape":"ChoiceUpdates", + "documentation":"A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.
" + }, + "Notes":{"shape":"Notes"}, + "IsApplicable":{"shape":"IsApplicable"}, + "Reason":{ + "shape":"AnswerReason", + "documentation":"The reason why a question is not applicable to your workload.
" + } + }, + "documentation":"Input to update answer.
" + }, + "UpdateAnswerOutput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "LensAlias":{"shape":"LensAlias"}, + "LensArn":{ + "shape":"LensArn", + "documentation":"The ARN for the lens.
" + }, + "Answer":{"shape":"Answer"} + }, + "documentation":"Output of a update answer call.
" + }, + "UpdateGlobalSettingsInput":{ + "type":"structure", + "members":{ + "OrganizationSharingStatus":{ + "shape":"OrganizationSharingStatus", + "documentation":"The status of organization sharing settings.
" + }, + "DiscoveryIntegrationStatus":{ + "shape":"DiscoveryIntegrationStatus", + "documentation":"The status of discovery support settings.
" + }, + "JiraConfiguration":{ + "shape":"AccountJiraConfigurationInput", + "documentation":"The status of Jira integration settings.
" + } + } + }, + "UpdateIntegrationInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "ClientRequestToken", + "IntegratingService" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + }, + "IntegratingService":{ + "shape":"IntegratingService", + "documentation":"Which integrated service to update.
" + } + } + }, + "UpdateLensReviewInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "LensAlias" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "LensNotes":{"shape":"Notes"}, + "PillarNotes":{"shape":"PillarNotes"}, + "JiraConfiguration":{ + "shape":"JiraSelectedQuestionConfiguration", + "documentation":"Configuration of the Jira integration.
" + } + }, + "documentation":"Input for update lens review.
" + }, + "UpdateLensReviewOutput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "LensReview":{"shape":"LensReview"} + }, + "documentation":"Output of a update lens review call.
" + }, + "UpdateProfileInput":{ + "type":"structure", + "required":["ProfileArn"], + "members":{ + "ProfileArn":{ + "shape":"ProfileArn", + "documentation":"The profile ARN.
", + "location":"uri", + "locationName":"ProfileArn" + }, + "ProfileDescription":{ + "shape":"ProfileDescription", + "documentation":"The profile description.
" + }, + "ProfileQuestions":{ + "shape":"ProfileQuestionUpdates", + "documentation":"Profile questions.
" + } + } + }, + "UpdateProfileOutput":{ + "type":"structure", + "members":{ + "Profile":{ + "shape":"Profile", + "documentation":"The profile.
" + } + } + }, + "UpdateReviewTemplateAnswerInput":{ + "type":"structure", + "required":[ + "TemplateArn", + "LensAlias", + "QuestionId" + ], + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
", + "location":"uri", + "locationName":"TemplateArn" + }, + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "QuestionId":{ + "shape":"QuestionId", + "location":"uri", + "locationName":"QuestionId" + }, + "SelectedChoices":{"shape":"SelectedChoices"}, + "ChoiceUpdates":{ + "shape":"ChoiceUpdates", + "documentation":"A list of choices to be updated.
" + }, + "Notes":{"shape":"Notes"}, + "IsApplicable":{"shape":"IsApplicable"}, + "Reason":{ + "shape":"AnswerReason", + "documentation":"The update reason.
" + } + } + }, + "UpdateReviewTemplateAnswerOutput":{ + "type":"structure", + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
" + }, + "LensAlias":{"shape":"LensAlias"}, + "Answer":{ + "shape":"ReviewTemplateAnswer", + "documentation":"An answer of the question.
" + } + } + }, + "UpdateReviewTemplateInput":{ + "type":"structure", + "required":["TemplateArn"], + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
", + "location":"uri", + "locationName":"TemplateArn" + }, + "TemplateName":{ + "shape":"TemplateName", + "documentation":"The review template name.
" + }, + "Description":{ + "shape":"TemplateDescription", + "documentation":"The review template description.
" + }, + "Notes":{"shape":"Notes"}, + "LensesToAssociate":{ + "shape":"ReviewTemplateLensAliases", + "documentation":"A list of lens aliases or ARNs to apply to the review template.
" + }, + "LensesToDisassociate":{ + "shape":"ReviewTemplateLensAliases", + "documentation":"A list of lens aliases or ARNs to unapply to the review template. The wellarchitected lens cannot be unapplied.
The review template ARN.
", + "location":"uri", + "locationName":"TemplateArn" + }, + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "LensNotes":{"shape":"Notes"}, + "PillarNotes":{"shape":"PillarNotes"} + } + }, + "UpdateReviewTemplateLensReviewOutput":{ + "type":"structure", + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The review template ARN.
" + }, + "LensReview":{ + "shape":"ReviewTemplateLensReview", + "documentation":"A lens review of a question.
" + } + } + }, + "UpdateReviewTemplateOutput":{ + "type":"structure", + "members":{ + "ReviewTemplate":{ + "shape":"ReviewTemplate", + "documentation":"A review template.
" + } + } + }, + "UpdateShareInvitationInput":{ + "type":"structure", + "required":[ + "ShareInvitationId", + "ShareInvitationAction" + ], + "members":{ + "ShareInvitationId":{ + "shape":"ShareInvitationId", + "documentation":"The ID assigned to the share invitation.
", + "location":"uri", + "locationName":"ShareInvitationId" + }, + "ShareInvitationAction":{"shape":"ShareInvitationAction"} + }, + "documentation":"Input for Update Share Invitation
" + }, + "UpdateShareInvitationOutput":{ + "type":"structure", + "members":{ + "ShareInvitation":{ + "shape":"ShareInvitation", + "documentation":"The updated workload or custom lens share invitation.
" + } + } + }, + "UpdateWorkloadInput":{ + "type":"structure", + "required":["WorkloadId"], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "WorkloadName":{"shape":"WorkloadName"}, + "Description":{"shape":"WorkloadDescription"}, + "Environment":{"shape":"WorkloadEnvironment"}, + "AccountIds":{"shape":"WorkloadAccountIds"}, + "AwsRegions":{"shape":"WorkloadAwsRegions"}, + "NonAwsRegions":{"shape":"WorkloadNonAwsRegions"}, + "PillarPriorities":{"shape":"WorkloadPillarPriorities"}, + "ArchitecturalDesign":{"shape":"WorkloadArchitecturalDesign"}, + "ReviewOwner":{"shape":"WorkloadReviewOwner"}, + "IsReviewOwnerUpdateAcknowledged":{ + "shape":"IsReviewOwnerUpdateAcknowledged", + "documentation":"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.
" + }, + "IndustryType":{"shape":"WorkloadIndustryType"}, + "Industry":{"shape":"WorkloadIndustry"}, + "Notes":{"shape":"Notes"}, + "ImprovementStatus":{"shape":"WorkloadImprovementStatus"}, + "DiscoveryConfig":{ + "shape":"WorkloadDiscoveryConfig", + "documentation":"Well-Architected discovery configuration settings to associate to the workload.
" + }, + "Applications":{ + "shape":"WorkloadApplications", + "documentation":"List of AppRegistry application ARNs to associate to the workload.
" + }, + "JiraConfiguration":{ + "shape":"WorkloadJiraConfigurationInput", + "documentation":"Configuration of the Jira integration.
" + } + }, + "documentation":"Input to update a workload.
" + }, + "UpdateWorkloadOutput":{ + "type":"structure", + "members":{ + "Workload":{"shape":"Workload"} + }, + "documentation":"Output of an update workload call.
" + }, + "UpdateWorkloadShareInput":{ + "type":"structure", + "required":[ + "ShareId", + "WorkloadId", + "PermissionType" + ], + "members":{ + "ShareId":{ + "shape":"ShareId", + "location":"uri", + "locationName":"ShareId" + }, + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "PermissionType":{"shape":"PermissionType"} + }, + "documentation":"Input for Update Workload Share
" + }, + "UpdateWorkloadShareOutput":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "WorkloadShare":{"shape":"WorkloadShare"} + }, + "documentation":"Input for Update Workload Share
" + }, + "UpgradeLensReviewInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "LensAlias", + "MilestoneName" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "MilestoneName":{"shape":"MilestoneName"}, + "ClientRequestToken":{"shape":"ClientRequestToken"} + } + }, + "UpgradeProfileVersionInput":{ + "type":"structure", + "required":[ + "WorkloadId", + "ProfileArn" + ], + "members":{ + "WorkloadId":{ + "shape":"WorkloadId", + "location":"uri", + "locationName":"WorkloadId" + }, + "ProfileArn":{ + "shape":"ProfileArn", + "documentation":"The profile ARN.
", + "location":"uri", + "locationName":"ProfileArn" + }, + "MilestoneName":{"shape":"MilestoneName"}, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + } + } + }, + "UpgradeReviewTemplateLensReviewInput":{ + "type":"structure", + "required":[ + "TemplateArn", + "LensAlias" + ], + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"The ARN of the review template.
", + "location":"uri", + "locationName":"TemplateArn" + }, + "LensAlias":{ + "shape":"LensAlias", + "location":"uri", + "locationName":"LensAlias" + }, + "ClientRequestToken":{"shape":"ClientRequestToken"} + } + }, + "Urls":{ + "type":"list", + "member":{"shape":"ChoiceContent"} + }, + "ValidationException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "Reason":{"shape":"ValidationExceptionReason"}, + "Fields":{"shape":"ValidationExceptionFieldList"} + }, + "documentation":"The user input is not valid.
", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "Name", + "Message" + ], + "members":{ + "Name":{"shape":"ValidationExceptionFieldName"}, + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"Stores information about a field passed inside a request that resulted in an exception.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"}, + "documentation":"The fields that caused the error, if applicable.
" + }, + "ValidationExceptionFieldName":{ + "type":"string", + "documentation":"The field name for which validation failed.
" + }, + "ValidationExceptionReason":{ + "type":"string", + "documentation":"The reason why the request failed validation.
", + "enum":[ + "UNKNOWN_OPERATION", + "CANNOT_PARSE", + "FIELD_VALIDATION_FAILED", + "OTHER" + ] + }, + "VersionDifferences":{ + "type":"structure", + "members":{ + "PillarDifferences":{ + "shape":"PillarDifferences", + "documentation":"The differences between the base and latest versions of the lens.
" + } + }, + "documentation":"The differences between the base and latest versions of the lens.
" + }, + "Workload":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "WorkloadArn":{"shape":"WorkloadArn"}, + "WorkloadName":{"shape":"WorkloadName"}, + "Description":{"shape":"WorkloadDescription"}, + "Environment":{"shape":"WorkloadEnvironment"}, + "UpdatedAt":{"shape":"Timestamp"}, + "AccountIds":{"shape":"WorkloadAccountIds"}, + "AwsRegions":{"shape":"WorkloadAwsRegions"}, + "NonAwsRegions":{"shape":"WorkloadNonAwsRegions"}, + "ArchitecturalDesign":{"shape":"WorkloadArchitecturalDesign"}, + "ReviewOwner":{"shape":"WorkloadReviewOwner"}, + "ReviewRestrictionDate":{"shape":"Timestamp"}, + "IsReviewOwnerUpdateAcknowledged":{ + "shape":"IsReviewOwnerUpdateAcknowledged", + "documentation":"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.
" + }, + "IndustryType":{"shape":"WorkloadIndustryType"}, + "Industry":{"shape":"WorkloadIndustry"}, + "Notes":{"shape":"Notes"}, + "ImprovementStatus":{"shape":"WorkloadImprovementStatus"}, + "RiskCounts":{"shape":"RiskCounts"}, + "PillarPriorities":{"shape":"WorkloadPillarPriorities"}, + "Lenses":{"shape":"WorkloadLenses"}, + "Owner":{"shape":"AwsAccountId"}, + "ShareInvitationId":{ + "shape":"ShareInvitationId", + "documentation":"The ID assigned to the share invitation.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The tags associated with the workload.
" + }, + "DiscoveryConfig":{ + "shape":"WorkloadDiscoveryConfig", + "documentation":"Discovery configuration associated to the workload.
" + }, + "Applications":{ + "shape":"WorkloadApplications", + "documentation":"List of AppRegistry application ARNs associated to the workload.
" + }, + "Profiles":{ + "shape":"WorkloadProfiles", + "documentation":"Profile associated with a workload.
" + }, + "PrioritizedRiskCounts":{"shape":"RiskCounts"}, + "JiraConfiguration":{ + "shape":"WorkloadJiraConfigurationOutput", + "documentation":"Jira configuration for a specific workload.
" + } + }, + "documentation":"A workload return object.
" + }, + "WorkloadAccountIds":{ + "type":"list", + "member":{"shape":"AwsAccountId"}, + "documentation":"The list of Amazon Web Services account IDs associated with the workload.
", + "max":100 + }, + "WorkloadApplications":{ + "type":"list", + "member":{"shape":"ApplicationArn"}, + "max":1 + }, + "WorkloadArchitecturalDesign":{ + "type":"string", + "documentation":"The URL of the architectural design for the workload.
", + "max":2048, + "pattern":"^(|(https?|ftp):\\/\\/[^\\s/$.?#].[^\\s]*)$" + }, + "WorkloadArn":{ + "type":"string", + "documentation":"The ARN for the workload.
" + }, + "WorkloadAwsRegions":{ + "type":"list", + "member":{"shape":"AwsRegion"}, + "documentation":"The list of Amazon Web Services Regions associated with the workload, for example, us-east-2, or ca-central-1.
The description for the workload.
", + "max":250, + "min":3 + }, + "WorkloadDiscoveryConfig":{ + "type":"structure", + "members":{ + "TrustedAdvisorIntegrationStatus":{ + "shape":"TrustedAdvisorIntegrationStatus", + "documentation":"Discovery integration status in respect to Trusted Advisor for the workload.
" + }, + "WorkloadResourceDefinition":{ + "shape":"WorkloadResourceDefinition", + "documentation":"The mode to use for identifying resources associated with the workload.
You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.
Discovery configuration associated to the workload.
" + }, + "WorkloadEnvironment":{ + "type":"string", + "documentation":"The environment for the workload.
", + "enum":[ + "PRODUCTION", + "PREPRODUCTION" + ] + }, + "WorkloadId":{ + "type":"string", + "documentation":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
", + "max":32, + "min":32, + "pattern":"[0-9a-f]{32}" + }, + "WorkloadImprovementStatus":{ + "type":"string", + "documentation":"The improvement status for a workload.
", + "enum":[ + "NOT_APPLICABLE", + "NOT_STARTED", + "IN_PROGRESS", + "COMPLETE", + "RISK_ACKNOWLEDGED" + ] + }, + "WorkloadIndustry":{ + "type":"string", + "documentation":"The industry for the workload.
", + "max":100 + }, + "WorkloadIndustryType":{ + "type":"string", + "documentation":"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
Workload-level: Jira issue management status.
" + }, + "IssueManagementType":{ + "shape":"IssueManagementType", + "documentation":"Workload-level: Jira issue management type.
" + }, + "JiraProjectKey":{ + "shape":"JiraProjectKey", + "documentation":"Workload-level: Jira project key to sync workloads to.
" + } + }, + "documentation":"Workload-level: Input for the Jira configuration.
" + }, + "WorkloadJiraConfigurationOutput":{ + "type":"structure", + "members":{ + "IssueManagementStatus":{ + "shape":"WorkloadIssueManagementStatus", + "documentation":"Workload-level: Jira issue management status.
" + }, + "IssueManagementType":{ + "shape":"IssueManagementType", + "documentation":"Workload-level: Jira issue management type.
" + }, + "JiraProjectKey":{ + "shape":"JiraProjectKey", + "documentation":"Workload-level: Jira project key to sync workloads to.
" + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"Workload-level: Status message on configuration of the Jira integration.
" + } + }, + "documentation":"Workload-level: Output configuration of the Jira integration.
" + }, + "WorkloadLenses":{ + "type":"list", + "member":{"shape":"LensAlias"}, + "documentation":"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.
" + }, + "WorkloadName":{ + "type":"string", + "documentation":"The name of the workload.
The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
", + "max":100, + "min":3 + }, + "WorkloadNamePrefix":{ + "type":"string", + "documentation":"An optional string added to the beginning of each workload name returned in the results.
", + "max":100 + }, + "WorkloadNonAwsRegion":{ + "type":"string", + "max":25, + "min":3 + }, + "WorkloadNonAwsRegions":{ + "type":"list", + "member":{"shape":"WorkloadNonAwsRegion"}, + "documentation":"The list of non-Amazon Web Services Regions associated with the workload.
", + "max":5 + }, + "WorkloadPillarPriorities":{ + "type":"list", + "member":{"shape":"PillarId"}, + "documentation":"The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
" + }, + "WorkloadProfile":{ + "type":"structure", + "members":{ + "ProfileArn":{ + "shape":"ProfileArn", + "documentation":"The profile ARN.
" + }, + "ProfileVersion":{ + "shape":"ProfileVersion", + "documentation":"The profile version.
" + } + }, + "documentation":"The profile associated with a workload.
" + }, + "WorkloadProfileArns":{ + "type":"list", + "member":{"shape":"ProfileArn"}, + "max":1 + }, + "WorkloadProfiles":{ + "type":"list", + "member":{"shape":"WorkloadProfile"}, + "max":1 + }, + "WorkloadResourceDefinition":{ + "type":"list", + "member":{"shape":"DefinitionType"} + }, + "WorkloadReviewOwner":{ + "type":"string", + "documentation":"The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
", + "max":255, + "min":3 + }, + "WorkloadShare":{ + "type":"structure", + "members":{ + "ShareId":{"shape":"ShareId"}, + "SharedBy":{"shape":"AwsAccountId"}, + "SharedWith":{"shape":"SharedWith"}, + "PermissionType":{"shape":"PermissionType"}, + "Status":{"shape":"ShareStatus"}, + "WorkloadName":{"shape":"WorkloadName"}, + "WorkloadId":{"shape":"WorkloadId"} + }, + "documentation":"A workload share return object.
" + }, + "WorkloadShareSummaries":{ + "type":"list", + "member":{"shape":"WorkloadShareSummary"}, + "documentation":"A list of workload share summaries.
" + }, + "WorkloadShareSummary":{ + "type":"structure", + "members":{ + "ShareId":{"shape":"ShareId"}, + "SharedWith":{"shape":"SharedWith"}, + "PermissionType":{"shape":"PermissionType"}, + "Status":{"shape":"ShareStatus"}, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"Optional message to compliment the Status field.
" + } + }, + "documentation":"A workload share summary return object.
" + }, + "WorkloadSummaries":{ + "type":"list", + "member":{"shape":"WorkloadSummary"}, + "documentation":"A list of workload summaries.
" + }, + "WorkloadSummary":{ + "type":"structure", + "members":{ + "WorkloadId":{"shape":"WorkloadId"}, + "WorkloadArn":{"shape":"WorkloadArn"}, + "WorkloadName":{"shape":"WorkloadName"}, + "Owner":{"shape":"AwsAccountId"}, + "UpdatedAt":{"shape":"Timestamp"}, + "Lenses":{"shape":"WorkloadLenses"}, + "RiskCounts":{"shape":"RiskCounts"}, + "ImprovementStatus":{"shape":"WorkloadImprovementStatus"}, + "Profiles":{ + "shape":"WorkloadProfiles", + "documentation":"Profile associated with a workload.
" + }, + "PrioritizedRiskCounts":{"shape":"RiskCounts"} + }, + "documentation":"A workload summary return object.
" + } + }, + "documentation":"This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the Well-Architected Tool in the Amazon Web Services Management Console. For information about the Well-Architected Tool, see the Well-Architected Tool User Guide.
" +} diff --git a/testbed/boto__botocore/botocore/data/wisdom/2020-10-19/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/wisdom/2020-10-19/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..47191e6df0bb7974b84ac409943a00e1d5f25258 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/wisdom/2020-10-19/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wisdom-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wisdom-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wisdom.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://wisdom.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/wisdom/2020-10-19/examples-1.json b/testbed/boto__botocore/botocore/data/wisdom/2020-10-19/examples-1.json new file mode 100644 index 0000000000000000000000000000000000000000..0ea7e3b0bbe917eb027880396ac01509becd1fa0 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/wisdom/2020-10-19/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/testbed/boto__botocore/botocore/data/wisdom/2020-10-19/paginators-1.json b/testbed/boto__botocore/botocore/data/wisdom/2020-10-19/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..60b1dca5d5a2dcda0bcba13e929ddb9dd516756d --- /dev/null +++ b/testbed/boto__botocore/botocore/data/wisdom/2020-10-19/paginators-1.json @@ -0,0 +1,64 @@ +{ + "pagination": { + "ListAssistantAssociations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "assistantAssociationSummaries" + }, + "ListAssistants": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "assistantSummaries" + }, + "ListContents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "contentSummaries" + }, + "ListKnowledgeBases": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "knowledgeBaseSummaries" + }, + "QueryAssistant": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "results" + }, + "SearchContent": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "contentSummaries" + }, + "SearchSessions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "sessionSummaries" + }, + "ListImportJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "importJobSummaries" + }, + "ListQuickResponses": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "quickResponseSummaries" + }, + "SearchQuickResponses": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "results" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/wisdom/2020-10-19/service-2.json b/testbed/boto__botocore/botocore/data/wisdom/2020-10-19/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..4d1b66073600a4498778e08ccc917c245a1a8928 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/wisdom/2020-10-19/service-2.json @@ -0,0 +1,4128 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-10-19", + "endpointPrefix":"wisdom", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon Connect Wisdom Service", + "serviceId":"Wisdom", + "signatureVersion":"v4", + "signingName":"wisdom", + "uid":"wisdom-2020-10-19" + }, + "operations":{ + "CreateAssistant":{ + "name":"CreateAssistant", + "http":{ + "method":"POST", + "requestUri":"/assistants", + "responseCode":200 + }, + "input":{"shape":"CreateAssistantRequest"}, + "output":{"shape":"CreateAssistantResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates an Amazon Connect Wisdom assistant.
", + "idempotent":true + }, + "CreateAssistantAssociation":{ + "name":"CreateAssistantAssociation", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/associations", + "responseCode":200 + }, + "input":{"shape":"CreateAssistantAssociationRequest"}, + "output":{"shape":"CreateAssistantAssociationResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
", + "idempotent":true + }, + "CreateContent":{ + "name":"CreateContent", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents", + "responseCode":200 + }, + "input":{"shape":"CreateContentRequest"}, + "output":{"shape":"CreateContentResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.
", + "idempotent":true + }, + "CreateKnowledgeBase":{ + "name":"CreateKnowledgeBase", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases", + "responseCode":200 + }, + "input":{"shape":"CreateKnowledgeBaseRequest"}, + "output":{"shape":"CreateKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.
For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
Call DeleteKnowledgeBase.
Call DeleteDataIntegration.
Call CreateDataIntegration to recreate the DataIntegration or a create different one.
Call CreateKnowledgeBase.
Creates a Wisdom quick response.
", + "idempotent":true + }, + "CreateSession":{ + "name":"CreateSession", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/sessions", + "responseCode":200 + }, + "input":{"shape":"CreateSessionRequest"}, + "output":{"shape":"CreateSessionResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.
", + "idempotent":true + }, + "DeleteAssistant":{ + "name":"DeleteAssistant", + "http":{ + "method":"DELETE", + "requestUri":"/assistants/{assistantId}", + "responseCode":204 + }, + "input":{"shape":"DeleteAssistantRequest"}, + "output":{"shape":"DeleteAssistantResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Deletes an assistant.
", + "idempotent":true + }, + "DeleteAssistantAssociation":{ + "name":"DeleteAssistantAssociation", + "http":{ + "method":"DELETE", + "requestUri":"/assistants/{assistantId}/associations/{assistantAssociationId}", + "responseCode":204 + }, + "input":{"shape":"DeleteAssistantAssociationRequest"}, + "output":{"shape":"DeleteAssistantAssociationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Deletes an assistant association.
", + "idempotent":true + }, + "DeleteContent":{ + "name":"DeleteContent", + "http":{ + "method":"DELETE", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", + "responseCode":204 + }, + "input":{"shape":"DeleteContentRequest"}, + "output":{"shape":"DeleteContentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Deletes the content.
", + "idempotent":true + }, + "DeleteImportJob":{ + "name":"DeleteImportJob", + "http":{ + "method":"DELETE", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}", + "responseCode":204 + }, + "input":{"shape":"DeleteImportJobRequest"}, + "output":{"shape":"DeleteImportJobResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Deletes the quick response import job.
", + "idempotent":true + }, + "DeleteKnowledgeBase":{ + "name":"DeleteKnowledgeBase", + "http":{ + "method":"DELETE", + "requestUri":"/knowledgeBases/{knowledgeBaseId}", + "responseCode":204 + }, + "input":{"shape":"DeleteKnowledgeBaseRequest"}, + "output":{"shape":"DeleteKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Deletes the knowledge base.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
Deletes a quick response.
", + "idempotent":true + }, + "GetAssistant":{ + "name":"GetAssistant", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}", + "responseCode":200 + }, + "input":{"shape":"GetAssistantRequest"}, + "output":{"shape":"GetAssistantResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves information about an assistant.
" + }, + "GetAssistantAssociation":{ + "name":"GetAssistantAssociation", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/associations/{assistantAssociationId}", + "responseCode":200 + }, + "input":{"shape":"GetAssistantAssociationRequest"}, + "output":{"shape":"GetAssistantAssociationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves information about an assistant association.
" + }, + "GetContent":{ + "name":"GetContent", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", + "responseCode":200 + }, + "input":{"shape":"GetContentRequest"}, + "output":{"shape":"GetContentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves content, including a pre-signed URL to download the content.
" + }, + "GetContentSummary":{ + "name":"GetContentSummary", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/summary", + "responseCode":200 + }, + "input":{"shape":"GetContentSummaryRequest"}, + "output":{"shape":"GetContentSummaryResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves summary information about the content.
" + }, + "GetImportJob":{ + "name":"GetImportJob", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}", + "responseCode":200 + }, + "input":{"shape":"GetImportJobRequest"}, + "output":{"shape":"GetImportJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves the started import job.
" + }, + "GetKnowledgeBase":{ + "name":"GetKnowledgeBase", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}", + "responseCode":200 + }, + "input":{"shape":"GetKnowledgeBaseRequest"}, + "output":{"shape":"GetKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves information about the knowledge base.
" + }, + "GetQuickResponse":{ + "name":"GetQuickResponse", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", + "responseCode":200 + }, + "input":{"shape":"GetQuickResponseRequest"}, + "output":{"shape":"GetQuickResponseResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves the quick response.
" + }, + "GetRecommendations":{ + "name":"GetRecommendations", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/sessions/{sessionId}/recommendations", + "responseCode":200 + }, + "input":{"shape":"GetRecommendationsRequest"}, + "output":{"shape":"GetRecommendationsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.
Retrieves information for a specified session.
" + }, + "ListAssistantAssociations":{ + "name":"ListAssistantAssociations", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/associations", + "responseCode":200 + }, + "input":{"shape":"ListAssistantAssociationsRequest"}, + "output":{"shape":"ListAssistantAssociationsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Lists information about assistant associations.
" + }, + "ListAssistants":{ + "name":"ListAssistants", + "http":{ + "method":"GET", + "requestUri":"/assistants", + "responseCode":200 + }, + "input":{"shape":"ListAssistantsRequest"}, + "output":{"shape":"ListAssistantsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists information about assistants.
" + }, + "ListContents":{ + "name":"ListContents", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents", + "responseCode":200 + }, + "input":{"shape":"ListContentsRequest"}, + "output":{"shape":"ListContentsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Lists the content.
" + }, + "ListImportJobs":{ + "name":"ListImportJobs", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/importJobs", + "responseCode":200 + }, + "input":{"shape":"ListImportJobsRequest"}, + "output":{"shape":"ListImportJobsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists information about import jobs.
" + }, + "ListKnowledgeBases":{ + "name":"ListKnowledgeBases", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases", + "responseCode":200 + }, + "input":{"shape":"ListKnowledgeBasesRequest"}, + "output":{"shape":"ListKnowledgeBasesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists the knowledge bases.
" + }, + "ListQuickResponses":{ + "name":"ListQuickResponses", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/quickResponses", + "responseCode":200 + }, + "input":{"shape":"ListQuickResponsesRequest"}, + "output":{"shape":"ListQuickResponsesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Lists information about quick response.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Lists the tags for the specified resource.
" + }, + "NotifyRecommendationsReceived":{ + "name":"NotifyRecommendationsReceived", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/sessions/{sessionId}/recommendations/notify", + "responseCode":200 + }, + "input":{"shape":"NotifyRecommendationsReceivedRequest"}, + "output":{"shape":"NotifyRecommendationsReceivedResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
", + "deprecated":true, + "deprecatedMessage":"QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications." + }, + "RemoveKnowledgeBaseTemplateUri":{ + "name":"RemoveKnowledgeBaseTemplateUri", + "http":{ + "method":"DELETE", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/templateUri", + "responseCode":204 + }, + "input":{"shape":"RemoveKnowledgeBaseTemplateUriRequest"}, + "output":{"shape":"RemoveKnowledgeBaseTemplateUriResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Removes a URI template from a knowledge base.
" + }, + "SearchContent":{ + "name":"SearchContent", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/search", + "responseCode":200 + }, + "input":{"shape":"SearchContentRequest"}, + "output":{"shape":"SearchContentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
" + }, + "SearchQuickResponses":{ + "name":"SearchQuickResponses", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/search/quickResponses", + "responseCode":200 + }, + "input":{"shape":"SearchQuickResponsesRequest"}, + "output":{"shape":"SearchQuickResponsesResponse"}, + "errors":[ + {"shape":"RequestTimeoutException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Searches existing Wisdom quick responses in a Wisdom knowledge base.
" + }, + "SearchSessions":{ + "name":"SearchSessions", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/searchSessions", + "responseCode":200 + }, + "input":{"shape":"SearchSessionsRequest"}, + "output":{"shape":"SearchSessionsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Searches for sessions.
" + }, + "StartContentUpload":{ + "name":"StartContentUpload", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/upload", + "responseCode":200 + }, + "input":{"shape":"StartContentUploadRequest"}, + "output":{"shape":"StartContentUploadResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
" + }, + "StartImportJob":{ + "name":"StartImportJob", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/importJobs", + "responseCode":200 + }, + "input":{"shape":"StartImportJobRequest"}, + "output":{"shape":"StartImportJobResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Start an asynchronous job to import Wisdom resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.
For importing Wisdom quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.
Adds the specified tags to the specified resource.
", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Removes the specified tags from the specified resource.
", + "idempotent":true + }, + "UpdateContent":{ + "name":"UpdateContent", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", + "responseCode":200 + }, + "input":{"shape":"UpdateContentRequest"}, + "output":{"shape":"UpdateContentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Updates information about the content.
" + }, + "UpdateKnowledgeBaseTemplateUri":{ + "name":"UpdateKnowledgeBaseTemplateUri", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/templateUri", + "responseCode":200 + }, + "input":{"shape":"UpdateKnowledgeBaseTemplateUriRequest"}, + "output":{"shape":"UpdateKnowledgeBaseTemplateUriResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.
Updates an existing Wisdom quick response.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AppIntegrationsConfiguration":{ + "type":"structure", + "required":["appIntegrationArn"], + "members":{ + "appIntegrationArn":{ + "shape":"GenericArn", + "documentation":"The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.
For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.
For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.
For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.
For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.
The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.
The fields from the source that are made available to your agents in Wisdom. Optional if ObjectConfiguration is included in the provided DataIntegration.
For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.
For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.
For Zendesk, you must include at least id, title, updated_at, and draft.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
" + } + }, + "documentation":"Configuration information for Amazon AppIntegrations to automatically ingest content.
" + }, + "Arn":{ + "type":"string", + "pattern":"^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})?$" + }, + "AssistantAssociationData":{ + "type":"structure", + "required":[ + "assistantArn", + "assistantAssociationArn", + "assistantAssociationId", + "assistantId", + "associationData", + "associationType" + ], + "members":{ + "assistantArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the Wisdom assistant.
" + }, + "assistantAssociationArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the assistant association.
" + }, + "assistantAssociationId":{ + "shape":"Uuid", + "documentation":"The identifier of the assistant association.
" + }, + "assistantId":{ + "shape":"Uuid", + "documentation":"The identifier of the Wisdom assistant.
" + }, + "associationData":{ + "shape":"AssistantAssociationOutputData", + "documentation":"A union type that currently has a single argument, the knowledge base ID.
" + }, + "associationType":{ + "shape":"AssociationType", + "documentation":"The type of association.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + }, + "documentation":"Information about the assistant association.
" + }, + "AssistantAssociationInputData":{ + "type":"structure", + "members":{ + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
" + } + }, + "documentation":"The data that is input into Wisdom as a result of the assistant association.
", + "union":true + }, + "AssistantAssociationOutputData":{ + "type":"structure", + "members":{ + "knowledgeBaseAssociation":{ + "shape":"KnowledgeBaseAssociationData", + "documentation":"The knowledge base where output data is sent.
" + } + }, + "documentation":"The data that is output as a result of the assistant association.
", + "union":true + }, + "AssistantAssociationSummary":{ + "type":"structure", + "required":[ + "assistantArn", + "assistantAssociationArn", + "assistantAssociationId", + "assistantId", + "associationData", + "associationType" + ], + "members":{ + "assistantArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the Wisdom assistant.
" + }, + "assistantAssociationArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the assistant association.
" + }, + "assistantAssociationId":{ + "shape":"Uuid", + "documentation":"The identifier of the assistant association.
" + }, + "assistantId":{ + "shape":"Uuid", + "documentation":"The identifier of the Wisdom assistant.
" + }, + "associationData":{ + "shape":"AssistantAssociationOutputData", + "documentation":"The association data.
" + }, + "associationType":{ + "shape":"AssociationType", + "documentation":"The type of association.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + }, + "documentation":"Summary information about the assistant association.
" + }, + "AssistantAssociationSummaryList":{ + "type":"list", + "member":{"shape":"AssistantAssociationSummary"} + }, + "AssistantData":{ + "type":"structure", + "required":[ + "assistantArn", + "assistantId", + "name", + "status", + "type" + ], + "members":{ + "assistantArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the Wisdom assistant.
" + }, + "assistantId":{ + "shape":"Uuid", + "documentation":"The identifier of the Wisdom assistant.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description.
" + }, + "integrationConfiguration":{ + "shape":"AssistantIntegrationConfiguration", + "documentation":"The configuration information for the Wisdom assistant integration.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name.
" + }, + "serverSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
" + }, + "status":{ + "shape":"AssistantStatus", + "documentation":"The status of the assistant.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "type":{ + "shape":"AssistantType", + "documentation":"The type of assistant.
" + } + }, + "documentation":"The assistant data.
" + }, + "AssistantIntegrationConfiguration":{ + "type":"structure", + "members":{ + "topicIntegrationArn":{ + "shape":"GenericArn", + "documentation":"The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
" + } + }, + "documentation":"The configuration information for the Wisdom assistant integration.
" + }, + "AssistantList":{ + "type":"list", + "member":{"shape":"AssistantSummary"} + }, + "AssistantStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "ACTIVE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETED" + ] + }, + "AssistantSummary":{ + "type":"structure", + "required":[ + "assistantArn", + "assistantId", + "name", + "status", + "type" + ], + "members":{ + "assistantArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the Wisdom assistant.
" + }, + "assistantId":{ + "shape":"Uuid", + "documentation":"The identifier of the Wisdom assistant.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the assistant.
" + }, + "integrationConfiguration":{ + "shape":"AssistantIntegrationConfiguration", + "documentation":"The configuration information for the Wisdom assistant integration.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the assistant.
" + }, + "serverSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
" + }, + "status":{ + "shape":"AssistantStatus", + "documentation":"The status of the assistant.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "type":{ + "shape":"AssistantType", + "documentation":"The type of the assistant.
" + } + }, + "documentation":"Summary information about the assistant.
" + }, + "AssistantType":{ + "type":"string", + "enum":["AGENT"] + }, + "AssociationType":{ + "type":"string", + "enum":["KNOWLEDGE_BASE"] + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "Channel":{ + "type":"string", + "max":10, + "min":1, + "sensitive":true + }, + "Channels":{ + "type":"list", + "member":{"shape":"Channel"} + }, + "ClientToken":{ + "type":"string", + "max":4096, + "min":1 + }, + "Configuration":{ + "type":"structure", + "members":{ + "connectConfiguration":{ + "shape":"ConnectConfiguration", + "documentation":"The configuration information of the Amazon Connect data source.
" + } + }, + "documentation":"The configuration information of the external data source.
", + "union":true + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
" + } + }, + "documentation":"The configuration information of the Amazon Connect data source.
" + }, + "ContactAttributeKey":{"type":"string"}, + "ContactAttributeKeys":{ + "type":"list", + "member":{"shape":"ContactAttributeKey"}, + "sensitive":true + }, + "ContactAttributeValue":{"type":"string"}, + "ContactAttributes":{ + "type":"map", + "key":{"shape":"ContactAttributeKey"}, + "value":{"shape":"ContactAttributeValue"}, + "sensitive":true + }, + "ContentData":{ + "type":"structure", + "required":[ + "contentArn", + "contentId", + "contentType", + "knowledgeBaseArn", + "knowledgeBaseId", + "metadata", + "name", + "revisionId", + "status", + "title", + "url", + "urlExpiry" + ], + "members":{ + "contentArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the content.
" + }, + "contentId":{ + "shape":"Uuid", + "documentation":"The identifier of the content.
" + }, + "contentType":{ + "shape":"ContentType", + "documentation":"The media type of the content.
" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
" + }, + "linkOutUri":{ + "shape":"Uri", + "documentation":"The URI of the content.
" + }, + "metadata":{ + "shape":"ContentMetadata", + "documentation":"A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the content.
" + }, + "revisionId":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the content revision.
" + }, + "status":{ + "shape":"ContentStatus", + "documentation":"The status of the content.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "title":{ + "shape":"ContentTitle", + "documentation":"The title of the content.
" + }, + "url":{ + "shape":"Url", + "documentation":"The URL of the content.
" + }, + "urlExpiry":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"The expiration time of the URL as an epoch timestamp.
" + } + }, + "documentation":"Information about the content.
" + }, + "ContentMetadata":{ + "type":"map", + "key":{"shape":"NonEmptyString"}, + "value":{"shape":"NonEmptyString"}, + "max":10, + "min":0 + }, + "ContentReference":{ + "type":"structure", + "members":{ + "contentArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the content.
" + }, + "contentId":{ + "shape":"Uuid", + "documentation":"The identifier of the content.
" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
" + } + }, + "documentation":"Reference information about the content.
" + }, + "ContentStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "ACTIVE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETED", + "UPDATE_FAILED" + ] + }, + "ContentSummary":{ + "type":"structure", + "required":[ + "contentArn", + "contentId", + "contentType", + "knowledgeBaseArn", + "knowledgeBaseId", + "metadata", + "name", + "revisionId", + "status", + "title" + ], + "members":{ + "contentArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the content.
" + }, + "contentId":{ + "shape":"Uuid", + "documentation":"The identifier of the content.
" + }, + "contentType":{ + "shape":"ContentType", + "documentation":"The media type of the content.
" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
" + }, + "metadata":{ + "shape":"ContentMetadata", + "documentation":"A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the content.
" + }, + "revisionId":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the revision of the content.
" + }, + "status":{ + "shape":"ContentStatus", + "documentation":"The status of the content.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "title":{ + "shape":"ContentTitle", + "documentation":"The title of the content.
" + } + }, + "documentation":"Summary information about the content.
" + }, + "ContentSummaryList":{ + "type":"list", + "member":{"shape":"ContentSummary"} + }, + "ContentTitle":{ + "type":"string", + "max":255, + "min":1 + }, + "ContentType":{ + "type":"string", + "pattern":"^(text/(plain|html|csv))|(application/(pdf|vnd\\.openxmlformats-officedocument\\.wordprocessingml\\.document))|(application/x\\.wisdom-json;source=(salesforce|servicenow|zendesk))$" + }, + "CreateAssistantAssociationRequest":{ + "type":"structure", + "required":[ + "assistantId", + "association", + "associationType" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "association":{ + "shape":"AssistantAssociationInputData", + "documentation":"The identifier of the associated resource.
" + }, + "associationType":{ + "shape":"AssociationType", + "documentation":"The type of association.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "idempotencyToken":true + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + } + }, + "CreateAssistantAssociationResponse":{ + "type":"structure", + "members":{ + "assistantAssociation":{ + "shape":"AssistantAssociationData", + "documentation":"The assistant association.
" + } + } + }, + "CreateAssistantRequest":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "idempotencyToken":true + }, + "description":{ + "shape":"Description", + "documentation":"The description of the assistant.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the assistant.
" + }, + "serverSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"The configuration information for the customer managed key used for encryption.
The customer managed key must have a policy that allows kms:CreateGrant, kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "type":{ + "shape":"AssistantType", + "documentation":"The type of assistant.
" + } + } + }, + "CreateAssistantResponse":{ + "type":"structure", + "members":{ + "assistant":{ + "shape":"AssistantData", + "documentation":"Information about the assistant.
" + } + } + }, + "CreateContentRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "name", + "uploadId" + ], + "members":{ + "clientToken":{ + "shape":"NonEmptyString", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "idempotencyToken":true + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "metadata":{ + "shape":"ContentMetadata", + "documentation":"A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.
" + }, + "overrideLinkOutUri":{ + "shape":"Uri", + "documentation":"The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "title":{ + "shape":"ContentTitle", + "documentation":"The title of the content. If not set, the title is equal to the name.
" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"A pointer to the uploaded asset. This value is returned by StartContentUpload.
" + } + } + }, + "CreateContentResponse":{ + "type":"structure", + "members":{ + "content":{ + "shape":"ContentData", + "documentation":"The content.
" + } + } + }, + "CreateKnowledgeBaseRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseType", + "name" + ], + "members":{ + "clientToken":{ + "shape":"NonEmptyString", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "idempotencyToken":true + }, + "description":{ + "shape":"Description", + "documentation":"The description.
" + }, + "knowledgeBaseType":{ + "shape":"KnowledgeBaseType", + "documentation":"The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the knowledge base.
" + }, + "renderingConfiguration":{ + "shape":"RenderingConfiguration", + "documentation":"Information about how to render the content.
" + }, + "serverSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom.
For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
" + }, + "sourceConfiguration":{ + "shape":"SourceConfiguration", + "documentation":"The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + } + }, + "CreateKnowledgeBaseResponse":{ + "type":"structure", + "members":{ + "knowledgeBase":{ + "shape":"KnowledgeBaseData", + "documentation":"The knowledge base.
" + } + } + }, + "CreateQuickResponseRequest":{ + "type":"structure", + "required":[ + "content", + "knowledgeBaseId", + "name" + ], + "members":{ + "channels":{ + "shape":"Channels", + "documentation":"The Amazon Connect channels this quick response applies to.
" + }, + "clientToken":{ + "shape":"NonEmptyString", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "idempotencyToken":true + }, + "content":{ + "shape":"QuickResponseDataProvider", + "documentation":"The content of the quick response.
" + }, + "contentType":{ + "shape":"QuickResponseType", + "documentation":"The media type of the quick response content.
Use application/x.quickresponse;format=plain for a quick response written in plain text.
Use application/x.quickresponse;format=markdown for a quick response written in richtext.
The description of the quick response.
" + }, + "groupingConfiguration":{ + "shape":"GroupingConfiguration", + "documentation":"The configuration information of the user groups that the quick response is accessible to.
" + }, + "isActive":{ + "shape":"Boolean", + "documentation":"Whether the quick response is active.
" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "language":{ + "shape":"LanguageCode", + "documentation":"The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
The name of the quick response.
" + }, + "shortcutKey":{ + "shape":"ShortCutKey", + "documentation":"The shortcut key of the quick response. The value should be unique across the knowledge base.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + } + }, + "CreateQuickResponseResponse":{ + "type":"structure", + "members":{ + "quickResponse":{ + "shape":"QuickResponseData", + "documentation":"The quick response.
" + } + } + }, + "CreateSessionRequest":{ + "type":"structure", + "required":[ + "assistantId", + "name" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "idempotencyToken":true + }, + "description":{ + "shape":"Description", + "documentation":"The description.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the session.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + } + }, + "CreateSessionResponse":{ + "type":"structure", + "members":{ + "session":{ + "shape":"SessionData", + "documentation":"The session.
" + } + } + }, + "DeleteAssistantAssociationRequest":{ + "type":"structure", + "required":[ + "assistantAssociationId", + "assistantId" + ], + "members":{ + "assistantAssociationId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantAssociationId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "DeleteAssistantAssociationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteAssistantRequest":{ + "type":"structure", + "required":["assistantId"], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "DeleteAssistantResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteContentRequest":{ + "type":"structure", + "required":[ + "contentId", + "knowledgeBaseId" + ], + "members":{ + "contentId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"contentId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "DeleteContentResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteImportJobRequest":{ + "type":"structure", + "required":[ + "importJobId", + "knowledgeBaseId" + ], + "members":{ + "importJobId":{ + "shape":"Uuid", + "documentation":"The identifier of the import job to be deleted.
", + "location":"uri", + "locationName":"importJobId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "DeleteImportJobResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteKnowledgeBaseRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "DeleteKnowledgeBaseResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteQuickResponseRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "quickResponseId" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "quickResponseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the quick response to delete.
", + "location":"uri", + "locationName":"quickResponseId" + } + } + }, + "DeleteQuickResponseResponse":{ + "type":"structure", + "members":{ + } + }, + "Description":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\s_.,-]+" + }, + "Document":{ + "type":"structure", + "required":["contentReference"], + "members":{ + "contentReference":{ + "shape":"ContentReference", + "documentation":"A reference to the content resource.
" + }, + "excerpt":{ + "shape":"DocumentText", + "documentation":"The excerpt from the document.
" + }, + "title":{ + "shape":"DocumentText", + "documentation":"The title of the document.
" + } + }, + "documentation":"The document.
" + }, + "DocumentText":{ + "type":"structure", + "members":{ + "highlights":{ + "shape":"Highlights", + "documentation":"Highlights in the document text.
" + }, + "text":{ + "shape":"SensitiveString", + "documentation":"Text in the document.
" + } + }, + "documentation":"The text of the document.
" + }, + "ExternalSource":{ + "type":"string", + "enum":["AMAZON_CONNECT"] + }, + "ExternalSourceConfiguration":{ + "type":"structure", + "required":[ + "configuration", + "source" + ], + "members":{ + "configuration":{ + "shape":"Configuration", + "documentation":"The configuration information of the external data source.
" + }, + "source":{ + "shape":"ExternalSource", + "documentation":"The type of the external data source.
" + } + }, + "documentation":"The configuration information of the external data source.
" + }, + "Filter":{ + "type":"structure", + "required":[ + "field", + "operator", + "value" + ], + "members":{ + "field":{ + "shape":"FilterField", + "documentation":"The field on which to filter.
" + }, + "operator":{ + "shape":"FilterOperator", + "documentation":"The operator to use for comparing the field’s value with the provided value.
" + }, + "value":{ + "shape":"NonEmptyString", + "documentation":"The desired field value on which to filter.
" + } + }, + "documentation":"A search filter.
" + }, + "FilterField":{ + "type":"string", + "enum":["NAME"] + }, + "FilterList":{ + "type":"list", + "member":{"shape":"Filter"} + }, + "FilterOperator":{ + "type":"string", + "enum":["EQUALS"] + }, + "GenericArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$" + }, + "GetAssistantAssociationRequest":{ + "type":"structure", + "required":[ + "assistantAssociationId", + "assistantId" + ], + "members":{ + "assistantAssociationId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantAssociationId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "GetAssistantAssociationResponse":{ + "type":"structure", + "members":{ + "assistantAssociation":{ + "shape":"AssistantAssociationData", + "documentation":"The assistant association.
" + } + } + }, + "GetAssistantRequest":{ + "type":"structure", + "required":["assistantId"], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "GetAssistantResponse":{ + "type":"structure", + "members":{ + "assistant":{ + "shape":"AssistantData", + "documentation":"Information about the assistant.
" + } + } + }, + "GetContentRequest":{ + "type":"structure", + "required":[ + "contentId", + "knowledgeBaseId" + ], + "members":{ + "contentId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"contentId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "GetContentResponse":{ + "type":"structure", + "members":{ + "content":{ + "shape":"ContentData", + "documentation":"The content.
" + } + } + }, + "GetContentSummaryRequest":{ + "type":"structure", + "required":[ + "contentId", + "knowledgeBaseId" + ], + "members":{ + "contentId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"contentId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "GetContentSummaryResponse":{ + "type":"structure", + "members":{ + "contentSummary":{ + "shape":"ContentSummary", + "documentation":"The content summary.
" + } + } + }, + "GetImportJobRequest":{ + "type":"structure", + "required":[ + "importJobId", + "knowledgeBaseId" + ], + "members":{ + "importJobId":{ + "shape":"Uuid", + "documentation":"The identifier of the import job to retrieve.
", + "location":"uri", + "locationName":"importJobId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base that the import job belongs to.
", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "GetImportJobResponse":{ + "type":"structure", + "members":{ + "importJob":{ + "shape":"ImportJobData", + "documentation":"The import job.
" + } + } + }, + "GetKnowledgeBaseRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "GetKnowledgeBaseResponse":{ + "type":"structure", + "members":{ + "knowledgeBase":{ + "shape":"KnowledgeBaseData", + "documentation":"The knowledge base.
" + } + } + }, + "GetQuickResponseRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "quickResponseId" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "quickResponseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the quick response.
", + "location":"uri", + "locationName":"quickResponseId" + } + } + }, + "GetQuickResponseResponse":{ + "type":"structure", + "members":{ + "quickResponse":{ + "shape":"QuickResponseData", + "documentation":"The quick response.
" + } + } + }, + "GetRecommendationsRequest":{ + "type":"structure", + "required":[ + "assistantId", + "sessionId" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "sessionId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"sessionId" + }, + "waitTimeSeconds":{ + "shape":"WaitTimeSeconds", + "documentation":"The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.
The recommendations.
" + }, + "triggers":{ + "shape":"RecommendationTriggerList", + "documentation":"The triggers corresponding to recommendations.
" + } + } + }, + "GetSessionRequest":{ + "type":"structure", + "required":[ + "assistantId", + "sessionId" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "sessionId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"sessionId" + } + } + }, + "GetSessionResponse":{ + "type":"structure", + "members":{ + "session":{ + "shape":"SessionData", + "documentation":"The session.
" + } + } + }, + "GroupingConfiguration":{ + "type":"structure", + "members":{ + "criteria":{ + "shape":"GroupingCriteria", + "documentation":"The criteria used for grouping Wisdom users.
The following is the list of supported criteria values.
RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
The list of values that define different groups of Wisdom users.
When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
The configuration information of the grouping of Wisdom users.
" + }, + "GroupingCriteria":{ + "type":"string", + "max":100, + "min":1, + "sensitive":true + }, + "GroupingValue":{ + "type":"string", + "max":2048, + "min":1, + "sensitive":true + }, + "GroupingValues":{ + "type":"list", + "member":{"shape":"GroupingValue"} + }, + "Headers":{ + "type":"map", + "key":{"shape":"NonEmptyString"}, + "value":{"shape":"NonEmptyString"} + }, + "Highlight":{ + "type":"structure", + "members":{ + "beginOffsetInclusive":{ + "shape":"HighlightOffset", + "documentation":"The offset for the start of the highlight.
" + }, + "endOffsetExclusive":{ + "shape":"HighlightOffset", + "documentation":"The offset for the end of the highlight.
" + } + }, + "documentation":"Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
" + }, + "HighlightOffset":{"type":"integer"}, + "Highlights":{ + "type":"list", + "member":{"shape":"Highlight"} + }, + "ImportJobData":{ + "type":"structure", + "required":[ + "createdTime", + "importJobId", + "importJobType", + "knowledgeBaseArn", + "knowledgeBaseId", + "lastModifiedTime", + "status", + "uploadId", + "url", + "urlExpiry" + ], + "members":{ + "createdTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"The timestamp when the import job was created.
" + }, + "externalSourceConfiguration":{"shape":"ExternalSourceConfiguration"}, + "failedRecordReport":{ + "shape":"Url", + "documentation":"The link to donwload the information of resource data that failed to be imported.
" + }, + "importJobId":{ + "shape":"Uuid", + "documentation":"The identifier of the import job.
" + }, + "importJobType":{ + "shape":"ImportJobType", + "documentation":"The type of the import job.
" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
" + }, + "lastModifiedTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"The timestamp when the import job data was last modified.
" + }, + "metadata":{ + "shape":"ContentMetadata", + "documentation":"The metadata fields of the imported Wisdom resources.
" + }, + "status":{ + "shape":"ImportJobStatus", + "documentation":"The status of the import job.
" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"A pointer to the uploaded asset. This value is returned by StartContentUpload.
" + }, + "url":{ + "shape":"Url", + "documentation":"The download link to the resource file that is uploaded to the import job.
" + }, + "urlExpiry":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"The expiration time of the URL as an epoch timestamp.
" + } + }, + "documentation":"Summary information about the import job.
" + }, + "ImportJobList":{ + "type":"list", + "member":{"shape":"ImportJobSummary"} + }, + "ImportJobStatus":{ + "type":"string", + "enum":[ + "START_IN_PROGRESS", + "FAILED", + "COMPLETE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETED" + ] + }, + "ImportJobSummary":{ + "type":"structure", + "required":[ + "createdTime", + "importJobId", + "importJobType", + "knowledgeBaseArn", + "knowledgeBaseId", + "lastModifiedTime", + "status", + "uploadId" + ], + "members":{ + "createdTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"The timestamp when the import job was created.
" + }, + "externalSourceConfiguration":{ + "shape":"ExternalSourceConfiguration", + "documentation":"The configuration information of the external source that the resource data are imported from.
" + }, + "importJobId":{ + "shape":"Uuid", + "documentation":"The identifier of the import job.
" + }, + "importJobType":{ + "shape":"ImportJobType", + "documentation":"The type of import job.
" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
" + }, + "lastModifiedTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"The timestamp when the import job was last modified.
" + }, + "metadata":{ + "shape":"ContentMetadata", + "documentation":"The metadata fields of the imported Wisdom resources.
" + }, + "status":{ + "shape":"ImportJobStatus", + "documentation":"The status of the import job.
" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"A pointer to the uploaded asset. This value is returned by StartContentUpload.
" + } + }, + "documentation":"Summary information about the import job.
" + }, + "ImportJobType":{ + "type":"string", + "enum":["QUICK_RESPONSES"] + }, + "KnowledgeBaseAssociationData":{ + "type":"structure", + "members":{ + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
" + } + }, + "documentation":"Association information about the knowledge base.
" + }, + "KnowledgeBaseData":{ + "type":"structure", + "required":[ + "knowledgeBaseArn", + "knowledgeBaseId", + "knowledgeBaseType", + "name", + "status" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"The description.
" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
" + }, + "knowledgeBaseType":{ + "shape":"KnowledgeBaseType", + "documentation":"The type of knowledge base.
" + }, + "lastContentModificationTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the knowledge base.
" + }, + "renderingConfiguration":{ + "shape":"RenderingConfiguration", + "documentation":"Information about how to render the content.
" + }, + "serverSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom.
For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
" + }, + "sourceConfiguration":{ + "shape":"SourceConfiguration", + "documentation":"Source configuration information about the knowledge base.
" + }, + "status":{ + "shape":"KnowledgeBaseStatus", + "documentation":"The status of the knowledge base.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + }, + "documentation":"Information about the knowledge base.
" + }, + "KnowledgeBaseList":{ + "type":"list", + "member":{"shape":"KnowledgeBaseSummary"} + }, + "KnowledgeBaseStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "ACTIVE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETED" + ] + }, + "KnowledgeBaseSummary":{ + "type":"structure", + "required":[ + "knowledgeBaseArn", + "knowledgeBaseId", + "knowledgeBaseType", + "name", + "status" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"The description of the knowledge base.
" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
" + }, + "knowledgeBaseType":{ + "shape":"KnowledgeBaseType", + "documentation":"The type of knowledge base.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the knowledge base.
" + }, + "renderingConfiguration":{ + "shape":"RenderingConfiguration", + "documentation":"Information about how to render the content.
" + }, + "serverSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom.
For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
" + }, + "sourceConfiguration":{ + "shape":"SourceConfiguration", + "documentation":"Configuration information about the external data source.
" + }, + "status":{ + "shape":"KnowledgeBaseStatus", + "documentation":"The status of the knowledge base summary.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + }, + "documentation":"Summary information about the knowledge base.
" + }, + "KnowledgeBaseType":{ + "type":"string", + "enum":[ + "EXTERNAL", + "CUSTOM", + "QUICK_RESPONSES" + ] + }, + "LanguageCode":{ + "type":"string", + "max":5, + "min":2 + }, + "ListAssistantAssociationsRequest":{ + "type":"structure", + "required":["assistantId"], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListAssistantAssociationsResponse":{ + "type":"structure", + "required":["assistantAssociationSummaries"], + "members":{ + "assistantAssociationSummaries":{ + "shape":"AssistantAssociationSummaryList", + "documentation":"Summary information about assistant associations.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If there are additional results, this is the token for the next set of results.
" + } + } + }, + "ListAssistantsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListAssistantsResponse":{ + "type":"structure", + "required":["assistantSummaries"], + "members":{ + "assistantSummaries":{ + "shape":"AssistantList", + "documentation":"Information about the assistants.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If there are additional results, this is the token for the next set of results.
" + } + } + }, + "ListContentsRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListContentsResponse":{ + "type":"structure", + "required":["contentSummaries"], + "members":{ + "contentSummaries":{ + "shape":"ContentSummaryList", + "documentation":"Information about the content.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If there are additional results, this is the token for the next set of results.
" + } + } + }, + "ListImportJobsRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListImportJobsResponse":{ + "type":"structure", + "required":["importJobSummaries"], + "members":{ + "importJobSummaries":{ + "shape":"ImportJobList", + "documentation":"Summary information about the import jobs.
" + }, + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"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.
" + } + } + }, + "ListKnowledgeBasesRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListKnowledgeBasesResponse":{ + "type":"structure", + "required":["knowledgeBaseSummaries"], + "members":{ + "knowledgeBaseSummaries":{ + "shape":"KnowledgeBaseList", + "documentation":"Information about the knowledge bases.
" + }, + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"If there are additional results, this is the token for the next set of results.
" + } + } + }, + "ListQuickResponsesRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListQuickResponsesResponse":{ + "type":"structure", + "required":["quickResponseSummaries"], + "members":{ + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"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.
" + }, + "quickResponseSummaries":{ + "shape":"QuickResponseSummaryList", + "documentation":"Summary information about the quick responses.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + } + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "Name":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\s_.,-]+" + }, + "NextToken":{ + "type":"string", + "max":2048, + "min":1 + }, + "NonEmptyString":{ + "type":"string", + "max":4096, + "min":1 + }, + "NotifyRecommendationsReceivedError":{ + "type":"structure", + "members":{ + "message":{ + "shape":"NotifyRecommendationsReceivedErrorMessage", + "documentation":"A recommendation is causing an error.
" + }, + "recommendationId":{ + "shape":"String", + "documentation":"The identifier of the recommendation that is in error.
" + } + }, + "documentation":"An error occurred when creating a recommendation.
" + }, + "NotifyRecommendationsReceivedErrorList":{ + "type":"list", + "member":{"shape":"NotifyRecommendationsReceivedError"} + }, + "NotifyRecommendationsReceivedErrorMessage":{"type":"string"}, + "NotifyRecommendationsReceivedRequest":{ + "type":"structure", + "required":[ + "assistantId", + "recommendationIds", + "sessionId" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "recommendationIds":{ + "shape":"RecommendationIdList", + "documentation":"The identifiers of the recommendations.
" + }, + "sessionId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"sessionId" + } + } + }, + "NotifyRecommendationsReceivedResponse":{ + "type":"structure", + "members":{ + "errors":{ + "shape":"NotifyRecommendationsReceivedErrorList", + "documentation":"The identifiers of recommendations that are causing errors.
" + }, + "recommendationIds":{ + "shape":"RecommendationIdList", + "documentation":"The identifiers of the recommendations.
" + } + } + }, + "ObjectFieldsList":{ + "type":"list", + "member":{"shape":"NonEmptyString"}, + "max":100, + "min":1 + }, + "Order":{ + "type":"string", + "enum":[ + "ASC", + "DESC" + ] + }, + "PreconditionFailedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The provided revisionId does not match, indicating the content has been modified since it was last read.
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
" + }, + "queryText":{ + "shape":"QueryText", + "documentation":"The text to search for.
" + } + } + }, + "QueryAssistantResponse":{ + "type":"structure", + "required":["results"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"If there are additional results, this is the token for the next set of results.
" + }, + "results":{ + "shape":"QueryResultsList", + "documentation":"The results of the query.
" + } + } + }, + "QueryRecommendationTriggerData":{ + "type":"structure", + "members":{ + "text":{ + "shape":"QueryText", + "documentation":"The text associated with the recommendation trigger.
" + } + }, + "documentation":"Data associated with the QUERY RecommendationTriggerType.
" + }, + "QueryResultsList":{ + "type":"list", + "member":{"shape":"ResultData"} + }, + "QueryText":{ + "type":"string", + "sensitive":true + }, + "QuickResponseContent":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "QuickResponseContentProvider":{ + "type":"structure", + "members":{ + "content":{ + "shape":"QuickResponseContent", + "documentation":"The content of the quick response.
" + } + }, + "documentation":"The container quick response content.
", + "union":true + }, + "QuickResponseContents":{ + "type":"structure", + "members":{ + "markdown":{"shape":"QuickResponseContentProvider"}, + "plainText":{"shape":"QuickResponseContentProvider"} + }, + "documentation":"The content of the quick response stored in different media types.
" + }, + "QuickResponseData":{ + "type":"structure", + "required":[ + "contentType", + "createdTime", + "knowledgeBaseArn", + "knowledgeBaseId", + "lastModifiedTime", + "name", + "quickResponseArn", + "quickResponseId", + "status" + ], + "members":{ + "channels":{ + "shape":"Channels", + "documentation":"The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The media type of the quick response content.
Use application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
The contents of the quick response.
" + }, + "createdTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"The timestamp when the quick response was created.
" + }, + "description":{ + "shape":"QuickResponseDescription", + "documentation":"The description of the quick response.
" + }, + "groupingConfiguration":{ + "shape":"GroupingConfiguration", + "documentation":"The configuration information of the user groups that the quick response is accessible to.
" + }, + "isActive":{ + "shape":"Boolean", + "documentation":"Whether the quick response is active.
" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
" + }, + "language":{ + "shape":"LanguageCode", + "documentation":"The language code value for the language in which the quick response is written.
" + }, + "lastModifiedBy":{ + "shape":"GenericArn", + "documentation":"The Amazon Resource Name (ARN) of the user who last updated the quick response data.
" + }, + "lastModifiedTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"The timestamp when the quick response data was last modified.
" + }, + "name":{ + "shape":"QuickResponseName", + "documentation":"The name of the quick response.
" + }, + "quickResponseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the quick response.
" + }, + "quickResponseId":{ + "shape":"Uuid", + "documentation":"The identifier of the quick response.
" + }, + "shortcutKey":{ + "shape":"ShortCutKey", + "documentation":"The shortcut key of the quick response. The value should be unique across the knowledge base.
" + }, + "status":{ + "shape":"QuickResponseStatus", + "documentation":"The status of the quick response data.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + }, + "documentation":"Information about the quick response.
" + }, + "QuickResponseDataProvider":{ + "type":"structure", + "members":{ + "content":{ + "shape":"QuickResponseContent", + "documentation":"The content of the quick response.
" + } + }, + "documentation":"The container of quick response data.
", + "union":true + }, + "QuickResponseDescription":{ + "type":"string", + "max":255, + "min":1 + }, + "QuickResponseFilterField":{ + "type":"structure", + "required":[ + "name", + "operator" + ], + "members":{ + "includeNoExistence":{ + "shape":"Boolean", + "documentation":"Whether to treat null value as a match for the attribute field.
" + }, + "name":{ + "shape":"NonEmptyString", + "documentation":"The name of the attribute field to filter the quick responses by.
" + }, + "operator":{ + "shape":"QuickResponseFilterOperator", + "documentation":"The operator to use for filtering.
" + }, + "values":{ + "shape":"QuickResponseFilterValueList", + "documentation":"The values of attribute field to filter the quick response by.
" + } + }, + "documentation":"The quick response fields to filter the quick response query results by.
The following is the list of supported field names.
name
description
shortcutKey
isActive
channels
language
contentType
createdTime
lastModifiedTime
lastModifiedBy
groupingConfiguration.criteria
groupingConfiguration.values
The name of the attribute to order the quick response query results by.
" + }, + "order":{ + "shape":"Order", + "documentation":"The order at which the quick responses are sorted by.
" + } + }, + "documentation":"The quick response fields to order the quick response query results by.
The following is the list of supported field names.
name
description
shortcutKey
isActive
channels
language
contentType
createdTime
lastModifiedTime
lastModifiedBy
groupingConfiguration.criteria
groupingConfiguration.values
Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.
" + }, + "name":{ + "shape":"NonEmptyString", + "documentation":"The name of the attribute to query the quick responses by.
" + }, + "operator":{ + "shape":"QuickResponseQueryOperator", + "documentation":"The operator to use for matching attribute field values in the query.
" + }, + "priority":{ + "shape":"Priority", + "documentation":"The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.
" + }, + "values":{ + "shape":"QuickResponseQueryValueList", + "documentation":"The values of the attribute to query the quick responses by.
" + } + }, + "documentation":"The quick response fields to query quick responses by.
The following is the list of supported field names.
content
name
description
shortcutKey
The configuration of filtering rules applied to quick response query results.
" + }, + "orderOnField":{ + "shape":"QuickResponseOrderField", + "documentation":"The quick response attribute fields on which the query results are ordered.
" + }, + "queries":{ + "shape":"QuickResponseQueryFieldList", + "documentation":"The quick response query expressions.
" + } + }, + "documentation":"Information about the import job.
" + }, + "QuickResponseSearchResultData":{ + "type":"structure", + "required":[ + "contentType", + "contents", + "createdTime", + "isActive", + "knowledgeBaseArn", + "knowledgeBaseId", + "lastModifiedTime", + "name", + "quickResponseArn", + "quickResponseId", + "status" + ], + "members":{ + "attributesInterpolated":{ + "shape":"ContactAttributeKeys", + "documentation":"The user defined contact attributes that are resolved when the search result is returned.
" + }, + "attributesNotInterpolated":{ + "shape":"ContactAttributeKeys", + "documentation":"The user defined contact attributes that are not resolved when the search result is returned.
" + }, + "channels":{ + "shape":"Channels", + "documentation":"The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The media type of the quick response content.
Use application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
The contents of the quick response.
" + }, + "createdTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"The timestamp when the quick response was created.
" + }, + "description":{ + "shape":"QuickResponseDescription", + "documentation":"The description of the quick response.
" + }, + "groupingConfiguration":{ + "shape":"GroupingConfiguration", + "documentation":"The configuration information of the user groups that the quick response is accessible to.
" + }, + "isActive":{ + "shape":"Boolean", + "documentation":"Whether the quick response is active.
" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
" + }, + "language":{ + "shape":"LanguageCode", + "documentation":"The language code value for the language in which the quick response is written.
" + }, + "lastModifiedBy":{ + "shape":"GenericArn", + "documentation":"The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.
" + }, + "lastModifiedTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"The timestamp when the quick response search result data was last modified.
" + }, + "name":{ + "shape":"QuickResponseName", + "documentation":"The name of the quick response.
" + }, + "quickResponseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the quick response.
" + }, + "quickResponseId":{ + "shape":"Uuid", + "documentation":"The identifier of the quick response.
" + }, + "shortcutKey":{ + "shape":"ShortCutKey", + "documentation":"The shortcut key of the quick response. The value should be unique across the knowledge base.
" + }, + "status":{ + "shape":"QuickResponseStatus", + "documentation":"The resource status of the quick response.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + }, + "documentation":"The result of quick response search.
" + }, + "QuickResponseSearchResultsList":{ + "type":"list", + "member":{"shape":"QuickResponseSearchResultData"} + }, + "QuickResponseStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "CREATED", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETED", + "UPDATE_IN_PROGRESS", + "UPDATE_FAILED" + ] + }, + "QuickResponseSummary":{ + "type":"structure", + "required":[ + "contentType", + "createdTime", + "knowledgeBaseArn", + "knowledgeBaseId", + "lastModifiedTime", + "name", + "quickResponseArn", + "quickResponseId", + "status" + ], + "members":{ + "channels":{ + "shape":"Channels", + "documentation":"The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The media type of the quick response content.
Use application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
The timestamp when the quick response was created.
" + }, + "description":{ + "shape":"QuickResponseDescription", + "documentation":"The description of the quick response.
" + }, + "isActive":{ + "shape":"Boolean", + "documentation":"Whether the quick response is active.
" + }, + "knowledgeBaseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" + }, + "knowledgeBaseId":{ + "shape":"Uuid", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
" + }, + "lastModifiedBy":{ + "shape":"GenericArn", + "documentation":"The Amazon Resource Name (ARN) of the user who last updated the quick response data.
" + }, + "lastModifiedTime":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"The timestamp when the quick response summary was last modified.
" + }, + "name":{ + "shape":"QuickResponseName", + "documentation":"The name of the quick response.
" + }, + "quickResponseArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the quick response.
" + }, + "quickResponseId":{ + "shape":"Uuid", + "documentation":"The identifier of the quick response.
" + }, + "status":{ + "shape":"QuickResponseStatus", + "documentation":"The resource status of the quick response.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + }, + "documentation":"The summary information about the quick response.
" + }, + "QuickResponseSummaryList":{ + "type":"list", + "member":{"shape":"QuickResponseSummary"} + }, + "QuickResponseType":{ + "type":"string", + "pattern":"^(application/x\\.quickresponse;format=(plain|markdown))$" + }, + "RecommendationData":{ + "type":"structure", + "required":[ + "document", + "recommendationId" + ], + "members":{ + "document":{ + "shape":"Document", + "documentation":"The recommended document.
" + }, + "recommendationId":{ + "shape":"String", + "documentation":"The identifier of the recommendation.
" + }, + "relevanceLevel":{ + "shape":"RelevanceLevel", + "documentation":"The relevance level of the recommendation.
" + }, + "relevanceScore":{ + "shape":"RelevanceScore", + "documentation":"The relevance score of the recommendation.
" + }, + "type":{ + "shape":"RecommendationType", + "documentation":"The type of recommendation.
" + } + }, + "documentation":"Information about the recommendation.
" + }, + "RecommendationIdList":{ + "type":"list", + "member":{"shape":"String"}, + "max":25, + "min":0 + }, + "RecommendationList":{ + "type":"list", + "member":{"shape":"RecommendationData"} + }, + "RecommendationSourceType":{ + "type":"string", + "enum":[ + "ISSUE_DETECTION", + "RULE_EVALUATION", + "OTHER" + ] + }, + "RecommendationTrigger":{ + "type":"structure", + "required":[ + "data", + "id", + "recommendationIds", + "source", + "type" + ], + "members":{ + "data":{ + "shape":"RecommendationTriggerData", + "documentation":"A union type containing information related to the trigger.
" + }, + "id":{ + "shape":"Uuid", + "documentation":"The identifier of the recommendation trigger.
" + }, + "recommendationIds":{ + "shape":"RecommendationIdList", + "documentation":"The identifiers of the recommendations.
" + }, + "source":{ + "shape":"RecommendationSourceType", + "documentation":"The source of the recommendation trigger.
ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.
RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.
The type of recommendation trigger.
" + } + }, + "documentation":"A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.
Data associated with the QUERY RecommendationTriggerType.
" + } + }, + "documentation":"A union type containing information related to the trigger.
", + "union":true + }, + "RecommendationTriggerList":{ + "type":"list", + "member":{"shape":"RecommendationTrigger"} + }, + "RecommendationTriggerType":{ + "type":"string", + "enum":["QUERY"] + }, + "RecommendationType":{ + "type":"string", + "enum":["KNOWLEDGE_CONTENT"] + }, + "RelevanceLevel":{ + "type":"string", + "enum":[ + "HIGH", + "MEDIUM", + "LOW" + ] + }, + "RelevanceScore":{ + "type":"double", + "min":0.0 + }, + "RemoveKnowledgeBaseTemplateUriRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "RemoveKnowledgeBaseTemplateUriResponse":{ + "type":"structure", + "members":{ + } + }, + "RenderingConfiguration":{ + "type":"structure", + "members":{ + "templateUri":{ + "shape":"Uri", + "documentation":"A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:
Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted
ServiceNow: number, short_description, sys_mod_count, workflow_state, or active
Zendesk: id, title, updated_at, or draft
The variable is replaced with the actual value for a piece of content when calling GetContent.
" + } + }, + "documentation":"Information about how to render the content.
" + }, + "RequestTimeoutException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
", + "error":{ + "httpStatusCode":408, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":false} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "resourceName":{ + "shape":"String", + "documentation":"The specified resource name.
" + } + }, + "documentation":"The specified resource does not exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResultData":{ + "type":"structure", + "required":[ + "document", + "resultId" + ], + "members":{ + "document":{ + "shape":"Document", + "documentation":"The document.
" + }, + "relevanceScore":{ + "shape":"RelevanceScore", + "documentation":"The relevance score of the results.
" + }, + "resultId":{ + "shape":"Uuid", + "documentation":"The identifier of the result data.
" + } + }, + "documentation":"Information about the result.
" + }, + "SearchContentRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "searchExpression" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + }, + "searchExpression":{ + "shape":"SearchExpression", + "documentation":"The search expression to filter results.
" + } + } + }, + "SearchContentResponse":{ + "type":"structure", + "required":["contentSummaries"], + "members":{ + "contentSummaries":{ + "shape":"ContentSummaryList", + "documentation":"Summary information about the content.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If there are additional results, this is the token for the next set of results.
" + } + } + }, + "SearchExpression":{ + "type":"structure", + "required":["filters"], + "members":{ + "filters":{ + "shape":"FilterList", + "documentation":"The search expression filters.
" + } + }, + "documentation":"The search expression.
" + }, + "SearchQuickResponsesRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "searchExpression" + ], + "members":{ + "attributes":{ + "shape":"ContactAttributes", + "documentation":"The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + }, + "searchExpression":{ + "shape":"QuickResponseSearchExpression", + "documentation":"The search expression for querying the quick response.
" + } + } + }, + "SearchQuickResponsesResponse":{ + "type":"structure", + "required":["results"], + "members":{ + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"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.
" + }, + "results":{ + "shape":"QuickResponseSearchResultsList", + "documentation":"The results of the quick response search.
" + } + } + }, + "SearchSessionsRequest":{ + "type":"structure", + "required":[ + "assistantId", + "searchExpression" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
", + "location":"querystring", + "locationName":"nextToken" + }, + "searchExpression":{ + "shape":"SearchExpression", + "documentation":"The search expression to filter results.
" + } + } + }, + "SearchSessionsResponse":{ + "type":"structure", + "required":["sessionSummaries"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"If there are additional results, this is the token for the next set of results.
" + }, + "sessionSummaries":{ + "shape":"SessionSummaries", + "documentation":"Summary information about the sessions.
" + } + } + }, + "SensitiveString":{ + "type":"string", + "sensitive":true + }, + "ServerSideEncryptionConfiguration":{ + "type":"structure", + "members":{ + "kmsKeyId":{ + "shape":"NonEmptyString", + "documentation":"The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId).
" + } + }, + "documentation":"The configuration information for the customer managed key used for encryption.
" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SessionData":{ + "type":"structure", + "required":[ + "name", + "sessionArn", + "sessionId" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"The description of the session.
" + }, + "integrationConfiguration":{ + "shape":"SessionIntegrationConfiguration", + "documentation":"The configuration information for the session integration.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the session.
" + }, + "sessionArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the session.
" + }, + "sessionId":{ + "shape":"Uuid", + "documentation":"The identifier of the session.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + }, + "documentation":"Information about the session.
" + }, + "SessionIntegrationConfiguration":{ + "type":"structure", + "members":{ + "topicIntegrationArn":{ + "shape":"GenericArn", + "documentation":"The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
" + } + }, + "documentation":"The configuration information for the session integration.
" + }, + "SessionSummaries":{ + "type":"list", + "member":{"shape":"SessionSummary"} + }, + "SessionSummary":{ + "type":"structure", + "required":[ + "assistantArn", + "assistantId", + "sessionArn", + "sessionId" + ], + "members":{ + "assistantArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the Wisdom assistant.
" + }, + "assistantId":{ + "shape":"Uuid", + "documentation":"The identifier of the Wisdom assistant.
" + }, + "sessionArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the session.
" + }, + "sessionId":{ + "shape":"Uuid", + "documentation":"The identifier of the session.
" + } + }, + "documentation":"Summary information about the session.
" + }, + "ShortCutKey":{ + "type":"string", + "max":10, + "min":1 + }, + "SourceConfiguration":{ + "type":"structure", + "members":{ + "appIntegrations":{ + "shape":"AppIntegrationsConfiguration", + "documentation":"Configuration information for Amazon AppIntegrations to automatically ingest content.
" + } + }, + "documentation":"Configuration information about the external data source.
", + "union":true + }, + "StartContentUploadRequest":{ + "type":"structure", + "required":[ + "contentType", + "knowledgeBaseId" + ], + "members":{ + "contentType":{ + "shape":"ContentType", + "documentation":"The type of content to upload.
" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "presignedUrlTimeToLive":{ + "shape":"TimeToLive", + "documentation":"The expected expiration time of the generated presigned URL, specified in minutes.
" + } + } + }, + "StartContentUploadResponse":{ + "type":"structure", + "required":[ + "headersToInclude", + "uploadId", + "url", + "urlExpiry" + ], + "members":{ + "headersToInclude":{ + "shape":"Headers", + "documentation":"The headers to include in the upload.
" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"The identifier of the upload.
" + }, + "url":{ + "shape":"Url", + "documentation":"The URL of the upload.
" + }, + "urlExpiry":{ + "shape":"SyntheticTimestamp_epoch_seconds", + "documentation":"The expiration time of the URL as an epoch timestamp.
" + } + } + }, + "StartImportJobRequest":{ + "type":"structure", + "required":[ + "importJobType", + "knowledgeBaseId", + "uploadId" + ], + "members":{ + "clientToken":{ + "shape":"NonEmptyString", + "documentation":"The tags used to organize, track, or control access for this resource.
", + "idempotencyToken":true + }, + "externalSourceConfiguration":{ + "shape":"ExternalSourceConfiguration", + "documentation":"The configuration information of the external source that the resource data are imported from.
" + }, + "importJobType":{ + "shape":"ImportJobType", + "documentation":"The type of the import job.
For importing quick response resource, set the value to QUICK_RESPONSES.
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
For importing Wisdom quick responses, this should be a QUICK_RESPONSES type knowledge base.
The metadata fields of the imported Wisdom resources.
" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"A pointer to the uploaded asset. This value is returned by StartContentUpload.
" + } + } + }, + "StartImportJobResponse":{ + "type":"structure", + "members":{ + "importJob":{ + "shape":"ImportJobData", + "documentation":"The import job.
" + } + } + }, + "String":{"type":"string"}, + "SyntheticTimestamp_epoch_seconds":{ + "type":"timestamp", + "timestampFormat":"unixTimestamp" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1 + }, + "Tags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TimeToLive":{ + "type":"integer", + "documentation":"Expiration time in minutes
", + "box":true, + "max":60, + "min":1 + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "resourceName":{ + "shape":"String", + "documentation":"The specified resource name.
" + } + }, + "documentation":"Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"The tag keys.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateContentRequest":{ + "type":"structure", + "required":[ + "contentId", + "knowledgeBaseId" + ], + "members":{ + "contentId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"contentId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "metadata":{ + "shape":"ContentMetadata", + "documentation":"A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
" + }, + "overrideLinkOutUri":{ + "shape":"Uri", + "documentation":"The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to true.
Unset the existing overrideLinkOutUri if it exists.
The revisionId of the content resource to update, taken from an earlier call to GetContent, GetContentSummary, SearchContent, or ListContents. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a PreconditionFailedException.
The title of the content.
" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"A pointer to the uploaded asset. This value is returned by StartContentUpload.
" + } + } + }, + "UpdateContentResponse":{ + "type":"structure", + "members":{ + "content":{ + "shape":"ContentData", + "documentation":"The content.
" + } + } + }, + "UpdateKnowledgeBaseTemplateUriRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "templateUri" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "templateUri":{ + "shape":"Uri", + "documentation":"The template URI to update.
" + } + } + }, + "UpdateKnowledgeBaseTemplateUriResponse":{ + "type":"structure", + "members":{ + "knowledgeBase":{ + "shape":"KnowledgeBaseData", + "documentation":"The knowledge base to update.
" + } + } + }, + "UpdateQuickResponseRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "quickResponseId" + ], + "members":{ + "channels":{ + "shape":"Channels", + "documentation":"The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The updated content of the quick response.
" + }, + "contentType":{ + "shape":"QuickResponseType", + "documentation":"The media type of the quick response content.
Use application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
The updated description of the quick response.
" + }, + "groupingConfiguration":{ + "shape":"GroupingConfiguration", + "documentation":"The updated grouping configuration of the quick response.
" + }, + "isActive":{ + "shape":"Boolean", + "documentation":"Whether the quick response is active.
" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "language":{ + "shape":"LanguageCode", + "documentation":"The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
The name of the quick response.
" + }, + "quickResponseId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the quick response.
", + "location":"uri", + "locationName":"quickResponseId" + }, + "removeDescription":{ + "shape":"Boolean", + "documentation":"Whether to remove the description from the quick response.
" + }, + "removeGroupingConfiguration":{ + "shape":"Boolean", + "documentation":"Whether to remove the grouping configuration of the quick response.
" + }, + "removeShortcutKey":{ + "shape":"Boolean", + "documentation":"Whether to remove the shortcut key of the quick response.
" + }, + "shortcutKey":{ + "shape":"ShortCutKey", + "documentation":"The shortcut key of the quick response. The value should be unique across the knowledge base.
" + } + } + }, + "UpdateQuickResponseResponse":{ + "type":"structure", + "members":{ + "quickResponse":{ + "shape":"QuickResponseData", + "documentation":"The quick response.
" + } + } + }, + "UploadId":{ + "type":"string", + "max":1200, + "min":1 + }, + "Uri":{ + "type":"string", + "max":4096, + "min":1 + }, + "Url":{ + "type":"string", + "max":4096, + "min":1, + "sensitive":true + }, + "Uuid":{ + "type":"string", + "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + }, + "UuidOrArn":{ + "type":"string", + "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^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})?$" + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The input fails to satisfy the constraints specified by a service.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "WaitTimeSeconds":{ + "type":"integer", + "max":20, + "min":0 + } + }, + "documentation":"Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers. Agents can search across connected repositories from within their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a knowledge base, for example, or manage content by uploading custom files.
" +} diff --git a/testbed/boto__botocore/botocore/data/workdocs/2016-05-01/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/workdocs/2016-05-01/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..3c324fd5d819317e46a8e503069c835e882bda64 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workdocs/2016-05-01/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://workdocs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://workdocs-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://workdocs.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://workdocs.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/workdocs/2016-05-01/examples-1.json b/testbed/boto__botocore/botocore/data/workdocs/2016-05-01/examples-1.json new file mode 100644 index 0000000000000000000000000000000000000000..0ea7e3b0bbe917eb027880396ac01509becd1fa0 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workdocs/2016-05-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/testbed/boto__botocore/botocore/data/workdocs/2016-05-01/paginators-1.json b/testbed/boto__botocore/botocore/data/workdocs/2016-05-01/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..ff2f410a92ee2c5d7e09edd708d2edf2527f8f1e --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workdocs/2016-05-01/paginators-1.json @@ -0,0 +1,67 @@ +{ + "pagination": { + "DescribeDocumentVersions": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "DocumentVersions" + }, + "DescribeFolderContents": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": [ + "Folders", + "Documents" + ] + }, + "DescribeUsers": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Users" + }, + "DescribeActivities": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "UserActivities" + }, + "DescribeComments": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Comments" + }, + "DescribeGroups": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Groups" + }, + "DescribeNotificationSubscriptions": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Subscriptions" + }, + "DescribeResourcePermissions": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Principals" + }, + "DescribeRootFolders": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Folders" + }, + "SearchResources": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Items" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/workdocs/2016-05-01/service-2.json b/testbed/boto__botocore/botocore/data/workdocs/2016-05-01/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..1e1f1518f580fac5ac6444773fac9f836a427321 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workdocs/2016-05-01/service-2.json @@ -0,0 +1,4251 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-05-01", + "endpointPrefix":"workdocs", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon WorkDocs", + "serviceId":"WorkDocs", + "signatureVersion":"v4", + "uid":"workdocs-2016-05-01" + }, + "operations":{ + "AbortDocumentVersionUpload":{ + "name":"AbortDocumentVersionUpload", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}", + "responseCode":204 + }, + "input":{"shape":"AbortDocumentVersionUploadRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so.
" + }, + "ActivateUser":{ + "name":"ActivateUser", + "http":{ + "method":"POST", + "requestUri":"/api/v1/users/{UserId}/activation", + "responseCode":200 + }, + "input":{"shape":"ActivateUserRequest"}, + "output":{"shape":"ActivateUserResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Activates the specified user. Only active users can access Amazon WorkDocs.
" + }, + "AddResourcePermissions":{ + "name":"AddResourcePermissions", + "http":{ + "method":"POST", + "requestUri":"/api/v1/resources/{ResourceId}/permissions", + "responseCode":201 + }, + "input":{"shape":"AddResourcePermissionsRequest"}, + "output":{"shape":"AddResourcePermissionsResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ProhibitedStateException"} + ], + "documentation":"Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.
" + }, + "CreateComment":{ + "name":"CreateComment", + "http":{ + "method":"POST", + "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}/comment", + "responseCode":201 + }, + "input":{"shape":"CreateCommentRequest"}, + "output":{"shape":"CreateCommentResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DocumentLockedForCommentsException"}, + {"shape":"InvalidCommentOperationException"} + ], + "documentation":"Adds a new comment to the specified document version.
" + }, + "CreateCustomMetadata":{ + "name":"CreateCustomMetadata", + "http":{ + "method":"PUT", + "requestUri":"/api/v1/resources/{ResourceId}/customMetadata", + "responseCode":200 + }, + "input":{"shape":"CreateCustomMetadataRequest"}, + "output":{"shape":"CreateCustomMetadataResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"CustomMetadataLimitExceededException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Adds one or more custom properties to the specified resource (a folder, document, or version).
" + }, + "CreateFolder":{ + "name":"CreateFolder", + "http":{ + "method":"POST", + "requestUri":"/api/v1/folders", + "responseCode":201 + }, + "input":{"shape":"CreateFolderRequest"}, + "output":{"shape":"CreateFolderResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConflictingOperationException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"LimitExceededException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Creates a folder with the specified name and parent folder.
" + }, + "CreateLabels":{ + "name":"CreateLabels", + "http":{ + "method":"PUT", + "requestUri":"/api/v1/resources/{ResourceId}/labels", + "responseCode":200 + }, + "input":{"shape":"CreateLabelsRequest"}, + "output":{"shape":"CreateLabelsResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"TooManyLabelsException"} + ], + "documentation":"Adds the specified list of labels to the given resource (a document or folder)
" + }, + "CreateNotificationSubscription":{ + "name":"CreateNotificationSubscription", + "http":{ + "method":"POST", + "requestUri":"/api/v1/organizations/{OrganizationId}/subscriptions", + "responseCode":200 + }, + "input":{"shape":"CreateNotificationSubscriptionRequest"}, + "output":{"shape":"CreateNotificationSubscriptionResponse"}, + "errors":[ + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"TooManySubscriptionsException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidArgumentException"} + ], + "documentation":"Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.
For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.
" + }, + "CreateUser":{ + "name":"CreateUser", + "http":{ + "method":"POST", + "requestUri":"/api/v1/users", + "responseCode":201 + }, + "input":{"shape":"CreateUserRequest"}, + "output":{"shape":"CreateUserResponse"}, + "errors":[ + {"shape":"EntityAlreadyExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is \"ACTIVE\". New users can access Amazon WorkDocs.
" + }, + "DeactivateUser":{ + "name":"DeactivateUser", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/users/{UserId}/activation", + "responseCode":204 + }, + "input":{"shape":"DeactivateUserRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
" + }, + "DeleteComment":{ + "name":"DeleteComment", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}/comment/{CommentId}", + "responseCode":204 + }, + "input":{"shape":"DeleteCommentRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DocumentLockedForCommentsException"} + ], + "documentation":"Deletes the specified comment from the document version.
" + }, + "DeleteCustomMetadata":{ + "name":"DeleteCustomMetadata", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/resources/{ResourceId}/customMetadata", + "responseCode":200 + }, + "input":{"shape":"DeleteCustomMetadataRequest"}, + "output":{"shape":"DeleteCustomMetadataResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Deletes custom metadata from the specified resource.
" + }, + "DeleteDocument":{ + "name":"DeleteDocument", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/documents/{DocumentId}", + "responseCode":204 + }, + "input":{"shape":"DeleteDocumentRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConflictingOperationException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Permanently deletes the specified document and its associated metadata.
" + }, + "DeleteDocumentVersion":{ + "name":"DeleteDocumentVersion", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/documentVersions/{DocumentId}/versions/{VersionId}", + "responseCode":204 + }, + "input":{"shape":"DeleteDocumentVersionRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConflictingOperationException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"InvalidOperationException"}, + {"shape":"UnauthorizedOperationException"} + ], + "documentation":"Deletes a specific version of a document.
" + }, + "DeleteFolder":{ + "name":"DeleteFolder", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/folders/{FolderId}", + "responseCode":204 + }, + "input":{"shape":"DeleteFolderRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConflictingOperationException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Permanently deletes the specified folder and its contents.
" + }, + "DeleteFolderContents":{ + "name":"DeleteFolderContents", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/folders/{FolderId}/contents", + "responseCode":204 + }, + "input":{"shape":"DeleteFolderContentsRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConflictingOperationException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Deletes the contents of the specified folder.
" + }, + "DeleteLabels":{ + "name":"DeleteLabels", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/resources/{ResourceId}/labels", + "responseCode":200 + }, + "input":{"shape":"DeleteLabelsRequest"}, + "output":{"shape":"DeleteLabelsResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ProhibitedStateException"} + ], + "documentation":"Deletes the specified list of labels from a resource.
" + }, + "DeleteNotificationSubscription":{ + "name":"DeleteNotificationSubscription", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/organizations/{OrganizationId}/subscriptions/{SubscriptionId}", + "responseCode":200 + }, + "input":{"shape":"DeleteNotificationSubscriptionRequest"}, + "errors":[ + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"EntityNotExistsException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ProhibitedStateException"} + ], + "documentation":"Deletes the specified subscription from the specified organization.
" + }, + "DeleteUser":{ + "name":"DeleteUser", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/users/{UserId}", + "responseCode":204 + }, + "input":{"shape":"DeleteUserRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Deletes the specified user from a Simple AD or Microsoft AD directory.
Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.
Describes the user activities in a specified time period.
" + }, + "DescribeComments":{ + "name":"DescribeComments", + "http":{ + "method":"GET", + "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}/comments", + "responseCode":200 + }, + "input":{"shape":"DescribeCommentsRequest"}, + "output":{"shape":"DescribeCommentsResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"List all the comments for the specified document version.
" + }, + "DescribeDocumentVersions":{ + "name":"DescribeDocumentVersions", + "http":{ + "method":"GET", + "requestUri":"/api/v1/documents/{DocumentId}/versions", + "responseCode":200 + }, + "input":{"shape":"DescribeDocumentVersionsRequest"}, + "output":{"shape":"DescribeDocumentVersionsResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"InvalidPasswordException"} + ], + "documentation":"Retrieves the document versions for the specified document.
By default, only active versions are returned.
" + }, + "DescribeFolderContents":{ + "name":"DescribeFolderContents", + "http":{ + "method":"GET", + "requestUri":"/api/v1/folders/{FolderId}/contents", + "responseCode":200 + }, + "input":{"shape":"DescribeFolderContentsRequest"}, + "output":{"shape":"DescribeFolderContentsResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ProhibitedStateException"} + ], + "documentation":"Describes the contents of the specified folder, including its documents and subfolders.
By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.
" + }, + "DescribeGroups":{ + "name":"DescribeGroups", + "http":{ + "method":"GET", + "requestUri":"/api/v1/groups", + "responseCode":200 + }, + "input":{"shape":"DescribeGroupsRequest"}, + "output":{"shape":"DescribeGroupsResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Describes the groups specified by the query. Groups are defined by the underlying Active Directory.
" + }, + "DescribeNotificationSubscriptions":{ + "name":"DescribeNotificationSubscriptions", + "http":{ + "method":"GET", + "requestUri":"/api/v1/organizations/{OrganizationId}/subscriptions", + "responseCode":200 + }, + "input":{"shape":"DescribeNotificationSubscriptionsRequest"}, + "output":{"shape":"DescribeNotificationSubscriptionsResponse"}, + "errors":[ + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"EntityNotExistsException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Lists the specified notification subscriptions.
" + }, + "DescribeResourcePermissions":{ + "name":"DescribeResourcePermissions", + "http":{ + "method":"GET", + "requestUri":"/api/v1/resources/{ResourceId}/permissions", + "responseCode":200 + }, + "input":{"shape":"DescribeResourcePermissionsRequest"}, + "output":{"shape":"DescribeResourcePermissionsResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Describes the permissions of a specified resource.
" + }, + "DescribeRootFolders":{ + "name":"DescribeRootFolders", + "http":{ + "method":"GET", + "requestUri":"/api/v1/me/root", + "responseCode":200 + }, + "input":{"shape":"DescribeRootFoldersRequest"}, + "output":{"shape":"DescribeRootFoldersResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.
This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.
" + }, + "DescribeUsers":{ + "name":"DescribeUsers", + "http":{ + "method":"GET", + "requestUri":"/api/v1/users", + "responseCode":200 + }, + "input":{"shape":"DescribeUsersRequest"}, + "output":{"shape":"DescribeUsersResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"RequestedEntityTooLargeException"} + ], + "documentation":"Describes the specified users. You can describe all users or filter the results (for example, by status or organization).
By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.
" + }, + "GetCurrentUser":{ + "name":"GetCurrentUser", + "http":{ + "method":"GET", + "requestUri":"/api/v1/me", + "responseCode":200 + }, + "input":{"shape":"GetCurrentUserRequest"}, + "output":{"shape":"GetCurrentUserResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.
This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.
" + }, + "GetDocument":{ + "name":"GetDocument", + "http":{ + "method":"GET", + "requestUri":"/api/v1/documents/{DocumentId}", + "responseCode":200 + }, + "input":{"shape":"GetDocumentRequest"}, + "output":{"shape":"GetDocumentResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidPasswordException"} + ], + "documentation":"Retrieves details of a document.
" + }, + "GetDocumentPath":{ + "name":"GetDocumentPath", + "http":{ + "method":"GET", + "requestUri":"/api/v1/documents/{DocumentId}/path", + "responseCode":200 + }, + "input":{"shape":"GetDocumentPathRequest"}, + "output":{"shape":"GetDocumentPathResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Retrieves the path information (the hierarchy from the root folder) for the requested document.
By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.
" + }, + "GetDocumentVersion":{ + "name":"GetDocumentVersion", + "http":{ + "method":"GET", + "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}", + "responseCode":200 + }, + "input":{"shape":"GetDocumentVersionRequest"}, + "output":{"shape":"GetDocumentVersionResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"InvalidPasswordException"} + ], + "documentation":"Retrieves version metadata for the specified document.
" + }, + "GetFolder":{ + "name":"GetFolder", + "http":{ + "method":"GET", + "requestUri":"/api/v1/folders/{FolderId}", + "responseCode":200 + }, + "input":{"shape":"GetFolderRequest"}, + "output":{"shape":"GetFolderResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ProhibitedStateException"} + ], + "documentation":"Retrieves the metadata of the specified folder.
" + }, + "GetFolderPath":{ + "name":"GetFolderPath", + "http":{ + "method":"GET", + "requestUri":"/api/v1/folders/{FolderId}/path", + "responseCode":200 + }, + "input":{"shape":"GetFolderPathRequest"}, + "output":{"shape":"GetFolderPathResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Retrieves the path information (the hierarchy from the root folder) for the specified folder.
By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.
" + }, + "GetResources":{ + "name":"GetResources", + "http":{ + "method":"GET", + "requestUri":"/api/v1/resources", + "responseCode":200 + }, + "input":{"shape":"GetResourcesRequest"}, + "output":{"shape":"GetResourcesResponse"}, + "errors":[ + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME.
Creates a new document object and version object.
The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion.
To cancel the document upload, call AbortDocumentVersionUpload.
" + }, + "RemoveAllResourcePermissions":{ + "name":"RemoveAllResourcePermissions", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/resources/{ResourceId}/permissions", + "responseCode":204 + }, + "input":{"shape":"RemoveAllResourcePermissionsRequest"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Removes all the permissions from the specified resource.
" + }, + "RemoveResourcePermission":{ + "name":"RemoveResourcePermission", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/resources/{ResourceId}/permissions/{PrincipalId}", + "responseCode":204 + }, + "input":{"shape":"RemoveResourcePermissionRequest"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Removes the permission for the specified principal from the specified resource.
" + }, + "RestoreDocumentVersions":{ + "name":"RestoreDocumentVersions", + "http":{ + "method":"POST", + "requestUri":"/api/v1/documentVersions/restore/{DocumentId}", + "responseCode":204 + }, + "input":{"shape":"RestoreDocumentVersionsRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConflictingOperationException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"InvalidOperationException"}, + {"shape":"UnauthorizedOperationException"} + ], + "documentation":"Recovers a deleted version of an Amazon WorkDocs document.
" + }, + "SearchResources":{ + "name":"SearchResources", + "http":{ + "method":"POST", + "requestUri":"/api/v1/search", + "responseCode":200 + }, + "input":{"shape":"SearchResourcesRequest"}, + "output":{"shape":"SearchResourcesResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Searches metadata and the content of folders, documents, document versions, and comments.
" + }, + "UpdateDocument":{ + "name":"UpdateDocument", + "http":{ + "method":"PATCH", + "requestUri":"/api/v1/documents/{DocumentId}", + "responseCode":200 + }, + "input":{"shape":"UpdateDocumentRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConflictingOperationException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
" + }, + "UpdateDocumentVersion":{ + "name":"UpdateDocumentVersion", + "http":{ + "method":"PATCH", + "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}", + "responseCode":200 + }, + "input":{"shape":"UpdateDocumentVersionRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidOperationException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Changes the status of the document version to ACTIVE.
Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload.
" + }, + "UpdateFolder":{ + "name":"UpdateFolder", + "http":{ + "method":"PATCH", + "requestUri":"/api/v1/folders/{FolderId}", + "responseCode":200 + }, + "input":{"shape":"UpdateFolderRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConflictingOperationException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"LimitExceededException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.
" + }, + "UpdateUser":{ + "name":"UpdateUser", + "http":{ + "method":"PATCH", + "requestUri":"/api/v1/users/{UserId}", + "responseCode":200 + }, + "input":{"shape":"UpdateUserRequest"}, + "output":{"shape":"UpdateUserResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"IllegalUserStateException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DeactivatingLastSystemUserException"}, + {"shape":"InvalidArgumentException"} + ], + "documentation":"Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
" + } + }, + "shapes":{ + "AbortDocumentVersionUploadRequest":{ + "type":"structure", + "required":[ + "DocumentId", + "VersionId" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the document.
", + "location":"uri", + "locationName":"DocumentId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"The ID of the version.
", + "location":"uri", + "locationName":"VersionId" + } + } + }, + "ActivateUserRequest":{ + "type":"structure", + "required":["UserId"], + "members":{ + "UserId":{ + "shape":"IdType", + "documentation":"The ID of the user.
", + "location":"uri", + "locationName":"UserId" + }, + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + } + } + }, + "ActivateUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"The user information.
" + } + } + }, + "Activity":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"ActivityType", + "documentation":"The activity type.
" + }, + "TimeStamp":{ + "shape":"TimestampType", + "documentation":"The timestamp when the action was performed.
" + }, + "IsIndirectActivity":{ + "shape":"BooleanType", + "documentation":"Indicates whether an activity is indirect or direct. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).
" + }, + "OrganizationId":{ + "shape":"IdType", + "documentation":"The ID of the organization.
" + }, + "Initiator":{ + "shape":"UserMetadata", + "documentation":"The user who performed the action.
" + }, + "Participants":{ + "shape":"Participants", + "documentation":"The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.
" + }, + "ResourceMetadata":{ + "shape":"ResourceMetadata", + "documentation":"The metadata of the resource involved in the user action.
" + }, + "OriginalParent":{ + "shape":"ResourceMetadata", + "documentation":"The original parent of the resource. This is an optional field and is filled for move activities.
" + }, + "CommentMetadata":{ + "shape":"CommentMetadata", + "documentation":"Metadata of the commenting activity. This is an optional field and is filled for commenting activities.
" + } + }, + "documentation":"Describes the activity information.
" + }, + "ActivityNamesFilterType":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[\\w,]+" + }, + "ActivityType":{ + "type":"string", + "enum":[ + "DOCUMENT_CHECKED_IN", + "DOCUMENT_CHECKED_OUT", + "DOCUMENT_RENAMED", + "DOCUMENT_VERSION_UPLOADED", + "DOCUMENT_VERSION_DELETED", + "DOCUMENT_VERSION_VIEWED", + "DOCUMENT_VERSION_DOWNLOADED", + "DOCUMENT_RECYCLED", + "DOCUMENT_RESTORED", + "DOCUMENT_REVERTED", + "DOCUMENT_SHARED", + "DOCUMENT_UNSHARED", + "DOCUMENT_SHARE_PERMISSION_CHANGED", + "DOCUMENT_SHAREABLE_LINK_CREATED", + "DOCUMENT_SHAREABLE_LINK_REMOVED", + "DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED", + "DOCUMENT_MOVED", + "DOCUMENT_COMMENT_ADDED", + "DOCUMENT_COMMENT_DELETED", + "DOCUMENT_ANNOTATION_ADDED", + "DOCUMENT_ANNOTATION_DELETED", + "FOLDER_CREATED", + "FOLDER_DELETED", + "FOLDER_RENAMED", + "FOLDER_RECYCLED", + "FOLDER_RESTORED", + "FOLDER_SHARED", + "FOLDER_UNSHARED", + "FOLDER_SHARE_PERMISSION_CHANGED", + "FOLDER_SHAREABLE_LINK_CREATED", + "FOLDER_SHAREABLE_LINK_REMOVED", + "FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED", + "FOLDER_MOVED" + ] + }, + "AddResourcePermissionsRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "Principals" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the resource.
", + "location":"uri", + "locationName":"ResourceId" + }, + "Principals":{ + "shape":"SharePrincipalList", + "documentation":"The users, groups, or organization being granted permission.
" + }, + "NotificationOptions":{ + "shape":"NotificationOptions", + "documentation":"The notification options.
" + } + } + }, + "AddResourcePermissionsResponse":{ + "type":"structure", + "members":{ + "ShareResults":{ + "shape":"ShareResultsList", + "documentation":"The share results.
" + } + } + }, + "AdditionalResponseFieldType":{ + "type":"string", + "enum":["WEBURL"] + }, + "AdditionalResponseFieldsList":{ + "type":"list", + "member":{"shape":"AdditionalResponseFieldType"} + }, + "AuthenticationHeaderType":{ + "type":"string", + "max":8199, + "min":1, + "sensitive":true + }, + "BooleanEnumType":{ + "type":"string", + "enum":[ + "TRUE", + "FALSE" + ] + }, + "BooleanType":{"type":"boolean"}, + "Comment":{ + "type":"structure", + "required":["CommentId"], + "members":{ + "CommentId":{ + "shape":"CommentIdType", + "documentation":"The ID of the comment.
" + }, + "ParentId":{ + "shape":"CommentIdType", + "documentation":"The ID of the parent comment.
" + }, + "ThreadId":{ + "shape":"CommentIdType", + "documentation":"The ID of the root comment in the thread.
" + }, + "Text":{ + "shape":"CommentTextType", + "documentation":"The text of the comment.
" + }, + "Contributor":{ + "shape":"User", + "documentation":"The details of the user who made the comment.
" + }, + "CreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"The time that the comment was created.
" + }, + "Status":{ + "shape":"CommentStatusType", + "documentation":"The status of the comment.
" + }, + "Visibility":{ + "shape":"CommentVisibilityType", + "documentation":"The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.
" + }, + "RecipientId":{ + "shape":"IdType", + "documentation":"If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.
" + } + }, + "documentation":"Describes a comment.
" + }, + "CommentIdType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+-.@]+" + }, + "CommentList":{ + "type":"list", + "member":{"shape":"Comment"} + }, + "CommentMetadata":{ + "type":"structure", + "members":{ + "CommentId":{ + "shape":"CommentIdType", + "documentation":"The ID of the comment.
" + }, + "Contributor":{ + "shape":"User", + "documentation":"The user who made the comment.
" + }, + "CreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"The timestamp that the comment was created.
" + }, + "CommentStatus":{ + "shape":"CommentStatusType", + "documentation":"The status of the comment.
" + }, + "RecipientId":{ + "shape":"IdType", + "documentation":"The ID of the user being replied to.
" + }, + "ContributorId":{ + "shape":"IdType", + "documentation":"The ID of the user who made the comment.
" + } + }, + "documentation":"Describes the metadata of a comment.
" + }, + "CommentStatusType":{ + "type":"string", + "enum":[ + "DRAFT", + "PUBLISHED", + "DELETED" + ] + }, + "CommentTextType":{ + "type":"string", + "max":2048, + "min":1, + "sensitive":true + }, + "CommentVisibilityType":{ + "type":"string", + "enum":[ + "PUBLIC", + "PRIVATE" + ] + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The resource hierarchy is changing.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ConflictingOperationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"Another operation is in progress on the resource that conflicts with the current operation.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ContentCategoryType":{ + "type":"string", + "enum":[ + "IMAGE", + "DOCUMENT", + "PDF", + "SPREADSHEET", + "PRESENTATION", + "AUDIO", + "VIDEO", + "SOURCE_CODE", + "OTHER" + ] + }, + "CreateCommentRequest":{ + "type":"structure", + "required":[ + "DocumentId", + "VersionId", + "Text" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the document.
", + "location":"uri", + "locationName":"DocumentId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"The ID of the document version.
", + "location":"uri", + "locationName":"VersionId" + }, + "ParentId":{ + "shape":"CommentIdType", + "documentation":"The ID of the parent comment.
" + }, + "ThreadId":{ + "shape":"CommentIdType", + "documentation":"The ID of the root comment in the thread.
" + }, + "Text":{ + "shape":"CommentTextType", + "documentation":"The text of the comment.
" + }, + "Visibility":{ + "shape":"CommentVisibilityType", + "documentation":"The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.
" + }, + "NotifyCollaborators":{ + "shape":"BooleanType", + "documentation":"Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
" + } + } + }, + "CreateCommentResponse":{ + "type":"structure", + "members":{ + "Comment":{ + "shape":"Comment", + "documentation":"The comment that has been created.
" + } + } + }, + "CreateCustomMetadataRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "CustomMetadata" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the resource.
", + "location":"uri", + "locationName":"ResourceId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"The ID of the version, if the custom metadata is being added to a document version.
", + "location":"querystring", + "locationName":"versionid" + }, + "CustomMetadata":{ + "shape":"CustomMetadataMap", + "documentation":"Custom metadata in the form of name-value pairs.
" + } + } + }, + "CreateCustomMetadataResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateFolderRequest":{ + "type":"structure", + "required":["ParentFolderId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"The name of the new folder.
" + }, + "ParentFolderId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the parent folder.
" + } + } + }, + "CreateFolderResponse":{ + "type":"structure", + "members":{ + "Metadata":{ + "shape":"FolderMetadata", + "documentation":"The metadata of the folder.
" + } + } + }, + "CreateLabelsRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "Labels" + ], + "members":{ + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the resource.
", + "location":"uri", + "locationName":"ResourceId" + }, + "Labels":{ + "shape":"SharedLabels", + "documentation":"List of labels to add to the resource.
" + }, + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + } + } + }, + "CreateLabelsResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateNotificationSubscriptionRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "Endpoint", + "Protocol", + "SubscriptionType" + ], + "members":{ + "OrganizationId":{ + "shape":"IdType", + "documentation":"The ID of the organization.
", + "location":"uri", + "locationName":"OrganizationId" + }, + "Endpoint":{ + "shape":"SubscriptionEndPointType", + "documentation":"The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with https.
The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.
" + }, + "SubscriptionType":{ + "shape":"SubscriptionType", + "documentation":"The notification type.
" + } + } + }, + "CreateNotificationSubscriptionResponse":{ + "type":"structure", + "members":{ + "Subscription":{ + "shape":"Subscription", + "documentation":"The subscription.
" + } + } + }, + "CreateUserRequest":{ + "type":"structure", + "required":[ + "Username", + "GivenName", + "Surname", + "Password" + ], + "members":{ + "OrganizationId":{ + "shape":"IdType", + "documentation":"The ID of the organization.
" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"The login name of the user.
" + }, + "EmailAddress":{ + "shape":"EmailAddressType", + "documentation":"The email address of the user.
" + }, + "GivenName":{ + "shape":"UserAttributeValueType", + "documentation":"The given name of the user.
" + }, + "Surname":{ + "shape":"UserAttributeValueType", + "documentation":"The surname of the user.
" + }, + "Password":{ + "shape":"PasswordType", + "documentation":"The password of the user.
" + }, + "TimeZoneId":{ + "shape":"TimeZoneIdType", + "documentation":"The time zone ID of the user.
" + }, + "StorageRule":{ + "shape":"StorageRuleType", + "documentation":"The amount of storage for the user.
" + }, + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + } + } + }, + "CreateUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"The user information.
" + } + } + }, + "CustomMetadataKeyList":{ + "type":"list", + "member":{"shape":"CustomMetadataKeyType"}, + "max":8 + }, + "CustomMetadataKeyType":{ + "type":"string", + "max":56, + "min":1, + "pattern":"[a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*" + }, + "CustomMetadataLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The limit has been reached on the number of custom properties for the specified resource.
", + "error":{"httpStatusCode":429}, + "exception":true + }, + "CustomMetadataMap":{ + "type":"map", + "key":{"shape":"CustomMetadataKeyType"}, + "value":{"shape":"CustomMetadataValueType"}, + "max":8, + "min":1 + }, + "CustomMetadataValueType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*" + }, + "DateRangeType":{ + "type":"structure", + "members":{ + "StartValue":{ + "shape":"TimestampType", + "documentation":"Timestamp range start value (in epochs)
" + }, + "EndValue":{ + "shape":"TimestampType", + "documentation":"Timestamp range end value (in epochs).
" + } + }, + "documentation":"Filters results based on timestamp range (in epochs).
" + }, + "DeactivateUserRequest":{ + "type":"structure", + "required":["UserId"], + "members":{ + "UserId":{ + "shape":"IdType", + "documentation":"The ID of the user.
", + "location":"uri", + "locationName":"UserId" + }, + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + } + } + }, + "DeactivatingLastSystemUserException":{ + "type":"structure", + "members":{ + }, + "documentation":"The last user in the organization is being deactivated.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DeleteCommentRequest":{ + "type":"structure", + "required":[ + "DocumentId", + "VersionId", + "CommentId" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the document.
", + "location":"uri", + "locationName":"DocumentId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"The ID of the document version.
", + "location":"uri", + "locationName":"VersionId" + }, + "CommentId":{ + "shape":"CommentIdType", + "documentation":"The ID of the comment.
", + "location":"uri", + "locationName":"CommentId" + } + } + }, + "DeleteCustomMetadataRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the resource, either a document or folder.
", + "location":"uri", + "locationName":"ResourceId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"The ID of the version, if the custom metadata is being deleted from a document version.
", + "location":"querystring", + "locationName":"versionId" + }, + "Keys":{ + "shape":"CustomMetadataKeyList", + "documentation":"List of properties to remove.
", + "location":"querystring", + "locationName":"keys" + }, + "DeleteAll":{ + "shape":"BooleanType", + "documentation":"Flag to indicate removal of all custom metadata properties from the specified resource.
", + "location":"querystring", + "locationName":"deleteAll" + } + } + }, + "DeleteCustomMetadataResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteDocumentRequest":{ + "type":"structure", + "required":["DocumentId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the document.
", + "location":"uri", + "locationName":"DocumentId" + } + } + }, + "DeleteDocumentVersionRequest":{ + "type":"structure", + "required":[ + "DocumentId", + "VersionId", + "DeletePriorVersions" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the document associated with the version being deleted.
", + "location":"uri", + "locationName":"DocumentId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"The ID of the version being deleted.
", + "location":"uri", + "locationName":"VersionId" + }, + "DeletePriorVersions":{ + "shape":"BooleanType", + "documentation":"Deletes all versions of a document prior to the current version.
", + "location":"querystring", + "locationName":"deletePriorVersions" + } + } + }, + "DeleteFolderContentsRequest":{ + "type":"structure", + "required":["FolderId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "FolderId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the folder.
", + "location":"uri", + "locationName":"FolderId" + } + } + }, + "DeleteFolderRequest":{ + "type":"structure", + "required":["FolderId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "FolderId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the folder.
", + "location":"uri", + "locationName":"FolderId" + } + } + }, + "DeleteLabelsRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the resource.
", + "location":"uri", + "locationName":"ResourceId" + }, + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "Labels":{ + "shape":"SharedLabels", + "documentation":"List of labels to delete from the resource.
", + "location":"querystring", + "locationName":"labels" + }, + "DeleteAll":{ + "shape":"BooleanType", + "documentation":"Flag to request removal of all labels from the specified resource.
", + "location":"querystring", + "locationName":"deleteAll" + } + } + }, + "DeleteLabelsResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteNotificationSubscriptionRequest":{ + "type":"structure", + "required":[ + "SubscriptionId", + "OrganizationId" + ], + "members":{ + "SubscriptionId":{ + "shape":"IdType", + "documentation":"The ID of the subscription.
", + "location":"uri", + "locationName":"SubscriptionId" + }, + "OrganizationId":{ + "shape":"IdType", + "documentation":"The ID of the organization.
", + "location":"uri", + "locationName":"OrganizationId" + } + } + }, + "DeleteUserRequest":{ + "type":"structure", + "required":["UserId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using Amazon Web Services credentials.
", + "location":"header", + "locationName":"Authentication" + }, + "UserId":{ + "shape":"IdType", + "documentation":"The ID of the user.
", + "location":"uri", + "locationName":"UserId" + } + } + }, + "DescribeActivitiesRequest":{ + "type":"structure", + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "StartTime":{ + "shape":"TimestampType", + "documentation":"The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.
", + "location":"querystring", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"TimestampType", + "documentation":"The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.
", + "location":"querystring", + "locationName":"endTime" + }, + "OrganizationId":{ + "shape":"IdType", + "documentation":"The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.
", + "location":"querystring", + "locationName":"organizationId" + }, + "ActivityTypes":{ + "shape":"ActivityNamesFilterType", + "documentation":"Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.
", + "location":"querystring", + "locationName":"activityTypes" + }, + "ResourceId":{ + "shape":"IdType", + "documentation":"The document or folder ID for which to describe activity types.
", + "location":"querystring", + "locationName":"resourceId" + }, + "UserId":{ + "shape":"IdType", + "documentation":"The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests.
", + "location":"querystring", + "locationName":"userId" + }, + "IncludeIndirectActivities":{ + "shape":"BooleanType", + "documentation":"Includes indirect activities. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).
", + "location":"querystring", + "locationName":"includeIndirectActivities" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"The maximum number of items to return.
", + "location":"querystring", + "locationName":"limit" + }, + "Marker":{ + "shape":"SearchMarkerType", + "documentation":"The marker for the next set of results.
", + "location":"querystring", + "locationName":"marker" + } + } + }, + "DescribeActivitiesResponse":{ + "type":"structure", + "members":{ + "UserActivities":{ + "shape":"UserActivities", + "documentation":"The list of activities for the specified user and time period.
" + }, + "Marker":{ + "shape":"SearchMarkerType", + "documentation":"The marker for the next set of results.
" + } + } + }, + "DescribeCommentsRequest":{ + "type":"structure", + "required":[ + "DocumentId", + "VersionId" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the document.
", + "location":"uri", + "locationName":"DocumentId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"The ID of the document version.
", + "location":"uri", + "locationName":"VersionId" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"The maximum number of items to return.
", + "location":"querystring", + "locationName":"limit" + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"The marker for the next set of results. This marker was received from a previous call.
", + "location":"querystring", + "locationName":"marker" + } + } + }, + "DescribeCommentsResponse":{ + "type":"structure", + "members":{ + "Comments":{ + "shape":"CommentList", + "documentation":"The list of comments for the specified document version.
" + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"The marker for the next set of results. This marker was received from a previous call.
" + } + } + }, + "DescribeDocumentVersionsRequest":{ + "type":"structure", + "required":["DocumentId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the document.
", + "location":"uri", + "locationName":"DocumentId" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"The marker for the next set of results. (You received this marker from a previous call.)
", + "location":"querystring", + "locationName":"marker" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"The maximum number of versions to return with this call.
", + "location":"querystring", + "locationName":"limit" + }, + "Include":{ + "shape":"FieldNamesType", + "documentation":"A comma-separated list of values. Specify \"INITIALIZED\" to include incomplete versions.
", + "location":"querystring", + "locationName":"include" + }, + "Fields":{ + "shape":"FieldNamesType", + "documentation":"Specify \"SOURCE\" to include initialized versions and a URL for the source document.
", + "location":"querystring", + "locationName":"fields" + } + } + }, + "DescribeDocumentVersionsResponse":{ + "type":"structure", + "members":{ + "DocumentVersions":{ + "shape":"DocumentVersionMetadataList", + "documentation":"The document versions.
" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
" + } + } + }, + "DescribeFolderContentsRequest":{ + "type":"structure", + "required":["FolderId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "FolderId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the folder.
", + "location":"uri", + "locationName":"FolderId" + }, + "Sort":{ + "shape":"ResourceSortType", + "documentation":"The sorting criteria.
", + "location":"querystring", + "locationName":"sort" + }, + "Order":{ + "shape":"OrderType", + "documentation":"The order for the contents of the folder.
", + "location":"querystring", + "locationName":"order" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"The maximum number of items to return with this call.
", + "location":"querystring", + "locationName":"limit" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"The marker for the next set of results. This marker was received from a previous call.
", + "location":"querystring", + "locationName":"marker" + }, + "Type":{ + "shape":"FolderContentType", + "documentation":"The type of items.
", + "location":"querystring", + "locationName":"type" + }, + "Include":{ + "shape":"FieldNamesType", + "documentation":"The contents to include. Specify \"INITIALIZED\" to include initialized documents.
", + "location":"querystring", + "locationName":"include" + } + } + }, + "DescribeFolderContentsResponse":{ + "type":"structure", + "members":{ + "Folders":{ + "shape":"FolderMetadataList", + "documentation":"The subfolders in the specified folder.
" + }, + "Documents":{ + "shape":"DocumentMetadataList", + "documentation":"The documents in the specified folder.
" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
" + } + } + }, + "DescribeGroupsRequest":{ + "type":"structure", + "required":["SearchQuery"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "SearchQuery":{ + "shape":"SearchQueryType", + "documentation":"A query to describe groups by group name.
", + "location":"querystring", + "locationName":"searchQuery" + }, + "OrganizationId":{ + "shape":"IdType", + "documentation":"The ID of the organization.
", + "location":"querystring", + "locationName":"organizationId" + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"The marker for the next set of results. (You received this marker from a previous call.)
", + "location":"querystring", + "locationName":"marker" + }, + "Limit":{ + "shape":"PositiveIntegerType", + "documentation":"The maximum number of items to return with this call.
", + "location":"querystring", + "locationName":"limit" + } + } + }, + "DescribeGroupsResponse":{ + "type":"structure", + "members":{ + "Groups":{ + "shape":"GroupMetadataList", + "documentation":"The list of groups.
" + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
" + } + } + }, + "DescribeNotificationSubscriptionsRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"IdType", + "documentation":"The ID of the organization.
", + "location":"uri", + "locationName":"OrganizationId" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"The marker for the next set of results. (You received this marker from a previous call.)
", + "location":"querystring", + "locationName":"marker" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"The maximum number of items to return with this call.
", + "location":"querystring", + "locationName":"limit" + } + } + }, + "DescribeNotificationSubscriptionsResponse":{ + "type":"structure", + "members":{ + "Subscriptions":{ + "shape":"SubscriptionList", + "documentation":"The subscriptions.
" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
" + } + } + }, + "DescribeResourcePermissionsRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the resource.
", + "location":"uri", + "locationName":"ResourceId" + }, + "PrincipalId":{ + "shape":"IdType", + "documentation":"The ID of the principal to filter permissions by.
", + "location":"querystring", + "locationName":"principalId" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"The maximum number of items to return with this call.
", + "location":"querystring", + "locationName":"limit" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"The marker for the next set of results. (You received this marker from a previous call)
", + "location":"querystring", + "locationName":"marker" + } + } + }, + "DescribeResourcePermissionsResponse":{ + "type":"structure", + "members":{ + "Principals":{ + "shape":"PrincipalList", + "documentation":"The principals.
" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
" + } + } + }, + "DescribeRootFoldersRequest":{ + "type":"structure", + "required":["AuthenticationToken"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token.
", + "location":"header", + "locationName":"Authentication" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"The maximum number of items to return.
", + "location":"querystring", + "locationName":"limit" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"The marker for the next set of results. (You received this marker from a previous call.)
", + "location":"querystring", + "locationName":"marker" + } + } + }, + "DescribeRootFoldersResponse":{ + "type":"structure", + "members":{ + "Folders":{ + "shape":"FolderMetadataList", + "documentation":"The user's special folders.
" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"The marker for the next set of results.
" + } + } + }, + "DescribeUsersRequest":{ + "type":"structure", + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "OrganizationId":{ + "shape":"IdType", + "documentation":"The ID of the organization.
", + "location":"querystring", + "locationName":"organizationId" + }, + "UserIds":{ + "shape":"UserIdsType", + "documentation":"The IDs of the users.
", + "location":"querystring", + "locationName":"userIds" + }, + "Query":{ + "shape":"SearchQueryType", + "documentation":"A query to filter users by user name. Remember the following about the Userids and Query parameters:
If you don't use either parameter, the API returns a paginated list of all users on the site.
If you use both parameters, the API ignores the Query parameter.
The Userid parameter only returns user names that match a corresponding user ID.
The Query parameter runs a \"prefix\" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson.
The state of the users. Specify \"ALL\" to include inactive users.
", + "location":"querystring", + "locationName":"include" + }, + "Order":{ + "shape":"OrderType", + "documentation":"The order for the results.
", + "location":"querystring", + "locationName":"order" + }, + "Sort":{ + "shape":"UserSortType", + "documentation":"The sorting criteria.
", + "location":"querystring", + "locationName":"sort" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"The marker for the next set of results. (You received this marker from a previous call.)
", + "location":"querystring", + "locationName":"marker" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"The maximum number of items to return.
", + "location":"querystring", + "locationName":"limit" + }, + "Fields":{ + "shape":"FieldNamesType", + "documentation":"A comma-separated list of values. Specify \"STORAGE_METADATA\" to include the user storage quota and utilization information.
", + "location":"querystring", + "locationName":"fields" + } + } + }, + "DescribeUsersResponse":{ + "type":"structure", + "members":{ + "Users":{ + "shape":"OrganizationUserList", + "documentation":"The users.
" + }, + "TotalNumberOfUsers":{ + "shape":"SizeType", + "documentation":"The total number of users included in the results.
", + "deprecated":true + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
" + } + } + }, + "DocumentContentType":{ + "type":"string", + "max":128, + "min":1 + }, + "DocumentLockedForCommentsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DocumentMetadata":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceIdType", + "documentation":"The ID of the document.
" + }, + "CreatorId":{ + "shape":"IdType", + "documentation":"The ID of the creator.
" + }, + "ParentFolderId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the parent folder.
" + }, + "CreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"The time when the document was created.
" + }, + "ModifiedTimestamp":{ + "shape":"TimestampType", + "documentation":"The time when the document was updated.
" + }, + "LatestVersionMetadata":{ + "shape":"DocumentVersionMetadata", + "documentation":"The latest version of the document.
" + }, + "ResourceState":{ + "shape":"ResourceStateType", + "documentation":"The resource state.
" + }, + "Labels":{ + "shape":"SharedLabels", + "documentation":"List of labels on the document.
" + } + }, + "documentation":"Describes the document.
" + }, + "DocumentMetadataList":{ + "type":"list", + "member":{"shape":"DocumentMetadata"} + }, + "DocumentSourceType":{ + "type":"string", + "enum":[ + "ORIGINAL", + "WITH_COMMENTS" + ] + }, + "DocumentSourceUrlMap":{ + "type":"map", + "key":{"shape":"DocumentSourceType"}, + "value":{"shape":"UrlType"} + }, + "DocumentStatusType":{ + "type":"string", + "enum":[ + "INITIALIZED", + "ACTIVE" + ] + }, + "DocumentThumbnailType":{ + "type":"string", + "enum":[ + "SMALL", + "SMALL_HQ", + "LARGE" + ] + }, + "DocumentThumbnailUrlMap":{ + "type":"map", + "key":{"shape":"DocumentThumbnailType"}, + "value":{"shape":"UrlType"} + }, + "DocumentVersionIdType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+-.@]+" + }, + "DocumentVersionMetadata":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"DocumentVersionIdType", + "documentation":"The ID of the version.
" + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"The name of the version.
" + }, + "ContentType":{ + "shape":"DocumentContentType", + "documentation":"The content type of the document.
" + }, + "Size":{ + "shape":"SizeType", + "documentation":"The size of the document, in bytes.
" + }, + "Signature":{ + "shape":"HashType", + "documentation":"The signature of the document.
" + }, + "Status":{ + "shape":"DocumentStatusType", + "documentation":"The status of the document.
" + }, + "CreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"The timestamp when the document was first uploaded.
" + }, + "ModifiedTimestamp":{ + "shape":"TimestampType", + "documentation":"The timestamp when the document was last uploaded.
" + }, + "ContentCreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"The timestamp when the content of the document was originally created.
" + }, + "ContentModifiedTimestamp":{ + "shape":"TimestampType", + "documentation":"The timestamp when the content of the document was modified.
" + }, + "CreatorId":{ + "shape":"IdType", + "documentation":"The ID of the creator.
" + }, + "Thumbnail":{ + "shape":"DocumentThumbnailUrlMap", + "documentation":"The thumbnail of the document.
" + }, + "Source":{ + "shape":"DocumentSourceUrlMap", + "documentation":"The source of the document.
" + } + }, + "documentation":"Describes a version of a document.
" + }, + "DocumentVersionMetadataList":{ + "type":"list", + "member":{"shape":"DocumentVersionMetadata"} + }, + "DocumentVersionStatus":{ + "type":"string", + "enum":["ACTIVE"] + }, + "DraftUploadOutOfSyncException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"This exception is thrown when a valid checkout ID is not presented on document version upload calls for a document that has been checked out from Web client.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "EmailAddressType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}", + "sensitive":true + }, + "EntityAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The resource already exists.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "EntityIdList":{ + "type":"list", + "member":{"shape":"IdType"} + }, + "EntityNotExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"}, + "EntityIds":{ + "shape":"EntityIdList", + "documentation":"The IDs of the non-existent resources.
" + } + }, + "documentation":"The resource does not exist.
", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ErrorMessageType":{"type":"string"}, + "FailedDependencyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
", + "error":{"httpStatusCode":424}, + "exception":true + }, + "FieldNamesType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\w,]+" + }, + "Filters":{ + "type":"structure", + "members":{ + "TextLocales":{ + "shape":"TextLocaleTypeList", + "documentation":"Filters by the locale of the content or comment.
" + }, + "ContentCategories":{ + "shape":"SearchContentCategoryTypeList", + "documentation":"Filters by content category.
" + }, + "ResourceTypes":{ + "shape":"SearchResourceTypeList", + "documentation":"Filters based on entity type.
" + }, + "Labels":{ + "shape":"SearchLabelList", + "documentation":"Filter by labels using exact match.
" + }, + "Principals":{ + "shape":"SearchPrincipalTypeList", + "documentation":"Filter based on UserIds or GroupIds.
" + }, + "AncestorIds":{ + "shape":"SearchAncestorIdList", + "documentation":"Filter based on resource’s path.
" + }, + "SearchCollectionTypes":{ + "shape":"SearchCollectionTypeList", + "documentation":"Filter based on file groupings.
" + }, + "SizeRange":{ + "shape":"LongRangeType", + "documentation":"Filter based on size (in bytes).
" + }, + "CreatedRange":{ + "shape":"DateRangeType", + "documentation":"Filter based on resource’s creation timestamp.
" + }, + "ModifiedRange":{ + "shape":"DateRangeType", + "documentation":"Filter based on resource’s modified timestamp.
" + } + }, + "documentation":"Filters results based on entity metadata.
" + }, + "FolderContentType":{ + "type":"string", + "enum":[ + "ALL", + "DOCUMENT", + "FOLDER" + ] + }, + "FolderMetadata":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceIdType", + "documentation":"The ID of the folder.
" + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"The name of the folder.
" + }, + "CreatorId":{ + "shape":"IdType", + "documentation":"The ID of the creator.
" + }, + "ParentFolderId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the parent folder.
" + }, + "CreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"The time when the folder was created.
" + }, + "ModifiedTimestamp":{ + "shape":"TimestampType", + "documentation":"The time when the folder was updated.
" + }, + "ResourceState":{ + "shape":"ResourceStateType", + "documentation":"The resource state of the folder.
" + }, + "Signature":{ + "shape":"HashType", + "documentation":"The unique identifier created from the subfolders and documents of the folder.
" + }, + "Labels":{ + "shape":"SharedLabels", + "documentation":"List of labels on the folder.
" + }, + "Size":{ + "shape":"SizeType", + "documentation":"The size of the folder metadata.
" + }, + "LatestVersionSize":{ + "shape":"SizeType", + "documentation":"The size of the latest version of the folder metadata.
" + } + }, + "documentation":"Describes a folder.
" + }, + "FolderMetadataList":{ + "type":"list", + "member":{"shape":"FolderMetadata"} + }, + "GetCurrentUserRequest":{ + "type":"structure", + "required":["AuthenticationToken"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token.
", + "location":"header", + "locationName":"Authentication" + } + } + }, + "GetCurrentUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"Metadata of the user.
" + } + } + }, + "GetDocumentPathRequest":{ + "type":"structure", + "required":["DocumentId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"IdType", + "documentation":"The ID of the document.
", + "location":"uri", + "locationName":"DocumentId" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"The maximum number of levels in the hierarchy to return.
", + "location":"querystring", + "locationName":"limit" + }, + "Fields":{ + "shape":"FieldNamesType", + "documentation":"A comma-separated list of values. Specify NAME to include the names of the parent folders.
This value is not supported.
", + "location":"querystring", + "locationName":"marker" + } + } + }, + "GetDocumentPathResponse":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"ResourcePath", + "documentation":"The path information.
" + } + } + }, + "GetDocumentRequest":{ + "type":"structure", + "required":["DocumentId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the document.
", + "location":"uri", + "locationName":"DocumentId" + }, + "IncludeCustomMetadata":{ + "shape":"BooleanType", + "documentation":"Set this to TRUE to include custom metadata in the response.
The metadata details of the document.
" + }, + "CustomMetadata":{ + "shape":"CustomMetadataMap", + "documentation":"The custom metadata on the document.
" + } + } + }, + "GetDocumentVersionRequest":{ + "type":"structure", + "required":[ + "DocumentId", + "VersionId" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the document.
", + "location":"uri", + "locationName":"DocumentId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"The version ID of the document.
", + "location":"uri", + "locationName":"VersionId" + }, + "Fields":{ + "shape":"FieldNamesType", + "documentation":"A comma-separated list of values. Specify \"SOURCE\" to include a URL for the source document.
", + "location":"querystring", + "locationName":"fields" + }, + "IncludeCustomMetadata":{ + "shape":"BooleanType", + "documentation":"Set this to TRUE to include custom metadata in the response.
", + "location":"querystring", + "locationName":"includeCustomMetadata" + } + } + }, + "GetDocumentVersionResponse":{ + "type":"structure", + "members":{ + "Metadata":{ + "shape":"DocumentVersionMetadata", + "documentation":"The version metadata.
" + }, + "CustomMetadata":{ + "shape":"CustomMetadataMap", + "documentation":"The custom metadata on the document version.
" + } + } + }, + "GetFolderPathRequest":{ + "type":"structure", + "required":["FolderId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "FolderId":{ + "shape":"IdType", + "documentation":"The ID of the folder.
", + "location":"uri", + "locationName":"FolderId" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"The maximum number of levels in the hierarchy to return.
", + "location":"querystring", + "locationName":"limit" + }, + "Fields":{ + "shape":"FieldNamesType", + "documentation":"A comma-separated list of values. Specify \"NAME\" to include the names of the parent folders.
", + "location":"querystring", + "locationName":"fields" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"This value is not supported.
", + "location":"querystring", + "locationName":"marker" + } + } + }, + "GetFolderPathResponse":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"ResourcePath", + "documentation":"The path information.
" + } + } + }, + "GetFolderRequest":{ + "type":"structure", + "required":["FolderId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "FolderId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the folder.
", + "location":"uri", + "locationName":"FolderId" + }, + "IncludeCustomMetadata":{ + "shape":"BooleanType", + "documentation":"Set to TRUE to include custom metadata in the response.
", + "location":"querystring", + "locationName":"includeCustomMetadata" + } + } + }, + "GetFolderResponse":{ + "type":"structure", + "members":{ + "Metadata":{ + "shape":"FolderMetadata", + "documentation":"The metadata of the folder.
" + }, + "CustomMetadata":{ + "shape":"CustomMetadataMap", + "documentation":"The custom metadata on the folder.
" + } + } + }, + "GetResourcesRequest":{ + "type":"structure", + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"The Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "UserId":{ + "shape":"IdType", + "documentation":"The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.
", + "location":"querystring", + "locationName":"userId" + }, + "CollectionType":{ + "shape":"ResourceCollectionType", + "documentation":"The collection type.
", + "location":"querystring", + "locationName":"collectionType" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"The maximum number of resources to return.
", + "location":"querystring", + "locationName":"limit" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"The marker for the next set of results. This marker was received from a previous call.
", + "location":"querystring", + "locationName":"marker" + } + } + }, + "GetResourcesResponse":{ + "type":"structure", + "members":{ + "Folders":{ + "shape":"FolderMetadataList", + "documentation":"The folders in the specified folder.
" + }, + "Documents":{ + "shape":"DocumentMetadataList", + "documentation":"The documents in the specified collection.
" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
" + } + } + }, + "GroupMetadata":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"IdType", + "documentation":"The ID of the user group.
" + }, + "Name":{ + "shape":"GroupNameType", + "documentation":"The name of the group.
" + } + }, + "documentation":"Describes the metadata of a user group.
" + }, + "GroupMetadataList":{ + "type":"list", + "member":{"shape":"GroupMetadata"} + }, + "GroupNameType":{"type":"string"}, + "HashType":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[&\\w+-.@]+" + }, + "HeaderNameType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\w-]+" + }, + "HeaderValueType":{ + "type":"string", + "max":1024, + "min":1 + }, + "IdType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[&\\w+-.@]+" + }, + "IllegalUserStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The user is undergoing transfer of ownership.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "InitiateDocumentVersionUploadRequest":{ + "type":"structure", + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "Id":{ + "shape":"ResourceIdType", + "documentation":"The ID of the document.
" + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"The name of the document.
" + }, + "ContentCreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"The timestamp when the content of the document was originally created.
" + }, + "ContentModifiedTimestamp":{ + "shape":"TimestampType", + "documentation":"The timestamp when the content of the document was modified.
" + }, + "ContentType":{ + "shape":"DocumentContentType", + "documentation":"The content type of the document.
" + }, + "DocumentSizeInBytes":{ + "shape":"SizeType", + "documentation":"The size of the document, in bytes.
" + }, + "ParentFolderId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the parent folder.
" + } + } + }, + "InitiateDocumentVersionUploadResponse":{ + "type":"structure", + "members":{ + "Metadata":{ + "shape":"DocumentMetadata", + "documentation":"The document metadata.
" + }, + "UploadMetadata":{ + "shape":"UploadMetadata", + "documentation":"The upload metadata.
" + } + } + }, + "InvalidArgumentException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The pagination marker or limit fields are not valid.
", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidCommentOperationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The requested operation is not allowed on the specified comment object.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "InvalidOperationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The operation is invalid.
", + "error":{"httpStatusCode":405}, + "exception":true + }, + "InvalidPasswordException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The password is invalid.
", + "error":{"httpStatusCode":401}, + "exception":true + }, + "LanguageCodeType":{ + "type":"string", + "enum":[ + "AR", + "BG", + "BN", + "DA", + "DE", + "CS", + "EL", + "EN", + "ES", + "FA", + "FI", + "FR", + "HI", + "HU", + "ID", + "IT", + "JA", + "KO", + "LT", + "LV", + "NL", + "NO", + "PT", + "RO", + "RU", + "SV", + "SW", + "TH", + "TR", + "ZH", + "DEFAULT" + ] + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The maximum of 100,000 files and folders under the parent folder has been exceeded.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "LimitType":{ + "type":"integer", + "max":999, + "min":1 + }, + "LocaleType":{ + "type":"string", + "enum":[ + "en", + "fr", + "ko", + "de", + "es", + "ja", + "ru", + "zh_CN", + "zh_TW", + "pt_BR", + "default" + ] + }, + "LongRangeType":{ + "type":"structure", + "members":{ + "StartValue":{ + "shape":"LongType", + "documentation":"The size start range (in bytes).
" + }, + "EndValue":{ + "shape":"LongType", + "documentation":"The size end range (in bytes).
" + } + }, + "documentation":"Filter based on size (in bytes).
" + }, + "LongType":{"type":"long"}, + "MarkerType":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[\\u0000-\\u00FF]+" + }, + "MessageType":{ + "type":"string", + "max":2048, + "min":0, + "sensitive":true + }, + "NextMarkerType":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[\\d]+" + }, + "NotificationOptions":{ + "type":"structure", + "members":{ + "SendEmail":{ + "shape":"BooleanType", + "documentation":"Boolean value to indicate an email notification should be sent to the recipients.
" + }, + "EmailMessage":{ + "shape":"MessageType", + "documentation":"Text value to be included in the email body.
" + } + }, + "documentation":"Set of options which defines notification preferences of given action.
" + }, + "OrderByFieldType":{ + "type":"string", + "enum":[ + "RELEVANCE", + "NAME", + "SIZE", + "CREATED_TIMESTAMP", + "MODIFIED_TIMESTAMP" + ] + }, + "OrderType":{ + "type":"string", + "enum":[ + "ASCENDING", + "DESCENDING" + ] + }, + "OrganizationUserList":{ + "type":"list", + "member":{"shape":"User"} + }, + "PageMarkerType":{ + "type":"string", + "max":2048, + "min":1 + }, + "Participants":{ + "type":"structure", + "members":{ + "Users":{ + "shape":"UserMetadataList", + "documentation":"The list of users.
" + }, + "Groups":{ + "shape":"GroupMetadataList", + "documentation":"The list of user groups.
" + } + }, + "documentation":"Describes the users or user groups.
" + }, + "PasswordType":{ + "type":"string", + "max":32, + "min":4, + "pattern":"[\\u0020-\\u00FF]+", + "sensitive":true + }, + "PermissionInfo":{ + "type":"structure", + "members":{ + "Role":{ + "shape":"RoleType", + "documentation":"The role of the user.
" + }, + "Type":{ + "shape":"RolePermissionType", + "documentation":"The type of permissions.
" + } + }, + "documentation":"Describes the permissions.
" + }, + "PermissionInfoList":{ + "type":"list", + "member":{"shape":"PermissionInfo"} + }, + "PositiveIntegerType":{ + "type":"integer", + "min":1 + }, + "PositiveSizeType":{ + "type":"long", + "min":0 + }, + "Principal":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"IdType", + "documentation":"The ID of the resource.
" + }, + "Type":{ + "shape":"PrincipalType", + "documentation":"The type of resource.
" + }, + "Roles":{ + "shape":"PermissionInfoList", + "documentation":"The permission information for the resource.
" + } + }, + "documentation":"Describes a resource.
" + }, + "PrincipalList":{ + "type":"list", + "member":{"shape":"Principal"} + }, + "PrincipalRoleType":{ + "type":"string", + "enum":[ + "VIEWER", + "CONTRIBUTOR", + "OWNER", + "COOWNER" + ] + }, + "PrincipalType":{ + "type":"string", + "enum":[ + "USER", + "GROUP", + "INVITE", + "ANONYMOUS", + "ORGANIZATION" + ] + }, + "ProhibitedStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The specified document version is not in the INITIALIZED state.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "RemoveAllResourcePermissionsRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the resource.
", + "location":"uri", + "locationName":"ResourceId" + } + } + }, + "RemoveResourcePermissionRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "PrincipalId" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the resource.
", + "location":"uri", + "locationName":"ResourceId" + }, + "PrincipalId":{ + "shape":"IdType", + "documentation":"The principal ID of the resource.
", + "location":"uri", + "locationName":"PrincipalId" + }, + "PrincipalType":{ + "shape":"PrincipalType", + "documentation":"The principal type of the resource.
", + "location":"querystring", + "locationName":"type" + } + } + }, + "RequestedEntityTooLargeException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The response is too large to return. The request must include a filter to reduce the size of the response.
", + "error":{"httpStatusCode":413}, + "exception":true + }, + "ResourceAlreadyCheckedOutException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The resource is already checked out.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceCollectionType":{ + "type":"string", + "enum":["SHARED_WITH_ME"] + }, + "ResourceIdType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+-.@]+" + }, + "ResourceMetadata":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"ResourceType", + "documentation":"The type of resource.
" + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"The name of the resource.
" + }, + "OriginalName":{ + "shape":"ResourceNameType", + "documentation":"The original name of the resource before a rename operation.
" + }, + "Id":{ + "shape":"ResourceIdType", + "documentation":"The ID of the resource.
" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"The version ID of the resource. This is an optional field and is filled for action on document version.
" + }, + "Owner":{ + "shape":"UserMetadata", + "documentation":"The owner of the resource.
" + }, + "ParentId":{ + "shape":"ResourceIdType", + "documentation":"The parent ID of the resource before a rename operation.
" + } + }, + "documentation":"Describes the metadata of a resource.
" + }, + "ResourceNameType":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\u0020-\\u202D\\u202F-\\uFFFF]+", + "sensitive":true + }, + "ResourcePath":{ + "type":"structure", + "members":{ + "Components":{ + "shape":"ResourcePathComponentList", + "documentation":"The components of the resource path.
" + } + }, + "documentation":"Describes the path information of a resource.
" + }, + "ResourcePathComponent":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"IdType", + "documentation":"The ID of the resource path.
" + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"The name of the resource path.
" + } + }, + "documentation":"Describes the resource path.
" + }, + "ResourcePathComponentList":{ + "type":"list", + "member":{"shape":"ResourcePathComponent"} + }, + "ResourceSortType":{ + "type":"string", + "enum":[ + "DATE", + "NAME" + ] + }, + "ResourceStateType":{ + "type":"string", + "enum":[ + "ACTIVE", + "RESTORING", + "RECYCLING", + "RECYCLED" + ] + }, + "ResourceType":{ + "type":"string", + "enum":[ + "FOLDER", + "DOCUMENT" + ] + }, + "ResponseItem":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"ResponseItemType", + "documentation":"The type of item being returned.
" + }, + "WebUrl":{ + "shape":"ResponseItemWebUrl", + "documentation":"The webUrl of the item being returned.
" + }, + "DocumentMetadata":{ + "shape":"DocumentMetadata", + "documentation":"The document that matches the query.
" + }, + "FolderMetadata":{ + "shape":"FolderMetadata", + "documentation":"The folder that matches the query.
" + }, + "CommentMetadata":{ + "shape":"CommentMetadata", + "documentation":"The comment that matches the query.
" + }, + "DocumentVersionMetadata":{ + "shape":"DocumentVersionMetadata", + "documentation":"The document version that matches the metadata.
" + } + }, + "documentation":"List of Documents, Folders, Comments, and Document Versions matching the query.
" + }, + "ResponseItemType":{ + "type":"string", + "enum":[ + "DOCUMENT", + "FOLDER", + "COMMENT", + "DOCUMENT_VERSION" + ] + }, + "ResponseItemWebUrl":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[\\u0020-\\uFFFF]+", + "sensitive":true + }, + "ResponseItemsList":{ + "type":"list", + "member":{"shape":"ResponseItem"}, + "max":100 + }, + "RestoreDocumentVersionsRequest":{ + "type":"structure", + "required":["DocumentId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the document.
", + "location":"uri", + "locationName":"DocumentId" + } + } + }, + "RolePermissionType":{ + "type":"string", + "enum":[ + "DIRECT", + "INHERITED" + ] + }, + "RoleType":{ + "type":"string", + "enum":[ + "VIEWER", + "CONTRIBUTOR", + "OWNER", + "COOWNER" + ] + }, + "SearchAncestorId":{ + "type":"string", + "max":128, + "min":1 + }, + "SearchAncestorIdList":{ + "type":"list", + "member":{"shape":"SearchAncestorId"}, + "max":10 + }, + "SearchCollectionType":{ + "type":"string", + "enum":[ + "OWNED", + "SHARED_WITH_ME" + ] + }, + "SearchCollectionTypeList":{ + "type":"list", + "member":{"shape":"SearchCollectionType"}, + "max":2 + }, + "SearchContentCategoryTypeList":{ + "type":"list", + "member":{"shape":"ContentCategoryType"}, + "max":9 + }, + "SearchLabel":{ + "type":"string", + "max":128, + "min":1 + }, + "SearchLabelList":{ + "type":"list", + "member":{"shape":"SearchLabel"}, + "max":10 + }, + "SearchMarkerType":{ + "type":"string", + "max":12288, + "min":1, + "pattern":"[\\u0000-\\u00FF]+" + }, + "SearchPrincipalRoleList":{ + "type":"list", + "member":{"shape":"PrincipalRoleType"}, + "max":4 + }, + "SearchPrincipalType":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"IdType", + "documentation":"UserIds or GroupIds.
" + }, + "Roles":{ + "shape":"SearchPrincipalRoleList", + "documentation":"The Role of a User or Group.
" + } + }, + "documentation":"Filter based on UserIds or GroupIds.
" + }, + "SearchPrincipalTypeList":{ + "type":"list", + "member":{"shape":"SearchPrincipalType"}, + "max":10 + }, + "SearchQueryScopeType":{ + "type":"string", + "enum":[ + "NAME", + "CONTENT" + ] + }, + "SearchQueryScopeTypeList":{ + "type":"list", + "member":{"shape":"SearchQueryScopeType"}, + "max":2 + }, + "SearchQueryType":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[\\u0020-\\uFFFF]+", + "sensitive":true + }, + "SearchResourceType":{ + "type":"string", + "enum":[ + "FOLDER", + "DOCUMENT", + "COMMENT", + "DOCUMENT_VERSION" + ] + }, + "SearchResourceTypeList":{ + "type":"list", + "member":{"shape":"SearchResourceType"}, + "max":4 + }, + "SearchResourcesRequest":{ + "type":"structure", + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "QueryText":{ + "shape":"SearchQueryType", + "documentation":"The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.
" + }, + "QueryScopes":{ + "shape":"SearchQueryScopeTypeList", + "documentation":"Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content
" + }, + "OrganizationId":{ + "shape":"IdType", + "documentation":"Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.
" + }, + "AdditionalResponseFields":{ + "shape":"AdditionalResponseFieldsList", + "documentation":"A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.
" + }, + "Filters":{ + "shape":"Filters", + "documentation":"Filters results based on entity metadata.
" + }, + "OrderBy":{ + "shape":"SearchResultSortList", + "documentation":"Order by results in one or more categories.
" + }, + "Limit":{ + "shape":"SearchResultsLimitType", + "documentation":"Max results count per page.
" + }, + "Marker":{ + "shape":"NextMarkerType", + "documentation":"The marker for the next set of results.
" + } + } + }, + "SearchResourcesResponse":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"ResponseItemsList", + "documentation":"List of Documents, Folders, Comments, and Document Versions matching the query.
" + }, + "Marker":{ + "shape":"NextMarkerType", + "documentation":"The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
" + } + } + }, + "SearchResultSortList":{ + "type":"list", + "member":{"shape":"SearchSortResult"}, + "max":1 + }, + "SearchResultsLimitType":{ + "type":"integer", + "max":100, + "min":1 + }, + "SearchSortResult":{ + "type":"structure", + "members":{ + "Field":{ + "shape":"OrderByFieldType", + "documentation":"Sort search results based on this field name.
" + }, + "Order":{ + "shape":"SortOrder", + "documentation":"Sort direction.
" + } + }, + "documentation":"The result of the sort operation.
" + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"One or more of the dependencies is unavailable.
", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "SharePrincipal":{ + "type":"structure", + "required":[ + "Id", + "Type", + "Role" + ], + "members":{ + "Id":{ + "shape":"IdType", + "documentation":"The ID of the recipient.
" + }, + "Type":{ + "shape":"PrincipalType", + "documentation":"The type of the recipient.
" + }, + "Role":{ + "shape":"RoleType", + "documentation":"The role of the recipient.
" + } + }, + "documentation":"Describes the recipient type and ID, if available.
" + }, + "SharePrincipalList":{ + "type":"list", + "member":{"shape":"SharePrincipal"} + }, + "ShareResult":{ + "type":"structure", + "members":{ + "PrincipalId":{ + "shape":"IdType", + "documentation":"The ID of the principal.
" + }, + "InviteePrincipalId":{ + "shape":"IdType", + "documentation":"The ID of the invited user.
" + }, + "Role":{ + "shape":"RoleType", + "documentation":"The role.
" + }, + "Status":{ + "shape":"ShareStatusType", + "documentation":"The status.
" + }, + "ShareId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the resource that was shared.
" + }, + "StatusMessage":{ + "shape":"MessageType", + "documentation":"The status message.
" + } + }, + "documentation":"Describes the share results of a resource.
" + }, + "ShareResultsList":{ + "type":"list", + "member":{"shape":"ShareResult"} + }, + "ShareStatusType":{ + "type":"string", + "enum":[ + "SUCCESS", + "FAILURE" + ] + }, + "SharedLabel":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*" + }, + "SharedLabels":{ + "type":"list", + "member":{"shape":"SharedLabel"}, + "max":20 + }, + "SignedHeaderMap":{ + "type":"map", + "key":{"shape":"HeaderNameType"}, + "value":{"shape":"HeaderValueType"} + }, + "SizeType":{"type":"long"}, + "SortOrder":{ + "type":"string", + "enum":[ + "ASC", + "DESC" + ] + }, + "StorageLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The storage limit has been exceeded.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "StorageLimitWillExceedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The storage limit will be exceeded.
", + "error":{"httpStatusCode":413}, + "exception":true + }, + "StorageRuleType":{ + "type":"structure", + "members":{ + "StorageAllocatedInBytes":{ + "shape":"PositiveSizeType", + "documentation":"The amount of storage allocated, in bytes.
" + }, + "StorageType":{ + "shape":"StorageType", + "documentation":"The type of storage.
" + } + }, + "documentation":"Describes the storage for a user.
" + }, + "StorageType":{ + "type":"string", + "enum":[ + "UNLIMITED", + "QUOTA" + ] + }, + "Subscription":{ + "type":"structure", + "members":{ + "SubscriptionId":{ + "shape":"IdType", + "documentation":"The ID of the subscription.
" + }, + "EndPoint":{ + "shape":"SubscriptionEndPointType", + "documentation":"The endpoint of the subscription.
" + }, + "Protocol":{ + "shape":"SubscriptionProtocolType", + "documentation":"The protocol of the subscription.
" + } + }, + "documentation":"Describes a subscription.
" + }, + "SubscriptionEndPointType":{ + "type":"string", + "max":256, + "min":1 + }, + "SubscriptionList":{ + "type":"list", + "member":{"shape":"Subscription"}, + "max":256 + }, + "SubscriptionProtocolType":{ + "type":"string", + "enum":[ + "HTTPS", + "SQS" + ] + }, + "SubscriptionType":{ + "type":"string", + "enum":["ALL"] + }, + "TextLocaleTypeList":{ + "type":"list", + "member":{"shape":"LanguageCodeType"}, + "max":1 + }, + "TimeZoneIdType":{ + "type":"string", + "max":256, + "min":1 + }, + "TimestampType":{"type":"timestamp"}, + "TooManyLabelsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The limit has been reached on the number of labels for the specified resource.
", + "error":{"httpStatusCode":429}, + "exception":true + }, + "TooManySubscriptionsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"You've reached the limit on the number of subscriptions for the WorkDocs instance.
", + "error":{"httpStatusCode":429}, + "exception":true + }, + "UnauthorizedOperationException":{ + "type":"structure", + "members":{ + }, + "documentation":"The operation is not permitted.
", + "error":{"httpStatusCode":403}, + "exception":true + }, + "UnauthorizedResourceAccessException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"The caller does not have access to perform the action on the resource.
", + "error":{"httpStatusCode":404}, + "exception":true + }, + "UpdateDocumentRequest":{ + "type":"structure", + "required":["DocumentId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the document.
", + "location":"uri", + "locationName":"DocumentId" + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"The name of the document.
" + }, + "ParentFolderId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the parent folder.
" + }, + "ResourceState":{ + "shape":"ResourceStateType", + "documentation":"The resource state of the document. Only ACTIVE and RECYCLED are supported.
" + } + } + }, + "UpdateDocumentVersionRequest":{ + "type":"structure", + "required":[ + "DocumentId", + "VersionId" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the document.
", + "location":"uri", + "locationName":"DocumentId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"The version ID of the document.
", + "location":"uri", + "locationName":"VersionId" + }, + "VersionStatus":{ + "shape":"DocumentVersionStatus", + "documentation":"The status of the version.
" + } + } + }, + "UpdateFolderRequest":{ + "type":"structure", + "required":["FolderId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "FolderId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the folder.
", + "location":"uri", + "locationName":"FolderId" + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"The name of the folder.
" + }, + "ParentFolderId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the parent folder.
" + }, + "ResourceState":{ + "shape":"ResourceStateType", + "documentation":"The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.
" + } + } + }, + "UpdateUserRequest":{ + "type":"structure", + "required":["UserId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
", + "location":"header", + "locationName":"Authentication" + }, + "UserId":{ + "shape":"IdType", + "documentation":"The ID of the user.
", + "location":"uri", + "locationName":"UserId" + }, + "GivenName":{ + "shape":"UserAttributeValueType", + "documentation":"The given name of the user.
" + }, + "Surname":{ + "shape":"UserAttributeValueType", + "documentation":"The surname of the user.
" + }, + "Type":{ + "shape":"UserType", + "documentation":"The type of the user.
" + }, + "StorageRule":{ + "shape":"StorageRuleType", + "documentation":"The amount of storage for the user.
" + }, + "TimeZoneId":{ + "shape":"TimeZoneIdType", + "documentation":"The time zone ID of the user.
" + }, + "Locale":{ + "shape":"LocaleType", + "documentation":"The locale of the user.
" + }, + "GrantPoweruserPrivileges":{ + "shape":"BooleanEnumType", + "documentation":"Boolean value to determine whether the user is granted Power user privileges.
" + } + } + }, + "UpdateUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"The user information.
" + } + } + }, + "UploadMetadata":{ + "type":"structure", + "members":{ + "UploadUrl":{ + "shape":"UrlType", + "documentation":"The URL of the upload.
" + }, + "SignedHeaders":{ + "shape":"SignedHeaderMap", + "documentation":"The signed headers.
" + } + }, + "documentation":"Describes the upload.
" + }, + "UrlType":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "User":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"IdType", + "documentation":"The ID of the user.
" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"The login name of the user.
" + }, + "EmailAddress":{ + "shape":"EmailAddressType", + "documentation":"The email address of the user.
" + }, + "GivenName":{ + "shape":"UserAttributeValueType", + "documentation":"The given name of the user.
" + }, + "Surname":{ + "shape":"UserAttributeValueType", + "documentation":"The surname of the user.
" + }, + "OrganizationId":{ + "shape":"IdType", + "documentation":"The ID of the organization.
" + }, + "RootFolderId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the root folder.
" + }, + "RecycleBinFolderId":{ + "shape":"ResourceIdType", + "documentation":"The ID of the recycle bin folder.
" + }, + "Status":{ + "shape":"UserStatusType", + "documentation":"The status of the user.
" + }, + "Type":{ + "shape":"UserType", + "documentation":"The type of user.
" + }, + "CreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"The time when the user was created.
" + }, + "ModifiedTimestamp":{ + "shape":"TimestampType", + "documentation":"The time when the user was modified.
" + }, + "TimeZoneId":{ + "shape":"TimeZoneIdType", + "documentation":"The time zone ID of the user.
" + }, + "Locale":{ + "shape":"LocaleType", + "documentation":"The locale of the user.
" + }, + "Storage":{ + "shape":"UserStorageMetadata", + "documentation":"The storage for the user.
" + } + }, + "documentation":"Describes a user.
" + }, + "UserActivities":{ + "type":"list", + "member":{"shape":"Activity"} + }, + "UserAttributeValueType":{ + "type":"string", + "max":64, + "min":1, + "sensitive":true + }, + "UserFilterType":{ + "type":"string", + "enum":[ + "ALL", + "ACTIVE_PENDING" + ] + }, + "UserIdsType":{ + "type":"string", + "max":2000, + "min":1, + "pattern":"[&\\w+-.@, ]+" + }, + "UserMetadata":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"IdType", + "documentation":"The ID of the user.
" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"The name of the user.
" + }, + "GivenName":{ + "shape":"UserAttributeValueType", + "documentation":"The given name of the user before a rename operation.
" + }, + "Surname":{ + "shape":"UserAttributeValueType", + "documentation":"The surname of the user.
" + }, + "EmailAddress":{ + "shape":"EmailAddressType", + "documentation":"The email address of the user.
" + } + }, + "documentation":"Describes the metadata of the user.
" + }, + "UserMetadataList":{ + "type":"list", + "member":{"shape":"UserMetadata"} + }, + "UserSortType":{ + "type":"string", + "enum":[ + "USER_NAME", + "FULL_NAME", + "STORAGE_LIMIT", + "USER_STATUS", + "STORAGE_USED" + ] + }, + "UserStatusType":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE", + "PENDING" + ] + }, + "UserStorageMetadata":{ + "type":"structure", + "members":{ + "StorageUtilizedInBytes":{ + "shape":"SizeType", + "documentation":"The amount of storage used, in bytes.
" + }, + "StorageRule":{ + "shape":"StorageRuleType", + "documentation":"The storage for a user.
" + } + }, + "documentation":"Describes the storage for a user.
" + }, + "UserType":{ + "type":"string", + "enum":[ + "USER", + "ADMIN", + "POWERUSER", + "MINIMALUSER", + "WORKSPACESUSER" + ] + }, + "UsernameType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\w\\-+.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z]+)?", + "sensitive":true + } + }, + "documentation":"The Amazon WorkDocs API is designed for the following use cases:
File Migration: File migration applications are supported for users who want to migrate their files from an on-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.
Security: Support security applications are supported for users who have additional security needs, such as antivirus or data loss prevention. The API actions, along with CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user.
eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with CloudTrail, to replicate data for eDiscovery, backup, or analytical applications.
All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissions and upload any file to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model.
The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:
READ (Get*)
WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)
LIST (Describe*)
DELETE*, CANCEL
For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing.
Adds a member (user or group) to the resource's set of delegates.
", + "idempotent":true + }, + "AssociateMemberToGroup":{ + "name":"AssociateMemberToGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateMemberToGroupRequest"}, + "output":{"shape":"AssociateMemberToGroupResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"Adds a member (user or group) to the group's set.
", + "idempotent":true + }, + "AssumeImpersonationRole":{ + "name":"AssumeImpersonationRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssumeImpersonationRoleRequest"}, + "output":{"shape":"AssumeImpersonationRoleResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.
" + }, + "CancelMailboxExportJob":{ + "name":"CancelMailboxExportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelMailboxExportJobRequest"}, + "output":{"shape":"CancelMailboxExportJobResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"EntityNotFoundException"} + ], + "documentation":"Cancels a mailbox export job.
If the mailbox export job is near completion, it might not be possible to cancel it.
Adds an alias to the set of a given member (user or group) of WorkMail.
", + "idempotent":true + }, + "CreateAvailabilityConfiguration":{ + "name":"CreateAvailabilityConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAvailabilityConfigurationRequest"}, + "output":{"shape":"CreateAvailabilityConfigurationResponse"}, + "errors":[ + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"NameAvailabilityException"}, + {"shape":"InvalidParameterException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"Creates an AvailabilityConfiguration for the given WorkMail organization and domain.
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
", + "idempotent":true + }, + "CreateImpersonationRole":{ + "name":"CreateImpersonationRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateImpersonationRoleRequest"}, + "output":{"shape":"CreateImpersonationRoleResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"Creates an impersonation role for the given WorkMail organization.
Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.
" + }, + "CreateMobileDeviceAccessRule":{ + "name":"CreateMobileDeviceAccessRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateMobileDeviceAccessRuleRequest"}, + "output":{"shape":"CreateMobileDeviceAccessRuleResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"LimitExceededException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Creates a new mobile device access rule for the specified WorkMail organization.
" + }, + "CreateOrganization":{ + "name":"CreateOrganization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateOrganizationRequest"}, + "output":{"shape":"CreateOrganizationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"DirectoryInUseException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"LimitExceededException"}, + {"shape":"NameAvailabilityException"} + ], + "documentation":"Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide.
You can associate multiple email domains with an organization, then choose your default email domain from the WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the WorkMail Administrator Guide.
Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.
", + "idempotent":true + }, + "CreateResource":{ + "name":"CreateResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateResourceRequest"}, + "output":{"shape":"CreateResourceResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NameAvailabilityException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"ReservedNameException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"Creates a new WorkMail resource.
", + "idempotent":true + }, + "CreateUser":{ + "name":"CreateUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserRequest"}, + "output":{"shape":"CreateUserResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidPasswordException"}, + {"shape":"NameAvailabilityException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"ReservedNameException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
", + "idempotent":true + }, + "DeleteAccessControlRule":{ + "name":"DeleteAccessControlRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAccessControlRuleRequest"}, + "output":{"shape":"DeleteAccessControlRuleResponse"}, + "errors":[ + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Deletes an access control rule for the specified WorkMail organization.
Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
Remove one or more specified aliases from a set of aliases for a given user.
", + "idempotent":true + }, + "DeleteAvailabilityConfiguration":{ + "name":"DeleteAvailabilityConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAvailabilityConfigurationRequest"}, + "output":{"shape":"DeleteAvailabilityConfigurationResponse"}, + "errors":[ + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.
Deletes the email monitoring configuration for a specified organization.
", + "idempotent":true + }, + "DeleteGroup":{ + "name":"DeleteGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGroupRequest"}, + "output":{"shape":"DeleteGroupResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"Deletes a group from WorkMail.
", + "idempotent":true + }, + "DeleteImpersonationRole":{ + "name":"DeleteImpersonationRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteImpersonationRoleRequest"}, + "output":{"shape":"DeleteImpersonationRoleResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Deletes an impersonation role for the given WorkMail organization.
" + }, + "DeleteMailboxPermissions":{ + "name":"DeleteMailboxPermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMailboxPermissionsRequest"}, + "output":{"shape":"DeleteMailboxPermissionsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Deletes permissions granted to a member (user or group).
", + "idempotent":true + }, + "DeleteMobileDeviceAccessOverride":{ + "name":"DeleteMobileDeviceAccessOverride", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMobileDeviceAccessOverrideRequest"}, + "output":{"shape":"DeleteMobileDeviceAccessOverrideResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"EntityNotFoundException"} + ], + "documentation":"Deletes the mobile device access override for the given WorkMail organization, user, and device.
Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
Deletes a mobile device access rule for the specified WorkMail organization.
Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.
", + "idempotent":true + }, + "DeleteResource":{ + "name":"DeleteResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResourceRequest"}, + "output":{"shape":"DeleteResourceResponse"}, + "errors":[ + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"Deletes the specified resource.
", + "idempotent":true + }, + "DeleteRetentionPolicy":{ + "name":"DeleteRetentionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRetentionPolicyRequest"}, + "output":{"shape":"DeleteRetentionPolicyResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Deletes the specified retention policy from the specified organization.
", + "idempotent":true + }, + "DeleteUser":{ + "name":"DeleteUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserRequest"}, + "output":{"shape":"DeleteUserResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state.
Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.
", + "idempotent":true + }, + "DeregisterFromWorkMail":{ + "name":"DeregisterFromWorkMail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterFromWorkMailRequest"}, + "output":{"shape":"DeregisterFromWorkMailResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
", + "idempotent":true + }, + "DeregisterMailDomain":{ + "name":"DeregisterMailDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterMailDomainRequest"}, + "output":{"shape":"DeregisterMailDomainResponse"}, + "errors":[ + {"shape":"MailDomainInUseException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidCustomSesConfigurationException"} + ], + "documentation":"Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.
", + "idempotent":true + }, + "DescribeEmailMonitoringConfiguration":{ + "name":"DescribeEmailMonitoringConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEmailMonitoringConfigurationRequest"}, + "output":{"shape":"DescribeEmailMonitoringConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Describes the current email monitoring configuration for a specified organization.
", + "idempotent":true + }, + "DescribeEntity":{ + "name":"DescribeEntity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEntityRequest"}, + "output":{"shape":"DescribeEntityResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Returns basic details about an entity in WorkMail.
", + "idempotent":true + }, + "DescribeGroup":{ + "name":"DescribeGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeGroupRequest"}, + "output":{"shape":"DescribeGroupResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Returns the data available for the group.
", + "idempotent":true + }, + "DescribeInboundDmarcSettings":{ + "name":"DescribeInboundDmarcSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInboundDmarcSettingsRequest"}, + "output":{"shape":"DescribeInboundDmarcSettingsResponse"}, + "errors":[ + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Lists the settings in a DMARC policy for a specified organization.
", + "idempotent":true + }, + "DescribeMailboxExportJob":{ + "name":"DescribeMailboxExportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMailboxExportJobRequest"}, + "output":{"shape":"DescribeMailboxExportJobResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"EntityNotFoundException"} + ], + "documentation":"Describes the current status of a mailbox export job.
", + "idempotent":true + }, + "DescribeOrganization":{ + "name":"DescribeOrganization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOrganizationRequest"}, + "output":{"shape":"DescribeOrganizationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"} + ], + "documentation":"Provides more information regarding a given organization based on its identifier.
", + "idempotent":true + }, + "DescribeResource":{ + "name":"DescribeResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeResourceRequest"}, + "output":{"shape":"DescribeResourceResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"Returns the data available for the resource.
", + "idempotent":true + }, + "DescribeUser":{ + "name":"DescribeUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUserRequest"}, + "output":{"shape":"DescribeUserResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Provides information regarding the user.
", + "idempotent":true + }, + "DisassociateDelegateFromResource":{ + "name":"DisassociateDelegateFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateDelegateFromResourceRequest"}, + "output":{"shape":"DisassociateDelegateFromResourceResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"Removes a member from the resource's set of delegates.
", + "idempotent":true + }, + "DisassociateMemberFromGroup":{ + "name":"DisassociateMemberFromGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateMemberFromGroupRequest"}, + "output":{"shape":"DisassociateMemberFromGroupResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"Removes a member from a group.
", + "idempotent":true + }, + "GetAccessControlEffect":{ + "name":"GetAccessControlEffect", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAccessControlEffectRequest"}, + "output":{"shape":"GetAccessControlEffectResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.
" + }, + "GetDefaultRetentionPolicy":{ + "name":"GetDefaultRetentionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDefaultRetentionPolicyRequest"}, + "output":{"shape":"GetDefaultRetentionPolicyResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"EntityNotFoundException"} + ], + "documentation":"Gets the default retention policy details for the specified organization.
", + "idempotent":true + }, + "GetImpersonationRole":{ + "name":"GetImpersonationRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetImpersonationRoleRequest"}, + "output":{"shape":"GetImpersonationRoleResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Gets the impersonation role details for the given WorkMail organization.
" + }, + "GetImpersonationRoleEffect":{ + "name":"GetImpersonationRoleEffect", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetImpersonationRoleEffectRequest"}, + "output":{"shape":"GetImpersonationRoleEffectResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"} + ], + "documentation":"Tests whether the given impersonation role can impersonate a target user.
" + }, + "GetMailDomain":{ + "name":"GetMailDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMailDomainRequest"}, + "output":{"shape":"GetMailDomainResponse"}, + "errors":[ + {"shape":"MailDomainNotFoundException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"Gets details for a mail domain, including domain records required to configure your domain with recommended security.
", + "idempotent":true + }, + "GetMailboxDetails":{ + "name":"GetMailboxDetails", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMailboxDetailsRequest"}, + "output":{"shape":"GetMailboxDetailsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"EntityNotFoundException"} + ], + "documentation":"Requests a user's mailbox details for a specified organization and user.
", + "idempotent":true + }, + "GetMobileDeviceAccessEffect":{ + "name":"GetMobileDeviceAccessEffect", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMobileDeviceAccessEffectRequest"}, + "output":{"shape":"GetMobileDeviceAccessEffectResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user's attributes.
" + }, + "GetMobileDeviceAccessOverride":{ + "name":"GetMobileDeviceAccessOverride", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMobileDeviceAccessOverrideRequest"}, + "output":{"shape":"GetMobileDeviceAccessOverrideResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Gets the mobile device access override for the given WorkMail organization, user, and device.
" + }, + "ListAccessControlRules":{ + "name":"ListAccessControlRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAccessControlRulesRequest"}, + "output":{"shape":"ListAccessControlRulesResponse"}, + "errors":[ + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Lists the access control rules for the specified organization.
" + }, + "ListAliases":{ + "name":"ListAliases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAliasesRequest"}, + "output":{"shape":"ListAliasesResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Creates a paginated call to list the aliases associated with a given entity.
", + "idempotent":true + }, + "ListAvailabilityConfigurations":{ + "name":"ListAvailabilityConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAvailabilityConfigurationsRequest"}, + "output":{"shape":"ListAvailabilityConfigurationsResponse"}, + "errors":[ + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"List all the AvailabilityConfiguration's for the given WorkMail organization.
Returns an overview of the members of a group. Users and groups can be members of a group.
", + "idempotent":true + }, + "ListGroups":{ + "name":"ListGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGroupsRequest"}, + "output":{"shape":"ListGroupsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Returns summaries of the organization's groups.
", + "idempotent":true + }, + "ListGroupsForEntity":{ + "name":"ListGroupsForEntity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGroupsForEntityRequest"}, + "output":{"shape":"ListGroupsForEntityResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"Returns all the groups to which an entity belongs.
", + "idempotent":true + }, + "ListImpersonationRoles":{ + "name":"ListImpersonationRoles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListImpersonationRolesRequest"}, + "output":{"shape":"ListImpersonationRolesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Lists all the impersonation roles for the given WorkMail organization.
" + }, + "ListMailDomains":{ + "name":"ListMailDomains", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMailDomainsRequest"}, + "output":{"shape":"ListMailDomainsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Lists the mail domains in a given WorkMail organization.
", + "idempotent":true + }, + "ListMailboxExportJobs":{ + "name":"ListMailboxExportJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMailboxExportJobsRequest"}, + "output":{"shape":"ListMailboxExportJobsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Lists the mailbox export jobs started for the specified organization within the last seven days.
", + "idempotent":true + }, + "ListMailboxPermissions":{ + "name":"ListMailboxPermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMailboxPermissionsRequest"}, + "output":{"shape":"ListMailboxPermissionsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Lists the mailbox permissions associated with a user, group, or resource mailbox.
", + "idempotent":true + }, + "ListMobileDeviceAccessOverrides":{ + "name":"ListMobileDeviceAccessOverrides", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMobileDeviceAccessOverridesRequest"}, + "output":{"shape":"ListMobileDeviceAccessOverridesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"EntityNotFoundException"} + ], + "documentation":"Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
" + }, + "ListMobileDeviceAccessRules":{ + "name":"ListMobileDeviceAccessRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMobileDeviceAccessRulesRequest"}, + "output":{"shape":"ListMobileDeviceAccessRulesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Lists the mobile device access rules for the specified WorkMail organization.
" + }, + "ListOrganizations":{ + "name":"ListOrganizations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOrganizationsRequest"}, + "output":{"shape":"ListOrganizationsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"} + ], + "documentation":"Returns summaries of the customer's organizations.
", + "idempotent":true + }, + "ListResourceDelegates":{ + "name":"ListResourceDelegates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourceDelegatesRequest"}, + "output":{"shape":"ListResourceDelegatesResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
", + "idempotent":true + }, + "ListResources":{ + "name":"ListResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourcesRequest"}, + "output":{"shape":"ListResourcesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"Returns summaries of the organization's resources.
", + "idempotent":true + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Lists the tags applied to an WorkMail organization resource.
" + }, + "ListUsers":{ + "name":"ListUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUsersRequest"}, + "output":{"shape":"ListUsersResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Returns summaries of the organization's users.
", + "idempotent":true + }, + "PutAccessControlRule":{ + "name":"PutAccessControlRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutAccessControlRuleRequest"}, + "output":{"shape":"PutAccessControlRuleResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InvalidParameterException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
" + }, + "PutEmailMonitoringConfiguration":{ + "name":"PutEmailMonitoringConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutEmailMonitoringConfigurationRequest"}, + "output":{"shape":"PutEmailMonitoringConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Creates or updates the email monitoring configuration for a specified organization.
", + "idempotent":true + }, + "PutInboundDmarcSettings":{ + "name":"PutInboundDmarcSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutInboundDmarcSettingsRequest"}, + "output":{"shape":"PutInboundDmarcSettingsResponse"}, + "errors":[ + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Enables or disables a DMARC policy for a given organization.
", + "idempotent":true + }, + "PutMailboxPermissions":{ + "name":"PutMailboxPermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutMailboxPermissionsRequest"}, + "output":{"shape":"PutMailboxPermissionsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
", + "idempotent":true + }, + "PutMobileDeviceAccessOverride":{ + "name":"PutMobileDeviceAccessOverride", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutMobileDeviceAccessOverrideRequest"}, + "output":{"shape":"PutMobileDeviceAccessOverrideResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"} + ], + "documentation":"Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
" + }, + "PutRetentionPolicy":{ + "name":"PutRetentionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRetentionPolicyRequest"}, + "output":{"shape":"PutRetentionPolicyResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"Puts a retention policy to the specified organization.
", + "idempotent":true + }, + "RegisterMailDomain":{ + "name":"RegisterMailDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterMailDomainRequest"}, + "output":{"shape":"RegisterMailDomainResponse"}, + "errors":[ + {"shape":"MailDomainInUseException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails.
", + "idempotent":true + }, + "RegisterToWorkMail":{ + "name":"RegisterToWorkMail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterToWorkMailRequest"}, + "output":{"shape":"RegisterToWorkMailResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EmailAddressInUseException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"EntityAlreadyRegisteredException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MailDomainNotFoundException"}, + {"shape":"MailDomainStateException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.
Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
", + "idempotent":true + }, + "ResetPassword":{ + "name":"ResetPassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetPasswordRequest"}, + "output":{"shape":"ResetPasswordResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidPasswordException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"Allows the administrator to reset the password for a user.
", + "idempotent":true + }, + "StartMailboxExportJob":{ + "name":"StartMailboxExportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartMailboxExportJobRequest"}, + "output":{"shape":"StartMailboxExportJobResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.
", + "idempotent":true + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyTagsException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Applies the specified tags to the specified WorkMailorganization resource.
" + }, + "TestAvailabilityConfiguration":{ + "name":"TestAvailabilityConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TestAvailabilityConfigurationRequest"}, + "output":{"shape":"TestAvailabilityConfigurationResponse"}, + "errors":[ + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a SourceArn or SourceAccount header.
The request must contain either one provider definition (EwsProvider or LambdaProvider) or the DomainName parameter. If the DomainName parameter is provided, the configuration stored under the DomainName will be tested.
Untags the specified tags from the specified WorkMail organization resource.
" + }, + "UpdateAvailabilityConfiguration":{ + "name":"UpdateAvailabilityConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAvailabilityConfigurationRequest"}, + "output":{"shape":"UpdateAvailabilityConfigurationResponse"}, + "errors":[ + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.
Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.
", + "idempotent":true + }, + "UpdateGroup":{ + "name":"UpdateGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGroupRequest"}, + "output":{"shape":"UpdateGroupResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"Updates attibutes in a group.
", + "idempotent":true + }, + "UpdateImpersonationRole":{ + "name":"UpdateImpersonationRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateImpersonationRoleRequest"}, + "output":{"shape":"UpdateImpersonationRoleResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"Updates an impersonation role for the given WorkMail organization.
" + }, + "UpdateMailboxQuota":{ + "name":"UpdateMailboxQuota", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMailboxQuotaRequest"}, + "output":{"shape":"UpdateMailboxQuotaResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"} + ], + "documentation":"Updates a user's current mailbox quota for a specified organization and user.
", + "idempotent":true + }, + "UpdateMobileDeviceAccessRule":{ + "name":"UpdateMobileDeviceAccessRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMobileDeviceAccessRuleRequest"}, + "output":{"shape":"UpdateMobileDeviceAccessRuleResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Updates a mobile device access rule for the specified WorkMail organization.
" + }, + "UpdatePrimaryEmailAddress":{ + "name":"UpdatePrimaryEmailAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdatePrimaryEmailAddressRequest"}, + "output":{"shape":"UpdatePrimaryEmailAddressResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EmailAddressInUseException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MailDomainNotFoundException"}, + {"shape":"MailDomainStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.
", + "idempotent":true + }, + "UpdateResource":{ + "name":"UpdateResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateResourceRequest"}, + "output":{"shape":"UpdateResourceResponse"}, + "errors":[ + {"shape":"DirectoryUnavailableException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidConfigurationException"}, + {"shape":"EmailAddressInUseException"}, + {"shape":"MailDomainNotFoundException"}, + {"shape":"MailDomainStateException"}, + {"shape":"NameAvailabilityException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.
Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The dataset in the request should be the one expected when performing another DescribeUser call.
The rule name.
" + }, + "Effect":{ + "shape":"AccessControlRuleEffect", + "documentation":"The rule effect.
" + }, + "Description":{ + "shape":"AccessControlRuleDescription", + "documentation":"The rule description.
" + }, + "IpRanges":{ + "shape":"IpRangeList", + "documentation":"IPv4 CIDR ranges to include in the rule.
" + }, + "NotIpRanges":{ + "shape":"IpRangeList", + "documentation":"IPv4 CIDR ranges to exclude from the rule.
" + }, + "Actions":{ + "shape":"ActionsList", + "documentation":"Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
User IDs to include in the rule.
" + }, + "NotUserIds":{ + "shape":"UserIdList", + "documentation":"User IDs to exclude from the rule.
" + }, + "DateCreated":{ + "shape":"Timestamp", + "documentation":"The date that the rule was created.
" + }, + "DateModified":{ + "shape":"Timestamp", + "documentation":"The date that the rule was modified.
" + }, + "ImpersonationRoleIds":{ + "shape":"ImpersonationRoleIdList", + "documentation":"Impersonation role IDs to include in the rule.
" + }, + "NotImpersonationRoleIds":{ + "shape":"ImpersonationRoleIdList", + "documentation":"Impersonation role IDs to exclude from the rule.
" + } + }, + "documentation":"A rule that controls access to an WorkMail organization.
" + }, + "AccessControlRuleAction":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z]+" + }, + "AccessControlRuleDescription":{ + "type":"string", + "max":255, + "min":0, + "pattern":"[\\u0020-\\u00FF]+" + }, + "AccessControlRuleEffect":{ + "type":"string", + "enum":[ + "ALLOW", + "DENY" + ] + }, + "AccessControlRuleName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "AccessControlRuleNameList":{ + "type":"list", + "member":{"shape":"AccessControlRuleName"}, + "max":10, + "min":0 + }, + "AccessControlRulesList":{ + "type":"list", + "member":{"shape":"AccessControlRule"}, + "max":10, + "min":0 + }, + "AccessEffect":{ + "type":"string", + "enum":[ + "ALLOW", + "DENY" + ] + }, + "ActionsList":{ + "type":"list", + "member":{"shape":"AccessControlRuleAction"}, + "max":10, + "min":0 + }, + "Aliases":{ + "type":"list", + "member":{"shape":"EmailAddress"} + }, + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"arn:aws:workmail:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}" + }, + "AssociateDelegateToResourceRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "ResourceId", + "EntityId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The organization under which the resource exists.
" + }, + "ResourceId":{ + "shape":"EntityIdentifier", + "documentation":"The resource for which members (users or groups) are associated.
The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:
Resource ID: r-0123456789a0123456789b0123456789
Email address: resource@domain.tld
Resource name: resource
The member (user or group) to associate to the resource.
The entity ID can accept UserId or GroupID, Username or Groupname, or email.
Entity: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: entity@domain.tld
Entity: entity
The organization under which the group exists.
" + }, + "GroupId":{ + "shape":"EntityIdentifier", + "documentation":"The group to which the member (user or group) is associated.
The identifier can accept GroupId, Groupname, or email. The following identity formats are available:
Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: group@domain.tld
Group name: group
The member (user or group) to associate to the group.
The member ID can accept UserID or GroupId, Username or Groupname, or email.
Member: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: member@domain.tld
Member name: member
The WorkMail organization under which the impersonation role will be assumed.
" + }, + "ImpersonationRoleId":{ + "shape":"ImpersonationRoleId", + "documentation":"The impersonation role ID to assume.
" + } + } + }, + "AssumeImpersonationRoleResponse":{ + "type":"structure", + "members":{ + "Token":{ + "shape":"ImpersonationToken", + "documentation":"The authentication token for the impersonation role.
" + }, + "ExpiresIn":{ + "shape":"ExpiresIn", + "documentation":"The authentication token's validity, in seconds.
" + } + } + }, + "AvailabilityConfiguration":{ + "type":"structure", + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"Displays the domain to which the provider applies.
" + }, + "ProviderType":{ + "shape":"AvailabilityProviderType", + "documentation":"Displays the provider type that applies to this domain.
" + }, + "EwsProvider":{ + "shape":"RedactedEwsAvailabilityProvider", + "documentation":"If ProviderType is EWS, then this field contains RedactedEwsAvailabilityProvider. Otherwise, it is not required.
If ProviderType is LAMBDA then this field contains LambdaAvailabilityProvider. Otherwise, it is not required.
The date and time at which the availability configuration was created.
" + }, + "DateModified":{ + "shape":"Timestamp", + "documentation":"The date and time at which the availability configuration was last modified.
" + } + }, + "documentation":"List all the AvailabilityConfiguration's for the given WorkMail organization.
The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource.
" + }, + "AutoDeclineRecurringRequests":{ + "shape":"Boolean", + "documentation":"The resource's ability to automatically decline any recurring requests.
" + }, + "AutoDeclineConflictingRequests":{ + "shape":"Boolean", + "documentation":"The resource's ability to automatically decline any conflicting requests.
" + } + }, + "documentation":"At least one delegate must be associated to the resource to disable automatic replies from the resource.
" + }, + "Boolean":{"type":"boolean"}, + "BooleanObject":{"type":"boolean"}, + "CancelMailboxExportJobRequest":{ + "type":"structure", + "required":[ + "ClientToken", + "JobId", + "OrganizationId" + ], + "members":{ + "ClientToken":{ + "shape":"IdempotencyClientToken", + "documentation":"The idempotency token for the client request.
", + "idempotencyToken":true + }, + "JobId":{ + "shape":"MailboxExportJobId", + "documentation":"The job ID.
" + }, + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The organization ID.
" + } + } + }, + "CancelMailboxExportJobResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateAliasRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId", + "Alias" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The organization under which the member (user or group) exists.
" + }, + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"The member (user or group) to which this alias is added.
" + }, + "Alias":{ + "shape":"EmailAddress", + "documentation":"The alias to add to the member set.
" + } + } + }, + "CreateAliasResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateAvailabilityConfigurationRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "DomainName" + ], + "members":{ + "ClientToken":{ + "shape":"IdempotencyClientToken", + "documentation":"An idempotent token that ensures that an API request is executed only once.
", + "idempotencyToken":true + }, + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization for which the AvailabilityConfiguration will be created.
The domain to which the provider applies.
" + }, + "EwsProvider":{ + "shape":"EwsAvailabilityProvider", + "documentation":"Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.
Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.
The organization under which the group is to be created.
" + }, + "Name":{ + "shape":"GroupName", + "documentation":"The name of the group.
" + }, + "HiddenFromGlobalAddressList":{ + "shape":"Boolean", + "documentation":"If this parameter is enabled, the group will be hidden from the address book.
" + } + } + }, + "CreateGroupResponse":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"WorkMailIdentifier", + "documentation":"The identifier of the group.
" + } + } + }, + "CreateImpersonationRoleRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "Name", + "Type", + "Rules" + ], + "members":{ + "ClientToken":{ + "shape":"IdempotencyClientToken", + "documentation":"The idempotency token for the client request.
", + "idempotencyToken":true + }, + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization to create the new impersonation role within.
" + }, + "Name":{ + "shape":"ImpersonationRoleName", + "documentation":"The name of the new impersonation role.
" + }, + "Type":{ + "shape":"ImpersonationRoleType", + "documentation":"The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS.
The description of the new impersonation role.
" + }, + "Rules":{ + "shape":"ImpersonationRuleList", + "documentation":"The list of rules for the impersonation role.
" + } + } + }, + "CreateImpersonationRoleResponse":{ + "type":"structure", + "members":{ + "ImpersonationRoleId":{ + "shape":"ImpersonationRoleId", + "documentation":"The new impersonation role ID.
" + } + } + }, + "CreateMobileDeviceAccessRuleRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "Name", + "Effect" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization under which the rule will be created.
" + }, + "ClientToken":{ + "shape":"IdempotencyClientToken", + "documentation":"The idempotency token for the client request.
", + "idempotencyToken":true + }, + "Name":{ + "shape":"MobileDeviceAccessRuleName", + "documentation":"The rule name.
" + }, + "Description":{ + "shape":"MobileDeviceAccessRuleDescription", + "documentation":"The rule description.
" + }, + "Effect":{ + "shape":"MobileDeviceAccessRuleEffect", + "documentation":"The effect of the rule when it matches. Allowed values are ALLOW or DENY.
Device types that the rule will match.
" + }, + "NotDeviceTypes":{ + "shape":"DeviceTypeList", + "documentation":"Device types that the rule will not match. All other device types will match.
" + }, + "DeviceModels":{ + "shape":"DeviceModelList", + "documentation":"Device models that the rule will match.
" + }, + "NotDeviceModels":{ + "shape":"DeviceModelList", + "documentation":"Device models that the rule will not match. All other device models will match.
" + }, + "DeviceOperatingSystems":{ + "shape":"DeviceOperatingSystemList", + "documentation":"Device operating systems that the rule will match.
" + }, + "NotDeviceOperatingSystems":{ + "shape":"DeviceOperatingSystemList", + "documentation":"Device operating systems that the rule will not match. All other device operating systems will match.
" + }, + "DeviceUserAgents":{ + "shape":"DeviceUserAgentList", + "documentation":"Device user agents that the rule will match.
" + }, + "NotDeviceUserAgents":{ + "shape":"DeviceUserAgentList", + "documentation":"Device user agents that the rule will not match. All other device user agents will match.
" + } + } + }, + "CreateMobileDeviceAccessRuleResponse":{ + "type":"structure", + "members":{ + "MobileDeviceAccessRuleId":{ + "shape":"MobileDeviceAccessRuleId", + "documentation":"The identifier for the newly created mobile device access rule.
" + } + } + }, + "CreateOrganizationRequest":{ + "type":"structure", + "required":["Alias"], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"The AWS Directory Service directory ID.
" + }, + "Alias":{ + "shape":"OrganizationName", + "documentation":"The organization alias.
" + }, + "ClientToken":{ + "shape":"IdempotencyClientToken", + "documentation":"The idempotency token associated with the request.
", + "idempotencyToken":true + }, + "Domains":{ + "shape":"Domains", + "documentation":"The email domains to associate with the organization.
" + }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.
" + }, + "EnableInteroperability":{ + "shape":"Boolean", + "documentation":"When true, allows organization interoperability between WorkMail and Microsoft Exchange. If true, you must include a AD Connector directory ID in the request.
The organization ID.
" + } + } + }, + "CreateResourceRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "Name", + "Type" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier associated with the organization for which the resource is created.
" + }, + "Name":{ + "shape":"ResourceName", + "documentation":"The name of the new resource.
" + }, + "Type":{ + "shape":"ResourceType", + "documentation":"The type of the new resource. The available types are equipment and room.
Resource description.
" + }, + "HiddenFromGlobalAddressList":{ + "shape":"Boolean", + "documentation":"If this parameter is enabled, the resource will be hidden from the address book.
" + } + } + }, + "CreateResourceResponse":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"ResourceId", + "documentation":"The identifier of the new resource.
" + } + } + }, + "CreateUserRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "Name", + "DisplayName" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier of the organization for which the user is created.
" + }, + "Name":{ + "shape":"UserName", + "documentation":"The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.
" + }, + "DisplayName":{ + "shape":"UserAttribute", + "documentation":"The display name for the new user.
" + }, + "Password":{ + "shape":"Password", + "documentation":"The password for the new user.
" + }, + "Role":{ + "shape":"UserRole", + "documentation":"The role of the new user.
You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.
" + }, + "FirstName":{ + "shape":"UserAttribute", + "documentation":"The first name of the new user.
" + }, + "LastName":{ + "shape":"UserAttribute", + "documentation":"The last name of the new user.
" + }, + "HiddenFromGlobalAddressList":{ + "shape":"Boolean", + "documentation":"If this parameter is enabled, the user will be hidden from the address book.
" + } + } + }, + "CreateUserResponse":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"WorkMailIdentifier", + "documentation":"The identifier for the new user.
" + } + } + }, + "Delegate":{ + "type":"structure", + "required":[ + "Id", + "Type" + ], + "members":{ + "Id":{ + "shape":"String", + "documentation":"The identifier for the user or group associated as the resource's delegate.
" + }, + "Type":{ + "shape":"MemberType", + "documentation":"The type of the delegate: user or group.
" + } + }, + "documentation":"The name of the attribute, which is one of the values defined in the UserAttribute enumeration.
" + }, + "DeleteAccessControlRuleRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "Name" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization.
" + }, + "Name":{ + "shape":"AccessControlRuleName", + "documentation":"The name of the access control rule.
" + } + } + }, + "DeleteAccessControlRuleResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteAliasRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId", + "Alias" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization under which the user exists.
" + }, + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"The identifier for the member (user or group) from which to have the aliases removed.
" + }, + "Alias":{ + "shape":"EmailAddress", + "documentation":"The aliases to be removed from the user's set of aliases. Duplicate entries in the list are collapsed into single entries (the list is transformed into a set).
" + } + } + }, + "DeleteAliasResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteAvailabilityConfigurationRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "DomainName" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization for which the AvailabilityConfiguration will be deleted.
The domain for which the AvailabilityConfiguration will be deleted.
The ID of the organization from which the email monitoring configuration is deleted.
" + } + } + }, + "DeleteEmailMonitoringConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteGroupRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "GroupId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The organization that contains the group.
" + }, + "GroupId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier of the group to be deleted.
The identifier can be the GroupId, or Groupname. The following identity formats are available:
Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Group name: group
The WorkMail organization from which to delete the impersonation role.
" + }, + "ImpersonationRoleId":{ + "shape":"ImpersonationRoleId", + "documentation":"The ID of the impersonation role to delete.
" + } + } + }, + "DeleteImpersonationRoleResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteMailboxPermissionsRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId", + "GranteeId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier of the organization under which the member (user or group) exists.
" + }, + "EntityId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier of the entity that owns the mailbox.
The identifier can be UserId or Group Id, Username or Groupname, or email.
Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234
Email address: entity@domain.tld
Entity name: entity
The identifier of the entity for which to delete granted permissions.
The identifier can be UserId, ResourceID, or Group Id, Username or Groupname, or email.
Grantee ID: 12345678-1234-1234-1234-123456789012,r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234
Email address: grantee@domain.tld
Grantee name: grantee
The WorkMail organization for which the access override will be deleted.
" + }, + "UserId":{ + "shape":"EntityIdentifier", + "documentation":"The WorkMail user for which you want to delete the override. Accepts the following types of user identities:
User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: user@domain.tld
User name: user
The mobile device for which you delete the override. DeviceId is case insensitive.
The WorkMail organization under which the rule will be deleted.
" + }, + "MobileDeviceAccessRuleId":{ + "shape":"MobileDeviceAccessRuleId", + "documentation":"The identifier of the rule to be deleted.
" + } + } + }, + "DeleteMobileDeviceAccessRuleResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteOrganizationRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "DeleteDirectory" + ], + "members":{ + "ClientToken":{ + "shape":"IdempotencyClientToken", + "documentation":"The idempotency token associated with the request.
", + "idempotencyToken":true + }, + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The organization ID.
" + }, + "DeleteDirectory":{ + "shape":"Boolean", + "documentation":"If true, deletes the AWS Directory Service directory associated with the organization.
" + }, + "ForceDelete":{ + "shape":"Boolean", + "documentation":"Deletes a WorkMail organization even if the organization has enabled users.
" + } + } + }, + "DeleteOrganizationResponse":{ + "type":"structure", + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The organization ID.
" + }, + "State":{ + "shape":"String", + "documentation":"The state of the organization.
" + } + } + }, + "DeleteResourceRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "ResourceId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier associated with the organization from which the resource is deleted.
" + }, + "ResourceId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier of the resource to be deleted.
The identifier can accept ResourceId, or Resourcename. The following identity formats are available:
Resource ID: r-0123456789a0123456789b0123456789
Resource name: resource
The organization ID.
" + }, + "Id":{ + "shape":"ShortString", + "documentation":"The retention policy ID.
" + } + } + }, + "DeleteRetentionPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteUserRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "UserId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The organization that contains the user to be deleted.
" + }, + "UserId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier of the user to be deleted.
The identifier can be the UserId or Username. The following identity formats are available:
User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
User name: user
The identifier for the organization under which the WorkMail entity exists.
" + }, + "EntityId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier for the member to be updated.
The identifier can be UserId, ResourceId, or Group Id, Username, Resourcename, or Groupname, or email.
Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234
Email address: entity@domain.tld
Entity name: entity
The WorkMail organization for which the domain will be deregistered.
" + }, + "DomainName":{ + "shape":"WorkMailDomainName", + "documentation":"The domain to deregister in WorkMail and SES.
" + } + } + }, + "DeregisterMailDomainResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeEmailMonitoringConfigurationRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The ID of the organization for which the email monitoring configuration is described.
" + } + } + }, + "DescribeEmailMonitoringConfigurationResponse":{ + "type":"structure", + "members":{ + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.
" + }, + "LogGroupArn":{ + "shape":"LogGroupArn", + "documentation":"The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.
" + } + } + }, + "DescribeEntityRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "Email" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization under which the entity exists.
" + }, + "Email":{ + "shape":"EmailAddress", + "documentation":"The email under which the entity exists.
" + } + } + }, + "DescribeEntityResponse":{ + "type":"structure", + "members":{ + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"The entity ID under which the entity exists.
" + }, + "Name":{ + "shape":"String", + "documentation":"Username, GroupName, or ResourceName based on entity type.
" + }, + "Type":{ + "shape":"EntityType", + "documentation":"Entity type.
" + } + } + }, + "DescribeGroupRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "GroupId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization under which the group exists.
" + }, + "GroupId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier for the group to be described.
The identifier can accept GroupId, Groupname, or email. The following identity formats are available:
Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: group@domain.tld
Group name: group
The identifier of the described group.
" + }, + "Name":{ + "shape":"GroupName", + "documentation":"The name of the described group.
" + }, + "Email":{ + "shape":"EmailAddress", + "documentation":"The email of the described group.
" + }, + "State":{ + "shape":"EntityState", + "documentation":"The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
" + }, + "EnabledDate":{ + "shape":"Timestamp", + "documentation":"The date and time when a user was registered to WorkMail, in UNIX epoch time format.
" + }, + "DisabledDate":{ + "shape":"Timestamp", + "documentation":"The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.
" + }, + "HiddenFromGlobalAddressList":{ + "shape":"Boolean", + "documentation":"If the value is set to true, the group is hidden from the address book.
" + } + } + }, + "DescribeInboundDmarcSettingsRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"Lists the ID of the given organization.
" + } + } + }, + "DescribeInboundDmarcSettingsResponse":{ + "type":"structure", + "members":{ + "Enforced":{ + "shape":"Boolean", + "documentation":"Lists the enforcement setting of the applied policy.
" + } + } + }, + "DescribeMailboxExportJobRequest":{ + "type":"structure", + "required":[ + "JobId", + "OrganizationId" + ], + "members":{ + "JobId":{ + "shape":"MailboxExportJobId", + "documentation":"The mailbox export job ID.
" + }, + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The organization ID.
" + } + } + }, + "DescribeMailboxExportJobResponse":{ + "type":"structure", + "members":{ + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"The identifier of the user or resource associated with the mailbox.
" + }, + "Description":{ + "shape":"Description", + "documentation":"The mailbox export job description.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket.
" + }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
" + }, + "S3BucketName":{ + "shape":"S3BucketName", + "documentation":"The name of the S3 bucket.
" + }, + "S3Prefix":{ + "shape":"S3ObjectKey", + "documentation":"The S3 bucket prefix.
" + }, + "S3Path":{ + "shape":"S3ObjectKey", + "documentation":"The path to the S3 bucket and file that the mailbox export job is exporting to.
" + }, + "EstimatedProgress":{ + "shape":"Percentage", + "documentation":"The estimated progress of the mailbox export job, in percentage points.
" + }, + "State":{ + "shape":"MailboxExportJobState", + "documentation":"The state of the mailbox export job.
" + }, + "ErrorInfo":{ + "shape":"MailboxExportErrorInfo", + "documentation":"Error information for failed mailbox export jobs.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The mailbox export job start timestamp.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The mailbox export job end timestamp.
" + } + } + }, + "DescribeOrganizationRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization to be described.
" + } + } + }, + "DescribeOrganizationResponse":{ + "type":"structure", + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier of an organization.
" + }, + "Alias":{ + "shape":"OrganizationName", + "documentation":"The alias for an organization.
" + }, + "State":{ + "shape":"String", + "documentation":"The state of an organization.
" + }, + "DirectoryId":{ + "shape":"String", + "documentation":"The identifier for the directory associated with an WorkMail organization.
" + }, + "DirectoryType":{ + "shape":"String", + "documentation":"The type of directory associated with the WorkMail organization.
" + }, + "DefaultMailDomain":{ + "shape":"String", + "documentation":"The default mail domain associated with the organization.
" + }, + "CompletedDate":{ + "shape":"Timestamp", + "documentation":"The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.
" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"(Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.
" + }, + "ARN":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the organization.
" + }, + "MigrationAdmin":{ + "shape":"WorkMailIdentifier", + "documentation":"The user ID of the migration admin if migration is enabled for the organization.
" + }, + "InteroperabilityEnabled":{ + "shape":"Boolean", + "documentation":"Indicates if interoperability is enabled for this organization.
" + } + } + }, + "DescribeResourceRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "ResourceId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier associated with the organization for which the resource is described.
" + }, + "ResourceId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier of the resource to be described.
The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:
Resource ID: r-0123456789a0123456789b0123456789
Email address: resource@domain.tld
Resource name: resource
The identifier of the described resource.
" + }, + "Email":{ + "shape":"EmailAddress", + "documentation":"The email of the described resource.
" + }, + "Name":{ + "shape":"ResourceName", + "documentation":"The name of the described resource.
" + }, + "Type":{ + "shape":"ResourceType", + "documentation":"The type of the described resource.
" + }, + "BookingOptions":{ + "shape":"BookingOptions", + "documentation":"The booking options for the described resource.
" + }, + "State":{ + "shape":"EntityState", + "documentation":"The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.
" + }, + "EnabledDate":{ + "shape":"Timestamp", + "documentation":"The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.
" + }, + "DisabledDate":{ + "shape":"Timestamp", + "documentation":"The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.
" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"Description of the resource.
" + }, + "HiddenFromGlobalAddressList":{ + "shape":"Boolean", + "documentation":"If enabled, the resource is hidden from the global address list.
" + } + } + }, + "DescribeUserRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "UserId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization under which the user exists.
" + }, + "UserId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier for the user to be described.
The identifier can be the UserId, Username, or email. The following identity formats are available:
User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: user@domain.tld
User name: user
The identifier for the described user.
" + }, + "Name":{ + "shape":"UserName", + "documentation":"The name for the user.
" + }, + "Email":{ + "shape":"EmailAddress", + "documentation":"The email of the user.
" + }, + "DisplayName":{ + "shape":"UserAttribute", + "documentation":"The display name of the user.
" + }, + "State":{ + "shape":"EntityState", + "documentation":"The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
" + }, + "UserRole":{ + "shape":"UserRole", + "documentation":"In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.
" + }, + "EnabledDate":{ + "shape":"Timestamp", + "documentation":"The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.
" + }, + "DisabledDate":{ + "shape":"Timestamp", + "documentation":"The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.
" + }, + "MailboxProvisionedDate":{ + "shape":"Timestamp", + "documentation":"The date when the mailbox was created for the user.
" + }, + "MailboxDeprovisionedDate":{ + "shape":"Timestamp", + "documentation":"The date when the mailbox was removed for the user.
" + }, + "FirstName":{ + "shape":"UserAttribute", + "documentation":"First name of the user.
" + }, + "LastName":{ + "shape":"UserAttribute", + "documentation":"Last name of the user.
" + }, + "HiddenFromGlobalAddressList":{ + "shape":"Boolean", + "documentation":"If enabled, the user is hidden from the global address list.
" + }, + "Initials":{ + "shape":"UserAttribute", + "documentation":"Initials of the user.
" + }, + "Telephone":{ + "shape":"UserAttribute", + "documentation":"User's contact number.
" + }, + "Street":{ + "shape":"UserAttribute", + "documentation":"Street where the user is located.
" + }, + "JobTitle":{ + "shape":"UserAttribute", + "documentation":"Job title of the user.
" + }, + "City":{ + "shape":"UserAttribute", + "documentation":"City where the user is located.
" + }, + "Company":{ + "shape":"UserAttribute", + "documentation":"Company of the user.
" + }, + "ZipCode":{ + "shape":"UserAttribute", + "documentation":"Zip code of the user.
" + }, + "Department":{ + "shape":"UserAttribute", + "documentation":"Department of the user.
" + }, + "Country":{ + "shape":"UserAttribute", + "documentation":"Country where the user is located.
" + }, + "Office":{ + "shape":"UserAttribute", + "documentation":"Office where the user is located.
" + } + } + }, + "Description":{ + "type":"string", + "max":1023, + "min":0, + "pattern":"[\\S\\s]*" + }, + "DeviceId":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[A-Za-z0-9]+" + }, + "DeviceModel":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "DeviceModelList":{ + "type":"list", + "member":{"shape":"DeviceModel"}, + "max":10, + "min":1 + }, + "DeviceOperatingSystem":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "DeviceOperatingSystemList":{ + "type":"list", + "member":{"shape":"DeviceOperatingSystem"}, + "max":10, + "min":1 + }, + "DeviceType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "DeviceTypeList":{ + "type":"list", + "member":{"shape":"DeviceType"}, + "max":10, + "min":1 + }, + "DeviceUserAgent":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "DeviceUserAgentList":{ + "type":"list", + "member":{"shape":"DeviceUserAgent"}, + "max":10, + "min":1 + }, + "DirectoryId":{ + "type":"string", + "max":12, + "min":12, + "pattern":"^d-[0-9a-f]{10}$" + }, + "DirectoryInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The directory is already in use by another WorkMail organization in the same account and Region.
", + "exception":true + }, + "DirectoryServiceAuthenticationFailedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The directory service doesn't recognize the credentials supplied by WorkMail.
", + "exception":true + }, + "DirectoryUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The directory is unavailable. It might be located in another Region or deleted.
", + "exception":true + }, + "DisassociateDelegateFromResourceRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "ResourceId", + "EntityId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization under which the resource exists.
" + }, + "ResourceId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier of the resource from which delegates' set members are removed.
The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:
Resource ID: r-0123456789a0123456789b0123456789
Email address: resource@domain.tld
Resource name: resource
The identifier for the member (user, group) to be removed from the resource's delegates.
The entity ID can accept UserId or GroupID, Username or Groupname, or email.
Entity: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: entity@domain.tld
Entity: entity
The identifier for the organization under which the group exists.
" + }, + "GroupId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier for the group from which members are removed.
The identifier can accept GroupId, Groupname, or email. The following identity formats are available:
Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: group@domain.tld
Group name: group
The identifier for the member to be removed from the group.
The member ID can accept UserID or GroupId, Username or Groupname, or email.
Member ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: member@domain.tld
Member name: member
The RFC 1035 record type. Possible values: CNAME, A, MX.
The DNS hostname.- For example, domain.example.com.
The value returned by the DNS for a query to that hostname and record type.
" + } + }, + "documentation":"A DNS record uploaded to your DNS provider.
" + }, + "DnsRecordVerificationStatus":{ + "type":"string", + "enum":[ + "PENDING", + "VERIFIED", + "FAILED" + ] + }, + "DnsRecords":{ + "type":"list", + "member":{"shape":"DnsRecord"} + }, + "Domain":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"The fully qualified domain name.
" + }, + "HostedZoneId":{ + "shape":"HostedZoneId", + "documentation":"The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53.
" + } + }, + "documentation":"The domain to associate with an WorkMail organization.
When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see Adding a domain in the WorkMail Administrator Guide.
" + }, + "DomainName":{ + "type":"string", + "max":255, + "min":3, + "pattern":"[a-zA-Z0-9.-]+" + }, + "Domains":{ + "type":"list", + "member":{"shape":"Domain"}, + "max":5, + "min":0 + }, + "EmailAddress":{ + "type":"string", + "max":254, + "min":1, + "pattern":"[a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\\.[a-zA-Z-]{2,}" + }, + "EmailAddressInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The email address that you're trying to assign is already created for a different user, group, or resource.
", + "exception":true + }, + "EntityAlreadyRegisteredException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The user, group, or resource that you're trying to register is already registered.
", + "exception":true + }, + "EntityIdentifier":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9._%+@-]+" + }, + "EntityNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The identifier supplied for the user, group, or resource does not exist in your organization.
", + "exception":true + }, + "EntityState":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED", + "DELETED" + ] + }, + "EntityStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
", + "exception":true + }, + "EntityType":{ + "type":"string", + "enum":[ + "GROUP", + "USER", + "RESOURCE" + ] + }, + "EwsAvailabilityProvider":{ + "type":"structure", + "required":[ + "EwsEndpoint", + "EwsUsername", + "EwsPassword" + ], + "members":{ + "EwsEndpoint":{ + "shape":"Url", + "documentation":"The endpoint of the remote EWS server.
" + }, + "EwsUsername":{ + "shape":"ExternalUserName", + "documentation":"The username used to authenticate the remote EWS server.
" + }, + "EwsPassword":{ + "shape":"Password", + "documentation":"The password used to authenticate the remote EWS server.
" + } + }, + "documentation":"Describes an EWS based availability provider. This is only used as input to the service.
" + }, + "ExpiresIn":{ + "type":"long", + "box":true + }, + "ExternalUserName":{ + "type":"string", + "max":256, + "pattern":"[\\u0020-\\u00FF]+" + }, + "FolderConfiguration":{ + "type":"structure", + "required":[ + "Name", + "Action" + ], + "members":{ + "Name":{ + "shape":"FolderName", + "documentation":"The folder name.
" + }, + "Action":{ + "shape":"RetentionAction", + "documentation":"The action to take on the folder contents at the end of the folder configuration period.
" + }, + "Period":{ + "shape":"RetentionPeriod", + "documentation":"The number of days for which the folder-configuration action applies.
" + } + }, + "documentation":"The configuration applied to an organization's folders by its retention policy.
" + }, + "FolderConfigurations":{ + "type":"list", + "member":{"shape":"FolderConfiguration"} + }, + "FolderName":{ + "type":"string", + "enum":[ + "INBOX", + "DELETED_ITEMS", + "SENT_ITEMS", + "DRAFTS", + "JUNK_EMAIL" + ] + }, + "GetAccessControlEffectRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "IpAddress", + "Action" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization.
" + }, + "IpAddress":{ + "shape":"IpAddress", + "documentation":"The IPv4 address.
" + }, + "Action":{ + "shape":"AccessControlRuleAction", + "documentation":"The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
The user ID.
" + }, + "ImpersonationRoleId":{ + "shape":"ImpersonationRoleId", + "documentation":"The impersonation role ID.
" + } + } + }, + "GetAccessControlEffectResponse":{ + "type":"structure", + "members":{ + "Effect":{ + "shape":"AccessControlRuleEffect", + "documentation":"The rule effect.
" + }, + "MatchedRules":{ + "shape":"AccessControlRuleNameList", + "documentation":"The rules that match the given parameters, resulting in an effect.
" + } + } + }, + "GetDefaultRetentionPolicyRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The organization ID.
" + } + } + }, + "GetDefaultRetentionPolicyResponse":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ShortString", + "documentation":"The retention policy ID.
" + }, + "Name":{ + "shape":"ShortString", + "documentation":"The retention policy name.
" + }, + "Description":{ + "shape":"String", + "documentation":"The retention policy description.
" + }, + "FolderConfigurations":{ + "shape":"FolderConfigurations", + "documentation":"The retention policy folder configurations.
" + } + } + }, + "GetImpersonationRoleEffectRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "ImpersonationRoleId", + "TargetUser" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization where the impersonation role is defined.
" + }, + "ImpersonationRoleId":{ + "shape":"ImpersonationRoleId", + "documentation":"The impersonation role ID to test.
" + }, + "TargetUser":{ + "shape":"EntityIdentifier", + "documentation":"The WorkMail organization user chosen to test the impersonation role. The following identity formats are available:
User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: user@domain.tld
User name: user
The impersonation role type.
" + }, + "Effect":{ + "shape":"AccessEffect", + "documentation":" Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.
A list of the rules that match the input and produce the configured effect.
" + } + } + }, + "GetImpersonationRoleRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "ImpersonationRoleId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization from which to retrieve the impersonation role.
" + }, + "ImpersonationRoleId":{ + "shape":"ImpersonationRoleId", + "documentation":"The impersonation role ID to retrieve.
" + } + } + }, + "GetImpersonationRoleResponse":{ + "type":"structure", + "members":{ + "ImpersonationRoleId":{ + "shape":"ImpersonationRoleId", + "documentation":"The impersonation role ID.
" + }, + "Name":{ + "shape":"ImpersonationRoleName", + "documentation":"The impersonation role name.
" + }, + "Type":{ + "shape":"ImpersonationRoleType", + "documentation":"The impersonation role type.
" + }, + "Description":{ + "shape":"ImpersonationRoleDescription", + "documentation":"The impersonation role description.
" + }, + "Rules":{ + "shape":"ImpersonationRuleList", + "documentation":"The list of rules for the given impersonation role.
" + }, + "DateCreated":{ + "shape":"Timestamp", + "documentation":"The date when the impersonation role was created.
" + }, + "DateModified":{ + "shape":"Timestamp", + "documentation":"The date when the impersonation role was last modified.
" + } + } + }, + "GetMailDomainRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "DomainName" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization for which the domain is retrieved.
" + }, + "DomainName":{ + "shape":"WorkMailDomainName", + "documentation":"The domain from which you want to retrieve details.
" + } + } + }, + "GetMailDomainResponse":{ + "type":"structure", + "members":{ + "Records":{ + "shape":"DnsRecords", + "documentation":"A list of the DNS records that WorkMail recommends adding in your DNS provider for the best user experience. The records configure your domain with DMARC, SPF, DKIM, and direct incoming email traffic to SES. See admin guide for more details.
" + }, + "IsTestDomain":{ + "shape":"Boolean", + "documentation":"Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.
" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"Specifies whether the domain is the default domain for your organization.
" + }, + "OwnershipVerificationStatus":{ + "shape":"DnsRecordVerificationStatus", + "documentation":"Indicates the status of the domain ownership verification.
" + }, + "DkimVerificationStatus":{ + "shape":"DnsRecordVerificationStatus", + "documentation":"Indicates the status of a DKIM verification.
" + } + } + }, + "GetMailboxDetailsRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "UserId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization that contains the user whose mailbox details are being requested.
" + }, + "UserId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier for the user whose mailbox details are being requested.
The identifier can be the UserId, Username, or email. The following identity formats are available:
User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: user@domain.tld
User name: user
The maximum allowed mailbox size, in MB, for the specified user.
" + }, + "MailboxSize":{ + "shape":"MailboxSize", + "documentation":"The current mailbox size, in MB, for the specified user.
" + } + } + }, + "GetMobileDeviceAccessEffectRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization to simulate the access effect for.
" + }, + "DeviceType":{ + "shape":"DeviceType", + "documentation":"Device type the simulated user will report.
" + }, + "DeviceModel":{ + "shape":"DeviceModel", + "documentation":"Device model the simulated user will report.
" + }, + "DeviceOperatingSystem":{ + "shape":"DeviceOperatingSystem", + "documentation":"Device operating system the simulated user will report.
" + }, + "DeviceUserAgent":{ + "shape":"DeviceUserAgent", + "documentation":"Device user agent the simulated user will report.
" + } + } + }, + "GetMobileDeviceAccessEffectResponse":{ + "type":"structure", + "members":{ + "Effect":{ + "shape":"MobileDeviceAccessRuleEffect", + "documentation":"The effect of the simulated access, ALLOW or DENY, after evaluating mobile device access rules in the WorkMail organization for the simulated user parameters.
A list of the rules which matched the simulated user input and produced the effect.
" + } + } + }, + "GetMobileDeviceAccessOverrideRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "UserId", + "DeviceId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization to which you want to apply the override.
" + }, + "UserId":{ + "shape":"EntityIdentifier", + "documentation":"Identifies the WorkMail user for the override. Accepts the following types of user identities:
User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: user@domain.tld
User name: user
The mobile device to which the override applies. DeviceId is case insensitive.
The WorkMail user to which the access override applies.
" + }, + "DeviceId":{ + "shape":"DeviceId", + "documentation":"The device to which the access override applies.
" + }, + "Effect":{ + "shape":"MobileDeviceAccessRuleEffect", + "documentation":"The effect of the override, ALLOW or DENY.
A description of the override.
" + }, + "DateCreated":{ + "shape":"Timestamp", + "documentation":"The date the override was first created.
" + }, + "DateModified":{ + "shape":"Timestamp", + "documentation":"The date the description was last modified.
" + } + } + }, + "Group":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"WorkMailIdentifier", + "documentation":"The identifier of the group.
" + }, + "Email":{ + "shape":"EmailAddress", + "documentation":"The email of the group.
" + }, + "Name":{ + "shape":"GroupName", + "documentation":"The name of the group.
" + }, + "State":{ + "shape":"EntityState", + "documentation":"The state of the group, which can be ENABLED, DISABLED, or DELETED.
" + }, + "EnabledDate":{ + "shape":"Timestamp", + "documentation":"The date indicating when the group was enabled for WorkMail use.
" + }, + "DisabledDate":{ + "shape":"Timestamp", + "documentation":"The date indicating when the group was disabled from WorkMail use.
" + } + }, + "documentation":"The representation of an WorkMail group.
" + }, + "GroupIdentifier":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"WorkMailIdentifier", + "documentation":"Group ID that matched the group.
" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"Group name that matched the group.
" + } + }, + "documentation":"The identifier that contains the Group ID and name of a group.
" + }, + "GroupIdentifiers":{ + "type":"list", + "member":{"shape":"GroupIdentifier"} + }, + "GroupName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "Groups":{ + "type":"list", + "member":{"shape":"Group"} + }, + "HostedZoneId":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[^/\\\\]*" + }, + "IdempotencyClientToken":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\x21-\\x7e]+" + }, + "ImpersonationMatchedRule":{ + "type":"structure", + "members":{ + "ImpersonationRuleId":{ + "shape":"ImpersonationRuleId", + "documentation":"The ID of the rule that matched the input
" + }, + "Name":{ + "shape":"ImpersonationRuleName", + "documentation":"The name of the rule that matched the input.
" + } + }, + "documentation":"The impersonation rule that matched the input.
" + }, + "ImpersonationMatchedRuleList":{ + "type":"list", + "member":{"shape":"ImpersonationMatchedRule"}, + "max":10, + "min":0 + }, + "ImpersonationRole":{ + "type":"structure", + "members":{ + "ImpersonationRoleId":{ + "shape":"ImpersonationRoleId", + "documentation":"The identifier of the impersonation role.
" + }, + "Name":{ + "shape":"ImpersonationRoleName", + "documentation":"The impersonation role name.
" + }, + "Type":{ + "shape":"ImpersonationRoleType", + "documentation":"The impersonation role type.
" + }, + "DateCreated":{ + "shape":"Timestamp", + "documentation":"The date when the impersonation role was created.
" + }, + "DateModified":{ + "shape":"Timestamp", + "documentation":"The date when the impersonation role was last modified.
" + } + }, + "documentation":"An impersonation role for the given WorkMail organization.
" + }, + "ImpersonationRoleDescription":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F\\x3C\\x3E\\x5C]+" + }, + "ImpersonationRoleId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "ImpersonationRoleIdList":{ + "type":"list", + "member":{"shape":"ImpersonationRoleId"}, + "max":10, + "min":0 + }, + "ImpersonationRoleList":{ + "type":"list", + "member":{"shape":"ImpersonationRole"}, + "max":20, + "min":0 + }, + "ImpersonationRoleName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[^\\x00-\\x1F\\x7F\\x3C\\x3E\\x5C]+" + }, + "ImpersonationRoleType":{ + "type":"string", + "enum":[ + "FULL_ACCESS", + "READ_ONLY" + ] + }, + "ImpersonationRule":{ + "type":"structure", + "required":[ + "ImpersonationRuleId", + "Effect" + ], + "members":{ + "ImpersonationRuleId":{ + "shape":"ImpersonationRuleId", + "documentation":"The identifier of the rule.
" + }, + "Name":{ + "shape":"ImpersonationRuleName", + "documentation":"The rule name.
" + }, + "Description":{ + "shape":"ImpersonationRuleDescription", + "documentation":"The rule description.
" + }, + "Effect":{ + "shape":"AccessEffect", + "documentation":"The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY.
A list of user IDs that match the rule.
" + }, + "NotTargetUsers":{ + "shape":"TargetUsers", + "documentation":"A list of user IDs that don't match the rule.
" + } + }, + "documentation":"The rules for the given impersonation role.
" + }, + "ImpersonationRuleDescription":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F\\x3C\\x3E\\x5C]+" + }, + "ImpersonationRuleId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "ImpersonationRuleList":{ + "type":"list", + "member":{"shape":"ImpersonationRule"}, + "max":10, + "min":0 + }, + "ImpersonationRuleName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[^\\x00-\\x1F\\x7F\\x3C\\x3E\\x5C]+" + }, + "ImpersonationToken":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\x21-\\x7e]+" + }, + "InvalidConfigurationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests or have at least one delegate associated that can do so on its behalf.
", + "exception":true + }, + "InvalidCustomSesConfigurationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule.
", + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"One or more of the input parameters don't match the service's restrictions.
", + "exception":true + }, + "InvalidPasswordException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The supplied password doesn't match the minimum security constraints, such as length or use of special characters.
", + "exception":true + }, + "IpAddress":{ + "type":"string", + "max":15, + "min":1, + "pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" + }, + "IpRange":{ + "type":"string", + "max":18, + "min":1, + "pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$" + }, + "IpRangeList":{ + "type":"list", + "member":{"shape":"IpRange"}, + "max":1024, + "min":0 + }, + "Jobs":{ + "type":"list", + "member":{"shape":"MailboxExportJob"} + }, + "KmsKeyArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws:kms:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}" + }, + "LambdaArn":{ + "type":"string", + "max":256, + "min":49, + "pattern":"arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9\\-_\\.]+(:(\\$LATEST|[a-zA-Z0-9\\-_]+))?" + }, + "LambdaAvailabilityProvider":{ + "type":"structure", + "required":["LambdaArn"], + "members":{ + "LambdaArn":{ + "shape":"LambdaArn", + "documentation":"The Amazon Resource Name (ARN) of the Lambda that acts as the availability provider.
" + } + }, + "documentation":"Describes a Lambda based availability provider.
" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The request exceeds the limit of the resource.
", + "exception":true + }, + "ListAccessControlRulesRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization.
" + } + } + }, + "ListAccessControlRulesResponse":{ + "type":"structure", + "members":{ + "Rules":{ + "shape":"AccessControlRulesList", + "documentation":"The access control rules.
" + } + } + }, + "ListAliasesRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization under which the entity exists.
" + }, + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"The identifier for the entity for which to list the aliases.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The first call does not contain any tokens.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return in a single call.
" + } + } + }, + "ListAliasesResponse":{ + "type":"structure", + "members":{ + "Aliases":{ + "shape":"Aliases", + "documentation":"The entity's paginated aliases.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The value is \"null\" when there are no more results to return.
" + } + } + }, + "ListAvailabilityConfigurationsRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization for which the AvailabilityConfiguration's will be listed.
The maximum number of results to return in a single call.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The first call does not require a token.
" + } + } + }, + "ListAvailabilityConfigurationsResponse":{ + "type":"structure", + "members":{ + "AvailabilityConfigurations":{ + "shape":"AvailabilityConfigurationList", + "documentation":"The list of AvailabilityConfiguration's that exist for the specified WorkMail organization.
The token to use to retrieve the next page of results. The value is null when there are no further results to return.
The identifier for the organization under which the group exists.
" + }, + "GroupId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier for the group to which the members (users or groups) are associated.
The identifier can accept GroupId, Groupname, or email. The following identity formats are available:
Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: group@domain.tld
Group name: group
The token to use to retrieve the next page of results. The first call does not contain any tokens.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return in a single call.
" + } + } + }, + "ListGroupMembersResponse":{ + "type":"structure", + "members":{ + "Members":{ + "shape":"Members", + "documentation":"The members associated to the group.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The first call does not contain any tokens.
" + } + } + }, + "ListGroupsFilters":{ + "type":"structure", + "members":{ + "NamePrefix":{ + "shape":"String", + "documentation":"Filters only groups with the provided name prefix.
" + }, + "PrimaryEmailPrefix":{ + "shape":"String", + "documentation":"Filters only groups with the provided primary email prefix.
" + }, + "State":{ + "shape":"EntityState", + "documentation":"Filters only groups with the provided state.
" + } + }, + "documentation":"Filtering options for ListGroups operation. This is only used as input to Operation.
" + }, + "ListGroupsForEntityFilters":{ + "type":"structure", + "members":{ + "GroupNamePrefix":{ + "shape":"String", + "documentation":"Filters only group names that start with the provided name prefix.
" + } + }, + "documentation":"Filtering options for ListGroupsForEntity operation. This is only used as input to Operation.
" + }, + "ListGroupsForEntityRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization under which the entity exists.
" + }, + "EntityId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier for the entity.
The entity ID can accept UserId or GroupID, Username or Groupname, or email.
Entity ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: entity@domain.tld
Entity name: entity
Limit the search results based on the filter criteria.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The first call does not contain any tokens.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return in a single call.
" + } + } + }, + "ListGroupsForEntityResponse":{ + "type":"structure", + "members":{ + "Groups":{ + "shape":"GroupIdentifiers", + "documentation":"The overview of groups in an organization.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.
" + } + } + }, + "ListGroupsRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization under which the groups exist.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The first call does not contain any tokens.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return in a single call.
" + }, + "Filters":{ + "shape":"ListGroupsFilters", + "documentation":"Limit the search results based on the filter criteria. Only one filter per request is supported.
" + } + } + }, + "ListGroupsResponse":{ + "type":"structure", + "members":{ + "Groups":{ + "shape":"Groups", + "documentation":"The overview of groups for an organization.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The value is \"null\" when there are no more results to return.
" + } + } + }, + "ListImpersonationRolesRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization to which the listed impersonation roles belong.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token used to retrieve the next page of results. The first call doesn't require a token.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results returned in a single call.
" + } + } + }, + "ListImpersonationRolesResponse":{ + "type":"structure", + "members":{ + "Roles":{ + "shape":"ImpersonationRoleList", + "documentation":"The list of impersonation roles under the given WorkMail organization.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to retrieve the next page of results. The value is null when there are no results to return.
The WorkMail organization for which to list domains.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return in a single call.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The first call does not require a token.
" + } + } + }, + "ListMailDomainsResponse":{ + "type":"structure", + "members":{ + "MailDomains":{ + "shape":"MailDomains", + "documentation":"The list of mail domain summaries, specifying domains that exist in the specified WorkMail organization, along with the information about whether the domain is or isn't the default.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The value becomes null when there are no more results to return.
The organization ID.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return in a single call.
" + } + } + }, + "ListMailboxExportJobsResponse":{ + "type":"structure", + "members":{ + "Jobs":{ + "shape":"Jobs", + "documentation":"The mailbox export job details.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results.
" + } + } + }, + "ListMailboxPermissionsRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier of the organization under which the user, group, or resource exists.
" + }, + "EntityId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier of the user, or resource for which to list mailbox permissions.
The entity ID can accept UserId or ResourceId, Username or Resourcename, or email.
Entity ID: 12345678-1234-1234-1234-123456789012, or r-0123456789a0123456789b0123456789
Email address: entity@domain.tld
Entity name: entity
The token to use to retrieve the next page of results. The first call does not contain any tokens.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return in a single call.
" + } + } + }, + "ListMailboxPermissionsResponse":{ + "type":"structure", + "members":{ + "Permissions":{ + "shape":"Permissions", + "documentation":"One page of the user, group, or resource mailbox permissions.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The value is \"null\" when there are no more results to return.
" + } + } + }, + "ListMobileDeviceAccessOverridesRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization under which to list mobile device access overrides.
" + }, + "UserId":{ + "shape":"EntityIdentifier", + "documentation":"The WorkMail user under which you list the mobile device access overrides. Accepts the following types of user identities:
User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: user@domain.tld
User name: user
The mobile device to which the access override applies.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The first call does not require a token.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return in a single call.
" + } + } + }, + "ListMobileDeviceAccessOverridesResponse":{ + "type":"structure", + "members":{ + "Overrides":{ + "shape":"MobileDeviceAccessOverridesList", + "documentation":"The list of mobile device access overrides that exist for the specified WorkMail organization and user.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.
" + } + } + }, + "ListMobileDeviceAccessRulesRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization for which to list the rules.
" + } + } + }, + "ListMobileDeviceAccessRulesResponse":{ + "type":"structure", + "members":{ + "Rules":{ + "shape":"MobileDeviceAccessRulesList", + "documentation":"The list of mobile device access rules that exist under the specified WorkMail organization.
" + } + } + }, + "ListOrganizationsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The first call does not contain any tokens.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return in a single call.
" + } + } + }, + "ListOrganizationsResponse":{ + "type":"structure", + "members":{ + "OrganizationSummaries":{ + "shape":"OrganizationSummaries", + "documentation":"The overview of owned organizations presented as a list of organization summaries.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The value is \"null\" when there are no more results to return.
" + } + } + }, + "ListResourceDelegatesRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "ResourceId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization that contains the resource for which delegates are listed.
" + }, + "ResourceId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier for the resource whose delegates are listed.
The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:
Resource ID: r-0123456789a0123456789b0123456789
Email address: resource@domain.tld
Resource name: resource
The token used to paginate through the delegates associated with a resource.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The number of maximum results in a page.
" + } + } + }, + "ListResourceDelegatesResponse":{ + "type":"structure", + "members":{ + "Delegates":{ + "shape":"ResourceDelegates", + "documentation":"One page of the resource's delegates.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token used to paginate through the delegates associated with a resource. While results are still available, it has an associated value. When the last page is reached, the token is empty.
" + } + } + }, + "ListResourcesFilters":{ + "type":"structure", + "members":{ + "NamePrefix":{ + "shape":"String", + "documentation":"Filters only resource that start with the entered name prefix .
" + }, + "PrimaryEmailPrefix":{ + "shape":"String", + "documentation":"Filters only resource with the provided primary email prefix.
" + }, + "State":{ + "shape":"EntityState", + "documentation":"Filters only resource with the provided state.
" + } + }, + "documentation":"Filtering options for ListResources operation. This is only used as input to Operation.
" + }, + "ListResourcesRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization under which the resources exist.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The first call does not contain any tokens.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return in a single call.
" + }, + "Filters":{ + "shape":"ListResourcesFilters", + "documentation":"Limit the resource search results based on the filter criteria. You can only use one filter per request.
" + } + } + }, + "ListResourcesResponse":{ + "type":"structure", + "members":{ + "Resources":{ + "shape":"Resources", + "documentation":"One page of the organization's resource representation.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token used to paginate through all the organization's resources. While results are still available, it has an associated value. When the last page is reached, the token is empty.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"The resource ARN.
" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"A list of tag key-value pairs.
" + } + } + }, + "ListUsersFilters":{ + "type":"structure", + "members":{ + "UsernamePrefix":{ + "shape":"String", + "documentation":"Filters only users with the provided username prefix.
" + }, + "DisplayNamePrefix":{ + "shape":"UserAttribute", + "documentation":"Filters only users with the provided display name prefix.
" + }, + "PrimaryEmailPrefix":{ + "shape":"String", + "documentation":"Filters only users with the provided email prefix.
" + }, + "State":{ + "shape":"EntityState", + "documentation":"Filters only users with the provided state.
" + } + }, + "documentation":"Filtering options for ListUsers operation. This is only used as input to Operation.
" + }, + "ListUsersRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization under which the users exist.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. The first call does not contain any tokens.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return in a single call.
" + }, + "Filters":{ + "shape":"ListUsersFilters", + "documentation":"Limit the user search results based on the filter criteria. You can only use one filter per request.
" + } + } + }, + "ListUsersResponse":{ + "type":"structure", + "members":{ + "Users":{ + "shape":"Users", + "documentation":"The overview of users for an organization.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.
" + } + } + }, + "LogGroupArn":{ + "type":"string", + "max":562, + "min":47, + "pattern":"arn:aws:logs:[a-z\\-0-9]*:[0-9]{12}:log-group:([\\.\\-_/#A-Za-z0-9]+):\\*$" + }, + "MailDomainInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The domain you're trying to change is in use by another user or organization in your account. See the error message for details.
", + "exception":true + }, + "MailDomainNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The domain specified is not found in your organization.
", + "exception":true + }, + "MailDomainStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"After a domain has been added to the organization, it must be verified. The domain is not yet verified.
", + "exception":true + }, + "MailDomainSummary":{ + "type":"structure", + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"The domain name.
" + }, + "DefaultDomain":{ + "shape":"Boolean", + "documentation":"Whether the domain is default or not.
" + } + }, + "documentation":"The data for a given domain.
" + }, + "MailDomains":{ + "type":"list", + "member":{"shape":"MailDomainSummary"} + }, + "MailboxExportErrorInfo":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[\\S\\s]*" + }, + "MailboxExportJob":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"MailboxExportJobId", + "documentation":"The identifier of the mailbox export job.
" + }, + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"The identifier of the user or resource associated with the mailbox.
" + }, + "Description":{ + "shape":"Description", + "documentation":"The mailbox export job description.
" + }, + "S3BucketName":{ + "shape":"S3BucketName", + "documentation":"The name of the S3 bucket.
" + }, + "S3Path":{ + "shape":"S3ObjectKey", + "documentation":"The path to the S3 bucket and file that the mailbox export job exports to.
" + }, + "EstimatedProgress":{ + "shape":"Percentage", + "documentation":"The estimated progress of the mailbox export job, in percentage points.
" + }, + "State":{ + "shape":"MailboxExportJobState", + "documentation":"The state of the mailbox export job.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The mailbox export job start timestamp.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The mailbox export job end timestamp.
" + } + }, + "documentation":"The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.
" + }, + "MailboxExportJobId":{ + "type":"string", + "max":63, + "min":1, + "pattern":"[A-Za-z0-9-]+" + }, + "MailboxExportJobState":{ + "type":"string", + "enum":[ + "RUNNING", + "COMPLETED", + "FAILED", + "CANCELLED" + ] + }, + "MailboxQuota":{ + "type":"integer", + "box":true, + "min":1 + }, + "MailboxSize":{ + "type":"double", + "min":0 + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "Member":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"String", + "documentation":"The identifier of the member.
" + }, + "Name":{ + "shape":"String", + "documentation":"The name of the member.
" + }, + "Type":{ + "shape":"MemberType", + "documentation":"A member can be a user or group.
" + }, + "State":{ + "shape":"EntityState", + "documentation":"The state of the member, which can be ENABLED, DISABLED, or DELETED.
" + }, + "EnabledDate":{ + "shape":"Timestamp", + "documentation":"The date indicating when the member was enabled for WorkMail use.
" + }, + "DisabledDate":{ + "shape":"Timestamp", + "documentation":"The date indicating when the member was disabled from WorkMail use.
" + } + }, + "documentation":"The representation of a user or group.
" + }, + "MemberType":{ + "type":"string", + "enum":[ + "GROUP", + "USER" + ] + }, + "Members":{ + "type":"list", + "member":{"shape":"Member"} + }, + "MobileDeviceAccessMatchedRule":{ + "type":"structure", + "members":{ + "MobileDeviceAccessRuleId":{ + "shape":"MobileDeviceAccessRuleId", + "documentation":"Identifier of the rule that a simulated user matches.
" + }, + "Name":{ + "shape":"MobileDeviceAccessRuleName", + "documentation":"Name of a rule that a simulated user matches.
" + } + }, + "documentation":"The rule that a simulated user matches.
" + }, + "MobileDeviceAccessMatchedRuleList":{ + "type":"list", + "member":{"shape":"MobileDeviceAccessMatchedRule"}, + "max":10, + "min":0 + }, + "MobileDeviceAccessOverride":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"WorkMailIdentifier", + "documentation":"The WorkMail user to which the access override applies.
" + }, + "DeviceId":{ + "shape":"DeviceId", + "documentation":"The device to which the override applies.
" + }, + "Effect":{ + "shape":"MobileDeviceAccessRuleEffect", + "documentation":"The effect of the override, ALLOW or DENY.
A description of the override.
" + }, + "DateCreated":{ + "shape":"Timestamp", + "documentation":"The date the override was first created.
" + }, + "DateModified":{ + "shape":"Timestamp", + "documentation":"The date the override was last modified.
" + } + }, + "documentation":"The override object.
" + }, + "MobileDeviceAccessOverridesList":{ + "type":"list", + "member":{"shape":"MobileDeviceAccessOverride"} + }, + "MobileDeviceAccessRule":{ + "type":"structure", + "members":{ + "MobileDeviceAccessRuleId":{ + "shape":"MobileDeviceAccessRuleId", + "documentation":"The ID assigned to a mobile access rule.
" + }, + "Name":{ + "shape":"MobileDeviceAccessRuleName", + "documentation":"The name of a mobile access rule.
" + }, + "Description":{ + "shape":"MobileDeviceAccessRuleDescription", + "documentation":"The description of a mobile access rule.
" + }, + "Effect":{ + "shape":"MobileDeviceAccessRuleEffect", + "documentation":"The effect of the rule when it matches. Allowed values are ALLOW or DENY.
Device types that a rule will match.
" + }, + "NotDeviceTypes":{ + "shape":"DeviceTypeList", + "documentation":"Device types that a rule will not match. All other device types will match.
" + }, + "DeviceModels":{ + "shape":"DeviceModelList", + "documentation":"Device models that a rule will match.
" + }, + "NotDeviceModels":{ + "shape":"DeviceModelList", + "documentation":"Device models that a rule will not match. All other device models will match.
" + }, + "DeviceOperatingSystems":{ + "shape":"DeviceOperatingSystemList", + "documentation":"Device operating systems that a rule will match.
" + }, + "NotDeviceOperatingSystems":{ + "shape":"DeviceOperatingSystemList", + "documentation":"Device operating systems that a rule will not match. All other device types will match.
" + }, + "DeviceUserAgents":{ + "shape":"DeviceUserAgentList", + "documentation":"Device user agents that a rule will match.
" + }, + "NotDeviceUserAgents":{ + "shape":"DeviceUserAgentList", + "documentation":"Device user agents that a rule will not match. All other device user agents will match.
" + }, + "DateCreated":{ + "shape":"Timestamp", + "documentation":"The date and time at which an access rule was created.
" + }, + "DateModified":{ + "shape":"Timestamp", + "documentation":"The date and time at which an access rule was modified.
" + } + }, + "documentation":"A rule that controls access to mobile devices for an WorkMail group.
" + }, + "MobileDeviceAccessRuleDescription":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\S\\s]+" + }, + "MobileDeviceAccessRuleEffect":{ + "type":"string", + "enum":[ + "ALLOW", + "DENY" + ] + }, + "MobileDeviceAccessRuleId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "MobileDeviceAccessRuleName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\S\\s]+" + }, + "MobileDeviceAccessRulesList":{ + "type":"list", + "member":{"shape":"MobileDeviceAccessRule"}, + "max":10, + "min":0 + }, + "NameAvailabilityException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The user, group, or resource name isn't unique in WorkMail.
", + "exception":true + }, + "NewResourceDescription":{ + "type":"string", + "max":64, + "min":0 + }, + "NextToken":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[\\S\\s]*|[a-zA-Z0-9/+=]{1,1024}" + }, + "OrganizationId":{ + "type":"string", + "max":34, + "min":34, + "pattern":"^m-[0-9a-f]{32}$" + }, + "OrganizationName":{ + "type":"string", + "max":62, + "min":1, + "pattern":"^(?!d-)([\\da-zA-Z]+)([-][\\da-zA-Z]+)*" + }, + "OrganizationNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"An operation received a valid organization identifier that either doesn't belong or exist in the system.
", + "exception":true + }, + "OrganizationStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The organization must have a valid state to perform certain operations on the organization or its members.
", + "exception":true + }, + "OrganizationSummaries":{ + "type":"list", + "member":{"shape":"OrganizationSummary"} + }, + "OrganizationSummary":{ + "type":"structure", + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier associated with the organization.
" + }, + "Alias":{ + "shape":"OrganizationName", + "documentation":"The alias associated with the organization.
" + }, + "DefaultMailDomain":{ + "shape":"DomainName", + "documentation":"The default email domain associated with the organization.
" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"The error message associated with the organization. It is only present if unexpected behavior has occurred with regards to the organization. It provides insight or solutions regarding unexpected behavior.
" + }, + "State":{ + "shape":"String", + "documentation":"The state associated with the organization.
" + } + }, + "documentation":"The representation of an organization.
" + }, + "Password":{ + "type":"string", + "max":256, + "pattern":"[\\u0020-\\u00FF]+", + "sensitive":true + }, + "Percentage":{ + "type":"integer", + "max":100, + "min":0 + }, + "Permission":{ + "type":"structure", + "required":[ + "GranteeId", + "GranteeType", + "PermissionValues" + ], + "members":{ + "GranteeId":{ + "shape":"WorkMailIdentifier", + "documentation":"The identifier of the user, group, or resource to which the permissions are granted.
" + }, + "GranteeType":{ + "shape":"MemberType", + "documentation":"The type of user, group, or resource referred to in GranteeId.
" + }, + "PermissionValues":{ + "shape":"PermissionValues", + "documentation":"The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.
" + } + }, + "documentation":"Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.
" + }, + "PermissionType":{ + "type":"string", + "enum":[ + "FULL_ACCESS", + "SEND_AS", + "SEND_ON_BEHALF" + ] + }, + "PermissionValues":{ + "type":"list", + "member":{"shape":"PermissionType"} + }, + "Permissions":{ + "type":"list", + "member":{"shape":"Permission"} + }, + "PolicyDescription":{ + "type":"string", + "max":256, + "pattern":"[\\w\\d\\s\\S\\-!?=,.;:'_]+", + "sensitive":true + }, + "PutAccessControlRuleRequest":{ + "type":"structure", + "required":[ + "Name", + "Effect", + "Description", + "OrganizationId" + ], + "members":{ + "Name":{ + "shape":"AccessControlRuleName", + "documentation":"The rule name.
" + }, + "Effect":{ + "shape":"AccessControlRuleEffect", + "documentation":"The rule effect.
" + }, + "Description":{ + "shape":"AccessControlRuleDescription", + "documentation":"The rule description.
" + }, + "IpRanges":{ + "shape":"IpRangeList", + "documentation":"IPv4 CIDR ranges to include in the rule.
" + }, + "NotIpRanges":{ + "shape":"IpRangeList", + "documentation":"IPv4 CIDR ranges to exclude from the rule.
" + }, + "Actions":{ + "shape":"ActionsList", + "documentation":"Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
User IDs to include in the rule.
" + }, + "NotUserIds":{ + "shape":"UserIdList", + "documentation":"User IDs to exclude from the rule.
" + }, + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier of the organization.
" + }, + "ImpersonationRoleIds":{ + "shape":"ImpersonationRoleIdList", + "documentation":"Impersonation role IDs to include in the rule.
" + }, + "NotImpersonationRoleIds":{ + "shape":"ImpersonationRoleIdList", + "documentation":"Impersonation role IDs to exclude from the rule.
" + } + } + }, + "PutAccessControlRuleResponse":{ + "type":"structure", + "members":{ + } + }, + "PutEmailMonitoringConfigurationRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "RoleArn", + "LogGroupArn" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The ID of the organization for which the email monitoring configuration is set.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.
" + }, + "LogGroupArn":{ + "shape":"LogGroupArn", + "documentation":"The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.
" + } + } + }, + "PutEmailMonitoringConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "PutInboundDmarcSettingsRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "Enforced" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The ID of the organization that you are applying the DMARC policy to.
" + }, + "Enforced":{ + "shape":"BooleanObject", + "documentation":"Enforces or suspends a policy after it's applied.
" + } + } + }, + "PutInboundDmarcSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "PutMailboxPermissionsRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId", + "GranteeId", + "PermissionValues" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier of the organization under which the user, group, or resource exists.
" + }, + "EntityId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier of the user or resource for which to update mailbox permissions.
The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.
Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234
Email address: entity@domain.tld
Entity name: entity
The identifier of the user, group, or resource to which to grant the permissions.
The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.
Grantee ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234
Email address: grantee@domain.tld
Grantee name: grantee
The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.
" + } + } + }, + "PutMailboxPermissionsResponse":{ + "type":"structure", + "members":{ + } + }, + "PutMobileDeviceAccessOverrideRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "UserId", + "DeviceId", + "Effect" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"Identifies the WorkMail organization for which you create the override.
" + }, + "UserId":{ + "shape":"EntityIdentifier", + "documentation":"The WorkMail user for which you create the override. Accepts the following types of user identities:
User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: user@domain.tld
User name: user
The mobile device for which you create the override. DeviceId is case insensitive.
The effect of the override, ALLOW or DENY.
A description of the override.
" + } + } + }, + "PutMobileDeviceAccessOverrideResponse":{ + "type":"structure", + "members":{ + } + }, + "PutRetentionPolicyRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "Name", + "FolderConfigurations" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The organization ID.
" + }, + "Id":{ + "shape":"ShortString", + "documentation":"The retention policy ID.
" + }, + "Name":{ + "shape":"ShortString", + "documentation":"The retention policy name.
" + }, + "Description":{ + "shape":"PolicyDescription", + "documentation":"The retention policy description.
" + }, + "FolderConfigurations":{ + "shape":"FolderConfigurations", + "documentation":"The retention policy folder configurations.
" + } + } + }, + "PutRetentionPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "RedactedEwsAvailabilityProvider":{ + "type":"structure", + "members":{ + "EwsEndpoint":{ + "shape":"Url", + "documentation":"The endpoint of the remote EWS server.
" + }, + "EwsUsername":{ + "shape":"ExternalUserName", + "documentation":"The username used to authenticate the remote EWS server.
" + } + }, + "documentation":"Describes an EWS based availability provider when returned from the service. It does not contain the password of the endpoint.
" + }, + "RegisterMailDomainRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "DomainName" + ], + "members":{ + "ClientToken":{ + "shape":"IdempotencyClientToken", + "documentation":"Idempotency token used when retrying requests.
", + "idempotencyToken":true + }, + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization under which you're creating the domain.
" + }, + "DomainName":{ + "shape":"WorkMailDomainName", + "documentation":"The name of the mail domain to create in WorkMail and SES.
" + } + } + }, + "RegisterMailDomainResponse":{ + "type":"structure", + "members":{ + } + }, + "RegisterToWorkMailRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId", + "Email" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization under which the user, group, or resource exists.
" + }, + "EntityId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier for the user, group, or resource to be updated.
The identifier can accept UserId, ResourceId, or GroupId, or Username, Resourcename, or Groupname. The following identity formats are available:
Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234
Entity name: entity
The email for the user, group, or resource to be updated.
" + } + } + }, + "RegisterToWorkMailResponse":{ + "type":"structure", + "members":{ + } + }, + "ReservedNameException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"This user, group, or resource name is not allowed in WorkMail.
", + "exception":true + }, + "ResetPasswordRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "UserId", + "Password" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier of the organization that contains the user for which the password is reset.
" + }, + "UserId":{ + "shape":"WorkMailIdentifier", + "documentation":"The identifier of the user for whom the password is reset.
" + }, + "Password":{ + "shape":"Password", + "documentation":"The new password for the user.
" + } + } + }, + "ResetPasswordResponse":{ + "type":"structure", + "members":{ + } + }, + "Resource":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"WorkMailIdentifier", + "documentation":"The identifier of the resource.
" + }, + "Email":{ + "shape":"EmailAddress", + "documentation":"The email of the resource.
" + }, + "Name":{ + "shape":"ResourceName", + "documentation":"The name of the resource.
" + }, + "Type":{ + "shape":"ResourceType", + "documentation":"The type of the resource: equipment or room.
" + }, + "State":{ + "shape":"EntityState", + "documentation":"The state of the resource, which can be ENABLED, DISABLED, or DELETED.
" + }, + "EnabledDate":{ + "shape":"Timestamp", + "documentation":"The date indicating when the resource was enabled for WorkMail use.
" + }, + "DisabledDate":{ + "shape":"Timestamp", + "documentation":"The date indicating when the resource was disabled from WorkMail use.
" + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"Resource description.
" + } + }, + "documentation":"The representation of a resource.
" + }, + "ResourceDelegates":{ + "type":"list", + "member":{"shape":"Delegate"} + }, + "ResourceDescription":{ + "type":"string", + "max":64, + "min":1 + }, + "ResourceId":{ + "type":"string", + "max":34, + "min":34, + "pattern":"^r-[0-9a-f]{32}$" + }, + "ResourceName":{ + "type":"string", + "max":20, + "min":1, + "pattern":"[\\w\\-.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z0-9-]{2,})?" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The resource cannot be found.
", + "exception":true + }, + "ResourceType":{ + "type":"string", + "enum":[ + "ROOM", + "EQUIPMENT" + ] + }, + "Resources":{ + "type":"list", + "member":{"shape":"Resource"} + }, + "RetentionAction":{ + "type":"string", + "enum":[ + "NONE", + "DELETE", + "PERMANENTLY_DELETE" + ] + }, + "RetentionPeriod":{ + "type":"integer", + "box":true, + "max":730, + "min":1 + }, + "RoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws:iam:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}" + }, + "S3BucketName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"[A-Za-z0-9.-]+" + }, + "S3ObjectKey":{ + "type":"string", + "max":1023, + "min":1, + "pattern":"[A-Za-z0-9!_.*'()/-]+" + }, + "ShortString":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "StartMailboxExportJobRequest":{ + "type":"structure", + "required":[ + "ClientToken", + "OrganizationId", + "EntityId", + "RoleArn", + "KmsKeyArn", + "S3BucketName", + "S3Prefix" + ], + "members":{ + "ClientToken":{ + "shape":"IdempotencyClientToken", + "documentation":"The idempotency token for the client request.
", + "idempotencyToken":true + }, + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier associated with the organization.
" + }, + "EntityId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier of the user or resource associated with the mailbox.
The identifier can accept UserId or ResourceId, Username or Resourcename, or email. The following identity formats are available:
Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789 , or S-1-1-12-1234567890-123456789-123456789-1234
Email address: entity@domain.tld
Entity name: entity
The mailbox export job description.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
" + }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
" + }, + "S3BucketName":{ + "shape":"S3BucketName", + "documentation":"The name of the S3 bucket.
" + }, + "S3Prefix":{ + "shape":"S3ObjectKey", + "documentation":"The S3 bucket prefix.
" + } + } + }, + "StartMailboxExportJobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"MailboxExportJobId", + "documentation":"The job ID.
" + } + } + }, + "String":{ + "type":"string", + "max":256 + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"The key of the tag.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The value of the tag.
" + } + }, + "documentation":"Describes a tag applied to a resource.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":0 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"The resource ARN.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tag key-value pairs.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TargetUsers":{ + "type":"list", + "member":{"shape":"EntityIdentifier"}, + "max":10, + "min":1 + }, + "TestAvailabilityConfigurationRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization where the availability provider will be tested.
" + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"The domain to which the provider applies. If this field is provided, a stored availability provider associated to this domain name will be tested.
" + }, + "EwsProvider":{"shape":"EwsAvailabilityProvider"}, + "LambdaProvider":{"shape":"LambdaAvailabilityProvider"} + } + }, + "TestAvailabilityConfigurationResponse":{ + "type":"structure", + "members":{ + "TestPassed":{ + "shape":"Boolean", + "documentation":"Boolean indicating whether the test passed or failed.
" + }, + "FailureReason":{ + "shape":"String", + "documentation":"String containing the reason for a failed test if TestPassed is false.
The resource can have up to 50 user-applied tags.
", + "exception":true + }, + "UnsupportedOperationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"You can't perform a write operation against a read-only directory.
", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"The resource ARN.
" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"The tag keys.
" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateAvailabilityConfigurationRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "DomainName" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization for which the AvailabilityConfiguration will be updated.
The domain to which the provider applies the availability configuration.
" + }, + "EwsProvider":{ + "shape":"EwsAvailabilityProvider", + "documentation":"The EWS availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider. The previously stored provider will be overridden by the one provided.
The Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider. The previously stored provider will be overridden by the one provided.
The WorkMail organization for which to list domains.
" + }, + "DomainName":{ + "shape":"WorkMailDomainName", + "documentation":"The domain name that will become the default domain.
" + } + } + }, + "UpdateDefaultMailDomainResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateGroupRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "GroupId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization under which the group exists.
" + }, + "GroupId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier for the group to be updated.
The identifier can accept GroupId, Groupname, or email. The following identity formats are available:
Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: group@domain.tld
Group name: group
If enabled, the group is hidden from the global address list.
" + } + } + }, + "UpdateGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateImpersonationRoleRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "ImpersonationRoleId", + "Name", + "Type", + "Rules" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization that contains the impersonation role to update.
" + }, + "ImpersonationRoleId":{ + "shape":"ImpersonationRoleId", + "documentation":"The ID of the impersonation role to update.
" + }, + "Name":{ + "shape":"ImpersonationRoleName", + "documentation":"The updated impersonation role name.
" + }, + "Type":{ + "shape":"ImpersonationRoleType", + "documentation":"The updated impersonation role type.
" + }, + "Description":{ + "shape":"ImpersonationRoleDescription", + "documentation":"The updated impersonation role description.
" + }, + "Rules":{ + "shape":"ImpersonationRuleList", + "documentation":"The updated list of rules.
" + } + } + }, + "UpdateImpersonationRoleResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateMailboxQuotaRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "UserId", + "MailboxQuota" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization that contains the user for whom to update the mailbox quota.
" + }, + "UserId":{ + "shape":"EntityIdentifier", + "documentation":"The identifer for the user for whom to update the mailbox quota.
The identifier can be the UserId, Username, or email. The following identity formats are available:
User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: user@domain.tld
User name: user
The updated mailbox quota, in MB, for the specified user.
" + } + } + }, + "UpdateMailboxQuotaResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateMobileDeviceAccessRuleRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "MobileDeviceAccessRuleId", + "Name", + "Effect" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The WorkMail organization under which the rule will be updated.
" + }, + "MobileDeviceAccessRuleId":{ + "shape":"MobileDeviceAccessRuleId", + "documentation":"The identifier of the rule to be updated.
" + }, + "Name":{ + "shape":"MobileDeviceAccessRuleName", + "documentation":"The updated rule name.
" + }, + "Description":{ + "shape":"MobileDeviceAccessRuleDescription", + "documentation":"The updated rule description.
" + }, + "Effect":{ + "shape":"MobileDeviceAccessRuleEffect", + "documentation":"The effect of the rule when it matches. Allowed values are ALLOW or DENY.
Device types that the updated rule will match.
" + }, + "NotDeviceTypes":{ + "shape":"DeviceTypeList", + "documentation":"Device types that the updated rule will not match. All other device types will match.
" + }, + "DeviceModels":{ + "shape":"DeviceModelList", + "documentation":"Device models that the updated rule will match.
" + }, + "NotDeviceModels":{ + "shape":"DeviceModelList", + "documentation":"Device models that the updated rule will not match. All other device models will match.
" + }, + "DeviceOperatingSystems":{ + "shape":"DeviceOperatingSystemList", + "documentation":"Device operating systems that the updated rule will match.
" + }, + "NotDeviceOperatingSystems":{ + "shape":"DeviceOperatingSystemList", + "documentation":"Device operating systems that the updated rule will not match. All other device operating systems will match.
" + }, + "DeviceUserAgents":{ + "shape":"DeviceUserAgentList", + "documentation":"User agents that the updated rule will match.
" + }, + "NotDeviceUserAgents":{ + "shape":"DeviceUserAgentList", + "documentation":"User agents that the updated rule will not match. All other user agents will match.
" + } + } + }, + "UpdateMobileDeviceAccessRuleResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdatePrimaryEmailAddressRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId", + "Email" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The organization that contains the user, group, or resource to update.
" + }, + "EntityId":{ + "shape":"EntityIdentifier", + "documentation":"The user, group, or resource to update.
The identifier can accept UseriD, ResourceId, or GroupId, Username, Resourcename, or Groupname, or email. The following identity formats are available:
Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234
Email address: entity@domain.tld
Entity name: entity
The value of the email to be updated as primary.
" + } + } + }, + "UpdatePrimaryEmailAddressResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateResourceRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "ResourceId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier associated with the organization for which the resource is updated.
" + }, + "ResourceId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier of the resource to be updated.
The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:
Resource ID: r-0123456789a0123456789b0123456789
Email address: resource@domain.tld
Resource name: resource
The name of the resource to be updated.
" + }, + "BookingOptions":{ + "shape":"BookingOptions", + "documentation":"The resource's booking options to be updated.
" + }, + "Description":{ + "shape":"NewResourceDescription", + "documentation":"Updates the resource description.
" + }, + "Type":{ + "shape":"ResourceType", + "documentation":"Updates the resource type.
" + }, + "HiddenFromGlobalAddressList":{ + "shape":"BooleanObject", + "documentation":"If enabled, the resource is hidden from the global address list.
" + } + } + }, + "UpdateResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateUserRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "UserId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The identifier for the organization under which the user exists.
" + }, + "UserId":{ + "shape":"EntityIdentifier", + "documentation":"The identifier for the user to be updated.
The identifier can be the UserId, Username, or email. The following identity formats are available:
User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: user@domain.tld
User name: user
Updates the user role.
You cannot pass SYSTEM_USER or RESOURCE.
" + }, + "DisplayName":{ + "shape":"UserAttribute", + "documentation":"Updates the display name of the user.
" + }, + "FirstName":{ + "shape":"UserAttribute", + "documentation":"Updates the user's first name.
" + }, + "LastName":{ + "shape":"UserAttribute", + "documentation":"Updates the user's last name.
" + }, + "HiddenFromGlobalAddressList":{ + "shape":"BooleanObject", + "documentation":"If enabled, the user is hidden from the global address list.
" + }, + "Initials":{ + "shape":"UserAttribute", + "documentation":"Updates the user's initials.
" + }, + "Telephone":{ + "shape":"UserAttribute", + "documentation":"Updates the user's contact details.
" + }, + "Street":{ + "shape":"UserAttribute", + "documentation":"Updates the user's street address.
" + }, + "JobTitle":{ + "shape":"UserAttribute", + "documentation":"Updates the user's job title.
" + }, + "City":{ + "shape":"UserAttribute", + "documentation":"Updates the user's city.
" + }, + "Company":{ + "shape":"UserAttribute", + "documentation":"Updates the user's company.
" + }, + "ZipCode":{ + "shape":"UserAttribute", + "documentation":"Updates the user's zipcode.
" + }, + "Department":{ + "shape":"UserAttribute", + "documentation":"Updates the user's department.
" + }, + "Country":{ + "shape":"UserAttribute", + "documentation":"Updates the user's country.
" + }, + "Office":{ + "shape":"UserAttribute", + "documentation":"Updates the user's office.
" + } + } + }, + "UpdateUserResponse":{ + "type":"structure", + "members":{ + } + }, + "Url":{ + "type":"string", + "max":256, + "pattern":"https?://[A-Za-z0-9.-]+(:[0-9]+)?/.*" + }, + "User":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"WorkMailIdentifier", + "documentation":"The identifier of the user.
" + }, + "Email":{ + "shape":"EmailAddress", + "documentation":"The email of the user.
" + }, + "Name":{ + "shape":"UserName", + "documentation":"The name of the user.
" + }, + "DisplayName":{ + "shape":"String", + "documentation":"The display name of the user.
" + }, + "State":{ + "shape":"EntityState", + "documentation":"The state of the user, which can be ENABLED, DISABLED, or DELETED.
" + }, + "UserRole":{ + "shape":"UserRole", + "documentation":"The role of the user.
" + }, + "EnabledDate":{ + "shape":"Timestamp", + "documentation":"The date indicating when the user was enabled for WorkMail use.
" + }, + "DisabledDate":{ + "shape":"Timestamp", + "documentation":"The date indicating when the user was disabled from WorkMail use.
" + } + }, + "documentation":"The representation of an WorkMail user.
" + }, + "UserAttribute":{ + "type":"string", + "max":256, + "sensitive":true + }, + "UserIdList":{ + "type":"list", + "member":{"shape":"WorkMailIdentifier"}, + "max":10, + "min":0 + }, + "UserName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\w\\-.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z0-9-]{2,})?" + }, + "UserRole":{ + "type":"string", + "enum":[ + "USER", + "RESOURCE", + "SYSTEM_USER", + "REMOTE_USER" + ] + }, + "Users":{ + "type":"list", + "member":{"shape":"User"} + }, + "WorkMailDomainName":{ + "type":"string", + "max":209, + "min":3, + "pattern":"[a-zA-Z0-9.-]+" + }, + "WorkMailIdentifier":{ + "type":"string", + "max":256, + "min":12 + } + }, + "documentation":"WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.
The WorkMail API is designed for the following scenarios:
Listing and describing organizations
Managing users
Managing groups
Managing resources
All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.
" +} diff --git a/testbed/boto__botocore/botocore/data/workmailmessageflow/2019-05-01/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/workmailmessageflow/2019-05-01/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..6aedb56843598e98dba2331548d7ed3ff3d1833d --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workmailmessageflow/2019-05-01/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://workmailmessageflow-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://workmailmessageflow-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://workmailmessageflow.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://workmailmessageflow.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/workmailmessageflow/2019-05-01/examples-1.json b/testbed/boto__botocore/botocore/data/workmailmessageflow/2019-05-01/examples-1.json new file mode 100644 index 0000000000000000000000000000000000000000..0ea7e3b0bbe917eb027880396ac01509becd1fa0 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workmailmessageflow/2019-05-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/testbed/boto__botocore/botocore/data/workmailmessageflow/2019-05-01/paginators-1.json b/testbed/boto__botocore/botocore/data/workmailmessageflow/2019-05-01/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..ea142457a6a77d6e6a54942329f1199bc2f2a60c --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workmailmessageflow/2019-05-01/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/testbed/boto__botocore/botocore/data/workmailmessageflow/2019-05-01/service-2.json b/testbed/boto__botocore/botocore/data/workmailmessageflow/2019-05-01/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..aa8aef0754c5d2acaefb55b65b3256fb8bf8aa0e --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workmailmessageflow/2019-05-01/service-2.json @@ -0,0 +1,189 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2019-05-01", + "endpointPrefix":"workmailmessageflow", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon WorkMail Message Flow", + "serviceId":"WorkMailMessageFlow", + "signatureVersion":"v4", + "uid":"workmailmessageflow-2019-05-01" + }, + "operations":{ + "GetRawMessageContent":{ + "name":"GetRawMessageContent", + "http":{ + "method":"GET", + "requestUri":"/messages/{messageId}" + }, + "input":{"shape":"GetRawMessageContentRequest"}, + "output":{"shape":"GetRawMessageContentResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves the raw content of an in-transit email message, in MIME format.
" + }, + "PutRawMessageContent":{ + "name":"PutRawMessageContent", + "http":{ + "method":"POST", + "requestUri":"/messages/{messageId}" + }, + "input":{"shape":"PutRawMessageContentRequest"}, + "output":{"shape":"PutRawMessageContentResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidContentLocation"}, + {"shape":"MessageRejected"}, + {"shape":"MessageFrozen"} + ], + "documentation":"Updates the raw content of an in-transit email message, in MIME format.
This example describes how to update in-transit email message. For more information and examples for using this API, see Updating message content with AWS Lambda.
Updates to an in-transit message only appear when you call PutRawMessageContent from an AWS Lambda function configured with a synchronous Run Lambda rule. If you call PutRawMessageContent on a delivered or sent message, the message remains unchanged, even though GetRawMessageContent returns an updated message.
The identifier of the email message to retrieve.
", + "location":"uri", + "locationName":"messageId" + } + } + }, + "GetRawMessageContentResponse":{ + "type":"structure", + "required":["messageContent"], + "members":{ + "messageContent":{ + "shape":"messageContentBlob", + "documentation":"The raw content of the email message, in MIME format.
" + } + }, + "payload":"messageContent" + }, + "InvalidContentLocation":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"WorkMail could not access the updated email content. Possible reasons:
You made the request in a region other than your S3 bucket region.
The S3 bucket owner is not the same as the calling AWS account.
You have an incomplete or missing S3 bucket policy. For more information about policies, see Updating message content with AWS Lambda in the WorkMail Administrator Guide.
The requested email is not eligible for update. This is usually the case for a redirected email.
", + "exception":true + }, + "MessageRejected":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"The requested email could not be updated due to an error in the MIME content. Check the error message for more information about what caused the error.
", + "exception":true + }, + "PutRawMessageContentRequest":{ + "type":"structure", + "required":[ + "messageId", + "content" + ], + "members":{ + "messageId":{ + "shape":"messageIdType", + "documentation":"The identifier of the email message being updated.
", + "location":"uri", + "locationName":"messageId" + }, + "content":{ + "shape":"RawMessageContent", + "documentation":"Describes the raw message content of the updated email message.
" + } + } + }, + "PutRawMessageContentResponse":{ + "type":"structure", + "members":{ + } + }, + "RawMessageContent":{ + "type":"structure", + "required":["s3Reference"], + "members":{ + "s3Reference":{ + "shape":"S3Reference", + "documentation":"The S3 reference of an email message.
" + } + }, + "documentation":"Provides the MIME content of the updated email message as an S3 object. All MIME content must meet the following criteria:
Each part of a multipart MIME message must be formatted properly.
Attachments must be of a content type that Amazon SES supports. For more information, see Unsupported Attachment Types.
If any of the MIME parts in a message contain content that is outside of the 7-bit ASCII character range, we recommend encoding that content.
Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.
The message must contain all the required header fields. Check the returned error message for more information.
The value of immutable headers must remain unchanged. Check the returned error message for more information.
Certain unique headers can only appear once. Check the returned error message for more information.
The requested email message is not found.
", + "error":{"httpStatusCode":404}, + "exception":true + }, + "S3Reference":{ + "type":"structure", + "required":[ + "bucket", + "key" + ], + "members":{ + "bucket":{ + "shape":"s3BucketIdType", + "documentation":"The S3 bucket name.
" + }, + "key":{ + "shape":"s3KeyIdType", + "documentation":"The S3 key object name.
" + }, + "objectVersion":{ + "shape":"s3VersionType", + "documentation":"If you enable versioning for the bucket, you can specify the object version.
" + } + }, + "documentation":"Amazon S3 object representing the updated message content, in MIME format.
The region for the S3 bucket containing the S3 object must match the region used for WorkMail operations. Also, for WorkMail to process an S3 object, it must have permission to access that object. For more information, see Updating message content with AWS Lambda.
The WorkMail Message Flow API provides access to email messages as they are being sent and received by a WorkMail organization.
" +} diff --git a/testbed/boto__botocore/botocore/data/workspaces-thin-client/2023-08-22/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/workspaces-thin-client/2023-08-22/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..e2a675a5752af0bbe609ba7237dbfbb5ad3a5b8d --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workspaces-thin-client/2023-08-22/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://thinclient-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://thinclient-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://thinclient.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://thinclient.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/workspaces-thin-client/2023-08-22/paginators-1.json b/testbed/boto__botocore/botocore/data/workspaces-thin-client/2023-08-22/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..9fe21a485705afb8fb5346c56eea58ad5918abfe --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workspaces-thin-client/2023-08-22/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListDevices": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "devices" + }, + "ListEnvironments": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "environments" + }, + "ListSoftwareSets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "softwareSets" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/workspaces-thin-client/2023-08-22/service-2.json b/testbed/boto__botocore/botocore/data/workspaces-thin-client/2023-08-22/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..0442a76e609febef16e006a7896a7c21f5bf9885 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workspaces-thin-client/2023-08-22/service-2.json @@ -0,0 +1,1638 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2023-08-22", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"thinclient", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"Amazon WorkSpaces Thin Client", + "serviceId":"WorkSpaces Thin Client", + "signatureVersion":"v4", + "signingName":"thinclient", + "uid":"workspaces-thin-client-2023-08-22" + }, + "operations":{ + "CreateEnvironment":{ + "name":"CreateEnvironment", + "http":{ + "method":"POST", + "requestUri":"/environments", + "responseCode":201 + }, + "input":{"shape":"CreateEnvironmentRequest"}, + "output":{"shape":"CreateEnvironmentResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates an environment for your thin client devices.
", + "endpoint":{"hostPrefix":"api."} + }, + "DeleteDevice":{ + "name":"DeleteDevice", + "http":{ + "method":"DELETE", + "requestUri":"/devices/{id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDeviceRequest"}, + "output":{"shape":"DeleteDeviceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes a thin client device.
", + "endpoint":{"hostPrefix":"api."}, + "idempotent":true + }, + "DeleteEnvironment":{ + "name":"DeleteEnvironment", + "http":{ + "method":"DELETE", + "requestUri":"/environments/{id}", + "responseCode":204 + }, + "input":{"shape":"DeleteEnvironmentRequest"}, + "output":{"shape":"DeleteEnvironmentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes an environment.
", + "endpoint":{"hostPrefix":"api."}, + "idempotent":true + }, + "DeregisterDevice":{ + "name":"DeregisterDevice", + "http":{ + "method":"POST", + "requestUri":"/deregister-device/{id}", + "responseCode":202 + }, + "input":{"shape":"DeregisterDeviceRequest"}, + "output":{"shape":"DeregisterDeviceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deregisters a thin client device.
", + "endpoint":{"hostPrefix":"api."}, + "idempotent":true + }, + "GetDevice":{ + "name":"GetDevice", + "http":{ + "method":"GET", + "requestUri":"/devices/{id}", + "responseCode":200 + }, + "input":{"shape":"GetDeviceRequest"}, + "output":{"shape":"GetDeviceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns information for a thin client device.
", + "endpoint":{"hostPrefix":"api."} + }, + "GetEnvironment":{ + "name":"GetEnvironment", + "http":{ + "method":"GET", + "requestUri":"/environments/{id}", + "responseCode":200 + }, + "input":{"shape":"GetEnvironmentRequest"}, + "output":{"shape":"GetEnvironmentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns information for an environment.
", + "endpoint":{"hostPrefix":"api."} + }, + "GetSoftwareSet":{ + "name":"GetSoftwareSet", + "http":{ + "method":"GET", + "requestUri":"/softwaresets/{id}", + "responseCode":200 + }, + "input":{"shape":"GetSoftwareSetRequest"}, + "output":{"shape":"GetSoftwareSetResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns information for a software set.
", + "endpoint":{"hostPrefix":"api."} + }, + "ListDevices":{ + "name":"ListDevices", + "http":{ + "method":"GET", + "requestUri":"/devices", + "responseCode":200 + }, + "input":{"shape":"ListDevicesRequest"}, + "output":{"shape":"ListDevicesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns a list of thin client devices.
", + "endpoint":{"hostPrefix":"api."} + }, + "ListEnvironments":{ + "name":"ListEnvironments", + "http":{ + "method":"GET", + "requestUri":"/environments", + "responseCode":200 + }, + "input":{"shape":"ListEnvironmentsRequest"}, + "output":{"shape":"ListEnvironmentsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns a list of environments.
", + "endpoint":{"hostPrefix":"api."} + }, + "ListSoftwareSets":{ + "name":"ListSoftwareSets", + "http":{ + "method":"GET", + "requestUri":"/softwaresets", + "responseCode":200 + }, + "input":{"shape":"ListSoftwareSetsRequest"}, + "output":{"shape":"ListSoftwareSetsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns a list of software sets.
", + "endpoint":{"hostPrefix":"api."} + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns a list of tags for a resource.
", + "endpoint":{"hostPrefix":"api."} + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Assigns one or more tags (key-value pairs) to the specified resource.
", + "endpoint":{"hostPrefix":"api."} + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Removes a tag or tags from a resource.
", + "endpoint":{"hostPrefix":"api."}, + "idempotent":true + }, + "UpdateDevice":{ + "name":"UpdateDevice", + "http":{ + "method":"PATCH", + "requestUri":"/devices/{id}", + "responseCode":200 + }, + "input":{"shape":"UpdateDeviceRequest"}, + "output":{"shape":"UpdateDeviceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates a thin client device.
", + "endpoint":{"hostPrefix":"api."}, + "idempotent":true + }, + "UpdateEnvironment":{ + "name":"UpdateEnvironment", + "http":{ + "method":"PATCH", + "requestUri":"/environments/{id}", + "responseCode":200 + }, + "input":{"shape":"UpdateEnvironmentRequest"}, + "output":{"shape":"UpdateEnvironmentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates an environment.
", + "endpoint":{"hostPrefix":"api."}, + "idempotent":true + }, + "UpdateSoftwareSet":{ + "name":"UpdateSoftwareSet", + "http":{ + "method":"PATCH", + "requestUri":"/softwaresets/{id}", + "responseCode":204 + }, + "input":{"shape":"UpdateSoftwareSetRequest"}, + "output":{"shape":"UpdateSoftwareSetResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates a software set.
", + "endpoint":{"hostPrefix":"api."}, + "idempotent":true + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "ActivationCode":{ + "type":"string", + "pattern":"[a-z]{2}[a-z0-9]{6}" + }, + "ApplyTimeOf":{ + "type":"string", + "enum":[ + "UTC", + "DEVICE" + ] + }, + "Arn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[0-9]{0,12}:[a-zA-Z0-9\\-\\/\\._]+" + }, + "ClientToken":{ + "type":"string", + "max":512, + "min":1 + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "resourceId":{ + "shape":"ResourceId", + "documentation":"The ID of the resource associated with the request.
" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"The type of the resource associated with the request.
" + } + }, + "documentation":"The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateEnvironmentRequest":{ + "type":"structure", + "required":["desktopArn"], + "members":{ + "name":{ + "shape":"EnvironmentName", + "documentation":"The name for the environment.
" + }, + "desktopArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
" + }, + "desktopEndpoint":{ + "shape":"DesktopEndpoint", + "documentation":"The URL for the identity provider login (only for environments that use AppStream 2.0).
" + }, + "softwareSetUpdateSchedule":{ + "shape":"SoftwareSetUpdateSchedule", + "documentation":"An option to define if software updates should be applied within a maintenance window.
" + }, + "maintenanceWindow":{ + "shape":"MaintenanceWindow", + "documentation":"A specification for a time window to apply software updates.
" + }, + "softwareSetUpdateMode":{ + "shape":"SoftwareSetUpdateMode", + "documentation":"An option to define which software updates to apply.
" + }, + "desiredSoftwareSetId":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set to apply.
" + }, + "kmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
A map of the key-value pairs of the tag or tags to assign to the resource.
" + }, + "deviceCreationTags":{ + "shape":"DeviceCreationTagsMap", + "documentation":"A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
" + } + } + }, + "CreateEnvironmentResponse":{ + "type":"structure", + "members":{ + "environment":{ + "shape":"EnvironmentSummary", + "documentation":"Describes an environment.
" + } + } + }, + "DayOfWeek":{ + "type":"string", + "enum":[ + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ] + }, + "DayOfWeekList":{ + "type":"list", + "member":{"shape":"DayOfWeek"}, + "max":7, + "min":1 + }, + "DeleteDeviceRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"DeviceId", + "documentation":"The ID of the device to delete.
", + "location":"uri", + "locationName":"id" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The ID of the environment to delete.
", + "location":"uri", + "locationName":"id" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The ID of the device to deregister.
", + "location":"uri", + "locationName":"id" + }, + "targetDeviceStatus":{ + "shape":"TargetDeviceStatus", + "documentation":"The desired new status for the device.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The ID of the device.
" + }, + "serialNumber":{ + "shape":"String", + "documentation":"The hardware serial number of the device.
" + }, + "name":{ + "shape":"DeviceName", + "documentation":"The name of the device.
" + }, + "model":{ + "shape":"String", + "documentation":"The model number of the device.
" + }, + "environmentId":{ + "shape":"EnvironmentId", + "documentation":"The ID of the environment the device is associated with.
" + }, + "status":{ + "shape":"DeviceStatus", + "documentation":"The status of the device.
" + }, + "currentSoftwareSetId":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set currently installed on the device.
" + }, + "currentSoftwareSetVersion":{ + "shape":"String", + "documentation":"The version of the software set currently installed on the device.
" + }, + "desiredSoftwareSetId":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set which the device has been set to.
" + }, + "pendingSoftwareSetId":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set that is pending to be installed on the device.
" + }, + "pendingSoftwareSetVersion":{ + "shape":"String", + "documentation":"The version of the software set that is pending to be installed on the device.
" + }, + "softwareSetUpdateSchedule":{ + "shape":"SoftwareSetUpdateSchedule", + "documentation":"An option to define if software updates should be applied within a maintenance window.
" + }, + "softwareSetComplianceStatus":{ + "shape":"DeviceSoftwareSetComplianceStatus", + "documentation":"Describes if the software currently installed on the device is a supported version.
" + }, + "softwareSetUpdateStatus":{ + "shape":"SoftwareSetUpdateStatus", + "documentation":"Describes if the device has a supported version of software installed.
" + }, + "lastConnectedAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of the most recent session on the device.
" + }, + "lastPostureAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of the most recent check-in of the device.
" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the device was created.
" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the device was updated.
" + }, + "arn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the device.
" + }, + "kmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the device.
" + }, + "tags":{ + "shape":"TagsMap", + "documentation":"The tag keys and optional values for the resource.
" + } + }, + "documentation":"Describes a thin client device.
" + }, + "DeviceCreationTagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"(?!aws:)[A-Za-z0-9 _=@:.+-/]+" + }, + "DeviceCreationTagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"[A-Za-z0-9 _=@:.+-/]+" + }, + "DeviceCreationTagsMap":{ + "type":"map", + "key":{"shape":"DeviceCreationTagKey"}, + "value":{"shape":"DeviceCreationTagValue"}, + "max":50, + "min":0, + "sensitive":true + }, + "DeviceId":{ + "type":"string", + "pattern":"[a-zA-Z0-9]{24}" + }, + "DeviceList":{ + "type":"list", + "member":{"shape":"DeviceSummary"} + }, + "DeviceName":{ + "type":"string", + "pattern":"[0-9\\p{IsAlphabetic}+:,.@'\" -]{1,64}", + "sensitive":true + }, + "DeviceSoftwareSetComplianceStatus":{ + "type":"string", + "enum":[ + "NONE", + "COMPLIANT", + "NOT_COMPLIANT" + ] + }, + "DeviceStatus":{ + "type":"string", + "enum":[ + "REGISTERED", + "DEREGISTERING", + "DEREGISTERED", + "ARCHIVED" + ] + }, + "DeviceSummary":{ + "type":"structure", + "members":{ + "id":{ + "shape":"DeviceId", + "documentation":"The ID of the device.
" + }, + "serialNumber":{ + "shape":"String", + "documentation":"The hardware serial number of the device.
" + }, + "name":{ + "shape":"DeviceName", + "documentation":"The name of the device.
" + }, + "model":{ + "shape":"String", + "documentation":"The model number of the device.
" + }, + "environmentId":{ + "shape":"EnvironmentId", + "documentation":"The ID of the environment the device is associated with.
" + }, + "status":{ + "shape":"DeviceStatus", + "documentation":"The status of the device.
" + }, + "currentSoftwareSetId":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set currently installed on the device.
" + }, + "desiredSoftwareSetId":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set which the device has been set to.
" + }, + "pendingSoftwareSetId":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set that is pending to be installed on the device.
" + }, + "softwareSetUpdateSchedule":{ + "shape":"SoftwareSetUpdateSchedule", + "documentation":"An option to define if software updates should be applied within a maintenance window.
" + }, + "lastConnectedAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of the most recent session on the device.
" + }, + "lastPostureAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of the most recent check-in of the device.
" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the device was created.
" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the device was updated.
" + }, + "arn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the device.
" + } + }, + "documentation":"Describes a thin client device.
" + }, + "Environment":{ + "type":"structure", + "members":{ + "id":{ + "shape":"EnvironmentId", + "documentation":"The ID of the environment.
" + }, + "name":{ + "shape":"EnvironmentName", + "documentation":"The name of the environment.
" + }, + "desktopArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
" + }, + "desktopEndpoint":{ + "shape":"DesktopEndpoint", + "documentation":"The URL for the identity provider login (only for environments that use AppStream 2.0).
" + }, + "desktopType":{ + "shape":"DesktopType", + "documentation":"The type of streaming desktop for the environment.
" + }, + "activationCode":{ + "shape":"ActivationCode", + "documentation":"The activation code to register a device to the environment.
" + }, + "registeredDevicesCount":{ + "shape":"Integer", + "documentation":"The number of devices registered to the environment.
" + }, + "softwareSetUpdateSchedule":{ + "shape":"SoftwareSetUpdateSchedule", + "documentation":"An option to define if software updates should be applied within a maintenance window.
" + }, + "maintenanceWindow":{ + "shape":"MaintenanceWindow", + "documentation":"A specification for a time window to apply software updates.
" + }, + "softwareSetUpdateMode":{ + "shape":"SoftwareSetUpdateMode", + "documentation":"An option to define which software updates to apply.
" + }, + "desiredSoftwareSetId":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set to apply.
" + }, + "pendingSoftwareSetId":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set that is pending to be installed.
" + }, + "pendingSoftwareSetVersion":{ + "shape":"String", + "documentation":"The version of the software set that is pending to be installed.
" + }, + "softwareSetComplianceStatus":{ + "shape":"EnvironmentSoftwareSetComplianceStatus", + "documentation":"Describes if the software currently installed on all devices in the environment is a supported version.
" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the environment was created.
" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the device was updated.
" + }, + "arn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the environment.
" + }, + "kmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the environment.
" + }, + "tags":{ + "shape":"TagsMap", + "documentation":"The tag keys and optional values for the resource.
" + }, + "deviceCreationTags":{ + "shape":"DeviceCreationTagsMap", + "documentation":"The tag keys and optional values for the newly created devices for this environment.
" + } + }, + "documentation":"Describes an environment.
" + }, + "EnvironmentId":{ + "type":"string", + "pattern":"[a-z0-9]{9}" + }, + "EnvironmentList":{ + "type":"list", + "member":{"shape":"EnvironmentSummary"} + }, + "EnvironmentName":{ + "type":"string", + "pattern":"[0-9\\p{IsAlphabetic}+:,.@'\" -][0-9\\p{IsAlphabetic}+=:,.@'\" -]{0,63}", + "sensitive":true + }, + "EnvironmentSoftwareSetComplianceStatus":{ + "type":"string", + "enum":[ + "NO_REGISTERED_DEVICES", + "COMPLIANT", + "NOT_COMPLIANT" + ] + }, + "EnvironmentSummary":{ + "type":"structure", + "members":{ + "id":{ + "shape":"EnvironmentId", + "documentation":"The ID of the environment.
" + }, + "name":{ + "shape":"EnvironmentName", + "documentation":"The name of the environment.
" + }, + "desktopArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
" + }, + "desktopEndpoint":{ + "shape":"DesktopEndpoint", + "documentation":"The URL for the identity provider login (only for environments that use AppStream 2.0).
" + }, + "desktopType":{ + "shape":"DesktopType", + "documentation":"The type of streaming desktop for the environment.
" + }, + "activationCode":{ + "shape":"ActivationCode", + "documentation":"The activation code to register a device to the environment.
" + }, + "softwareSetUpdateSchedule":{ + "shape":"SoftwareSetUpdateSchedule", + "documentation":"An option to define if software updates should be applied within a maintenance window.
" + }, + "maintenanceWindow":{ + "shape":"MaintenanceWindow", + "documentation":"A specification for a time window to apply software updates.
" + }, + "softwareSetUpdateMode":{ + "shape":"SoftwareSetUpdateMode", + "documentation":"An option to define which software updates to apply.
" + }, + "desiredSoftwareSetId":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set to apply.
" + }, + "pendingSoftwareSetId":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set that is pending to be installed.
" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the environment was created.
" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the device was updated.
" + }, + "arn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the environment.
" + } + }, + "documentation":"Describes an environment.
" + }, + "ExceptionMessage":{"type":"string"}, + "FieldName":{"type":"string"}, + "GetDeviceRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"DeviceId", + "documentation":"The ID of the device for which to return information.
", + "location":"uri", + "locationName":"id" + } + } + }, + "GetDeviceResponse":{ + "type":"structure", + "members":{ + "device":{ + "shape":"Device", + "documentation":"Describes an device.
" + } + } + }, + "GetEnvironmentRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"EnvironmentId", + "documentation":"The ID of the environment for which to return information.
", + "location":"uri", + "locationName":"id" + } + } + }, + "GetEnvironmentResponse":{ + "type":"structure", + "members":{ + "environment":{ + "shape":"Environment", + "documentation":"Describes an environment.
" + } + } + }, + "GetSoftwareSetRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set for which to return information.
", + "location":"uri", + "locationName":"id" + } + } + }, + "GetSoftwareSetResponse":{ + "type":"structure", + "members":{ + "softwareSet":{ + "shape":"SoftwareSet", + "documentation":"Describes a software set.
" + } + } + }, + "Hour":{ + "type":"integer", + "box":true, + "max":23, + "min":0 + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "retryAfterSeconds":{ + "shape":"RetryAfterSeconds", + "documentation":"The number of seconds to wait before retrying the next request.
", + "location":"header", + "locationName":"Retry-After" + } + }, + "documentation":"The server encountered an internal error and is unable to complete the request.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "KmsKeyArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[0-9]{0,12}:key\\/[a-zA-Z0-9-]+" + }, + "ListDevicesRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListDevicesResponse":{ + "type":"structure", + "members":{ + "devices":{ + "shape":"DeviceList", + "documentation":"Describes devices.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListEnvironmentsResponse":{ + "type":"structure", + "members":{ + "environments":{ + "shape":"EnvironmentList", + "documentation":"Describes environments.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListSoftwareSetsResponse":{ + "type":"structure", + "members":{ + "softwareSets":{ + "shape":"SoftwareSetList", + "documentation":"Describes software sets.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagsMap", + "documentation":"A map of the key-value pairs for the tag or tags assigned to the specified resource.
" + } + } + }, + "MaintenanceWindow":{ + "type":"structure", + "members":{ + "type":{ + "shape":"MaintenanceWindowType", + "documentation":"An option to select the default or custom maintenance window.
" + }, + "startTimeHour":{ + "shape":"Hour", + "documentation":"The hour for the maintenance window start (00-23).
The minutes past the hour for the maintenance window start (00-59).
The hour for the maintenance window end (00-23).
The minutes for the maintenance window end (00-59).
The days of the week during which the maintenance window is open.
" + }, + "applyTimeOf":{ + "shape":"ApplyTimeOf", + "documentation":"The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).
" + } + }, + "documentation":"Describes the maintenance window for a thin client device.
" + }, + "MaintenanceWindowType":{ + "type":"string", + "enum":[ + "SYSTEM", + "CUSTOM" + ] + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "Minute":{ + "type":"integer", + "box":true, + "max":59, + "min":0 + }, + "PaginationToken":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"\\S*" + }, + "QuotaCode":{"type":"string"}, + "ResourceId":{"type":"string"}, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "resourceId":{ + "shape":"ResourceId", + "documentation":"The ID of the resource associated with the request.
" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"The type of the resource associated with the request.
" + } + }, + "documentation":"The resource specified in the request was not found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceType":{"type":"string"}, + "RetryAfterSeconds":{ + "type":"integer", + "box":true + }, + "ServiceCode":{"type":"string"}, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "resourceId":{ + "shape":"ResourceId", + "documentation":"The ID of the resource that exceeds the service quota.
" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"The type of the resource that exceeds the service quota.
" + }, + "serviceCode":{ + "shape":"ServiceCode", + "documentation":"The code for the service in Service Quotas.
" + }, + "quotaCode":{ + "shape":"QuotaCode", + "documentation":"The code for the quota in Service Quotas.
" + } + }, + "documentation":"Your request exceeds a service quota.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "Software":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of the software component.
" + }, + "version":{ + "shape":"String", + "documentation":"The version of the software component.
" + } + }, + "documentation":"Describes software.
" + }, + "SoftwareList":{ + "type":"list", + "member":{"shape":"Software"} + }, + "SoftwareSet":{ + "type":"structure", + "members":{ + "id":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set.
" + }, + "version":{ + "shape":"String", + "documentation":"The version of the software set.
" + }, + "releasedAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the software set was released.
" + }, + "supportedUntil":{ + "shape":"Timestamp", + "documentation":"The timestamp of the end of support for the software set.
" + }, + "validationStatus":{ + "shape":"SoftwareSetValidationStatus", + "documentation":"An option to define if the software set has been validated.
" + }, + "software":{ + "shape":"SoftwareList", + "documentation":"A list of the software components in the software set.
" + }, + "arn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the software set.
" + }, + "tags":{ + "shape":"TagsMap", + "documentation":"The tag keys and optional values for the resource.
" + } + }, + "documentation":"Describes a software set.
" + }, + "SoftwareSetId":{ + "type":"string", + "pattern":"[0-9]{1,9}" + }, + "SoftwareSetIdOrEmptyString":{ + "type":"string", + "pattern":"[0-9]{0,9}" + }, + "SoftwareSetList":{ + "type":"list", + "member":{"shape":"SoftwareSetSummary"} + }, + "SoftwareSetSummary":{ + "type":"structure", + "members":{ + "id":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set.
" + }, + "version":{ + "shape":"String", + "documentation":"The version of the software set.
" + }, + "releasedAt":{ + "shape":"Timestamp", + "documentation":"The timestamp of when the software set was released.
" + }, + "supportedUntil":{ + "shape":"Timestamp", + "documentation":"The timestamp of the end of support for the software set.
" + }, + "validationStatus":{ + "shape":"SoftwareSetValidationStatus", + "documentation":"An option to define if the software set has been validated.
" + }, + "arn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the software set.
" + } + }, + "documentation":"Describes a software set.
" + }, + "SoftwareSetUpdateMode":{ + "type":"string", + "enum":[ + "USE_LATEST", + "USE_DESIRED" + ] + }, + "SoftwareSetUpdateSchedule":{ + "type":"string", + "enum":[ + "USE_MAINTENANCE_WINDOW", + "APPLY_IMMEDIATELY" + ] + }, + "SoftwareSetUpdateStatus":{ + "type":"string", + "enum":[ + "AVAILABLE", + "IN_PROGRESS", + "UP_TO_DATE" + ] + }, + "SoftwareSetValidationStatus":{ + "type":"string", + "enum":[ + "VALIDATED", + "NOT_VALIDATED" + ] + }, + "String":{"type":"string"}, + "TagKeys":{ + "type":"list", + "member":{"shape":"String"}, + "sensitive":true + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the resource that you want to tag.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagsMap", + "documentation":"A map of the key-value pairs of the tag or tags to assign to the resource.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagsMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"}, + "sensitive":true + }, + "TargetDeviceStatus":{ + "type":"string", + "enum":[ + "DEREGISTERED", + "ARCHIVED" + ] + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "serviceCode":{ + "shape":"ServiceCode", + "documentation":"The code for the service in Service Quotas.
" + }, + "quotaCode":{ + "shape":"QuotaCode", + "documentation":"The code for the quota in Service Quotas.
" + }, + "retryAfterSeconds":{ + "shape":"RetryAfterSeconds", + "documentation":"The number of seconds to wait before retrying the next request.
", + "location":"header", + "locationName":"Retry-After" + } + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the resource that you want to untag.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeys", + "documentation":"The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateDeviceRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"DeviceId", + "documentation":"The ID of the device to update.
", + "location":"uri", + "locationName":"id" + }, + "name":{ + "shape":"DeviceName", + "documentation":"The name of the device to update.
" + }, + "desiredSoftwareSetId":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set to apply.
" + }, + "softwareSetUpdateSchedule":{ + "shape":"SoftwareSetUpdateSchedule", + "documentation":"An option to define if software updates should be applied within a maintenance window.
" + } + } + }, + "UpdateDeviceResponse":{ + "type":"structure", + "members":{ + "device":{ + "shape":"DeviceSummary", + "documentation":"Describes a device.
" + } + } + }, + "UpdateEnvironmentRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"EnvironmentId", + "documentation":"The ID of the environment to update.
", + "location":"uri", + "locationName":"id" + }, + "name":{ + "shape":"EnvironmentName", + "documentation":"The name of the environment to update.
" + }, + "desktopArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
" + }, + "desktopEndpoint":{ + "shape":"DesktopEndpoint", + "documentation":"The URL for the identity provider login (only for environments that use AppStream 2.0).
" + }, + "softwareSetUpdateSchedule":{ + "shape":"SoftwareSetUpdateSchedule", + "documentation":"An option to define if software updates should be applied within a maintenance window.
" + }, + "maintenanceWindow":{ + "shape":"MaintenanceWindow", + "documentation":"A specification for a time window to apply software updates.
" + }, + "softwareSetUpdateMode":{ + "shape":"SoftwareSetUpdateMode", + "documentation":"An option to define which software updates to apply.
" + }, + "desiredSoftwareSetId":{ + "shape":"SoftwareSetIdOrEmptyString", + "documentation":"The ID of the software set to apply.
" + }, + "deviceCreationTags":{ + "shape":"DeviceCreationTagsMap", + "documentation":"A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
" + } + } + }, + "UpdateEnvironmentResponse":{ + "type":"structure", + "members":{ + "environment":{ + "shape":"EnvironmentSummary", + "documentation":"Describes an environment.
" + } + } + }, + "UpdateSoftwareSetRequest":{ + "type":"structure", + "required":[ + "id", + "validationStatus" + ], + "members":{ + "id":{ + "shape":"SoftwareSetId", + "documentation":"The ID of the software set to update.
", + "location":"uri", + "locationName":"id" + }, + "validationStatus":{ + "shape":"SoftwareSetValidationStatus", + "documentation":"An option to define if the software set has been validated.
" + } + } + }, + "UpdateSoftwareSetResponse":{ + "type":"structure", + "members":{ + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "reason":{ + "shape":"ValidationExceptionReason", + "documentation":"The reason for the exception.
" + }, + "fieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"A list of fields that didn't validate.
" + } + }, + "documentation":"The input fails to satisfy the specified constraints.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "name", + "message" + ], + "members":{ + "name":{ + "shape":"FieldName", + "documentation":"The name of the exception.
" + }, + "message":{ + "shape":"ExceptionMessage", + "documentation":"A message that describes the reason for the exception.
" + } + }, + "documentation":"Describes a validation exception.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "unknownOperation", + "cannotParse", + "fieldValidationFailed", + "other" + ] + } + }, + "documentation":"Amazon WorkSpaces Thin Client is an affordable device built to work with Amazon Web Services End User Computing (EUC) virtual desktops to provide users with a complete cloud desktop solution. WorkSpaces Thin Client is a compact device designed to connect up to two monitors and USB devices like a keyboard, mouse, headset, and webcam. To maximize endpoint security, WorkSpaces Thin Client devices do not allow local data storage or installation of unapproved applications. The WorkSpaces Thin Client device ships preloaded with device management software.
You can use these APIs to complete WorkSpaces Thin Client tasks, such as creating environments or viewing devices. For more information about WorkSpaces Thin Client, including the required permissions to use the service, see the Amazon WorkSpaces Thin Client Administrator Guide. For more information about using the Command Line Interface (CLI) to manage your WorkSpaces Thin Client resources, see the WorkSpaces Thin Client section of the CLI Reference.
" +} diff --git a/testbed/boto__botocore/botocore/data/workspaces-web/2020-07-08/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/workspaces-web/2020-07-08/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..2398c28612fd7a2e3c66913d9b165d97bc3a0bc2 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workspaces-web/2020-07-08/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://workspaces-web-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://workspaces-web-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://workspaces-web.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://workspaces-web.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/workspaces-web/2020-07-08/examples-1.json b/testbed/boto__botocore/botocore/data/workspaces-web/2020-07-08/examples-1.json new file mode 100644 index 0000000000000000000000000000000000000000..0ea7e3b0bbe917eb027880396ac01509becd1fa0 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workspaces-web/2020-07-08/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/testbed/boto__botocore/botocore/data/workspaces-web/2020-07-08/paginators-1.json b/testbed/boto__botocore/botocore/data/workspaces-web/2020-07-08/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..14b5114c40c3fe36561255ec104fd8d6673eb948 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workspaces-web/2020-07-08/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListSessions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "sessions" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/workspaces-web/2020-07-08/service-2.json b/testbed/boto__botocore/botocore/data/workspaces-web/2020-07-08/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..8fc91d9a909ddb72452144db3ce2115b76f0dad7 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workspaces-web/2020-07-08/service-2.json @@ -0,0 +1,4277 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-07-08", + "endpointPrefix":"workspaces-web", + "jsonVersion":"1.1", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"Amazon WorkSpaces Web", + "serviceId":"WorkSpaces Web", + "signatureVersion":"v4", + "signingName":"workspaces-web", + "uid":"workspaces-web-2020-07-08", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "AssociateBrowserSettings":{ + "name":"AssociateBrowserSettings", + "http":{ + "method":"PUT", + "requestUri":"/portals/{portalArn+}/browserSettings", + "responseCode":200 + }, + "input":{"shape":"AssociateBrowserSettingsRequest"}, + "output":{"shape":"AssociateBrowserSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Associates a browser settings resource with a web portal.
", + "idempotent":true + }, + "AssociateIpAccessSettings":{ + "name":"AssociateIpAccessSettings", + "http":{ + "method":"PUT", + "requestUri":"/portals/{portalArn+}/ipAccessSettings", + "responseCode":200 + }, + "input":{"shape":"AssociateIpAccessSettingsRequest"}, + "output":{"shape":"AssociateIpAccessSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Associates an IP access settings resource with a web portal.
", + "idempotent":true + }, + "AssociateNetworkSettings":{ + "name":"AssociateNetworkSettings", + "http":{ + "method":"PUT", + "requestUri":"/portals/{portalArn+}/networkSettings", + "responseCode":200 + }, + "input":{"shape":"AssociateNetworkSettingsRequest"}, + "output":{"shape":"AssociateNetworkSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Associates a network settings resource with a web portal.
", + "idempotent":true + }, + "AssociateTrustStore":{ + "name":"AssociateTrustStore", + "http":{ + "method":"PUT", + "requestUri":"/portals/{portalArn+}/trustStores", + "responseCode":200 + }, + "input":{"shape":"AssociateTrustStoreRequest"}, + "output":{"shape":"AssociateTrustStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Associates a trust store with a web portal.
", + "idempotent":true + }, + "AssociateUserAccessLoggingSettings":{ + "name":"AssociateUserAccessLoggingSettings", + "http":{ + "method":"PUT", + "requestUri":"/portals/{portalArn+}/userAccessLoggingSettings", + "responseCode":200 + }, + "input":{"shape":"AssociateUserAccessLoggingSettingsRequest"}, + "output":{"shape":"AssociateUserAccessLoggingSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Associates a user access logging settings resource with a web portal.
", + "idempotent":true + }, + "AssociateUserSettings":{ + "name":"AssociateUserSettings", + "http":{ + "method":"PUT", + "requestUri":"/portals/{portalArn+}/userSettings", + "responseCode":200 + }, + "input":{"shape":"AssociateUserSettingsRequest"}, + "output":{"shape":"AssociateUserSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Associates a user settings resource with a web portal.
", + "idempotent":true + }, + "CreateBrowserSettings":{ + "name":"CreateBrowserSettings", + "http":{ + "method":"POST", + "requestUri":"/browserSettings", + "responseCode":200 + }, + "input":{"shape":"CreateBrowserSettingsRequest"}, + "output":{"shape":"CreateBrowserSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Creates a browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal.
" + }, + "CreateIdentityProvider":{ + "name":"CreateIdentityProvider", + "http":{ + "method":"POST", + "requestUri":"/identityProviders", + "responseCode":200 + }, + "input":{"shape":"CreateIdentityProviderRequest"}, + "output":{"shape":"CreateIdentityProviderResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Creates an identity provider resource that is then associated with a web portal.
" + }, + "CreateIpAccessSettings":{ + "name":"CreateIpAccessSettings", + "http":{ + "method":"POST", + "requestUri":"/ipAccessSettings", + "responseCode":200 + }, + "input":{"shape":"CreateIpAccessSettingsRequest"}, + "output":{"shape":"CreateIpAccessSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Creates an IP access settings resource that can be associated with a web portal.
" + }, + "CreateNetworkSettings":{ + "name":"CreateNetworkSettings", + "http":{ + "method":"POST", + "requestUri":"/networkSettings", + "responseCode":200 + }, + "input":{"shape":"CreateNetworkSettingsRequest"}, + "output":{"shape":"CreateNetworkSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Creates a network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC.
" + }, + "CreatePortal":{ + "name":"CreatePortal", + "http":{ + "method":"POST", + "requestUri":"/portals", + "responseCode":200 + }, + "input":{"shape":"CreatePortalRequest"}, + "output":{"shape":"CreatePortalResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Creates a web portal.
" + }, + "CreateTrustStore":{ + "name":"CreateTrustStore", + "http":{ + "method":"POST", + "requestUri":"/trustStores", + "responseCode":200 + }, + "input":{"shape":"CreateTrustStoreRequest"}, + "output":{"shape":"CreateTrustStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Creates a trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a streaming session will recognize certificates that have been issued using any of the CAs in the trust store. If your organization has internal websites that use certificates issued by private CAs, you should add the private CA certificate to the trust store.
" + }, + "CreateUserAccessLoggingSettings":{ + "name":"CreateUserAccessLoggingSettings", + "http":{ + "method":"POST", + "requestUri":"/userAccessLoggingSettings", + "responseCode":200 + }, + "input":{"shape":"CreateUserAccessLoggingSettingsRequest"}, + "output":{"shape":"CreateUserAccessLoggingSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Creates a user access logging settings resource that can be associated with a web portal.
" + }, + "CreateUserSettings":{ + "name":"CreateUserSettings", + "http":{ + "method":"POST", + "requestUri":"/userSettings", + "responseCode":200 + }, + "input":{"shape":"CreateUserSettingsRequest"}, + "output":{"shape":"CreateUserSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Creates a user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.
" + }, + "DeleteBrowserSettings":{ + "name":"DeleteBrowserSettings", + "http":{ + "method":"DELETE", + "requestUri":"/browserSettings/{browserSettingsArn+}", + "responseCode":200 + }, + "input":{"shape":"DeleteBrowserSettingsRequest"}, + "output":{"shape":"DeleteBrowserSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes browser settings.
", + "idempotent":true + }, + "DeleteIdentityProvider":{ + "name":"DeleteIdentityProvider", + "http":{ + "method":"DELETE", + "requestUri":"/identityProviders/{identityProviderArn+}", + "responseCode":200 + }, + "input":{"shape":"DeleteIdentityProviderRequest"}, + "output":{"shape":"DeleteIdentityProviderResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes the identity provider.
", + "idempotent":true + }, + "DeleteIpAccessSettings":{ + "name":"DeleteIpAccessSettings", + "http":{ + "method":"DELETE", + "requestUri":"/ipAccessSettings/{ipAccessSettingsArn+}", + "responseCode":200 + }, + "input":{"shape":"DeleteIpAccessSettingsRequest"}, + "output":{"shape":"DeleteIpAccessSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes IP access settings.
", + "idempotent":true + }, + "DeleteNetworkSettings":{ + "name":"DeleteNetworkSettings", + "http":{ + "method":"DELETE", + "requestUri":"/networkSettings/{networkSettingsArn+}", + "responseCode":200 + }, + "input":{"shape":"DeleteNetworkSettingsRequest"}, + "output":{"shape":"DeleteNetworkSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes network settings.
", + "idempotent":true + }, + "DeletePortal":{ + "name":"DeletePortal", + "http":{ + "method":"DELETE", + "requestUri":"/portals/{portalArn+}", + "responseCode":200 + }, + "input":{"shape":"DeletePortalRequest"}, + "output":{"shape":"DeletePortalResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes a web portal.
", + "idempotent":true + }, + "DeleteTrustStore":{ + "name":"DeleteTrustStore", + "http":{ + "method":"DELETE", + "requestUri":"/trustStores/{trustStoreArn+}", + "responseCode":200 + }, + "input":{"shape":"DeleteTrustStoreRequest"}, + "output":{"shape":"DeleteTrustStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes the trust store.
", + "idempotent":true + }, + "DeleteUserAccessLoggingSettings":{ + "name":"DeleteUserAccessLoggingSettings", + "http":{ + "method":"DELETE", + "requestUri":"/userAccessLoggingSettings/{userAccessLoggingSettingsArn+}", + "responseCode":200 + }, + "input":{"shape":"DeleteUserAccessLoggingSettingsRequest"}, + "output":{"shape":"DeleteUserAccessLoggingSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes user access logging settings.
", + "idempotent":true + }, + "DeleteUserSettings":{ + "name":"DeleteUserSettings", + "http":{ + "method":"DELETE", + "requestUri":"/userSettings/{userSettingsArn+}", + "responseCode":200 + }, + "input":{"shape":"DeleteUserSettingsRequest"}, + "output":{"shape":"DeleteUserSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes user settings.
", + "idempotent":true + }, + "DisassociateBrowserSettings":{ + "name":"DisassociateBrowserSettings", + "http":{ + "method":"DELETE", + "requestUri":"/portals/{portalArn+}/browserSettings", + "responseCode":200 + }, + "input":{"shape":"DisassociateBrowserSettingsRequest"}, + "output":{"shape":"DisassociateBrowserSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Disassociates browser settings from a web portal.
", + "idempotent":true + }, + "DisassociateIpAccessSettings":{ + "name":"DisassociateIpAccessSettings", + "http":{ + "method":"DELETE", + "requestUri":"/portals/{portalArn+}/ipAccessSettings", + "responseCode":200 + }, + "input":{"shape":"DisassociateIpAccessSettingsRequest"}, + "output":{"shape":"DisassociateIpAccessSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Disassociates IP access settings from a web portal.
", + "idempotent":true + }, + "DisassociateNetworkSettings":{ + "name":"DisassociateNetworkSettings", + "http":{ + "method":"DELETE", + "requestUri":"/portals/{portalArn+}/networkSettings", + "responseCode":200 + }, + "input":{"shape":"DisassociateNetworkSettingsRequest"}, + "output":{"shape":"DisassociateNetworkSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Disassociates network settings from a web portal.
", + "idempotent":true + }, + "DisassociateTrustStore":{ + "name":"DisassociateTrustStore", + "http":{ + "method":"DELETE", + "requestUri":"/portals/{portalArn+}/trustStores", + "responseCode":200 + }, + "input":{"shape":"DisassociateTrustStoreRequest"}, + "output":{"shape":"DisassociateTrustStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Disassociates a trust store from a web portal.
", + "idempotent":true + }, + "DisassociateUserAccessLoggingSettings":{ + "name":"DisassociateUserAccessLoggingSettings", + "http":{ + "method":"DELETE", + "requestUri":"/portals/{portalArn+}/userAccessLoggingSettings", + "responseCode":200 + }, + "input":{"shape":"DisassociateUserAccessLoggingSettingsRequest"}, + "output":{"shape":"DisassociateUserAccessLoggingSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Disassociates user access logging settings from a web portal.
", + "idempotent":true + }, + "DisassociateUserSettings":{ + "name":"DisassociateUserSettings", + "http":{ + "method":"DELETE", + "requestUri":"/portals/{portalArn+}/userSettings", + "responseCode":200 + }, + "input":{"shape":"DisassociateUserSettingsRequest"}, + "output":{"shape":"DisassociateUserSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Disassociates user settings from a web portal.
", + "idempotent":true + }, + "ExpireSession":{ + "name":"ExpireSession", + "http":{ + "method":"DELETE", + "requestUri":"/portals/{portalId}/sessions/{sessionId}", + "responseCode":200 + }, + "input":{"shape":"ExpireSessionRequest"}, + "output":{"shape":"ExpireSessionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Expires an active secure browser session.
", + "idempotent":true + }, + "GetBrowserSettings":{ + "name":"GetBrowserSettings", + "http":{ + "method":"GET", + "requestUri":"/browserSettings/{browserSettingsArn+}", + "responseCode":200 + }, + "input":{"shape":"GetBrowserSettingsRequest"}, + "output":{"shape":"GetBrowserSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets browser settings.
" + }, + "GetIdentityProvider":{ + "name":"GetIdentityProvider", + "http":{ + "method":"GET", + "requestUri":"/identityProviders/{identityProviderArn+}", + "responseCode":200 + }, + "input":{"shape":"GetIdentityProviderRequest"}, + "output":{"shape":"GetIdentityProviderResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets the identity provider.
" + }, + "GetIpAccessSettings":{ + "name":"GetIpAccessSettings", + "http":{ + "method":"GET", + "requestUri":"/ipAccessSettings/{ipAccessSettingsArn+}", + "responseCode":200 + }, + "input":{"shape":"GetIpAccessSettingsRequest"}, + "output":{"shape":"GetIpAccessSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets the IP access settings.
" + }, + "GetNetworkSettings":{ + "name":"GetNetworkSettings", + "http":{ + "method":"GET", + "requestUri":"/networkSettings/{networkSettingsArn+}", + "responseCode":200 + }, + "input":{"shape":"GetNetworkSettingsRequest"}, + "output":{"shape":"GetNetworkSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets the network settings.
" + }, + "GetPortal":{ + "name":"GetPortal", + "http":{ + "method":"GET", + "requestUri":"/portals/{portalArn+}", + "responseCode":200 + }, + "input":{"shape":"GetPortalRequest"}, + "output":{"shape":"GetPortalResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets the web portal.
" + }, + "GetPortalServiceProviderMetadata":{ + "name":"GetPortalServiceProviderMetadata", + "http":{ + "method":"GET", + "requestUri":"/portalIdp/{portalArn+}", + "responseCode":200 + }, + "input":{"shape":"GetPortalServiceProviderMetadataRequest"}, + "output":{"shape":"GetPortalServiceProviderMetadataResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets the service provider metadata.
" + }, + "GetSession":{ + "name":"GetSession", + "http":{ + "method":"GET", + "requestUri":"/portals/{portalId}/sessions/{sessionId}", + "responseCode":200 + }, + "input":{"shape":"GetSessionRequest"}, + "output":{"shape":"GetSessionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets information for a secure browser session.
" + }, + "GetTrustStore":{ + "name":"GetTrustStore", + "http":{ + "method":"GET", + "requestUri":"/trustStores/{trustStoreArn+}", + "responseCode":200 + }, + "input":{"shape":"GetTrustStoreRequest"}, + "output":{"shape":"GetTrustStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets the trust store.
" + }, + "GetTrustStoreCertificate":{ + "name":"GetTrustStoreCertificate", + "http":{ + "method":"GET", + "requestUri":"/trustStores/{trustStoreArn+}/certificate", + "responseCode":200 + }, + "input":{"shape":"GetTrustStoreCertificateRequest"}, + "output":{"shape":"GetTrustStoreCertificateResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets the trust store certificate.
" + }, + "GetUserAccessLoggingSettings":{ + "name":"GetUserAccessLoggingSettings", + "http":{ + "method":"GET", + "requestUri":"/userAccessLoggingSettings/{userAccessLoggingSettingsArn+}", + "responseCode":200 + }, + "input":{"shape":"GetUserAccessLoggingSettingsRequest"}, + "output":{"shape":"GetUserAccessLoggingSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets user access logging settings.
" + }, + "GetUserSettings":{ + "name":"GetUserSettings", + "http":{ + "method":"GET", + "requestUri":"/userSettings/{userSettingsArn+}", + "responseCode":200 + }, + "input":{"shape":"GetUserSettingsRequest"}, + "output":{"shape":"GetUserSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets user settings.
" + }, + "ListBrowserSettings":{ + "name":"ListBrowserSettings", + "http":{ + "method":"GET", + "requestUri":"/browserSettings", + "responseCode":200 + }, + "input":{"shape":"ListBrowserSettingsRequest"}, + "output":{"shape":"ListBrowserSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Retrieves a list of browser settings.
" + }, + "ListIdentityProviders":{ + "name":"ListIdentityProviders", + "http":{ + "method":"GET", + "requestUri":"/portals/{portalArn+}/identityProviders", + "responseCode":200 + }, + "input":{"shape":"ListIdentityProvidersRequest"}, + "output":{"shape":"ListIdentityProvidersResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Retrieves a list of identity providers for a specific web portal.
" + }, + "ListIpAccessSettings":{ + "name":"ListIpAccessSettings", + "http":{ + "method":"GET", + "requestUri":"/ipAccessSettings", + "responseCode":200 + }, + "input":{"shape":"ListIpAccessSettingsRequest"}, + "output":{"shape":"ListIpAccessSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Retrieves a list of IP access settings.
" + }, + "ListNetworkSettings":{ + "name":"ListNetworkSettings", + "http":{ + "method":"GET", + "requestUri":"/networkSettings", + "responseCode":200 + }, + "input":{"shape":"ListNetworkSettingsRequest"}, + "output":{"shape":"ListNetworkSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Retrieves a list of network settings.
" + }, + "ListPortals":{ + "name":"ListPortals", + "http":{ + "method":"GET", + "requestUri":"/portals", + "responseCode":200 + }, + "input":{"shape":"ListPortalsRequest"}, + "output":{"shape":"ListPortalsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Retrieves a list or web portals.
" + }, + "ListSessions":{ + "name":"ListSessions", + "http":{ + "method":"GET", + "requestUri":"/portals/{portalId}/sessions", + "responseCode":200 + }, + "input":{"shape":"ListSessionsRequest"}, + "output":{"shape":"ListSessionsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Lists information for multiple secure browser sessions from a specific portal.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn+}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Retrieves a list of tags for a resource.
" + }, + "ListTrustStoreCertificates":{ + "name":"ListTrustStoreCertificates", + "http":{ + "method":"GET", + "requestUri":"/trustStores/{trustStoreArn+}/certificates", + "responseCode":200 + }, + "input":{"shape":"ListTrustStoreCertificatesRequest"}, + "output":{"shape":"ListTrustStoreCertificatesResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Retrieves a list of trust store certificates.
" + }, + "ListTrustStores":{ + "name":"ListTrustStores", + "http":{ + "method":"GET", + "requestUri":"/trustStores", + "responseCode":200 + }, + "input":{"shape":"ListTrustStoresRequest"}, + "output":{"shape":"ListTrustStoresResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Retrieves a list of trust stores.
" + }, + "ListUserAccessLoggingSettings":{ + "name":"ListUserAccessLoggingSettings", + "http":{ + "method":"GET", + "requestUri":"/userAccessLoggingSettings", + "responseCode":200 + }, + "input":{"shape":"ListUserAccessLoggingSettingsRequest"}, + "output":{"shape":"ListUserAccessLoggingSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Retrieves a list of user access logging settings.
" + }, + "ListUserSettings":{ + "name":"ListUserSettings", + "http":{ + "method":"GET", + "requestUri":"/userSettings", + "responseCode":200 + }, + "input":{"shape":"ListUserSettingsRequest"}, + "output":{"shape":"ListUserSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Retrieves a list of user settings.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn+}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"TooManyTagsException"} + ], + "documentation":"Adds or overwrites one or more tags for the specified resource.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn+}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Removes one or more tags from the specified resource.
", + "idempotent":true + }, + "UpdateBrowserSettings":{ + "name":"UpdateBrowserSettings", + "http":{ + "method":"PATCH", + "requestUri":"/browserSettings/{browserSettingsArn+}", + "responseCode":200 + }, + "input":{"shape":"UpdateBrowserSettingsRequest"}, + "output":{"shape":"UpdateBrowserSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates browser settings.
" + }, + "UpdateIdentityProvider":{ + "name":"UpdateIdentityProvider", + "http":{ + "method":"PATCH", + "requestUri":"/identityProviders/{identityProviderArn+}", + "responseCode":200 + }, + "input":{"shape":"UpdateIdentityProviderRequest"}, + "output":{"shape":"UpdateIdentityProviderResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates the identity provider.
" + }, + "UpdateIpAccessSettings":{ + "name":"UpdateIpAccessSettings", + "http":{ + "method":"PATCH", + "requestUri":"/ipAccessSettings/{ipAccessSettingsArn+}", + "responseCode":200 + }, + "input":{"shape":"UpdateIpAccessSettingsRequest"}, + "output":{"shape":"UpdateIpAccessSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates IP access settings.
" + }, + "UpdateNetworkSettings":{ + "name":"UpdateNetworkSettings", + "http":{ + "method":"PATCH", + "requestUri":"/networkSettings/{networkSettingsArn+}", + "responseCode":200 + }, + "input":{"shape":"UpdateNetworkSettingsRequest"}, + "output":{"shape":"UpdateNetworkSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates network settings.
" + }, + "UpdatePortal":{ + "name":"UpdatePortal", + "http":{ + "method":"PUT", + "requestUri":"/portals/{portalArn+}", + "responseCode":200 + }, + "input":{"shape":"UpdatePortalRequest"}, + "output":{"shape":"UpdatePortalResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Updates a web portal.
", + "idempotent":true + }, + "UpdateTrustStore":{ + "name":"UpdateTrustStore", + "http":{ + "method":"PATCH", + "requestUri":"/trustStores/{trustStoreArn+}", + "responseCode":200 + }, + "input":{"shape":"UpdateTrustStoreRequest"}, + "output":{"shape":"UpdateTrustStoreResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates the trust store.
" + }, + "UpdateUserAccessLoggingSettings":{ + "name":"UpdateUserAccessLoggingSettings", + "http":{ + "method":"PATCH", + "requestUri":"/userAccessLoggingSettings/{userAccessLoggingSettingsArn+}", + "responseCode":200 + }, + "input":{"shape":"UpdateUserAccessLoggingSettingsRequest"}, + "output":{"shape":"UpdateUserAccessLoggingSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates the user access logging settings.
" + }, + "UpdateUserSettings":{ + "name":"UpdateUserSettings", + "http":{ + "method":"PATCH", + "requestUri":"/userSettings/{userSettingsArn+}", + "responseCode":200 + }, + "input":{"shape":"UpdateUserSettingsRequest"}, + "output":{"shape":"UpdateUserSettingsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Updates the user settings.
" + } + }, + "shapes":{ + "ARN":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$" + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"Access is denied.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "ArnList":{ + "type":"list", + "member":{"shape":"ARN"} + }, + "AssociateBrowserSettingsRequest":{ + "type":"structure", + "required":[ + "browserSettingsArn", + "portalArn" + ], + "members":{ + "browserSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the browser settings.
", + "location":"querystring", + "locationName":"browserSettingsArn" + }, + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + } + } + }, + "AssociateBrowserSettingsResponse":{ + "type":"structure", + "required":[ + "browserSettingsArn", + "portalArn" + ], + "members":{ + "browserSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the browser settings.
" + }, + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
" + } + } + }, + "AssociateIpAccessSettingsRequest":{ + "type":"structure", + "required":[ + "ipAccessSettingsArn", + "portalArn" + ], + "members":{ + "ipAccessSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the IP access settings.
", + "location":"querystring", + "locationName":"ipAccessSettingsArn" + }, + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + } + } + }, + "AssociateIpAccessSettingsResponse":{ + "type":"structure", + "required":[ + "ipAccessSettingsArn", + "portalArn" + ], + "members":{ + "ipAccessSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the IP access settings resource.
" + }, + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
" + } + } + }, + "AssociateNetworkSettingsRequest":{ + "type":"structure", + "required":[ + "networkSettingsArn", + "portalArn" + ], + "members":{ + "networkSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the network settings.
", + "location":"querystring", + "locationName":"networkSettingsArn" + }, + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + } + } + }, + "AssociateNetworkSettingsResponse":{ + "type":"structure", + "required":[ + "networkSettingsArn", + "portalArn" + ], + "members":{ + "networkSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the network settings.
" + }, + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
" + } + } + }, + "AssociateTrustStoreRequest":{ + "type":"structure", + "required":[ + "portalArn", + "trustStoreArn" + ], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + }, + "trustStoreArn":{ + "shape":"ARN", + "documentation":"The ARN of the trust store.
", + "location":"querystring", + "locationName":"trustStoreArn" + } + } + }, + "AssociateTrustStoreResponse":{ + "type":"structure", + "required":[ + "portalArn", + "trustStoreArn" + ], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
" + }, + "trustStoreArn":{ + "shape":"ARN", + "documentation":"The ARN of the trust store.
" + } + } + }, + "AssociateUserAccessLoggingSettingsRequest":{ + "type":"structure", + "required":[ + "portalArn", + "userAccessLoggingSettingsArn" + ], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + }, + "userAccessLoggingSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user access logging settings.
", + "location":"querystring", + "locationName":"userAccessLoggingSettingsArn" + } + } + }, + "AssociateUserAccessLoggingSettingsResponse":{ + "type":"structure", + "required":[ + "portalArn", + "userAccessLoggingSettingsArn" + ], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
" + }, + "userAccessLoggingSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user access logging settings.
" + } + } + }, + "AssociateUserSettingsRequest":{ + "type":"structure", + "required":[ + "portalArn", + "userSettingsArn" + ], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + }, + "userSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user settings.
", + "location":"querystring", + "locationName":"userSettingsArn" + } + } + }, + "AssociateUserSettingsResponse":{ + "type":"structure", + "required":[ + "portalArn", + "userSettingsArn" + ], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
" + }, + "userSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user settings.
" + } + } + }, + "AuthenticationType":{ + "type":"string", + "enum":[ + "Standard", + "IAM_Identity_Center" + ] + }, + "BrowserPolicy":{ + "type":"string", + "max":131072, + "min":2, + "pattern":"\\{[\\S\\s]*\\}\\s*", + "sensitive":true + }, + "BrowserSettings":{ + "type":"structure", + "required":["browserSettingsArn"], + "members":{ + "additionalEncryptionContext":{ + "shape":"EncryptionContextMap", + "documentation":"The additional encryption context of the browser settings.
" + }, + "associatedPortalArns":{ + "shape":"ArnList", + "documentation":"A list of web portal ARNs that this browser settings is associated with.
" + }, + "browserPolicy":{ + "shape":"BrowserPolicy", + "documentation":"A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
" + }, + "browserSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the browser settings.
" + }, + "customerManagedKey":{ + "shape":"keyArn", + "documentation":"The customer managed key used to encrypt sensitive information in the browser settings.
" + } + }, + "documentation":"The browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal.
" + }, + "BrowserSettingsList":{ + "type":"list", + "member":{"shape":"BrowserSettingsSummary"} + }, + "BrowserSettingsSummary":{ + "type":"structure", + "required":["browserSettingsArn"], + "members":{ + "browserSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the browser settings.
" + } + }, + "documentation":"The summary for browser settings.
" + }, + "BrowserType":{ + "type":"string", + "enum":["Chrome"] + }, + "Certificate":{ + "type":"structure", + "members":{ + "body":{ + "shape":"CertificateAuthorityBody", + "documentation":"The body of the certificate.
" + }, + "issuer":{ + "shape":"CertificatePrincipal", + "documentation":"The entity that issued the certificate.
" + }, + "notValidAfter":{ + "shape":"Timestamp", + "documentation":"The certificate is not valid after this date.
" + }, + "notValidBefore":{ + "shape":"Timestamp", + "documentation":"The certificate is not valid before this date.
" + }, + "subject":{ + "shape":"CertificatePrincipal", + "documentation":"The entity the certificate belongs to.
" + }, + "thumbprint":{ + "shape":"CertificateThumbprint", + "documentation":"A hexadecimal identifier for the certificate.
" + } + }, + "documentation":"The certificate.
" + }, + "CertificateAuthorityBody":{"type":"blob"}, + "CertificateList":{ + "type":"list", + "member":{"shape":"CertificateAuthorityBody"} + }, + "CertificatePrincipal":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^\\S+$" + }, + "CertificateSummary":{ + "type":"structure", + "members":{ + "issuer":{ + "shape":"CertificatePrincipal", + "documentation":"The entity that issued the certificate.
" + }, + "notValidAfter":{ + "shape":"Timestamp", + "documentation":"The certificate is not valid after this date.
" + }, + "notValidBefore":{ + "shape":"Timestamp", + "documentation":"The certificate is not valid before this date.
" + }, + "subject":{ + "shape":"CertificatePrincipal", + "documentation":"The entity the certificate belongs to.
" + }, + "thumbprint":{ + "shape":"CertificateThumbprint", + "documentation":"A hexadecimal identifier for the certificate.
" + } + }, + "documentation":"The summary of the certificate.
" + }, + "CertificateSummaryList":{ + "type":"list", + "member":{"shape":"CertificateSummary"} + }, + "CertificateThumbprint":{ + "type":"string", + "max":64, + "min":64, + "pattern":"^[A-Fa-f0-9]{64}$" + }, + "CertificateThumbprintList":{ + "type":"list", + "member":{"shape":"CertificateThumbprint"} + }, + "ClientToken":{ + "type":"string", + "max":512, + "min":1 + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "resourceId":{ + "shape":"ResourceId", + "documentation":"Identifier of the resource affected.
" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"Type of the resource affected.
" + } + }, + "documentation":"There is a conflict.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CookieDomain":{ + "type":"string", + "max":253, + "min":0, + "pattern":"^(\\.?)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$", + "sensitive":true + }, + "CookieName":{ + "type":"string", + "max":4096, + "min":0, + "sensitive":true + }, + "CookiePath":{ + "type":"string", + "max":2000, + "min":0, + "pattern":"^/(\\S)*$", + "sensitive":true + }, + "CookieSpecification":{ + "type":"structure", + "required":["domain"], + "members":{ + "domain":{ + "shape":"CookieDomain", + "documentation":"The domain of the cookie.
" + }, + "name":{ + "shape":"CookieName", + "documentation":"The name of the cookie.
" + }, + "path":{ + "shape":"CookiePath", + "documentation":"The path of the cookie.
" + } + }, + "documentation":"Specifies a single cookie or set of cookies in an end user's browser.
" + }, + "CookieSpecifications":{ + "type":"list", + "member":{"shape":"CookieSpecification"}, + "max":10, + "min":0 + }, + "CookieSynchronizationConfiguration":{ + "type":"structure", + "required":["allowlist"], + "members":{ + "allowlist":{ + "shape":"CookieSpecifications", + "documentation":"The list of cookie specifications that are allowed to be synchronized to the remote browser.
" + }, + "blocklist":{ + "shape":"CookieSpecifications", + "documentation":"The list of cookie specifications that are blocked from being synchronized to the remote browser.
" + } + }, + "documentation":"The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
", + "sensitive":true + }, + "CreateBrowserSettingsRequest":{ + "type":"structure", + "required":["browserPolicy"], + "members":{ + "additionalEncryptionContext":{ + "shape":"EncryptionContextMap", + "documentation":"Additional encryption context of the browser settings.
" + }, + "browserPolicy":{ + "shape":"BrowserPolicy", + "documentation":"A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"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, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + }, + "customerManagedKey":{ + "shape":"keyArn", + "documentation":"The custom managed key of the browser settings.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags to add to the browser settings resource. A tag is a key-value pair.
" + } + } + }, + "CreateBrowserSettingsResponse":{ + "type":"structure", + "required":["browserSettingsArn"], + "members":{ + "browserSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the browser settings.
" + } + } + }, + "CreateIdentityProviderRequest":{ + "type":"structure", + "required":[ + "identityProviderDetails", + "identityProviderName", + "identityProviderType", + "portalArn" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"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, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + }, + "identityProviderDetails":{ + "shape":"IdentityProviderDetails", + "documentation":"The identity provider details. The following list describes the provider detail keys for each identity provider type.
For Google and Login with Amazon:
client_id
client_secret
authorize_scopes
For Facebook:
client_id
client_secret
authorize_scopes
api_version
For Sign in with Apple:
client_id
team_id
key_id
private_key
authorize_scopes
For OIDC providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
authorize_url if not available from discovery URL specified by oidc_issuer key
token_url if not available from discovery URL specified by oidc_issuer key
attributes_url if not available from discovery URL specified by oidc_issuer key
jwks_uri if not available from discovery URL specified by oidc_issuer key
For SAML providers:
MetadataFile OR MetadataURL
IDPSignout (boolean) optional
IDPInit (boolean) optional
RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256
EncryptedResponses (boolean) optional
The identity provider name.
" + }, + "identityProviderType":{ + "shape":"IdentityProviderType", + "documentation":"The identity provider type.
" + }, + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags to add to the identity provider resource. A tag is a key-value pair.
" + } + } + }, + "CreateIdentityProviderResponse":{ + "type":"structure", + "required":["identityProviderArn"], + "members":{ + "identityProviderArn":{ + "shape":"SubresourceARN", + "documentation":"The ARN of the identity provider.
" + } + } + }, + "CreateIpAccessSettingsRequest":{ + "type":"structure", + "required":["ipRules"], + "members":{ + "additionalEncryptionContext":{ + "shape":"EncryptionContextMap", + "documentation":"Additional encryption context of the IP access settings.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"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, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + }, + "customerManagedKey":{ + "shape":"keyArn", + "documentation":"The custom managed key of the IP access settings.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the IP access settings.
" + }, + "displayName":{ + "shape":"DisplayName", + "documentation":"The display name of the IP access settings.
" + }, + "ipRules":{ + "shape":"IpRuleList", + "documentation":"The IP rules of the IP access settings.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags to add to the IP access settings resource. A tag is a key-value pair.
" + } + } + }, + "CreateIpAccessSettingsResponse":{ + "type":"structure", + "required":["ipAccessSettingsArn"], + "members":{ + "ipAccessSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the IP access settings resource.
" + } + } + }, + "CreateNetworkSettingsRequest":{ + "type":"structure", + "required":[ + "securityGroupIds", + "subnetIds", + "vpcId" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"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, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + }, + "securityGroupIds":{ + "shape":"SecurityGroupIdList", + "documentation":"One or more security groups used to control access from streaming instances to your VPC.
" + }, + "subnetIds":{ + "shape":"SubnetIdList", + "documentation":"The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags to add to the network settings resource. A tag is a key-value pair.
" + }, + "vpcId":{ + "shape":"VpcId", + "documentation":"The VPC that streaming instances will connect to.
" + } + } + }, + "CreateNetworkSettingsResponse":{ + "type":"structure", + "required":["networkSettingsArn"], + "members":{ + "networkSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the network settings.
" + } + } + }, + "CreatePortalRequest":{ + "type":"structure", + "members":{ + "additionalEncryptionContext":{ + "shape":"EncryptionContextMap", + "documentation":"The additional encryption context of the portal.
" + }, + "authenticationType":{ + "shape":"AuthenticationType", + "documentation":"The type of authentication integration points used when signing into the web portal. Defaults to Standard.
Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
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, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + }, + "customerManagedKey":{ + "shape":"keyArn", + "documentation":"The customer managed key of the web portal.
" + }, + "displayName":{ + "shape":"DisplayName", + "documentation":"The name of the web portal. This is not visible to users who log into the web portal.
" + }, + "instanceType":{ + "shape":"InstanceType", + "documentation":"The type and resources of the underlying instance.
" + }, + "maxConcurrentSessions":{ + "shape":"MaxConcurrentSessions", + "documentation":"The maximum number of concurrent sessions for the portal.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags to add to the web portal. A tag is a key-value pair.
" + } + } + }, + "CreatePortalResponse":{ + "type":"structure", + "required":[ + "portalArn", + "portalEndpoint" + ], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
" + }, + "portalEndpoint":{ + "shape":"PortalEndpoint", + "documentation":"The endpoint URL of the web portal that users access in order to start streaming sessions.
" + } + } + }, + "CreateTrustStoreRequest":{ + "type":"structure", + "required":["certificateList"], + "members":{ + "certificateList":{ + "shape":"CertificateList", + "documentation":"A list of CA certificates to be added to the trust store.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"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, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags to add to the trust store. A tag is a key-value pair.
" + } + } + }, + "CreateTrustStoreResponse":{ + "type":"structure", + "required":["trustStoreArn"], + "members":{ + "trustStoreArn":{ + "shape":"ARN", + "documentation":"The ARN of the trust store.
" + } + } + }, + "CreateUserAccessLoggingSettingsRequest":{ + "type":"structure", + "required":["kinesisStreamArn"], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"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, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + }, + "kinesisStreamArn":{ + "shape":"KinesisStreamArn", + "documentation":"The ARN of the Kinesis stream.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags to add to the user settings resource. A tag is a key-value pair.
" + } + } + }, + "CreateUserAccessLoggingSettingsResponse":{ + "type":"structure", + "required":["userAccessLoggingSettingsArn"], + "members":{ + "userAccessLoggingSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user access logging settings.
" + } + } + }, + "CreateUserSettingsRequest":{ + "type":"structure", + "required":[ + "copyAllowed", + "downloadAllowed", + "pasteAllowed", + "printAllowed", + "uploadAllowed" + ], + "members":{ + "additionalEncryptionContext":{ + "shape":"EncryptionContextMap", + "documentation":"The additional encryption context of the user settings.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"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, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + }, + "cookieSynchronizationConfiguration":{ + "shape":"CookieSynchronizationConfiguration", + "documentation":"The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
" + }, + "copyAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can copy text from the streaming session to the local device.
" + }, + "customerManagedKey":{ + "shape":"keyArn", + "documentation":"The customer managed key used to encrypt sensitive information in the user settings.
" + }, + "deepLinkAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can use deep links that open automatically when connecting to a session.
" + }, + "disconnectTimeoutInMinutes":{ + "shape":"DisconnectTimeoutInMinutes", + "documentation":"The amount of time that a streaming session remains active after users disconnect.
" + }, + "downloadAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can download files from the streaming session to the local device.
" + }, + "idleDisconnectTimeoutInMinutes":{ + "shape":"IdleDisconnectTimeoutInMinutes", + "documentation":"The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" + }, + "pasteAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can paste text from the local device to the streaming session.
" + }, + "printAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can print to the local device.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags to add to the user settings resource. A tag is a key-value pair.
" + }, + "uploadAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can upload files from the local device to the streaming session.
" + } + } + }, + "CreateUserSettingsResponse":{ + "type":"structure", + "required":["userSettingsArn"], + "members":{ + "userSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user settings.
" + } + } + }, + "DeleteBrowserSettingsRequest":{ + "type":"structure", + "required":["browserSettingsArn"], + "members":{ + "browserSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the browser settings.
", + "location":"uri", + "locationName":"browserSettingsArn" + } + } + }, + "DeleteBrowserSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteIdentityProviderRequest":{ + "type":"structure", + "required":["identityProviderArn"], + "members":{ + "identityProviderArn":{ + "shape":"SubresourceARN", + "documentation":"The ARN of the identity provider.
", + "location":"uri", + "locationName":"identityProviderArn" + } + } + }, + "DeleteIdentityProviderResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteIpAccessSettingsRequest":{ + "type":"structure", + "required":["ipAccessSettingsArn"], + "members":{ + "ipAccessSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the IP access settings.
", + "location":"uri", + "locationName":"ipAccessSettingsArn" + } + } + }, + "DeleteIpAccessSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteNetworkSettingsRequest":{ + "type":"structure", + "required":["networkSettingsArn"], + "members":{ + "networkSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the network settings.
", + "location":"uri", + "locationName":"networkSettingsArn" + } + } + }, + "DeleteNetworkSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "DeletePortalRequest":{ + "type":"structure", + "required":["portalArn"], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + } + } + }, + "DeletePortalResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteTrustStoreRequest":{ + "type":"structure", + "required":["trustStoreArn"], + "members":{ + "trustStoreArn":{ + "shape":"ARN", + "documentation":"The ARN of the trust store.
", + "location":"uri", + "locationName":"trustStoreArn" + } + } + }, + "DeleteTrustStoreResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteUserAccessLoggingSettingsRequest":{ + "type":"structure", + "required":["userAccessLoggingSettingsArn"], + "members":{ + "userAccessLoggingSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user access logging settings.
", + "location":"uri", + "locationName":"userAccessLoggingSettingsArn" + } + } + }, + "DeleteUserAccessLoggingSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteUserSettingsRequest":{ + "type":"structure", + "required":["userSettingsArn"], + "members":{ + "userSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user settings.
", + "location":"uri", + "locationName":"userSettingsArn" + } + } + }, + "DeleteUserSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "Description":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^.+$", + "sensitive":true + }, + "DisassociateBrowserSettingsRequest":{ + "type":"structure", + "required":["portalArn"], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + } + } + }, + "DisassociateBrowserSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateIpAccessSettingsRequest":{ + "type":"structure", + "required":["portalArn"], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + } + } + }, + "DisassociateIpAccessSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateNetworkSettingsRequest":{ + "type":"structure", + "required":["portalArn"], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + } + } + }, + "DisassociateNetworkSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateTrustStoreRequest":{ + "type":"structure", + "required":["portalArn"], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + } + } + }, + "DisassociateTrustStoreResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateUserAccessLoggingSettingsRequest":{ + "type":"structure", + "required":["portalArn"], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + } + } + }, + "DisassociateUserAccessLoggingSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateUserSettingsRequest":{ + "type":"structure", + "required":["portalArn"], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + } + } + }, + "DisassociateUserSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "DisconnectTimeoutInMinutes":{ + "type":"integer", + "box":true, + "max":600, + "min":1 + }, + "DisplayName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^.+$", + "sensitive":true + }, + "EnabledType":{ + "type":"string", + "enum":[ + "Disabled", + "Enabled" + ] + }, + "EncryptionContextMap":{ + "type":"map", + "key":{"shape":"StringType"}, + "value":{"shape":"StringType"} + }, + "ExceptionMessage":{"type":"string"}, + "ExpireSessionRequest":{ + "type":"structure", + "required":[ + "portalId", + "sessionId" + ], + "members":{ + "portalId":{ + "shape":"PortalId", + "documentation":"The ID of the web portal for the session.
", + "location":"uri", + "locationName":"portalId" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"The ID of the session to expire.
", + "location":"uri", + "locationName":"sessionId" + } + } + }, + "ExpireSessionResponse":{ + "type":"structure", + "members":{ + } + }, + "FieldName":{"type":"string"}, + "GetBrowserSettingsRequest":{ + "type":"structure", + "required":["browserSettingsArn"], + "members":{ + "browserSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the browser settings.
", + "location":"uri", + "locationName":"browserSettingsArn" + } + } + }, + "GetBrowserSettingsResponse":{ + "type":"structure", + "members":{ + "browserSettings":{ + "shape":"BrowserSettings", + "documentation":"The browser settings.
" + } + } + }, + "GetIdentityProviderRequest":{ + "type":"structure", + "required":["identityProviderArn"], + "members":{ + "identityProviderArn":{ + "shape":"SubresourceARN", + "documentation":"The ARN of the identity provider.
", + "location":"uri", + "locationName":"identityProviderArn" + } + } + }, + "GetIdentityProviderResponse":{ + "type":"structure", + "members":{ + "identityProvider":{ + "shape":"IdentityProvider", + "documentation":"The identity provider.
" + } + } + }, + "GetIpAccessSettingsRequest":{ + "type":"structure", + "required":["ipAccessSettingsArn"], + "members":{ + "ipAccessSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the IP access settings.
", + "location":"uri", + "locationName":"ipAccessSettingsArn" + } + } + }, + "GetIpAccessSettingsResponse":{ + "type":"structure", + "members":{ + "ipAccessSettings":{ + "shape":"IpAccessSettings", + "documentation":"The IP access settings.
" + } + } + }, + "GetNetworkSettingsRequest":{ + "type":"structure", + "required":["networkSettingsArn"], + "members":{ + "networkSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the network settings.
", + "location":"uri", + "locationName":"networkSettingsArn" + } + } + }, + "GetNetworkSettingsResponse":{ + "type":"structure", + "members":{ + "networkSettings":{ + "shape":"NetworkSettings", + "documentation":"The network settings.
" + } + } + }, + "GetPortalRequest":{ + "type":"structure", + "required":["portalArn"], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + } + } + }, + "GetPortalResponse":{ + "type":"structure", + "members":{ + "portal":{ + "shape":"Portal", + "documentation":"The web portal.
" + } + } + }, + "GetPortalServiceProviderMetadataRequest":{ + "type":"structure", + "required":["portalArn"], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + } + } + }, + "GetPortalServiceProviderMetadataResponse":{ + "type":"structure", + "required":["portalArn"], + "members":{ + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
" + }, + "serviceProviderSamlMetadata":{ + "shape":"SamlMetadata", + "documentation":"The service provider SAML metadata.
" + } + } + }, + "GetSessionRequest":{ + "type":"structure", + "required":[ + "portalId", + "sessionId" + ], + "members":{ + "portalId":{ + "shape":"PortalId", + "documentation":"The ID of the web portal for the session.
", + "location":"uri", + "locationName":"portalId" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"The ID of the session.
", + "location":"uri", + "locationName":"sessionId" + } + } + }, + "GetSessionResponse":{ + "type":"structure", + "members":{ + "session":{ + "shape":"Session", + "documentation":"The sessions in a list.
" + } + } + }, + "GetTrustStoreCertificateRequest":{ + "type":"structure", + "required":[ + "thumbprint", + "trustStoreArn" + ], + "members":{ + "thumbprint":{ + "shape":"CertificateThumbprint", + "documentation":"The thumbprint of the trust store certificate.
", + "location":"querystring", + "locationName":"thumbprint" + }, + "trustStoreArn":{ + "shape":"ARN", + "documentation":"The ARN of the trust store certificate.
", + "location":"uri", + "locationName":"trustStoreArn" + } + } + }, + "GetTrustStoreCertificateResponse":{ + "type":"structure", + "required":["trustStoreArn"], + "members":{ + "certificate":{ + "shape":"Certificate", + "documentation":"The certificate of the trust store certificate.
" + }, + "trustStoreArn":{ + "shape":"ARN", + "documentation":"The ARN of the trust store certificate.
" + } + } + }, + "GetTrustStoreRequest":{ + "type":"structure", + "required":["trustStoreArn"], + "members":{ + "trustStoreArn":{ + "shape":"ARN", + "documentation":"The ARN of the trust store.
", + "location":"uri", + "locationName":"trustStoreArn" + } + } + }, + "GetTrustStoreResponse":{ + "type":"structure", + "members":{ + "trustStore":{ + "shape":"TrustStore", + "documentation":"The trust store.
" + } + } + }, + "GetUserAccessLoggingSettingsRequest":{ + "type":"structure", + "required":["userAccessLoggingSettingsArn"], + "members":{ + "userAccessLoggingSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user access logging settings.
", + "location":"uri", + "locationName":"userAccessLoggingSettingsArn" + } + } + }, + "GetUserAccessLoggingSettingsResponse":{ + "type":"structure", + "members":{ + "userAccessLoggingSettings":{ + "shape":"UserAccessLoggingSettings", + "documentation":"The user access logging settings.
" + } + } + }, + "GetUserSettingsRequest":{ + "type":"structure", + "required":["userSettingsArn"], + "members":{ + "userSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user settings.
", + "location":"uri", + "locationName":"userSettingsArn" + } + } + }, + "GetUserSettingsResponse":{ + "type":"structure", + "members":{ + "userSettings":{ + "shape":"UserSettings", + "documentation":"The user settings.
" + } + } + }, + "IdentityProvider":{ + "type":"structure", + "required":["identityProviderArn"], + "members":{ + "identityProviderArn":{ + "shape":"SubresourceARN", + "documentation":"The ARN of the identity provider.
" + }, + "identityProviderDetails":{ + "shape":"IdentityProviderDetails", + "documentation":"The identity provider details. The following list describes the provider detail keys for each identity provider type.
For Google and Login with Amazon:
client_id
client_secret
authorize_scopes
For Facebook:
client_id
client_secret
authorize_scopes
api_version
For Sign in with Apple:
client_id
team_id
key_id
private_key
authorize_scopes
For OIDC providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
authorize_url if not available from discovery URL specified by oidc_issuer key
token_url if not available from discovery URL specified by oidc_issuer key
attributes_url if not available from discovery URL specified by oidc_issuer key
jwks_uri if not available from discovery URL specified by oidc_issuer key
For SAML providers:
MetadataFile OR MetadataURL
IDPSignout (boolean) optional
IDPInit (boolean) optional
RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256
EncryptedResponses (boolean) optional
The identity provider name.
" + }, + "identityProviderType":{ + "shape":"IdentityProviderType", + "documentation":"The identity provider type.
" + } + }, + "documentation":"The identity provider.
" + }, + "IdentityProviderDetails":{ + "type":"map", + "key":{"shape":"StringType"}, + "value":{"shape":"StringType"}, + "sensitive":true + }, + "IdentityProviderList":{ + "type":"list", + "member":{"shape":"IdentityProviderSummary"} + }, + "IdentityProviderName":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+$", + "sensitive":true + }, + "IdentityProviderSummary":{ + "type":"structure", + "required":["identityProviderArn"], + "members":{ + "identityProviderArn":{ + "shape":"SubresourceARN", + "documentation":"The ARN of the identity provider.
" + }, + "identityProviderName":{ + "shape":"IdentityProviderName", + "documentation":"The identity provider name.
" + }, + "identityProviderType":{ + "shape":"IdentityProviderType", + "documentation":"The identity provider type.
" + } + }, + "documentation":"The summary of the identity provider.
" + }, + "IdentityProviderType":{ + "type":"string", + "enum":[ + "SAML", + "Facebook", + "Google", + "LoginWithAmazon", + "SignInWithApple", + "OIDC" + ] + }, + "IdleDisconnectTimeoutInMinutes":{ + "type":"integer", + "box":true, + "max":60, + "min":0 + }, + "InstanceType":{ + "type":"string", + "enum":[ + "standard.regular", + "standard.large", + "standard.xlarge" + ] + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "retryAfterSeconds":{ + "shape":"RetryAfterSeconds", + "documentation":"Advice to clients on when the call can be safely retried.
", + "location":"header", + "locationName":"Retry-After" + } + }, + "documentation":"There is an internal server error.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "IpAccessSettings":{ + "type":"structure", + "required":["ipAccessSettingsArn"], + "members":{ + "additionalEncryptionContext":{ + "shape":"EncryptionContextMap", + "documentation":"The additional encryption context of the IP access settings.
" + }, + "associatedPortalArns":{ + "shape":"ArnList", + "documentation":"A list of web portal ARNs that this IP access settings resource is associated with.
" + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"The creation date timestamp of the IP access settings.
" + }, + "customerManagedKey":{ + "shape":"keyArn", + "documentation":"The customer managed key used to encrypt sensitive information in the IP access settings.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the IP access settings.
" + }, + "displayName":{ + "shape":"DisplayName", + "documentation":"The display name of the IP access settings.
" + }, + "ipAccessSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the IP access settings resource.
" + }, + "ipRules":{ + "shape":"IpRuleList", + "documentation":"The IP rules of the IP access settings.
" + } + }, + "documentation":"The IP access settings resource that can be associated with a web portal.
" + }, + "IpAccessSettingsList":{ + "type":"list", + "member":{"shape":"IpAccessSettingsSummary"} + }, + "IpAccessSettingsSummary":{ + "type":"structure", + "required":["ipAccessSettingsArn"], + "members":{ + "creationDate":{ + "shape":"Timestamp", + "documentation":"The creation date timestamp of the IP access settings.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the IP access settings.
" + }, + "displayName":{ + "shape":"DisplayName", + "documentation":"The display name of the IP access settings.
" + }, + "ipAccessSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of IP access settings.
" + } + }, + "documentation":"The summary of IP access settings.
" + }, + "IpAddress":{ + "type":"string", + "max":15, + "min":1, + "pattern":"^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$", + "sensitive":true + }, + "IpAddressList":{ + "type":"list", + "member":{"shape":"IpAddress"}, + "max":45, + "min":1 + }, + "IpRange":{ + "type":"string", + "documentation":"A single IP address or an IP address range in CIDR notation
", + "pattern":"^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}(?:/([0-9]|[12][0-9]|3[0-2])|)$", + "sensitive":true + }, + "IpRule":{ + "type":"structure", + "required":["ipRange"], + "members":{ + "description":{ + "shape":"Description", + "documentation":"The description of the IP rule.
" + }, + "ipRange":{ + "shape":"IpRange", + "documentation":"The IP range of the IP rule.
" + } + }, + "documentation":"The IP rules of the IP access settings.
" + }, + "IpRuleList":{ + "type":"list", + "member":{"shape":"IpRule"}, + "max":100, + "min":1, + "sensitive":true + }, + "KinesisStreamArn":{ + "type":"string", + "documentation":"Kinesis stream ARN to which log events are published.
", + "max":2048, + "min":20, + "pattern":"arn:[\\w+=/,.@-]+:kinesis:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:stream/.+" + }, + "ListBrowserSettingsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to be included in the next page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListBrowserSettingsResponse":{ + "type":"structure", + "members":{ + "browserSettings":{ + "shape":"BrowserSettingsList", + "documentation":"The browser settings.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
" + } + } + }, + "ListIdentityProvidersRequest":{ + "type":"structure", + "required":["portalArn"], + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to be included in the next page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
", + "location":"querystring", + "locationName":"nextToken" + }, + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + } + } + }, + "ListIdentityProvidersResponse":{ + "type":"structure", + "members":{ + "identityProviders":{ + "shape":"IdentityProviderList", + "documentation":"The identity providers.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
" + } + } + }, + "ListIpAccessSettingsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to be included in the next page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListIpAccessSettingsResponse":{ + "type":"structure", + "members":{ + "ipAccessSettings":{ + "shape":"IpAccessSettingsList", + "documentation":"The IP access settings.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
" + } + } + }, + "ListNetworkSettingsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to be included in the next page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListNetworkSettingsResponse":{ + "type":"structure", + "members":{ + "networkSettings":{ + "shape":"NetworkSettingsList", + "documentation":"The network settings.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
" + } + } + }, + "ListPortalsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to be included in the next page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListPortalsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
" + }, + "portals":{ + "shape":"PortalList", + "documentation":"The portals in the list.
" + } + } + }, + "ListSessionsRequest":{ + "type":"structure", + "required":["portalId"], + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to be included in the next page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
", + "location":"querystring", + "locationName":"nextToken" + }, + "portalId":{ + "shape":"PortalId", + "documentation":"The ID of the web portal for the sessions.
", + "location":"uri", + "locationName":"portalId" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"The ID of the session.
", + "location":"querystring", + "locationName":"sessionId" + }, + "sortBy":{ + "shape":"SessionSortBy", + "documentation":"The method in which the returned sessions should be sorted.
", + "location":"querystring", + "locationName":"sortBy" + }, + "status":{ + "shape":"SessionStatus", + "documentation":"The status of the session.
", + "location":"querystring", + "locationName":"status" + }, + "username":{ + "shape":"Username", + "documentation":"The username of the session.
", + "location":"querystring", + "locationName":"username" + } + } + }, + "ListSessionsResponse":{ + "type":"structure", + "required":["sessions"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
" + }, + "sessions":{ + "shape":"SessionSummaryList", + "documentation":"The sessions in a list.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ARN", + "documentation":"The ARN of the resource.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"The tags of the resource.
" + } + } + }, + "ListTrustStoreCertificatesRequest":{ + "type":"structure", + "required":["trustStoreArn"], + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to be included in the next page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
", + "location":"querystring", + "locationName":"nextToken" + }, + "trustStoreArn":{ + "shape":"ARN", + "documentation":"The ARN of the trust store
", + "location":"uri", + "locationName":"trustStoreArn" + } + } + }, + "ListTrustStoreCertificatesResponse":{ + "type":"structure", + "required":["trustStoreArn"], + "members":{ + "certificateList":{ + "shape":"CertificateSummaryList", + "documentation":"The certificate list.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.>
" + }, + "trustStoreArn":{ + "shape":"ARN", + "documentation":"The ARN of the trust store.
" + } + } + }, + "ListTrustStoresRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to be included in the next page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListTrustStoresResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
" + }, + "trustStores":{ + "shape":"TrustStoreSummaryList", + "documentation":"The trust stores.
" + } + } + }, + "ListUserAccessLoggingSettingsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to be included in the next page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListUserAccessLoggingSettingsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
" + }, + "userAccessLoggingSettings":{ + "shape":"UserAccessLoggingSettingsList", + "documentation":"The user access logging settings.
" + } + } + }, + "ListUserSettingsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to be included in the next page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListUserSettingsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The pagination token used to retrieve the next page of results for this operation.
" + }, + "userSettings":{ + "shape":"UserSettingsList", + "documentation":"The user settings.
" + } + } + }, + "MaxConcurrentSessions":{ + "type":"integer", + "box":true, + "max":5000, + "min":1 + }, + "MaxResults":{ + "type":"integer", + "box":true, + "min":1 + }, + "NetworkSettings":{ + "type":"structure", + "required":["networkSettingsArn"], + "members":{ + "associatedPortalArns":{ + "shape":"ArnList", + "documentation":"A list of web portal ARNs that this network settings is associated with.
" + }, + "networkSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the network settings.
" + }, + "securityGroupIds":{ + "shape":"SecurityGroupIdList", + "documentation":"One or more security groups used to control access from streaming instances to your VPC.
" + }, + "subnetIds":{ + "shape":"SubnetIdList", + "documentation":"The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.
" + }, + "vpcId":{ + "shape":"VpcId", + "documentation":"The VPC that streaming instances will connect to.
" + } + }, + "documentation":"A network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC.
" + }, + "NetworkSettingsList":{ + "type":"list", + "member":{"shape":"NetworkSettingsSummary"} + }, + "NetworkSettingsSummary":{ + "type":"structure", + "required":["networkSettingsArn"], + "members":{ + "networkSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the network settings.
" + }, + "vpcId":{ + "shape":"VpcId", + "documentation":"The VPC ID of the network settings.
" + } + }, + "documentation":"The summary of network settings.
" + }, + "PaginationToken":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^\\S+$" + }, + "Portal":{ + "type":"structure", + "required":["portalArn"], + "members":{ + "additionalEncryptionContext":{ + "shape":"EncryptionContextMap", + "documentation":"The additional encryption context of the portal.
" + }, + "authenticationType":{ + "shape":"AuthenticationType", + "documentation":"The type of authentication integration points used when signing into the web portal. Defaults to Standard.
Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
The ARN of the browser settings that is associated with this web portal.
" + }, + "browserType":{ + "shape":"BrowserType", + "documentation":"The browser that users see when using a streaming session.
" + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"The creation date of the web portal.
" + }, + "customerManagedKey":{ + "shape":"keyArn", + "documentation":"The customer managed key used to encrypt sensitive information in the portal.
" + }, + "displayName":{ + "shape":"DisplayName", + "documentation":"The name of the web portal.
" + }, + "instanceType":{ + "shape":"InstanceType", + "documentation":"The type and resources of the underlying instance.
" + }, + "ipAccessSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the IP access settings.
" + }, + "maxConcurrentSessions":{ + "shape":"MaxConcurrentSessions", + "documentation":"The maximum number of concurrent sessions for the portal.
" + }, + "networkSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the network settings that is associated with the web portal.
" + }, + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
" + }, + "portalEndpoint":{ + "shape":"PortalEndpoint", + "documentation":"The endpoint URL of the web portal that users access in order to start streaming sessions.
" + }, + "portalStatus":{ + "shape":"PortalStatus", + "documentation":"The status of the web portal.
" + }, + "rendererType":{ + "shape":"RendererType", + "documentation":"The renderer that is used in streaming sessions.
" + }, + "statusReason":{ + "shape":"StatusReason", + "documentation":"A message that explains why the web portal is in its current status.
" + }, + "trustStoreArn":{ + "shape":"ARN", + "documentation":"The ARN of the trust store that is associated with the web portal.
" + }, + "userAccessLoggingSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user access logging settings that is associated with the web portal.
" + }, + "userSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user settings that is associated with the web portal.
" + } + }, + "documentation":"The web portal.
" + }, + "PortalEndpoint":{ + "type":"string", + "max":253, + "min":1, + "pattern":"^[a-zA-Z0-9]?((?!-)([A-Za-z0-9-]*[A-Za-z0-9])\\.)+[a-zA-Z0-9]+$" + }, + "PortalId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[a-zA-Z0-9\\-]+$" + }, + "PortalList":{ + "type":"list", + "member":{"shape":"PortalSummary"} + }, + "PortalStatus":{ + "type":"string", + "enum":[ + "Incomplete", + "Pending", + "Active" + ] + }, + "PortalSummary":{ + "type":"structure", + "required":["portalArn"], + "members":{ + "authenticationType":{ + "shape":"AuthenticationType", + "documentation":"The type of authentication integration points used when signing into the web portal. Defaults to Standard.
Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
The ARN of the browser settings that is associated with the web portal.
" + }, + "browserType":{ + "shape":"BrowserType", + "documentation":"The browser type of the web portal.
" + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"The creation date of the web portal.
" + }, + "displayName":{ + "shape":"DisplayName", + "documentation":"The name of the web portal.
" + }, + "instanceType":{ + "shape":"InstanceType", + "documentation":"The type and resources of the underlying instance.
" + }, + "ipAccessSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the IP access settings.
" + }, + "maxConcurrentSessions":{ + "shape":"MaxConcurrentSessions", + "documentation":"The maximum number of concurrent sessions for the portal.
" + }, + "networkSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the network settings that is associated with the web portal.
" + }, + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
" + }, + "portalEndpoint":{ + "shape":"PortalEndpoint", + "documentation":"The endpoint URL of the web portal that users access in order to start streaming sessions.
" + }, + "portalStatus":{ + "shape":"PortalStatus", + "documentation":"The status of the web portal.
" + }, + "rendererType":{ + "shape":"RendererType", + "documentation":"The renderer that is used in streaming sessions.
" + }, + "trustStoreArn":{ + "shape":"ARN", + "documentation":"The ARN of the trust that is associated with this web portal.
" + }, + "userAccessLoggingSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user access logging settings that is associated with the web portal.
" + }, + "userSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user settings that is associated with the web portal.
" + } + }, + "documentation":"The summary of the portal.
" + }, + "QuotaCode":{"type":"string"}, + "RendererType":{ + "type":"string", + "enum":["AppStream"] + }, + "ResourceId":{"type":"string"}, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "resourceId":{ + "shape":"ResourceId", + "documentation":"Hypothetical identifier of the resource affected.
" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"Hypothetical type of the resource affected.
" + } + }, + "documentation":"The resource cannot be found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceType":{"type":"string"}, + "RetryAfterSeconds":{"type":"integer"}, + "SamlMetadata":{ + "type":"string", + "max":204800, + "min":1, + "pattern":"^.+$" + }, + "SecurityGroupId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[\\w+\\-]+$" + }, + "SecurityGroupIdList":{ + "type":"list", + "member":{"shape":"SecurityGroupId"}, + "max":5, + "min":1 + }, + "ServiceCode":{"type":"string"}, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "quotaCode":{ + "shape":"QuotaCode", + "documentation":"The originating quota.
" + }, + "resourceId":{ + "shape":"ResourceId", + "documentation":"Identifier of the resource affected.
" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"Type of the resource affected.
" + }, + "serviceCode":{ + "shape":"ServiceCode", + "documentation":"The originating service.
" + } + }, + "documentation":"The service quota has been exceeded.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "Session":{ + "type":"structure", + "members":{ + "clientIpAddresses":{ + "shape":"IpAddressList", + "documentation":"The IP address of the client.
" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"The end time of the session.
" + }, + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
" + }, + "sessionId":{ + "shape":"StringType", + "documentation":"The ID of the session.
" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"The start time of the session.
" + }, + "status":{ + "shape":"SessionStatus", + "documentation":"The status of the session.
" + }, + "username":{ + "shape":"Username", + "documentation":"The username of the session.
" + } + }, + "documentation":"Information about a secure browser session.
" + }, + "SessionId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[a-zA-Z0-9\\-]+$" + }, + "SessionSortBy":{ + "type":"string", + "enum":[ + "StartTimeAscending", + "StartTimeDescending" + ] + }, + "SessionStatus":{ + "type":"string", + "enum":[ + "Active", + "Terminated" + ] + }, + "SessionSummary":{ + "type":"structure", + "members":{ + "endTime":{ + "shape":"Timestamp", + "documentation":"The end time of the session.
" + }, + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
" + }, + "sessionId":{ + "shape":"StringType", + "documentation":"The ID of the session.
" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"The start time of the session.
" + }, + "status":{ + "shape":"SessionStatus", + "documentation":"The status of the session.
" + }, + "username":{ + "shape":"Username", + "documentation":"The username of the session.
" + } + }, + "documentation":"Summary information about a secure browser session.
" + }, + "SessionSummaryList":{ + "type":"list", + "member":{"shape":"SessionSummary"} + }, + "StatusReason":{ + "type":"string", + "max":1024, + "min":1, + "pattern":".*" + }, + "StringType":{ + "type":"string", + "max":131072, + "min":0, + "pattern":"^[\\s\\S]*$" + }, + "SubnetId":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^subnet-([0-9a-f]{8}|[0-9a-f]{17})$" + }, + "SubnetIdList":{ + "type":"list", + "member":{"shape":"SubnetId"}, + "max":5, + "min":2 + }, + "SubresourceARN":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36}){2,}$" + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"The key of the tag.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The value of the tag
" + } + }, + "documentation":"The tag.
", + "sensitive":true + }, + "TagExceptionMessage":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "sensitive":true + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"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, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + }, + "resourceArn":{ + "shape":"ARN", + "documentation":"The ARN of the resource.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags of the resource.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "sensitive":true + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "quotaCode":{ + "shape":"QuotaCode", + "documentation":"The originating quota.
" + }, + "retryAfterSeconds":{ + "shape":"RetryAfterSeconds", + "documentation":"Advice to clients on when the call can be safely retried.
", + "location":"header", + "locationName":"Retry-After" + }, + "serviceCode":{ + "shape":"ServiceCode", + "documentation":"The originating service.
" + } + }, + "documentation":"There is a throttling error.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "message":{"shape":"TagExceptionMessage"}, + "resourceName":{ + "shape":"ARN", + "documentation":"Name of the resource affected.
" + } + }, + "documentation":"There are too many tags.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TrustStore":{ + "type":"structure", + "required":["trustStoreArn"], + "members":{ + "associatedPortalArns":{ + "shape":"ArnList", + "documentation":"A list of web portal ARNs that this trust store is associated with.
" + }, + "trustStoreArn":{ + "shape":"ARN", + "documentation":"The ARN of the trust store.
" + } + }, + "documentation":"A trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a streaming session will recognize certificates that have been issued using any of the CAs in the trust store. If your organization has internal websites that use certificates issued by private CAs, you should add the private CA certificate to the trust store.
" + }, + "TrustStoreSummary":{ + "type":"structure", + "members":{ + "trustStoreArn":{ + "shape":"ARN", + "documentation":"The ARN of the trust store.
" + } + }, + "documentation":"The summary of the trust store.
" + }, + "TrustStoreSummaryList":{ + "type":"list", + "member":{"shape":"TrustStoreSummary"} + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ARN", + "documentation":"The ARN of the resource.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"The list of tag keys to remove from the resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateBrowserSettingsRequest":{ + "type":"structure", + "required":["browserSettingsArn"], + "members":{ + "browserPolicy":{ + "shape":"BrowserPolicy", + "documentation":"A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
" + }, + "browserSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the browser settings.
", + "location":"uri", + "locationName":"browserSettingsArn" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"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, subsequent retries with the same client token return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + } + } + }, + "UpdateBrowserSettingsResponse":{ + "type":"structure", + "required":["browserSettings"], + "members":{ + "browserSettings":{ + "shape":"BrowserSettings", + "documentation":"The browser settings.
" + } + } + }, + "UpdateIdentityProviderRequest":{ + "type":"structure", + "required":["identityProviderArn"], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"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, subsequent retries with the same client token return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + }, + "identityProviderArn":{ + "shape":"SubresourceARN", + "documentation":"The ARN of the identity provider.
", + "location":"uri", + "locationName":"identityProviderArn" + }, + "identityProviderDetails":{ + "shape":"IdentityProviderDetails", + "documentation":"The details of the identity provider. The following list describes the provider detail keys for each identity provider type.
For Google and Login with Amazon:
client_id
client_secret
authorize_scopes
For Facebook:
client_id
client_secret
authorize_scopes
api_version
For Sign in with Apple:
client_id
team_id
key_id
private_key
authorize_scopes
For OIDC providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
authorize_url if not available from discovery URL specified by oidc_issuer key
token_url if not available from discovery URL specified by oidc_issuer key
attributes_url if not available from discovery URL specified by oidc_issuer key
jwks_uri if not available from discovery URL specified by oidc_issuer key
For SAML providers:
MetadataFile OR MetadataURL
IDPSignout (boolean) optional
IDPInit (boolean) optional
RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256
EncryptedResponses (boolean) optional
The name of the identity provider.
" + }, + "identityProviderType":{ + "shape":"IdentityProviderType", + "documentation":"The type of the identity provider.
" + } + } + }, + "UpdateIdentityProviderResponse":{ + "type":"structure", + "required":["identityProvider"], + "members":{ + "identityProvider":{ + "shape":"IdentityProvider", + "documentation":"The identity provider.
" + } + } + }, + "UpdateIpAccessSettingsRequest":{ + "type":"structure", + "required":["ipAccessSettingsArn"], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"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, subsequent retries with the same client token return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + }, + "description":{ + "shape":"Description", + "documentation":"The description of the IP access settings.
" + }, + "displayName":{ + "shape":"DisplayName", + "documentation":"The display name of the IP access settings.
" + }, + "ipAccessSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the IP access settings.
", + "location":"uri", + "locationName":"ipAccessSettingsArn" + }, + "ipRules":{ + "shape":"IpRuleList", + "documentation":"The updated IP rules of the IP access settings.
" + } + } + }, + "UpdateIpAccessSettingsResponse":{ + "type":"structure", + "required":["ipAccessSettings"], + "members":{ + "ipAccessSettings":{ + "shape":"IpAccessSettings", + "documentation":"The IP access settings.
" + } + } + }, + "UpdateNetworkSettingsRequest":{ + "type":"structure", + "required":["networkSettingsArn"], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"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, subsequent retries with the same client token return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + }, + "networkSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the network settings.
", + "location":"uri", + "locationName":"networkSettingsArn" + }, + "securityGroupIds":{ + "shape":"SecurityGroupIdList", + "documentation":"One or more security groups used to control access from streaming instances to your VPC.
" + }, + "subnetIds":{ + "shape":"SubnetIdList", + "documentation":"The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.
" + }, + "vpcId":{ + "shape":"VpcId", + "documentation":"The VPC that streaming instances will connect to.
" + } + } + }, + "UpdateNetworkSettingsResponse":{ + "type":"structure", + "required":["networkSettings"], + "members":{ + "networkSettings":{ + "shape":"NetworkSettings", + "documentation":"The network settings.
" + } + } + }, + "UpdatePortalRequest":{ + "type":"structure", + "required":["portalArn"], + "members":{ + "authenticationType":{ + "shape":"AuthenticationType", + "documentation":"The type of authentication integration points used when signing into the web portal. Defaults to Standard.
Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
The name of the web portal. This is not visible to users who log into the web portal.
" + }, + "instanceType":{ + "shape":"InstanceType", + "documentation":"The type and resources of the underlying instance.
" + }, + "maxConcurrentSessions":{ + "shape":"MaxConcurrentSessions", + "documentation":"The maximum number of concurrent sessions for the portal.
" + }, + "portalArn":{ + "shape":"ARN", + "documentation":"The ARN of the web portal.
", + "location":"uri", + "locationName":"portalArn" + } + } + }, + "UpdatePortalResponse":{ + "type":"structure", + "members":{ + "portal":{ + "shape":"Portal", + "documentation":"The web portal.
" + } + } + }, + "UpdateTrustStoreRequest":{ + "type":"structure", + "required":["trustStoreArn"], + "members":{ + "certificatesToAdd":{ + "shape":"CertificateList", + "documentation":"A list of CA certificates to add to the trust store.
" + }, + "certificatesToDelete":{ + "shape":"CertificateThumbprintList", + "documentation":"A list of CA certificates to delete from a trust store.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"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, subsequent retries with the same client token return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + }, + "trustStoreArn":{ + "shape":"ARN", + "documentation":"The ARN of the trust store.
", + "location":"uri", + "locationName":"trustStoreArn" + } + } + }, + "UpdateTrustStoreResponse":{ + "type":"structure", + "required":["trustStoreArn"], + "members":{ + "trustStoreArn":{ + "shape":"ARN", + "documentation":"The ARN of the trust store.
" + } + } + }, + "UpdateUserAccessLoggingSettingsRequest":{ + "type":"structure", + "required":["userAccessLoggingSettingsArn"], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"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, subsequent retries with the same client token return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + }, + "kinesisStreamArn":{ + "shape":"KinesisStreamArn", + "documentation":"The ARN of the Kinesis stream.
" + }, + "userAccessLoggingSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user access logging settings.
", + "location":"uri", + "locationName":"userAccessLoggingSettingsArn" + } + } + }, + "UpdateUserAccessLoggingSettingsResponse":{ + "type":"structure", + "required":["userAccessLoggingSettings"], + "members":{ + "userAccessLoggingSettings":{ + "shape":"UserAccessLoggingSettings", + "documentation":"The user access logging settings.
" + } + } + }, + "UpdateUserSettingsRequest":{ + "type":"structure", + "required":["userSettingsArn"], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"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, subsequent retries with the same client token return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
", + "idempotencyToken":true + }, + "cookieSynchronizationConfiguration":{ + "shape":"CookieSynchronizationConfiguration", + "documentation":"The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
If the allowlist and blocklist are empty, the configuration becomes null.
" + }, + "copyAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can copy text from the streaming session to the local device.
" + }, + "deepLinkAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can use deep links that open automatically when connecting to a session.
" + }, + "disconnectTimeoutInMinutes":{ + "shape":"DisconnectTimeoutInMinutes", + "documentation":"The amount of time that a streaming session remains active after users disconnect.
" + }, + "downloadAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can download files from the streaming session to the local device.
" + }, + "idleDisconnectTimeoutInMinutes":{ + "shape":"IdleDisconnectTimeoutInMinutes", + "documentation":"The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" + }, + "pasteAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can paste text from the local device to the streaming session.
" + }, + "printAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can print to the local device.
" + }, + "uploadAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can upload files from the local device to the streaming session.
" + }, + "userSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user settings.
", + "location":"uri", + "locationName":"userSettingsArn" + } + } + }, + "UpdateUserSettingsResponse":{ + "type":"structure", + "required":["userSettings"], + "members":{ + "userSettings":{ + "shape":"UserSettings", + "documentation":"The user settings.
" + } + } + }, + "UserAccessLoggingSettings":{ + "type":"structure", + "required":["userAccessLoggingSettingsArn"], + "members":{ + "associatedPortalArns":{ + "shape":"ArnList", + "documentation":"A list of web portal ARNs that this user access logging settings is associated with.
" + }, + "kinesisStreamArn":{ + "shape":"KinesisStreamArn", + "documentation":"The ARN of the Kinesis stream.
" + }, + "userAccessLoggingSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user access logging settings.
" + } + }, + "documentation":"A user access logging settings resource that can be associated with a web portal.
" + }, + "UserAccessLoggingSettingsList":{ + "type":"list", + "member":{"shape":"UserAccessLoggingSettingsSummary"} + }, + "UserAccessLoggingSettingsSummary":{ + "type":"structure", + "required":["userAccessLoggingSettingsArn"], + "members":{ + "kinesisStreamArn":{ + "shape":"KinesisStreamArn", + "documentation":"The ARN of the Kinesis stream.
" + }, + "userAccessLoggingSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user access logging settings.
" + } + }, + "documentation":"The summary of user access logging settings.
" + }, + "UserSettings":{ + "type":"structure", + "required":["userSettingsArn"], + "members":{ + "additionalEncryptionContext":{ + "shape":"EncryptionContextMap", + "documentation":"The additional encryption context of the user settings.
" + }, + "associatedPortalArns":{ + "shape":"ArnList", + "documentation":"A list of web portal ARNs that this user settings is associated with.
" + }, + "cookieSynchronizationConfiguration":{ + "shape":"CookieSynchronizationConfiguration", + "documentation":"The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
" + }, + "copyAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can copy text from the streaming session to the local device.
" + }, + "customerManagedKey":{ + "shape":"keyArn", + "documentation":"The customer managed key used to encrypt sensitive information in the user settings.
" + }, + "deepLinkAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can use deep links that open automatically when connecting to a session.
" + }, + "disconnectTimeoutInMinutes":{ + "shape":"DisconnectTimeoutInMinutes", + "documentation":"The amount of time that a streaming session remains active after users disconnect.
" + }, + "downloadAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can download files from the streaming session to the local device.
" + }, + "idleDisconnectTimeoutInMinutes":{ + "shape":"IdleDisconnectTimeoutInMinutes", + "documentation":"The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" + }, + "pasteAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can paste text from the local device to the streaming session.
" + }, + "printAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can print to the local device.
" + }, + "uploadAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can upload files from the local device to the streaming session.
" + }, + "userSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user settings.
" + } + }, + "documentation":"A user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.
" + }, + "UserSettingsList":{ + "type":"list", + "member":{"shape":"UserSettingsSummary"} + }, + "UserSettingsSummary":{ + "type":"structure", + "required":["userSettingsArn"], + "members":{ + "cookieSynchronizationConfiguration":{ + "shape":"CookieSynchronizationConfiguration", + "documentation":"The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
" + }, + "copyAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can copy text from the streaming session to the local device.
" + }, + "deepLinkAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can use deep links that open automatically when connecting to a session.
" + }, + "disconnectTimeoutInMinutes":{ + "shape":"DisconnectTimeoutInMinutes", + "documentation":"The amount of time that a streaming session remains active after users disconnect.
" + }, + "downloadAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can download files from the streaming session to the local device.
" + }, + "idleDisconnectTimeoutInMinutes":{ + "shape":"IdleDisconnectTimeoutInMinutes", + "documentation":"The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" + }, + "pasteAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can paste text from the local device to the streaming session.
" + }, + "printAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can print to the local device.
" + }, + "uploadAllowed":{ + "shape":"EnabledType", + "documentation":"Specifies whether the user can upload files from the local device to the streaming session.
" + }, + "userSettingsArn":{ + "shape":"ARN", + "documentation":"The ARN of the user settings.
" + } + }, + "documentation":"The summary of user settings.
" + }, + "Username":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^[\\s\\S]*$", + "sensitive":true + }, + "ValidationException":{ + "type":"structure", + "members":{ + "fieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"The field that caused the error.
" + }, + "message":{"shape":"ExceptionMessage"}, + "reason":{ + "shape":"ValidationExceptionReason", + "documentation":"Reason the request failed validation
" + } + }, + "documentation":"There is a validation error.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "message", + "name" + ], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The message describing why the field failed validation.
" + }, + "name":{ + "shape":"FieldName", + "documentation":"The name of the field that failed validation.
" + } + }, + "documentation":"Information about a field passed inside a request that resulted in an exception.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "unknownOperation", + "cannotParse", + "fieldValidationFailed", + "other" + ] + }, + "VpcId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^vpc-[0-9a-z]*$" + }, + "keyArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:key\\/[a-zA-Z0-9-]+$" + } + }, + "documentation":"Amazon WorkSpaces Secure Browser is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads. WorkSpaces Secure Browser makes it easy for customers to safely provide their employees with access to internal websites and SaaS web applications without the administrative burden of appliances or specialized client software. WorkSpaces Secure Browser provides simple policy tools tailored for user interactions, while offloading common tasks like capacity management, scaling, and maintaining browser images.
" +} diff --git a/testbed/boto__botocore/botocore/data/workspaces/2015-04-08/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/workspaces/2015-04-08/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..8c5f0378c004317ea2d24496d12960809dae6a04 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workspaces/2015-04-08/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://workspaces-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://workspaces-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://workspaces.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://workspaces.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/workspaces/2015-04-08/examples-1.json b/testbed/boto__botocore/botocore/data/workspaces/2015-04-08/examples-1.json new file mode 100644 index 0000000000000000000000000000000000000000..0ea7e3b0bbe917eb027880396ac01509becd1fa0 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workspaces/2015-04-08/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/testbed/boto__botocore/botocore/data/workspaces/2015-04-08/paginators-1.json b/testbed/boto__botocore/botocore/data/workspaces/2015-04-08/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..01176ffbc705dbe19dc7cb609cc84460221d7220 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workspaces/2015-04-08/paginators-1.json @@ -0,0 +1,54 @@ +{ + "pagination": { + "DescribeWorkspaceBundles": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Bundles" + }, + "DescribeWorkspaceDirectories": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Directories" + }, + "DescribeWorkspaces": { + "limit_key": "Limit", + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Workspaces" + }, + "DescribeAccountModifications": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "AccountModifications" + }, + "DescribeIpGroups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Result" + }, + "DescribeWorkspaceImages": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Images" + }, + "DescribeWorkspacesConnectionStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "WorkspacesConnectionStatus" + }, + "ListAvailableManagementCidrRanges": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ManagementCidrRanges" + }, + "ListAccountLinks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "AccountLinks" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/workspaces/2015-04-08/service-2.json b/testbed/boto__botocore/botocore/data/workspaces/2015-04-08/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..6a7ea5c8023c5ca8a7d566231bbdb5794ec9eb65 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/workspaces/2015-04-08/service-2.json @@ -0,0 +1,7090 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-04-08", + "endpointPrefix":"workspaces", + "jsonVersion":"1.1", + "protocol":"json", + "protocols":["json"], + "serviceFullName":"Amazon WorkSpaces", + "serviceId":"WorkSpaces", + "signatureVersion":"v4", + "targetPrefix":"WorkspacesService", + "uid":"workspaces-2015-04-08", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "AcceptAccountLinkInvitation":{ + "name":"AcceptAccountLinkInvitation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptAccountLinkInvitationRequest"}, + "output":{"shape":"AcceptAccountLinkInvitationResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Accepts the account link invitation.
There's currently no unlinking capability after you accept the account linking invitation.
Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
Associates the specified IP access control group with the specified directory.
" + }, + "AssociateWorkspaceApplication":{ + "name":"AssociateWorkspaceApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateWorkspaceApplicationRequest"}, + "output":{"shape":"AssociateWorkspaceApplicationResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ComputeNotCompatibleException"}, + {"shape":"OperatingSystemNotCompatibleException"}, + {"shape":"ApplicationNotSupportedException"}, + {"shape":"IncompatibleApplicationsException"} + ], + "documentation":"Associates the specified application to the specified WorkSpace.
" + }, + "AuthorizeIpRules":{ + "name":"AuthorizeIpRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeIpRulesRequest"}, + "output":{"shape":"AuthorizeIpRulesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Adds one or more rules to the specified IP access control group.
This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
" + }, + "CopyWorkspaceImage":{ + "name":"CopyWorkspaceImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyWorkspaceImageRequest"}, + "output":{"shape":"CopyWorkspaceImageResult"}, + "errors":[ + {"shape":"ResourceLimitExceededException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceUnavailableException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.
In the China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.
Creates the account link invitation.
" + }, + "CreateConnectClientAddIn":{ + "name":"CreateConnectClientAddIn", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateConnectClientAddInRequest"}, + "output":{"shape":"CreateConnectClientAddInResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceCreationFailedException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"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.
" + }, + "CreateConnectionAlias":{ + "name":"CreateConnectionAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateConnectionAliasRequest"}, + "output":{"shape":"CreateConnectionAliasResult"}, + "errors":[ + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
" + }, + "CreateIpGroup":{ + "name":"CreateIpGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateIpGroupRequest"}, + "output":{"shape":"CreateIpGroupResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceCreationFailedException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Creates an IP access control group.
An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.
There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.
" + }, + "CreateStandbyWorkspaces":{ + "name":"CreateStandbyWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStandbyWorkspacesRequest"}, + "output":{"shape":"CreateStandbyWorkspacesResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceLimitExceededException"} + ], + "documentation":"Creates a standby WorkSpace in a secondary Region.
" + }, + "CreateTags":{ + "name":"CreateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagsRequest"}, + "output":{"shape":"CreateTagsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceLimitExceededException"} + ], + "documentation":"Creates the specified tags for the specified WorkSpaces resource.
" + }, + "CreateUpdatedWorkspaceImage":{ + "name":"CreateUpdatedWorkspaceImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUpdatedWorkspaceImageRequest"}, + "output":{"shape":"CreateUpdatedWorkspaceImageResult"}, + "errors":[ + {"shape":"ResourceLimitExceededException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.
To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages.
Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.
Microsoft Windows updates and other application updates are not included in the update process.
The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle.
Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.
" + }, + "CreateWorkspaceImage":{ + "name":"CreateWorkspaceImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWorkspaceImageRequest"}, + "output":{"shape":"CreateWorkspaceImageResult"}, + "errors":[ + {"shape":"ResourceLimitExceededException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"Creates a new WorkSpace image from an existing WorkSpace.
" + }, + "CreateWorkspaces":{ + "name":"CreateWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWorkspacesRequest"}, + "output":{"shape":"CreateWorkspacesResult"}, + "errors":[ + {"shape":"ResourceLimitExceededException"}, + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
You don't need to specify the PCOIP protocol for Linux bundles because WSP is the default protocol for those bundles.
User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core.
Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
Creates a pool of WorkSpaces.
" + }, + "DeleteAccountLinkInvitation":{ + "name":"DeleteAccountLinkInvitation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAccountLinkInvitationRequest"}, + "output":{"shape":"DeleteAccountLinkInvitationResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes the account link invitation.
" + }, + "DeleteClientBranding":{ + "name":"DeleteClientBranding", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClientBrandingRequest"}, + "output":{"shape":"DeleteClientBrandingResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you delete your customized client branding, your login portal reverts to the default client branding.
" + }, + "DeleteConnectClientAddIn":{ + "name":"DeleteConnectClientAddIn", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConnectClientAddInRequest"}, + "output":{"shape":"DeleteConnectClientAddInResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes a client-add-in for Amazon Connect that is configured within a directory.
" + }, + "DeleteConnectionAlias":{ + "name":"DeleteConnectionAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConnectionAliasRequest"}, + "output":{"shape":"DeleteConnectionAliasResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAssociatedException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
Deletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
" + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsRequest"}, + "output":{"shape":"DeleteTagsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"Deletes the specified tags from the specified WorkSpaces resource.
" + }, + "DeleteWorkspaceBundle":{ + "name":"DeleteWorkspaceBundle", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWorkspaceBundleRequest"}, + "output":{"shape":"DeleteWorkspaceBundleResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAssociatedException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.
" + }, + "DeleteWorkspaceImage":{ + "name":"DeleteWorkspaceImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWorkspaceImageRequest"}, + "output":{"shape":"DeleteWorkspaceImageResult"}, + "errors":[ + {"shape":"ResourceAssociatedException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.
" + }, + "DeployWorkspaceApplications":{ + "name":"DeployWorkspaceApplications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeployWorkspaceApplicationsRequest"}, + "output":{"shape":"DeployWorkspaceApplicationsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"IncompatibleApplicationsException"} + ], + "documentation":"Deploys associated applications to the specified WorkSpace
" + }, + "DeregisterWorkspaceDirectory":{ + "name":"DeregisterWorkspaceDirectory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterWorkspaceDirectoryRequest"}, + "output":{"shape":"DeregisterWorkspaceDirectoryResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidResourceStateException"} + ], + "documentation":"Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
" + }, + "DescribeAccountModifications":{ + "name":"DescribeAccountModifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountModificationsRequest"}, + "output":{"shape":"DescribeAccountModificationsResult"}, + "errors":[ + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
" + }, + "DescribeApplicationAssociations":{ + "name":"DescribeApplicationAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeApplicationAssociationsRequest"}, + "output":{"shape":"DescribeApplicationAssociationsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Describes the associations between the application and the specified associated resources.
" + }, + "DescribeApplications":{ + "name":"DescribeApplications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeApplicationsRequest"}, + "output":{"shape":"DescribeApplicationsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.
" + }, + "DescribeBundleAssociations":{ + "name":"DescribeBundleAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBundleAssociationsRequest"}, + "output":{"shape":"DescribeBundleAssociationsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Describes the associations between the applications and the specified bundle.
" + }, + "DescribeClientBranding":{ + "name":"DescribeClientBranding", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClientBrandingRequest"}, + "output":{"shape":"DescribeClientBrandingResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
Only device types that have branding information configured will be shown in the response.
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
" + }, + "DescribeConnectClientAddIns":{ + "name":"DescribeConnectClientAddIns", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConnectClientAddInsRequest"}, + "output":{"shape":"DescribeConnectClientAddInsResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of Amazon Connect client add-ins that have been created.
" + }, + "DescribeConnectionAliasPermissions":{ + "name":"DescribeConnectionAliasPermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConnectionAliasPermissionsRequest"}, + "output":{"shape":"DescribeConnectionAliasPermissionsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
" + }, + "DescribeConnectionAliases":{ + "name":"DescribeConnectionAliases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConnectionAliasesRequest"}, + "output":{"shape":"DescribeConnectionAliasesResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
" + }, + "DescribeImageAssociations":{ + "name":"DescribeImageAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImageAssociationsRequest"}, + "output":{"shape":"DescribeImageAssociationsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Describes the associations between the applications and the specified image.
" + }, + "DescribeIpGroups":{ + "name":"DescribeIpGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIpGroupsRequest"}, + "output":{"shape":"DescribeIpGroupsResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Describes one or more of your IP access control groups.
" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsRequest"}, + "output":{"shape":"DescribeTagsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Describes the specified tags for the specified WorkSpaces resource.
" + }, + "DescribeWorkspaceAssociations":{ + "name":"DescribeWorkspaceAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspaceAssociationsRequest"}, + "output":{"shape":"DescribeWorkspaceAssociationsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Describes the associations betweens applications and the specified WorkSpace.
" + }, + "DescribeWorkspaceBundles":{ + "name":"DescribeWorkspaceBundles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspaceBundlesRequest"}, + "output":{"shape":"DescribeWorkspaceBundlesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
" + }, + "DescribeWorkspaceDirectories":{ + "name":"DescribeWorkspaceDirectories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspaceDirectoriesRequest"}, + "output":{"shape":"DescribeWorkspaceDirectoriesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"Describes the available directories that are registered with Amazon WorkSpaces.
" + }, + "DescribeWorkspaceImagePermissions":{ + "name":"DescribeWorkspaceImagePermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspaceImagePermissionsRequest"}, + "output":{"shape":"DescribeWorkspaceImagePermissionsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.
" + }, + "DescribeWorkspaceImages":{ + "name":"DescribeWorkspaceImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspaceImagesRequest"}, + "output":{"shape":"DescribeWorkspaceImagesResult"}, + "errors":[ + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
" + }, + "DescribeWorkspaceSnapshots":{ + "name":"DescribeWorkspaceSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspaceSnapshotsRequest"}, + "output":{"shape":"DescribeWorkspaceSnapshotsResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Describes the snapshots for the specified WorkSpace.
" + }, + "DescribeWorkspaces":{ + "name":"DescribeWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspacesRequest"}, + "output":{"shape":"DescribeWorkspacesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"Describes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
" + }, + "DescribeWorkspacesConnectionStatus":{ + "name":"DescribeWorkspacesConnectionStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspacesConnectionStatusRequest"}, + "output":{"shape":"DescribeWorkspacesConnectionStatusResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"Describes the connection status of the specified WorkSpaces.
" + }, + "DescribeWorkspacesPoolSessions":{ + "name":"DescribeWorkspacesPoolSessions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspacesPoolSessionsRequest"}, + "output":{"shape":"DescribeWorkspacesPoolSessionsResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list that describes the streaming sessions for a specified pool.
" + }, + "DescribeWorkspacesPools":{ + "name":"DescribeWorkspacesPools", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspacesPoolsRequest"}, + "output":{"shape":"DescribeWorkspacesPoolsResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Describes the specified WorkSpaces Pools.
" + }, + "DisassociateConnectionAlias":{ + "name":"DisassociateConnectionAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateConnectionAliasRequest"}, + "output":{"shape":"DisassociateConnectionAliasResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
Disassociates the specified IP access control group from the specified directory.
" + }, + "DisassociateWorkspaceApplication":{ + "name":"DisassociateWorkspaceApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateWorkspaceApplicationRequest"}, + "output":{"shape":"DisassociateWorkspaceApplicationResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Disassociates the specified application from a WorkSpace.
" + }, + "GetAccountLink":{ + "name":"GetAccountLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAccountLinkRequest"}, + "output":{"shape":"GetAccountLinkResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves account link information.
" + }, + "ImportClientBranding":{ + "name":"ImportClientBranding", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportClientBrandingRequest"}, + "output":{"shape":"ImportClientBrandingResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience
You must specify at least one platform type when importing client branding.
You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.
Imported data can take up to a minute to appear in the WorkSpaces client.
Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
" + }, + "ListAccountLinks":{ + "name":"ListAccountLinks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAccountLinksRequest"}, + "output":{"shape":"ListAccountLinksResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists all account links.
" + }, + "ListAvailableManagementCidrRanges":{ + "name":"ListAvailableManagementCidrRanges", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAvailableManagementCidrRangesRequest"}, + "output":{"shape":"ListAvailableManagementCidrRangesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).
This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException error.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
" + }, + "MigrateWorkspace":{ + "name":"MigrateWorkspace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MigrateWorkspaceRequest"}, + "output":{"shape":"MigrateWorkspaceResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"OperationInProgressException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"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.
" + }, + "ModifyAccount":{ + "name":"ModifyAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyAccountRequest"}, + "output":{"shape":"ModifyAccountResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"ResourceUnavailableException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
" + }, + "ModifyCertificateBasedAuthProperties":{ + "name":"ModifyCertificateBasedAuthProperties", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyCertificateBasedAuthPropertiesRequest"}, + "output":{"shape":"ModifyCertificateBasedAuthPropertiesResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
" + }, + "ModifyClientProperties":{ + "name":"ModifyClientProperties", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClientPropertiesRequest"}, + "output":{"shape":"ModifyClientPropertiesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"Modifies the properties of the specified Amazon WorkSpaces clients.
" + }, + "ModifySamlProperties":{ + "name":"ModifySamlProperties", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySamlPropertiesRequest"}, + "output":{"shape":"ModifySamlPropertiesResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
" + }, + "ModifySelfservicePermissions":{ + "name":"ModifySelfservicePermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySelfservicePermissionsRequest"}, + "output":{"shape":"ModifySelfservicePermissionsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
" + }, + "ModifyStreamingProperties":{ + "name":"ModifyStreamingProperties", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyStreamingPropertiesRequest"}, + "output":{"shape":"ModifyStreamingPropertiesResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"Modifies the specified streaming properties.
" + }, + "ModifyWorkspaceAccessProperties":{ + "name":"ModifyWorkspaceAccessProperties", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyWorkspaceAccessPropertiesRequest"}, + "output":{"shape":"ModifyWorkspaceAccessPropertiesResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
" + }, + "ModifyWorkspaceCreationProperties":{ + "name":"ModifyWorkspaceCreationProperties", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyWorkspaceCreationPropertiesRequest"}, + "output":{"shape":"ModifyWorkspaceCreationPropertiesResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"Modify the default properties used to create WorkSpaces.
" + }, + "ModifyWorkspaceProperties":{ + "name":"ModifyWorkspaceProperties", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyWorkspacePropertiesRequest"}, + "output":{"shape":"ModifyWorkspacePropertiesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"OperationInProgressException"}, + {"shape":"UnsupportedWorkspaceConfigurationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
Sets the state of the specified WorkSpace.
To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.
Reboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE, UNHEALTHY, or REBOOTING. Reboot a WorkSpace in the REBOOTING state only if your WorkSpace has been stuck in the REBOOTING state for over 20 minutes.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
" + }, + "RebuildWorkspaces":{ + "name":"RebuildWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebuildWorkspacesRequest"}, + "output":{"shape":"RebuildWorkspacesResult"}, + "errors":[ + {"shape":"OperationNotSupportedException"} + ], + "documentation":"Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
" + }, + "RegisterWorkspaceDirectory":{ + "name":"RegisterWorkspaceDirectory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterWorkspaceDirectoryRequest"}, + "output":{"shape":"RegisterWorkspaceDirectoryResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"WorkspacesDefaultRoleNotFoundException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"UnsupportedNetworkConfigurationException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"ResourceAlreadyExistsException"} + ], + "documentation":"Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
" + }, + "RejectAccountLinkInvitation":{ + "name":"RejectAccountLinkInvitation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectAccountLinkInvitationRequest"}, + "output":{"shape":"RejectAccountLinkInvitationResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Rejects the account link invitation.
" + }, + "RestoreWorkspace":{ + "name":"RestoreWorkspace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreWorkspaceRequest"}, + "output":{"shape":"RestoreWorkspaceResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"Restores the specified WorkSpace to its last known healthy state.
You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED.
Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.
This operation is asynchronous and returns before the WorkSpace is completely restored.
" + }, + "RevokeIpRules":{ + "name":"RevokeIpRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeIpRulesRequest"}, + "output":{"shape":"RevokeIpRulesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Removes one or more rules from the specified IP access control group.
" + }, + "StartWorkspaces":{ + "name":"StartWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartWorkspacesRequest"}, + "output":{"shape":"StartWorkspacesResult"}, + "documentation":"Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop or Manual and a state of STOPPED.
Starts the specified pool.
You cannot start a pool unless it has a running mode of AutoStop and a state of STOPPED.
Stops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of AutoStop or Manual and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
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.
Terminates the specified WorkSpaces.
Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services Support before terminating the WorkSpace.
You can terminate a WorkSpace that is in any state except SUSPENDED.
This operation is asynchronous and returns before the WorkSpaces have been completely terminated. After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
Terminates the specified pool.
" + }, + "TerminateWorkspacesPoolSession":{ + "name":"TerminateWorkspacesPoolSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateWorkspacesPoolSessionRequest"}, + "output":{"shape":"TerminateWorkspacesPoolSessionResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"OperationInProgressException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Terminates the pool session.
" + }, + "UpdateConnectClientAddIn":{ + "name":"UpdateConnectClientAddIn", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateConnectClientAddInRequest"}, + "output":{"shape":"UpdateConnectClientAddInResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.
" + }, + "UpdateConnectionAliasPermission":{ + "name":"UpdateConnectionAliasPermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateConnectionAliasPermissionRequest"}, + "output":{"shape":"UpdateConnectionAliasPermissionResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAssociatedException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
Replaces the current rules of the specified IP access control group with the specified rules.
" + }, + "UpdateWorkspaceBundle":{ + "name":"UpdateWorkspaceBundle", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateWorkspaceBundleRequest"}, + "output":{"shape":"UpdateWorkspaceBundleResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceUnavailableException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.
Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.
Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.
After an image has been shared, the recipient account can copy the image to other Regions as needed.
In the China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
To delete an image that has been shared, you must unshare the image before you delete it.
Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.
Updates the specified pool.
" + } + }, + "shapes":{ + "ARN":{ + "type":"string", + "pattern":"^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\\\-]{0,1023}$" + }, + "AcceptAccountLinkInvitationRequest":{ + "type":"structure", + "required":["LinkId"], + "members":{ + "LinkId":{ + "shape":"LinkId", + "documentation":"The identifier of the account link.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
" + } + } + }, + "AcceptAccountLinkInvitationResult":{ + "type":"structure", + "members":{ + "AccountLink":{ + "shape":"AccountLink", + "documentation":"Information about the account link.
" + } + } + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"The user is not authorized to access a resource.
", + "exception":true + }, + "AccessPropertyValue":{ + "type":"string", + "enum":[ + "ALLOW", + "DENY" + ] + }, + "AccountLink":{ + "type":"structure", + "members":{ + "AccountLinkId":{ + "shape":"LinkId", + "documentation":"The identifier of the account link.
" + }, + "AccountLinkStatus":{ + "shape":"AccountLinkStatusEnum", + "documentation":"The status of the account link.
" + }, + "SourceAccountId":{ + "shape":"AwsAccount", + "documentation":"The identifier of the source account.
" + }, + "TargetAccountId":{ + "shape":"AwsAccount", + "documentation":"The identifier of the target account.
" + } + }, + "documentation":"Information about about the account link.
" + }, + "AccountLinkList":{ + "type":"list", + "member":{"shape":"AccountLink"} + }, + "AccountLinkStatusEnum":{ + "type":"string", + "enum":[ + "LINKED", + "LINKING_FAILED", + "LINK_NOT_FOUND", + "PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT", + "REJECTED" + ] + }, + "AccountModification":{ + "type":"structure", + "members":{ + "ModificationState":{ + "shape":"DedicatedTenancyModificationStateEnum", + "documentation":"The state of the modification to the configuration of BYOL.
" + }, + "DedicatedTenancySupport":{ + "shape":"DedicatedTenancySupportResultEnum", + "documentation":"The status of BYOL (whether BYOL is being enabled or disabled).
" + }, + "DedicatedTenancyManagementCidrRange":{ + "shape":"DedicatedTenancyManagementCidrRange", + "documentation":"The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when the modification of the BYOL configuration was started.
" + }, + "ErrorCode":{ + "shape":"WorkspaceErrorCode", + "documentation":"The error code that is returned if the configuration of BYOL cannot be modified.
" + }, + "ErrorMessage":{ + "shape":"Description", + "documentation":"The text of the error message that is returned if the configuration of BYOL cannot be modified.
" + } + }, + "documentation":"Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account.
" + }, + "AccountModificationList":{ + "type":"list", + "member":{"shape":"AccountModification"} + }, + "ActiveDirectoryConfig":{ + "type":"structure", + "required":[ + "DomainName", + "ServiceAccountSecretArn" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"The name of the domain.
" + }, + "ServiceAccountSecretArn":{ + "shape":"SecretsManagerArn", + "documentation":"Indicates the secret ARN on the service account.
" + } + }, + "documentation":"Information about the Active Directory config.
" + }, + "ActiveUserSessions":{ + "type":"integer", + "min":0 + }, + "ActualUserSessions":{ + "type":"integer", + "min":0 + }, + "AddInName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^.*$" + }, + "AddInUrl":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^(http|https)\\://\\S+" + }, + "Alias":{"type":"string"}, + "AmazonUuid":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" + }, + "Application":{ + "type":"string", + "enum":[ + "Microsoft_Office_2016", + "Microsoft_Office_2019" + ] + }, + "ApplicationAssociatedResourceType":{ + "type":"string", + "enum":[ + "WORKSPACE", + "BUNDLE", + "IMAGE" + ] + }, + "ApplicationAssociatedResourceTypeList":{ + "type":"list", + "member":{"shape":"ApplicationAssociatedResourceType"} + }, + "ApplicationList":{ + "type":"list", + "member":{"shape":"Application"}, + "max":5, + "min":1 + }, + "ApplicationNotSupportedException":{ + "type":"structure", + "members":{ + }, + "documentation":"The specified application is not supported.
", + "exception":true + }, + "ApplicationResourceAssociation":{ + "type":"structure", + "members":{ + "ApplicationId":{ + "shape":"WorkSpaceApplicationId", + "documentation":"The identifier of the application.
" + }, + "AssociatedResourceId":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the associated resource.
" + }, + "AssociatedResourceType":{ + "shape":"ApplicationAssociatedResourceType", + "documentation":"The resource type of the associated resource.
" + }, + "Created":{ + "shape":"Timestamp", + "documentation":"The time the association was created.
" + }, + "LastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"The time the association status was last updated.
" + }, + "State":{ + "shape":"AssociationState", + "documentation":"The status of the application resource association.
" + }, + "StateReason":{ + "shape":"AssociationStateReason", + "documentation":"The reason the association deployment failed.
" + } + }, + "documentation":"Describes the association between an application and an application resource.
" + }, + "ApplicationResourceAssociationList":{ + "type":"list", + "member":{"shape":"ApplicationResourceAssociation"} + }, + "ApplicationSettingsRequest":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"ApplicationSettingsStatusEnum", + "documentation":"Enables or disables persistent application settings for users during their pool sessions.
" + }, + "SettingsGroup":{ + "shape":"SettingsGroup", + "documentation":"The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple pools by specifying the same settings group for each pool.
" + } + }, + "documentation":"The persistent application settings for WorkSpaces Pools users.
" + }, + "ApplicationSettingsResponse":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"ApplicationSettingsStatusEnum", + "documentation":"Specifies whether persistent application settings are enabled for users during their pool sessions.
" + }, + "SettingsGroup":{ + "shape":"SettingsGroup", + "documentation":"The path prefix for the S3 bucket where users’ persistent application settings are stored.
" + }, + "S3BucketName":{ + "shape":"S3BucketName", + "documentation":"The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an Amazon Web Services Region, an S3 bucket is created. The bucket is unique to the Amazon Web Services account and the Region.
" + } + }, + "documentation":"Describes the persistent application settings for WorkSpaces Pools users.
" + }, + "ApplicationSettingsStatusEnum":{ + "type":"string", + "enum":[ + "DISABLED", + "ENABLED" + ] + }, + "AssociateConnectionAliasRequest":{ + "type":"structure", + "required":[ + "AliasId", + "ResourceId" + ], + "members":{ + "AliasId":{ + "shape":"ConnectionAliasId", + "documentation":"The identifier of the connection alias.
" + }, + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the directory to associate the connection alias with.
" + } + } + }, + "AssociateConnectionAliasResult":{ + "type":"structure", + "members":{ + "ConnectionIdentifier":{ + "shape":"ConnectionIdentifier", + "documentation":"The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
" + } + } + }, + "AssociateIpGroupsRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "GroupIds" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the directory.
" + }, + "GroupIds":{ + "shape":"IpGroupIdList", + "documentation":"The identifiers of one or more IP access control groups.
" + } + } + }, + "AssociateIpGroupsResult":{ + "type":"structure", + "members":{ + } + }, + "AssociateWorkspaceApplicationRequest":{ + "type":"structure", + "required":[ + "WorkspaceId", + "ApplicationId" + ], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + }, + "ApplicationId":{ + "shape":"WorkSpaceApplicationId", + "documentation":"The identifier of the application.
" + } + } + }, + "AssociateWorkspaceApplicationResult":{ + "type":"structure", + "members":{ + "Association":{ + "shape":"WorkspaceResourceAssociation", + "documentation":"Information about the association between the specified WorkSpace and the specified application.
" + } + } + }, + "AssociationErrorCode":{ + "type":"string", + "enum":[ + "ValidationError.InsufficientDiskSpace", + "ValidationError.InsufficientMemory", + "ValidationError.UnsupportedOperatingSystem", + "DeploymentError.InternalServerError", + "DeploymentError.WorkspaceUnreachable" + ] + }, + "AssociationState":{ + "type":"string", + "enum":[ + "PENDING_INSTALL", + "PENDING_INSTALL_DEPLOYMENT", + "PENDING_UNINSTALL", + "PENDING_UNINSTALL_DEPLOYMENT", + "INSTALLING", + "UNINSTALLING", + "ERROR", + "COMPLETED", + "REMOVED" + ] + }, + "AssociationStateReason":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"AssociationErrorCode", + "documentation":"The error code of the association deployment failure.
" + }, + "ErrorMessage":{ + "shape":"String2048", + "documentation":"The error message of the association deployment failure.
" + } + }, + "documentation":"Indicates the reason that the association deployment failed, including the error code and error message.
" + }, + "AssociationStatus":{ + "type":"string", + "enum":[ + "NOT_ASSOCIATED", + "ASSOCIATED_WITH_OWNER_ACCOUNT", + "ASSOCIATED_WITH_SHARED_ACCOUNT", + "PENDING_ASSOCIATION", + "PENDING_DISASSOCIATION" + ] + }, + "AuthenticationType":{ + "type":"string", + "enum":["SAML"] + }, + "AuthorizeIpRulesRequest":{ + "type":"structure", + "required":[ + "GroupId", + "UserRules" + ], + "members":{ + "GroupId":{ + "shape":"IpGroupId", + "documentation":"The identifier of the group.
" + }, + "UserRules":{ + "shape":"IpRuleList", + "documentation":"The rules to add to the group.
" + } + } + }, + "AuthorizeIpRulesResult":{ + "type":"structure", + "members":{ + } + }, + "AvailableUserSessions":{ + "type":"integer", + "min":0 + }, + "AwsAccount":{ + "type":"string", + "pattern":"^\\d{12}$" + }, + "BooleanObject":{"type":"boolean"}, + "BundleAssociatedResourceType":{ + "type":"string", + "enum":["APPLICATION"] + }, + "BundleAssociatedResourceTypeList":{ + "type":"list", + "member":{"shape":"BundleAssociatedResourceType"} + }, + "BundleId":{ + "type":"string", + "pattern":"^wsb-[0-9a-z]{8,63}$" + }, + "BundleIdList":{ + "type":"list", + "member":{"shape":"BundleId"}, + "max":25, + "min":1 + }, + "BundleList":{ + "type":"list", + "member":{"shape":"WorkspaceBundle"} + }, + "BundleOwner":{"type":"string"}, + "BundleResourceAssociation":{ + "type":"structure", + "members":{ + "AssociatedResourceId":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the associated resource.
" + }, + "AssociatedResourceType":{ + "shape":"BundleAssociatedResourceType", + "documentation":"The resource type of the associated resources.
" + }, + "BundleId":{ + "shape":"BundleId", + "documentation":"The identifier of the bundle.
" + }, + "Created":{ + "shape":"Timestamp", + "documentation":"The time the association is created.
" + }, + "LastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"The time the association status was last updated.
" + }, + "State":{ + "shape":"AssociationState", + "documentation":"The status of the bundle resource association.
" + }, + "StateReason":{ + "shape":"AssociationStateReason", + "documentation":"The reason the association deployment failed.
" + } + }, + "documentation":"Describes the association between an application and a bundle resource.
" + }, + "BundleResourceAssociationList":{ + "type":"list", + "member":{"shape":"BundleResourceAssociation"} + }, + "BundleType":{ + "type":"string", + "enum":[ + "REGULAR", + "STANDBY" + ] + }, + "Capacity":{ + "type":"structure", + "required":["DesiredUserSessions"], + "members":{ + "DesiredUserSessions":{ + "shape":"DesiredUserSessions", + "documentation":"The desired number of user sessions for the WorkSpaces in the pool.
" + } + }, + "documentation":"Describes the user capacity for a pool of WorkSpaces.
" + }, + "CapacityStatus":{ + "type":"structure", + "required":[ + "AvailableUserSessions", + "DesiredUserSessions", + "ActualUserSessions", + "ActiveUserSessions" + ], + "members":{ + "AvailableUserSessions":{ + "shape":"AvailableUserSessions", + "documentation":"The number of user sessions currently available for streaming from your pool.
AvailableUserSessions = ActualUserSessions - ActiveUserSessions
" + }, + "DesiredUserSessions":{ + "shape":"DesiredUserSessions", + "documentation":"The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state.
" + }, + "ActualUserSessions":{ + "shape":"ActualUserSessions", + "documentation":"The total number of user sessions that are available for streaming or are currently streaming in your pool.
ActualUserSessions = AvailableUserSessions + ActiveUserSessions
" + }, + "ActiveUserSessions":{ + "shape":"ActiveUserSessions", + "documentation":"The number of user sessions currently being used for your pool.
" + } + }, + "documentation":"Describes the capacity status for a pool of WorkSpaces.
" + }, + "CertificateAuthorityArn":{ + "type":"string", + "max":200, + "min":5, + "pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*" + }, + "CertificateBasedAuthProperties":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"CertificateBasedAuthStatusEnum", + "documentation":"The status of the certificate-based authentication properties.
" + }, + "CertificateAuthorityArn":{ + "shape":"CertificateAuthorityArn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.
" + } + }, + "documentation":"Describes the properties of the certificate-based authentication you want to use with your WorkSpaces.
" + }, + "CertificateBasedAuthStatusEnum":{ + "type":"string", + "enum":[ + "DISABLED", + "ENABLED" + ] + }, + "ClientDeviceType":{ + "type":"string", + "enum":[ + "DeviceTypeWindows", + "DeviceTypeOsx", + "DeviceTypeAndroid", + "DeviceTypeIos", + "DeviceTypeLinux", + "DeviceTypeWeb" + ] + }, + "ClientDeviceTypeList":{ + "type":"list", + "member":{"shape":"ClientDeviceType"}, + "max":6, + "min":1 + }, + "ClientEmail":{ + "type":"string", + "max":64, + "min":6, + "pattern":"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,4}$" + }, + "ClientLocale":{ + "type":"string", + "max":5, + "min":5, + "pattern":"^[a-z]{2}_[A-Z]{2}$" + }, + "ClientLoginMessage":{ + "type":"string", + "max":2000, + "min":0, + "pattern":"^.*$" + }, + "ClientProperties":{ + "type":"structure", + "members":{ + "ReconnectEnabled":{ + "shape":"ReconnectEnum", + "documentation":"Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
" + }, + "LogUploadEnabled":{ + "shape":"LogUploadEnum", + "documentation":"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.
" + } + }, + "documentation":"Describes an Amazon WorkSpaces client.
" + }, + "ClientPropertiesList":{ + "type":"list", + "member":{"shape":"ClientPropertiesResult"} + }, + "ClientPropertiesResult":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"The resource identifier, in the form of a directory ID.
" + }, + "ClientProperties":{ + "shape":"ClientProperties", + "documentation":"Information about the Amazon WorkSpaces client.
" + } + }, + "documentation":"Information about the Amazon WorkSpaces client.
" + }, + "ClientToken":{ + "type":"string", + "pattern":"^.{1,64}$" + }, + "ClientUrl":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^(http|https)\\://\\S+" + }, + "Compute":{ + "type":"string", + "enum":[ + "VALUE", + "STANDARD", + "PERFORMANCE", + "POWER", + "GRAPHICS", + "POWERPRO", + "GRAPHICSPRO", + "GRAPHICS_G4DN", + "GRAPHICSPRO_G4DN" + ] + }, + "ComputeList":{ + "type":"list", + "member":{"shape":"Compute"} + }, + "ComputeNotCompatibleException":{ + "type":"structure", + "members":{ + }, + "documentation":"The compute type of the WorkSpace is not compatible with the application.
", + "exception":true + }, + "ComputeType":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"Compute", + "documentation":"The compute type.
" + } + }, + "documentation":"Describes the compute type of the bundle.
" + }, + "ComputerName":{"type":"string"}, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"The TargetAccountId is already linked or invited.
The client add-in identifier.
" + }, + "ResourceId":{ + "shape":"DirectoryId", + "documentation":"The directory identifier for which the client add-in is configured.
" + }, + "Name":{ + "shape":"AddInName", + "documentation":"The name of the client add in.
" + }, + "URL":{ + "shape":"AddInUrl", + "documentation":"The endpoint URL of the client add-in.
" + } + }, + "documentation":"Describes an Amazon Connect client add-in.
" + }, + "ConnectClientAddInList":{ + "type":"list", + "member":{"shape":"ConnectClientAddIn"} + }, + "ConnectionAlias":{ + "type":"structure", + "members":{ + "ConnectionString":{ + "shape":"ConnectionString", + "documentation":"The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
The identifier of the connection alias.
" + }, + "State":{ + "shape":"ConnectionAliasState", + "documentation":"The current state of the connection alias.
" + }, + "OwnerAccountId":{ + "shape":"AwsAccount", + "documentation":"The identifier of the Amazon Web Services account that owns the connection alias.
" + }, + "Associations":{ + "shape":"ConnectionAliasAssociationList", + "documentation":"The association status of the connection alias.
" + } + }, + "documentation":"Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
" + }, + "ConnectionAliasAssociation":{ + "type":"structure", + "members":{ + "AssociationStatus":{ + "shape":"AssociationStatus", + "documentation":"The association status of the connection alias.
" + }, + "AssociatedAccountId":{ + "shape":"AwsAccount", + "documentation":"The identifier of the Amazon Web Services account that associated the connection alias with a directory.
" + }, + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the directory associated with a connection alias.
" + }, + "ConnectionIdentifier":{ + "shape":"ConnectionIdentifier", + "documentation":"The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
" + } + }, + "documentation":"Describes a connection alias association that is used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
" + }, + "ConnectionAliasAssociationList":{ + "type":"list", + "member":{"shape":"ConnectionAliasAssociation"}, + "max":25, + "min":1 + }, + "ConnectionAliasId":{ + "type":"string", + "max":68, + "min":13, + "pattern":"^wsca-[0-9a-z]{8,63}$" + }, + "ConnectionAliasIdList":{ + "type":"list", + "member":{"shape":"ConnectionAliasId"}, + "max":25, + "min":1 + }, + "ConnectionAliasList":{ + "type":"list", + "member":{"shape":"ConnectionAlias"}, + "max":25, + "min":1 + }, + "ConnectionAliasPermission":{ + "type":"structure", + "required":[ + "SharedAccountId", + "AllowAssociation" + ], + "members":{ + "SharedAccountId":{ + "shape":"AwsAccount", + "documentation":"The identifier of the Amazon Web Services account that the connection alias is shared with.
" + }, + "AllowAssociation":{ + "shape":"BooleanObject", + "documentation":"Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.
" + } + }, + "documentation":"Describes the permissions for a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
" + }, + "ConnectionAliasPermissions":{ + "type":"list", + "member":{"shape":"ConnectionAliasPermission"}, + "max":25, + "min":1 + }, + "ConnectionAliasState":{ + "type":"string", + "enum":[ + "CREATING", + "CREATED", + "DELETING" + ] + }, + "ConnectionIdentifier":{ + "type":"string", + "max":20, + "min":1, + "pattern":"^[a-zA-Z0-9]+$" + }, + "ConnectionState":{ + "type":"string", + "enum":[ + "CONNECTED", + "DISCONNECTED", + "UNKNOWN" + ] + }, + "ConnectionString":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[.0-9a-zA-Z\\-]{1,255}$" + }, + "CopyWorkspaceImageRequest":{ + "type":"structure", + "required":[ + "Name", + "SourceImageId", + "SourceRegion" + ], + "members":{ + "Name":{ + "shape":"WorkspaceImageName", + "documentation":"The name of the image.
" + }, + "Description":{ + "shape":"WorkspaceImageDescription", + "documentation":"A description of the image.
" + }, + "SourceImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the source image.
" + }, + "SourceRegion":{ + "shape":"Region", + "documentation":"The identifier of the source Region.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags for the image.
" + } + } + }, + "CopyWorkspaceImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the image.
" + } + } + }, + "CreateAccountLinkInvitationRequest":{ + "type":"structure", + "required":["TargetAccountId"], + "members":{ + "TargetAccountId":{ + "shape":"AwsAccount", + "documentation":"The identifier of the target account.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
" + } + } + }, + "CreateAccountLinkInvitationResult":{ + "type":"structure", + "members":{ + "AccountLink":{ + "shape":"AccountLink", + "documentation":"Information about the account link.
" + } + } + }, + "CreateConnectClientAddInRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "Name", + "URL" + ], + "members":{ + "ResourceId":{ + "shape":"DirectoryId", + "documentation":"The directory identifier for which to configure the client add-in.
" + }, + "Name":{ + "shape":"AddInName", + "documentation":"The name of the client add-in.
" + }, + "URL":{ + "shape":"AddInUrl", + "documentation":"The endpoint URL of the Amazon Connect client add-in.
" + } + } + }, + "CreateConnectClientAddInResult":{ + "type":"structure", + "members":{ + "AddInId":{ + "shape":"AmazonUuid", + "documentation":"The client add-in identifier.
" + } + } + }, + "CreateConnectionAliasRequest":{ + "type":"structure", + "required":["ConnectionString"], + "members":{ + "ConnectionString":{ + "shape":"ConnectionString", + "documentation":"A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com.
After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account.
The tags to associate with the connection alias.
" + } + } + }, + "CreateConnectionAliasResult":{ + "type":"structure", + "members":{ + "AliasId":{ + "shape":"ConnectionAliasId", + "documentation":"The identifier of the connection alias.
" + } + } + }, + "CreateIpGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"IpGroupName", + "documentation":"The name of the group.
" + }, + "GroupDesc":{ + "shape":"IpGroupDesc", + "documentation":"The description of the group.
" + }, + "UserRules":{ + "shape":"IpRuleList", + "documentation":"The rules to add to the group.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags. Each WorkSpaces resource can have a maximum of 50 tags.
" + } + } + }, + "CreateIpGroupResult":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"IpGroupId", + "documentation":"The identifier of the group.
" + } + } + }, + "CreateStandbyWorkspacesRequest":{ + "type":"structure", + "required":[ + "PrimaryRegion", + "StandbyWorkspaces" + ], + "members":{ + "PrimaryRegion":{ + "shape":"Region", + "documentation":"The Region of the primary WorkSpace.
" + }, + "StandbyWorkspaces":{ + "shape":"StandbyWorkspacesList", + "documentation":"Information about the standby WorkSpace to be created.
" + } + } + }, + "CreateStandbyWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedStandbyRequests":{ + "shape":"FailedCreateStandbyWorkspacesRequestList", + "documentation":"Information about the standby WorkSpace that could not be created.
" + }, + "PendingStandbyRequests":{ + "shape":"PendingCreateStandbyWorkspacesRequestList", + "documentation":"Information about the standby WorkSpace that was created.
" + } + } + }, + "CreateTagsRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "Tags" + ], + "members":{ + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags. Each WorkSpaces resource can have a maximum of 50 tags.
" + } + } + }, + "CreateTagsResult":{ + "type":"structure", + "members":{ + } + }, + "CreateUpdatedWorkspaceImageRequest":{ + "type":"structure", + "required":[ + "Name", + "Description", + "SourceImageId" + ], + "members":{ + "Name":{ + "shape":"WorkspaceImageName", + "documentation":"The name of the new updated WorkSpace image.
" + }, + "Description":{ + "shape":"WorkspaceImageDescription", + "documentation":"A description of whether updates for the WorkSpace image are available.
" + }, + "SourceImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the source WorkSpace image.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags that you want to add to the new updated WorkSpace image.
To add tags at the same time when you're creating the updated image, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.
The identifier of the new updated WorkSpace image.
" + } + } + }, + "CreateWorkspaceBundleRequest":{ + "type":"structure", + "required":[ + "BundleName", + "BundleDescription", + "ImageId", + "ComputeType", + "UserStorage" + ], + "members":{ + "BundleName":{ + "shape":"WorkspaceBundleName", + "documentation":"The name of the bundle.
" + }, + "BundleDescription":{ + "shape":"WorkspaceBundleDescription", + "documentation":"The description of the bundle.
" + }, + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the image that is used to create the bundle.
" + }, + "ComputeType":{"shape":"ComputeType"}, + "UserStorage":{"shape":"UserStorage"}, + "RootStorage":{"shape":"RootStorage"}, + "Tags":{ + "shape":"TagList", + "documentation":"The tags associated with the bundle.
To add tags at the same time when you're creating the bundle, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.
The name of the new WorkSpace image.
" + }, + "Description":{ + "shape":"WorkspaceImageDescription", + "documentation":"The description of the new WorkSpace image.
" + }, + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the source WorkSpace
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags.
The identifier of the new WorkSpace image.
" + }, + "Name":{ + "shape":"WorkspaceImageName", + "documentation":"The name of the image.
" + }, + "Description":{ + "shape":"WorkspaceImageDescription", + "documentation":"The description of the image.
" + }, + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"The operating system that the image is running.
" + }, + "State":{ + "shape":"WorkspaceImageState", + "documentation":"The availability status of the image.
" + }, + "RequiredTenancy":{ + "shape":"WorkspaceImageRequiredTenancy", + "documentation":"Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images..
" + }, + "Created":{ + "shape":"Timestamp", + "documentation":"The date when the image was created.
" + }, + "OwnerAccountId":{ + "shape":"AwsAccount", + "documentation":"The identifier of the Amazon Web Services account that owns the image.
" + } + } + }, + "CreateWorkspacesPoolRequest":{ + "type":"structure", + "required":[ + "PoolName", + "Description", + "BundleId", + "DirectoryId", + "Capacity" + ], + "members":{ + "PoolName":{ + "shape":"WorkspacesPoolName", + "documentation":"The name of the pool.
" + }, + "Description":{ + "shape":"UpdateDescription", + "documentation":"The pool description.
" + }, + "BundleId":{ + "shape":"BundleId", + "documentation":"The identifier of the bundle for the pool.
" + }, + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the directory for the pool.
" + }, + "Capacity":{ + "shape":"Capacity", + "documentation":"The user capacity of the pool.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags for the pool.
" + }, + "ApplicationSettings":{ + "shape":"ApplicationSettingsRequest", + "documentation":"Indicates the application settings of the pool.
" + }, + "TimeoutSettings":{ + "shape":"TimeoutSettings", + "documentation":"Indicates the timeout settings of the pool.
" + } + } + }, + "CreateWorkspacesPoolResult":{ + "type":"structure", + "members":{ + "WorkspacesPool":{ + "shape":"WorkspacesPool", + "documentation":"Indicates the pool to create.
" + } + } + }, + "CreateWorkspacesRequest":{ + "type":"structure", + "required":["Workspaces"], + "members":{ + "Workspaces":{ + "shape":"WorkspaceRequestList", + "documentation":"The WorkSpaces to create. You can specify up to 25 WorkSpaces.
" + } + } + }, + "CreateWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{ + "shape":"FailedCreateWorkspaceRequests", + "documentation":"Information about the WorkSpaces that could not be created.
" + }, + "PendingRequests":{ + "shape":"WorkspaceList", + "documentation":"Information about the WorkSpaces that were created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
" + } + } + }, + "DataReplication":{ + "type":"string", + "enum":[ + "NO_REPLICATION", + "PRIMARY_AS_SOURCE" + ] + }, + "DataReplicationSettings":{ + "type":"structure", + "members":{ + "DataReplication":{ + "shape":"DataReplication", + "documentation":"Indicates whether data replication is enabled, and if enabled, the type of data replication.
" + }, + "RecoverySnapshotTime":{ + "shape":"Timestamp", + "documentation":"The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.
" + } + }, + "documentation":"Describes the data replication settings.
" + }, + "DedicatedTenancyAccountType":{ + "type":"string", + "enum":[ + "SOURCE_ACCOUNT", + "TARGET_ACCOUNT" + ] + }, + "DedicatedTenancyCidrRangeList":{ + "type":"list", + "member":{"shape":"DedicatedTenancyManagementCidrRange"} + }, + "DedicatedTenancyManagementCidrRange":{ + "type":"string", + "pattern":"(^([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.0\\.0)(\\/(16$))$" + }, + "DedicatedTenancyModificationStateEnum":{ + "type":"string", + "enum":[ + "PENDING", + "COMPLETED", + "FAILED" + ] + }, + "DedicatedTenancySupportEnum":{ + "type":"string", + "enum":["ENABLED"] + }, + "DedicatedTenancySupportResultEnum":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "DefaultClientBrandingAttributes":{ + "type":"structure", + "members":{ + "LogoUrl":{ + "shape":"ClientUrl", + "documentation":"The logo. The only image format accepted is a binary data object that is converted from a .png file.
The support email. The company's customer support email address.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com.
The support link. The link for the company's customer support page for their WorkSpace.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com.
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
" + }, + "LoginMessage":{ + "shape":"LoginMessage", + "documentation":"The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.
Returns default client branding attributes that were imported. These attributes display on the client login screen.
Client branding attributes are public facing. Ensure that you don't include sensitive information.
The logo. The only image format accepted is a binary data object that is converted from a .png file.
The support email. The company's customer support email address.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com.
The support link. The link for the company's customer support page for their WorkSpace.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com.
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
" + }, + "LoginMessage":{ + "shape":"LoginMessage", + "documentation":"The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.
The default client branding attributes to be imported. These attributes display on the client login screen.
Client branding attributes are public facing. Ensure that you do not include sensitive information.
Specifies whether the directory is enabled for Amazon WorkDocs.
" + }, + "EnableInternetAccess":{ + "shape":"BooleanObject", + "documentation":"Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.
" + }, + "DefaultOu":{ + "shape":"DefaultOu", + "documentation":"The organizational unit (OU) in the directory for the WorkSpace machine accounts.
" + }, + "CustomSecurityGroupId":{ + "shape":"SecurityGroupId", + "documentation":"The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.
" + }, + "UserEnabledAsLocalAdministrator":{ + "shape":"BooleanObject", + "documentation":"Specifies whether WorkSpace users are local administrators on their WorkSpaces.
" + }, + "EnableMaintenanceMode":{ + "shape":"BooleanObject", + "documentation":"Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.
" + }, + "InstanceIamRoleArn":{ + "shape":"ARN", + "documentation":"Indicates the IAM role ARN of the instance.
" + } + }, + "documentation":"Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.
" + }, + "DeletableCertificateBasedAuthPropertiesList":{ + "type":"list", + "member":{"shape":"DeletableCertificateBasedAuthProperty"} + }, + "DeletableCertificateBasedAuthProperty":{ + "type":"string", + "enum":["CERTIFICATE_BASED_AUTH_PROPERTIES_CERTIFICATE_AUTHORITY_ARN"] + }, + "DeletableSamlPropertiesList":{ + "type":"list", + "member":{"shape":"DeletableSamlProperty"} + }, + "DeletableSamlProperty":{ + "type":"string", + "enum":[ + "SAML_PROPERTIES_USER_ACCESS_URL", + "SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME" + ] + }, + "DeleteAccountLinkInvitationRequest":{ + "type":"structure", + "required":["LinkId"], + "members":{ + "LinkId":{ + "shape":"LinkId", + "documentation":"The identifier of the account link.
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
" + } + } + }, + "DeleteAccountLinkInvitationResult":{ + "type":"structure", + "members":{ + "AccountLink":{ + "shape":"AccountLink", + "documentation":"Information about the account link.
" + } + } + }, + "DeleteClientBrandingRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "Platforms" + ], + "members":{ + "ResourceId":{ + "shape":"DirectoryId", + "documentation":"The directory identifier of the WorkSpace for which you want to delete client branding.
" + }, + "Platforms":{ + "shape":"ClientDeviceTypeList", + "documentation":"The device type for which you want to delete client branding.
" + } + } + }, + "DeleteClientBrandingResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteConnectClientAddInRequest":{ + "type":"structure", + "required":[ + "AddInId", + "ResourceId" + ], + "members":{ + "AddInId":{ + "shape":"AmazonUuid", + "documentation":"The identifier of the client add-in to delete.
" + }, + "ResourceId":{ + "shape":"DirectoryId", + "documentation":"The directory identifier for which the client add-in is configured.
" + } + } + }, + "DeleteConnectClientAddInResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteConnectionAliasRequest":{ + "type":"structure", + "required":["AliasId"], + "members":{ + "AliasId":{ + "shape":"ConnectionAliasId", + "documentation":"The identifier of the connection alias to delete.
" + } + } + }, + "DeleteConnectionAliasResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteIpGroupRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "GroupId":{ + "shape":"IpGroupId", + "documentation":"The identifier of the IP access control group.
" + } + } + }, + "DeleteIpGroupResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteTagsRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "TagKeys" + ], + "members":{ + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"The tag keys.
" + } + } + }, + "DeleteTagsResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteWorkspaceBundleRequest":{ + "type":"structure", + "members":{ + "BundleId":{ + "shape":"BundleId", + "documentation":"The identifier of the bundle.
" + } + } + }, + "DeleteWorkspaceBundleResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteWorkspaceImageRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the image.
" + } + } + }, + "DeleteWorkspaceImageResult":{ + "type":"structure", + "members":{ + } + }, + "DeployWorkspaceApplicationsRequest":{ + "type":"structure", + "required":["WorkspaceId"], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + }, + "Force":{ + "shape":"BooleanObject", + "documentation":"Indicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled, it allows previously failed deployments to be retried.
" + } + } + }, + "DeployWorkspaceApplicationsResult":{ + "type":"structure", + "members":{ + "Deployment":{ + "shape":"WorkSpaceApplicationDeployment", + "documentation":"The list of deployed associations and information about them.
" + } + } + }, + "DeregisterWorkspaceDirectoryRequest":{ + "type":"structure", + "required":["DirectoryId"], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the directory. If any WorkSpaces are registered to this directory, you must remove them before you deregister the directory, or you will receive an OperationNotSupportedException error.
" + } + } + }, + "DeregisterWorkspaceDirectoryResult":{ + "type":"structure", + "members":{ + } + }, + "DescribeAccountModificationsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The list of modifications to the configuration of BYOL.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" + } + } + }, + "DescribeAccountRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeAccountResult":{ + "type":"structure", + "members":{ + "DedicatedTenancySupport":{ + "shape":"DedicatedTenancySupportResultEnum", + "documentation":"The status of BYOL (whether BYOL is enabled or disabled).
" + }, + "DedicatedTenancyManagementCidrRange":{ + "shape":"DedicatedTenancyManagementCidrRange", + "documentation":"The IP address range, specified as an IPv4 CIDR block, used for the management network interface.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
" + }, + "DedicatedTenancyAccountType":{ + "shape":"DedicatedTenancyAccountType", + "documentation":"The type of linked account.
" + } + } + }, + "DescribeApplicationAssociationsRequest":{ + "type":"structure", + "required":[ + "ApplicationId", + "AssociatedResourceTypes" + ], + "members":{ + "MaxResults":{ + "shape":"Limit", + "documentation":"The maximum number of associations to return.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The identifier of the specified application.
" + }, + "AssociatedResourceTypes":{ + "shape":"ApplicationAssociatedResourceTypeList", + "documentation":"The resource type of the associated resources.
" + } + } + }, + "DescribeApplicationAssociationsResult":{ + "type":"structure", + "members":{ + "Associations":{ + "shape":"ApplicationResourceAssociationList", + "documentation":"List of associations and information about them.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The identifiers of one or more applications.
" + }, + "ComputeTypeNames":{ + "shape":"ComputeList", + "documentation":"The compute types supported by the applications.
" + }, + "LicenseType":{ + "shape":"WorkSpaceApplicationLicenseType", + "documentation":"The license availability for the applications.
" + }, + "OperatingSystemNames":{ + "shape":"OperatingSystemNameList", + "documentation":"The operating systems supported by the applications.
" + }, + "Owner":{ + "shape":"WorkSpaceApplicationOwner", + "documentation":"The owner of the applications.
" + }, + "MaxResults":{ + "shape":"Limit", + "documentation":"The maximum number of applications to return.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
List of information about the specified applications.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The identifier of the bundle.
" + }, + "AssociatedResourceTypes":{ + "shape":"BundleAssociatedResourceTypeList", + "documentation":"The resource types of the associated resource.
" + } + } + }, + "DescribeBundleAssociationsResult":{ + "type":"structure", + "members":{ + "Associations":{ + "shape":"BundleResourceAssociationList", + "documentation":"List of information about the specified associations.
" + } + } + }, + "DescribeClientBrandingRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "ResourceId":{ + "shape":"DirectoryId", + "documentation":"The directory identifier of the WorkSpace for which you want to view client branding information.
" + } + } + }, + "DescribeClientBrandingResult":{ + "type":"structure", + "members":{ + "DeviceTypeWindows":{ + "shape":"DefaultClientBrandingAttributes", + "documentation":"The branding information for Windows devices.
" + }, + "DeviceTypeOsx":{ + "shape":"DefaultClientBrandingAttributes", + "documentation":"The branding information for macOS devices.
" + }, + "DeviceTypeAndroid":{ + "shape":"DefaultClientBrandingAttributes", + "documentation":"The branding information for Android devices.
" + }, + "DeviceTypeIos":{ + "shape":"IosClientBrandingAttributes", + "documentation":"The branding information for iOS devices.
" + }, + "DeviceTypeLinux":{ + "shape":"DefaultClientBrandingAttributes", + "documentation":"The branding information for Linux devices.
" + }, + "DeviceTypeWeb":{ + "shape":"DefaultClientBrandingAttributes", + "documentation":"The branding information for Web access.
" + } + } + }, + "DescribeClientPropertiesRequest":{ + "type":"structure", + "required":["ResourceIds"], + "members":{ + "ResourceIds":{ + "shape":"ResourceIdList", + "documentation":"The resource identifier, in the form of directory IDs.
" + } + } + }, + "DescribeClientPropertiesResult":{ + "type":"structure", + "members":{ + "ClientPropertiesList":{ + "shape":"ClientPropertiesList", + "documentation":"Information about the specified Amazon WorkSpaces clients.
" + } + } + }, + "DescribeConnectClientAddInsRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "ResourceId":{ + "shape":"DirectoryId", + "documentation":"The directory identifier for which the client add-in is configured.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The maximum number of items to return.
" + } + } + }, + "DescribeConnectClientAddInsResult":{ + "type":"structure", + "members":{ + "AddIns":{ + "shape":"ConnectClientAddInList", + "documentation":"Information about client add-ins.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" + } + } + }, + "DescribeConnectionAliasPermissionsRequest":{ + "type":"structure", + "required":["AliasId"], + "members":{ + "AliasId":{ + "shape":"ConnectionAliasId", + "documentation":"The identifier of the connection alias.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The maximum number of results to return.
" + } + } + }, + "DescribeConnectionAliasPermissionsResult":{ + "type":"structure", + "members":{ + "AliasId":{ + "shape":"ConnectionAliasId", + "documentation":"The identifier of the connection alias.
" + }, + "ConnectionAliasPermissions":{ + "shape":"ConnectionAliasPermissions", + "documentation":"The permissions associated with a connection alias.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" + } + } + }, + "DescribeConnectionAliasesRequest":{ + "type":"structure", + "members":{ + "AliasIds":{ + "shape":"ConnectionAliasIdList", + "documentation":"The identifiers of the connection aliases to describe.
" + }, + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the directory associated with the connection alias.
" + }, + "Limit":{ + "shape":"Limit", + "documentation":"The maximum number of connection aliases to return.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
Information about the specified connection aliases.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" + } + } + }, + "DescribeImageAssociationsRequest":{ + "type":"structure", + "required":[ + "ImageId", + "AssociatedResourceTypes" + ], + "members":{ + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the image.
" + }, + "AssociatedResourceTypes":{ + "shape":"ImageAssociatedResourceTypeList", + "documentation":"The resource types of the associated resource.
" + } + } + }, + "DescribeImageAssociationsResult":{ + "type":"structure", + "members":{ + "Associations":{ + "shape":"ImageResourceAssociationList", + "documentation":"List of information about the specified associations.
" + } + } + }, + "DescribeIpGroupsRequest":{ + "type":"structure", + "members":{ + "GroupIds":{ + "shape":"IpGroupIdList", + "documentation":"The identifiers of one or more IP access control groups.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The maximum number of items to return.
" + } + } + }, + "DescribeIpGroupsResult":{ + "type":"structure", + "members":{ + "Result":{ + "shape":"WorkspacesIpGroupsList", + "documentation":"Information about the IP access control groups.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" + } + } + }, + "DescribeTagsRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
" + } + } + }, + "DescribeTagsResult":{ + "type":"structure", + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"The tags.
" + } + } + }, + "DescribeWorkspaceAssociationsRequest":{ + "type":"structure", + "required":[ + "WorkspaceId", + "AssociatedResourceTypes" + ], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + }, + "AssociatedResourceTypes":{ + "shape":"WorkSpaceAssociatedResourceTypeList", + "documentation":"The resource types of the associated resources.
" + } + } + }, + "DescribeWorkspaceAssociationsResult":{ + "type":"structure", + "members":{ + "Associations":{ + "shape":"WorkspaceResourceAssociationList", + "documentation":"List of information about the specified associations.
" + } + } + }, + "DescribeWorkspaceBundlesRequest":{ + "type":"structure", + "members":{ + "BundleIds":{ + "shape":"BundleIdList", + "documentation":"The identifiers of the bundles. You cannot combine this parameter with any other filter.
" + }, + "Owner":{ + "shape":"BundleOwner", + "documentation":"The owner of the bundles. You cannot combine this parameter with any other filter.
To describe the bundles provided by Amazon Web Services, specify AMAZON. To describe the bundles that belong to your account, don't specify a value.
The token for the next set of results. (You received this token from a previous call.)
" + } + } + }, + "DescribeWorkspaceBundlesResult":{ + "type":"structure", + "members":{ + "Bundles":{ + "shape":"BundleList", + "documentation":"Information about the bundles.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return. This token is valid for one day and must be used within that time frame.
" + } + } + }, + "DescribeWorkspaceDirectoriesFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"DescribeWorkspaceDirectoriesFilterName", + "documentation":"The name of the WorkSpaces to filter.
" + }, + "Values":{ + "shape":"DescribeWorkspaceDirectoriesFilterValues", + "documentation":"The values for filtering WorkSpaces
" + } + }, + "documentation":"Describes the filter conditions for the WorkSpaces to return.
" + }, + "DescribeWorkspaceDirectoriesFilterList":{ + "type":"list", + "member":{"shape":"DescribeWorkspaceDirectoriesFilter"}, + "max":25, + "min":1 + }, + "DescribeWorkspaceDirectoriesFilterName":{ + "type":"string", + "enum":[ + "USER_IDENTITY_TYPE", + "WORKSPACE_TYPE" + ] + }, + "DescribeWorkspaceDirectoriesFilterValue":{ + "type":"string", + "pattern":"^[0-9a-zA-Z\\*\\.\\\\/\\?-_]{0,64}$" + }, + "DescribeWorkspaceDirectoriesFilterValues":{ + "type":"list", + "member":{"shape":"DescribeWorkspaceDirectoriesFilterValue"}, + "max":25, + "min":1 + }, + "DescribeWorkspaceDirectoriesRequest":{ + "type":"structure", + "members":{ + "DirectoryIds":{ + "shape":"DirectoryIdList", + "documentation":"The identifiers of the directories. If the value is null, all directories are retrieved.
" + }, + "WorkspaceDirectoryNames":{ + "shape":"WorkspaceDirectoryNameList", + "documentation":"The names of the WorkSpace directories.
" + }, + "Limit":{ + "shape":"Limit", + "documentation":"The maximum number of directories to return.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The filter condition for the WorkSpaces.
" + } + } + }, + "DescribeWorkspaceDirectoriesResult":{ + "type":"structure", + "members":{ + "Directories":{ + "shape":"DirectoryList", + "documentation":"Information about the directories.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" + } + } + }, + "DescribeWorkspaceImagePermissionsRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the image.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The maximum number of items to return.
" + } + } + }, + "DescribeWorkspaceImagePermissionsResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the image.
" + }, + "ImagePermissions":{ + "shape":"ImagePermissions", + "documentation":"The identifiers of the Amazon Web Services accounts that the image has been shared with.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" + } + } + }, + "DescribeWorkspaceImagesRequest":{ + "type":"structure", + "members":{ + "ImageIds":{ + "shape":"WorkspaceImageIdList", + "documentation":"The identifier of the image.
" + }, + "ImageType":{ + "shape":"ImageType", + "documentation":"The type (owned or shared) of the image.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The maximum number of items to return.
" + } + } + }, + "DescribeWorkspaceImagesResult":{ + "type":"structure", + "members":{ + "Images":{ + "shape":"WorkspaceImageList", + "documentation":"Information about the images.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" + } + } + }, + "DescribeWorkspaceSnapshotsRequest":{ + "type":"structure", + "required":["WorkspaceId"], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + } + } + }, + "DescribeWorkspaceSnapshotsResult":{ + "type":"structure", + "members":{ + "RebuildSnapshots":{ + "shape":"SnapshotList", + "documentation":"Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.
" + }, + "RestoreSnapshots":{ + "shape":"SnapshotList", + "documentation":"Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.
" + } + } + }, + "DescribeWorkspacesConnectionStatusRequest":{ + "type":"structure", + "members":{ + "WorkspaceIds":{ + "shape":"WorkspaceIdList", + "documentation":"The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
Information about the connection status of the WorkSpace.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" + } + } + }, + "DescribeWorkspacesPoolSessionsRequest":{ + "type":"structure", + "required":["PoolId"], + "members":{ + "PoolId":{ + "shape":"WorkspacesPoolId", + "documentation":"The identifier of the pool.
" + }, + "UserId":{ + "shape":"WorkspacesPoolUserId", + "documentation":"The identifier of the user.
" + }, + "Limit":{ + "shape":"Limit50", + "documentation":"The maximum number of items to return.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
Describes the pool sessions.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The name of the pool to filter.
" + }, + "Values":{ + "shape":"DescribeWorkspacesPoolsFilterValues", + "documentation":"The values for filtering WorkSpaces Pools.
" + }, + "Operator":{ + "shape":"DescribeWorkspacesPoolsFilterOperator", + "documentation":"The operator values for filtering WorkSpaces Pools.
" + } + }, + "documentation":"Describes the filter conditions for WorkSpaces Pools to return.
" + }, + "DescribeWorkspacesPoolsFilterName":{ + "type":"string", + "enum":["PoolName"] + }, + "DescribeWorkspacesPoolsFilterOperator":{ + "type":"string", + "enum":[ + "EQUALS", + "NOTEQUALS", + "CONTAINS", + "NOTCONTAINS" + ] + }, + "DescribeWorkspacesPoolsFilterValue":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]+$" + }, + "DescribeWorkspacesPoolsFilterValues":{ + "type":"list", + "member":{"shape":"DescribeWorkspacesPoolsFilterValue"}, + "max":25, + "min":1 + }, + "DescribeWorkspacesPoolsFilters":{ + "type":"list", + "member":{"shape":"DescribeWorkspacesPoolsFilter"}, + "max":25, + "min":1 + }, + "DescribeWorkspacesPoolsRequest":{ + "type":"structure", + "members":{ + "PoolIds":{ + "shape":"WorkspacesPoolIds", + "documentation":"The identifier of the WorkSpaces Pools.
" + }, + "Filters":{ + "shape":"DescribeWorkspacesPoolsFilters", + "documentation":"The filter conditions for the WorkSpaces Pool to return.
" + }, + "Limit":{ + "shape":"Limit", + "documentation":"The maximum number of items to return.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
Information about the WorkSpaces Pools.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.
Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.
" + }, + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.
The name of the directory user. You must specify this parameter with DirectoryId.
The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.
" + }, + "Limit":{ + "shape":"Limit", + "documentation":"The maximum number of items to return.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The name of the user-decoupled WorkSpace.
" + } + } + }, + "DescribeWorkspacesResult":{ + "type":"structure", + "members":{ + "Workspaces":{ + "shape":"WorkspaceList", + "documentation":"Information about the WorkSpaces.
Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" + } + } + }, + "Description":{"type":"string"}, + "DesiredUserSessions":{ + "type":"integer", + "min":0 + }, + "DirectoryId":{ + "type":"string", + "max":65, + "min":10, + "pattern":"^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)" + }, + "DirectoryIdList":{ + "type":"list", + "member":{"shape":"DirectoryId"}, + "max":25, + "min":1 + }, + "DirectoryList":{ + "type":"list", + "member":{"shape":"WorkspaceDirectory"} + }, + "DirectoryName":{"type":"string"}, + "DisassociateConnectionAliasRequest":{ + "type":"structure", + "required":["AliasId"], + "members":{ + "AliasId":{ + "shape":"ConnectionAliasId", + "documentation":"The identifier of the connection alias to disassociate.
" + } + } + }, + "DisassociateConnectionAliasResult":{ + "type":"structure", + "members":{ + } + }, + "DisassociateIpGroupsRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "GroupIds" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the directory.
" + }, + "GroupIds":{ + "shape":"IpGroupIdList", + "documentation":"The identifiers of one or more IP access control groups.
" + } + } + }, + "DisassociateIpGroupsResult":{ + "type":"structure", + "members":{ + } + }, + "DisassociateWorkspaceApplicationRequest":{ + "type":"structure", + "required":[ + "WorkspaceId", + "ApplicationId" + ], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + }, + "ApplicationId":{ + "shape":"WorkSpaceApplicationId", + "documentation":"The identifier of the application.
" + } + } + }, + "DisassociateWorkspaceApplicationResult":{ + "type":"structure", + "members":{ + "Association":{ + "shape":"WorkspaceResourceAssociation", + "documentation":"Information about the targeted association.
" + } + } + }, + "DisconnectTimeoutInSeconds":{ + "type":"integer", + "max":36000, + "min":60 + }, + "DnsIpAddresses":{ + "type":"list", + "member":{"shape":"IpAddress"} + }, + "DomainName":{ + "type":"string", + "pattern":"^([a-zA-Z0-9]+[\\\\.-])+([a-zA-Z0-9])+$" + }, + "Ec2ImageId":{ + "type":"string", + "pattern":"^ami\\-([a-f0-9]{8}|[a-f0-9]{17})$" + }, + "ErrorDetails":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"WorkspaceImageErrorDetailCode", + "documentation":"Indicates the error code returned.
" + }, + "ErrorMessage":{ + "shape":"Description", + "documentation":"The text of the error message related the error code.
" + } + }, + "documentation":"Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.
" + }, + "ErrorDetailsList":{ + "type":"list", + "member":{"shape":"ErrorDetails"} + }, + "ErrorMessage":{"type":"string"}, + "ErrorType":{"type":"string"}, + "ExceptionErrorCode":{"type":"string"}, + "ExceptionMessage":{"type":"string"}, + "FailedCreateStandbyWorkspacesRequest":{ + "type":"structure", + "members":{ + "StandbyWorkspaceRequest":{ + "shape":"StandbyWorkspace", + "documentation":"Information about the standby WorkSpace that could not be created.
" + }, + "ErrorCode":{ + "shape":"WorkspaceErrorCode", + "documentation":"The error code that is returned if the standby WorkSpace could not be created.
" + }, + "ErrorMessage":{ + "shape":"Description", + "documentation":"The text of the error message that is returned if the standby WorkSpace could not be created.
" + } + }, + "documentation":"Describes the standby WorkSpace that could not be created.
" + }, + "FailedCreateStandbyWorkspacesRequestList":{ + "type":"list", + "member":{"shape":"FailedCreateStandbyWorkspacesRequest"} + }, + "FailedCreateWorkspaceRequest":{ + "type":"structure", + "members":{ + "WorkspaceRequest":{ + "shape":"WorkspaceRequest", + "documentation":"Information about the WorkSpace.
" + }, + "ErrorCode":{ + "shape":"ErrorType", + "documentation":"The error code that is returned if the WorkSpace cannot be created.
" + }, + "ErrorMessage":{ + "shape":"Description", + "documentation":"The text of the error message that is returned if the WorkSpace cannot be created.
" + } + }, + "documentation":"Describes a WorkSpace that cannot be created.
" + }, + "FailedCreateWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedCreateWorkspaceRequest"} + }, + "FailedRebootWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedWorkspaceChangeRequest"} + }, + "FailedRebuildWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedWorkspaceChangeRequest"} + }, + "FailedStartWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedWorkspaceChangeRequest"} + }, + "FailedStopWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedWorkspaceChangeRequest"} + }, + "FailedTerminateWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedWorkspaceChangeRequest"} + }, + "FailedWorkspaceChangeRequest":{ + "type":"structure", + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + }, + "ErrorCode":{ + "shape":"ErrorType", + "documentation":"The error code that is returned if the WorkSpace cannot be rebooted.
" + }, + "ErrorMessage":{ + "shape":"Description", + "documentation":"The text of the error message that is returned if the WorkSpace cannot be rebooted.
" + } + }, + "documentation":"Describes a WorkSpace that could not be rebooted. (RebootWorkspaces), rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).
" + }, + "GetAccountLinkRequest":{ + "type":"structure", + "members":{ + "LinkId":{ + "shape":"LinkId", + "documentation":"The identifier of the account to link.
" + }, + "LinkedAccountId":{ + "shape":"AwsAccount", + "documentation":"The identifier of the account link
" + } + } + }, + "GetAccountLinkResult":{ + "type":"structure", + "members":{ + "AccountLink":{ + "shape":"AccountLink", + "documentation":"The account link of the account link to retrieve.
" + } + } + }, + "IDCConfig":{ + "type":"structure", + "members":{ + "InstanceArn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the identity center instance.
" + }, + "ApplicationArn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the application.
" + } + }, + "documentation":"Specifies the configurations of the identity center.
" + }, + "IdleDisconnectTimeoutInSeconds":{ + "type":"integer", + "max":36000, + "min":0 + }, + "ImageAssociatedResourceType":{ + "type":"string", + "enum":["APPLICATION"] + }, + "ImageAssociatedResourceTypeList":{ + "type":"list", + "member":{"shape":"ImageAssociatedResourceType"} + }, + "ImagePermission":{ + "type":"structure", + "members":{ + "SharedAccountId":{ + "shape":"AwsAccount", + "documentation":"The identifier of the Amazon Web Services account that an image has been shared with.
" + } + }, + "documentation":"Describes the Amazon Web Services accounts that have been granted permission to use a shared image. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
" + }, + "ImagePermissions":{ + "type":"list", + "member":{"shape":"ImagePermission"} + }, + "ImageResourceAssociation":{ + "type":"structure", + "members":{ + "AssociatedResourceId":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the associated resource.
" + }, + "AssociatedResourceType":{ + "shape":"ImageAssociatedResourceType", + "documentation":"The resource type of the associated resources.
" + }, + "Created":{ + "shape":"Timestamp", + "documentation":"The time the association is created.
" + }, + "LastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"The time the association status was last updated.
" + }, + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the image.
" + }, + "State":{ + "shape":"AssociationState", + "documentation":"The status of the image resource association.
" + }, + "StateReason":{ + "shape":"AssociationStateReason", + "documentation":"The reason the association deployment failed.
" + } + }, + "documentation":"Describes the association between an application and an image resource.
" + }, + "ImageResourceAssociationList":{ + "type":"list", + "member":{"shape":"ImageResourceAssociation"} + }, + "ImageType":{ + "type":"string", + "enum":[ + "OWNED", + "SHARED" + ] + }, + "ImportClientBrandingRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "ResourceId":{ + "shape":"DirectoryId", + "documentation":"The directory identifier of the WorkSpace for which you want to import client branding.
" + }, + "DeviceTypeWindows":{ + "shape":"DefaultImportClientBrandingAttributes", + "documentation":"The branding information to import for Windows devices.
" + }, + "DeviceTypeOsx":{ + "shape":"DefaultImportClientBrandingAttributes", + "documentation":"The branding information to import for macOS devices.
" + }, + "DeviceTypeAndroid":{ + "shape":"DefaultImportClientBrandingAttributes", + "documentation":"The branding information to import for Android devices.
" + }, + "DeviceTypeIos":{ + "shape":"IosImportClientBrandingAttributes", + "documentation":"The branding information to import for iOS devices.
" + }, + "DeviceTypeLinux":{ + "shape":"DefaultImportClientBrandingAttributes", + "documentation":"The branding information to import for Linux devices.
" + }, + "DeviceTypeWeb":{ + "shape":"DefaultImportClientBrandingAttributes", + "documentation":"The branding information to import for web access.
" + } + } + }, + "ImportClientBrandingResult":{ + "type":"structure", + "members":{ + "DeviceTypeWindows":{ + "shape":"DefaultClientBrandingAttributes", + "documentation":"The branding information configured for Windows devices.
" + }, + "DeviceTypeOsx":{ + "shape":"DefaultClientBrandingAttributes", + "documentation":"The branding information configured for macOS devices.
" + }, + "DeviceTypeAndroid":{ + "shape":"DefaultClientBrandingAttributes", + "documentation":"The branding information configured for Android devices.
" + }, + "DeviceTypeIos":{ + "shape":"IosClientBrandingAttributes", + "documentation":"The branding information configured for iOS devices.
" + }, + "DeviceTypeLinux":{ + "shape":"DefaultClientBrandingAttributes", + "documentation":"The branding information configured for Linux devices.
" + }, + "DeviceTypeWeb":{ + "shape":"DefaultClientBrandingAttributes", + "documentation":"The branding information configured for web access.
" + } + } + }, + "ImportWorkspaceImageRequest":{ + "type":"structure", + "required":[ + "Ec2ImageId", + "IngestionProcess", + "ImageName", + "ImageDescription" + ], + "members":{ + "Ec2ImageId":{ + "shape":"Ec2ImageId", + "documentation":"The identifier of the EC2 image.
" + }, + "IngestionProcess":{ + "shape":"WorkspaceImageIngestionProcess", + "documentation":"The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP. To use BYOP, specify a value that ends in _BYOP.
For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol.
The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.
The name of the WorkSpace image.
" + }, + "ImageDescription":{ + "shape":"WorkspaceImageDescription", + "documentation":"The description of the WorkSpace image.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags. Each WorkSpaces resource can have a maximum of 50 tags.
" + }, + "Applications":{ + "shape":"ApplicationList", + "documentation":"If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.
Although this parameter is an array, only one item is allowed at this time.
During the image import process, non-GPU WSP WorkSpaces with Windows 11 support only Microsoft_Office_2019. GPU WSP WorkSpaces with Windows 11 do not support Office installation.
The identifier of the WorkSpace image.
" + } + } + }, + "IncompatibleApplicationsException":{ + "type":"structure", + "members":{ + }, + "documentation":"The specified application is not compatible with the resource.
", + "exception":true + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"Unexpected server error occured.
", + "exception":true + }, + "InvalidParameterValuesException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The exception error message.
" + } + }, + "documentation":"One or more parameter values are not valid.
", + "exception":true + }, + "InvalidResourceStateException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"The state of the resource is not valid for this operation.
", + "exception":true + }, + "Ios2XLogo":{ + "type":"blob", + "max":1770000, + "min":1 + }, + "Ios3XLogo":{ + "type":"blob", + "max":1770000, + "min":1 + }, + "IosClientBrandingAttributes":{ + "type":"structure", + "members":{ + "LogoUrl":{ + "shape":"ClientUrl", + "documentation":"The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.
The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).The only image format accepted is a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The support email. The company's customer support email address.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com.
The support link. The link for the company's customer support page for their WorkSpace.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com.
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
" + }, + "LoginMessage":{ + "shape":"LoginMessage", + "documentation":"The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.
The client branding attributes for iOS device types. These attributes are displayed on the iOS client login screen only.
Client branding attributes are public facing. Ensure you do not include sensitive information.
The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.
The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x). The only image format accepted is a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The support email. The company's customer support email address.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com.
The support link. The link for the company's customer support page for their WorkSpace.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com.
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
" + }, + "LoginMessage":{ + "shape":"LoginMessage", + "documentation":"The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.
The client branding attributes to import for iOS device types. These attributes are displayed on the iOS client login screen.
Client branding attributes are public facing. Ensure you do not include sensitive information.
The IP address range, in CIDR notation.
" + }, + "ruleDesc":{ + "shape":"IpRuleDesc", + "documentation":"The description.
" + } + }, + "documentation":"Describes a rule for an IP access control group.
" + }, + "IpRuleList":{ + "type":"list", + "member":{"shape":"IpRuleItem"} + }, + "Limit":{ + "type":"integer", + "max":25, + "min":1 + }, + "Limit50":{ + "type":"integer", + "max":50, + "min":1 + }, + "LinkId":{ + "type":"string", + "pattern":"^link-.{8,24}$" + }, + "LinkStatusFilterList":{ + "type":"list", + "member":{"shape":"AccountLinkStatusEnum"} + }, + "ListAccountLinksRequest":{ + "type":"structure", + "members":{ + "LinkStatusFilter":{ + "shape":"LinkStatusFilterList", + "documentation":"Filters the account based on their link status.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" + }, + "MaxResults":{ + "shape":"Limit", + "documentation":"The maximum number of accounts to return.
" + } + } + }, + "ListAccountLinksResult":{ + "type":"structure", + "members":{ + "AccountLinks":{ + "shape":"AccountLinkList", + "documentation":"Information about the account links.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" + } + } + }, + "ListAvailableManagementCidrRangesRequest":{ + "type":"structure", + "required":["ManagementCidrRangeConstraint"], + "members":{ + "ManagementCidrRangeConstraint":{ + "shape":"ManagementCidrRangeConstraint", + "documentation":"The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).
" + }, + "MaxResults":{ + "shape":"ManagementCidrRangeMaxResults", + "documentation":"The maximum number of items to return.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The list of available IP address ranges, specified as IPv4 CIDR blocks.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" + } + } + }, + "LogUploadEnum":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "LoginMessage":{ + "type":"map", + "key":{"shape":"ClientLocale"}, + "value":{"shape":"ClientLoginMessage"} + }, + "ManagementCidrRangeConstraint":{ + "type":"string", + "pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[0-9]))$" + }, + "ManagementCidrRangeMaxResults":{ + "type":"integer", + "max":5, + "min":1 + }, + "MaxUserDurationInSeconds":{ + "type":"integer", + "max":432000, + "min":600 + }, + "MaximumLength":{ + "type":"integer", + "min":0 + }, + "MicrosoftEntraConfig":{ + "type":"structure", + "members":{ + "TenantId":{ + "shape":"MicrosoftEntraConfigTenantId", + "documentation":"The identifier of the tenant.
" + }, + "ApplicationConfigSecretArn":{ + "shape":"SecretsManagerArn", + "documentation":"The Amazon Resource Name (ARN) of the application config.
" + } + }, + "documentation":"Specifies the configurations of the Microsoft Entra.
" + }, + "MicrosoftEntraConfigTenantId":{ + "type":"string", + "pattern":"^[a-zA-Z0-9-]{1,100}$" + }, + "MigrateWorkspaceRequest":{ + "type":"structure", + "required":[ + "SourceWorkspaceId", + "BundleId" + ], + "members":{ + "SourceWorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace to migrate from.
" + }, + "BundleId":{ + "shape":"BundleId", + "documentation":"The identifier of the target bundle type to migrate the WorkSpace to.
" + } + } + }, + "MigrateWorkspaceResult":{ + "type":"structure", + "members":{ + "SourceWorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The original identifier of the WorkSpace that is being migrated.
" + }, + "TargetWorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.
" + } + } + }, + "ModificationResourceEnum":{ + "type":"string", + "enum":[ + "ROOT_VOLUME", + "USER_VOLUME", + "COMPUTE_TYPE" + ] + }, + "ModificationState":{ + "type":"structure", + "members":{ + "Resource":{ + "shape":"ModificationResourceEnum", + "documentation":"The resource.
" + }, + "State":{ + "shape":"ModificationStateEnum", + "documentation":"The modification state.
" + } + }, + "documentation":"Describes a WorkSpace modification.
" + }, + "ModificationStateEnum":{ + "type":"string", + "enum":[ + "UPDATE_INITIATED", + "UPDATE_IN_PROGRESS" + ] + }, + "ModificationStateList":{ + "type":"list", + "member":{"shape":"ModificationState"} + }, + "ModifyAccountRequest":{ + "type":"structure", + "members":{ + "DedicatedTenancySupport":{ + "shape":"DedicatedTenancySupportEnum", + "documentation":"The status of BYOL.
" + }, + "DedicatedTenancyManagementCidrRange":{ + "shape":"DedicatedTenancyManagementCidrRange", + "documentation":"The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the ListAvailableManagementCidrRanges operation.
The resource identifiers, in the form of directory IDs.
" + }, + "CertificateBasedAuthProperties":{ + "shape":"CertificateBasedAuthProperties", + "documentation":"The properties of the certificate-based authentication.
" + }, + "PropertiesToDelete":{ + "shape":"DeletableCertificateBasedAuthPropertiesList", + "documentation":"The properties of the certificate-based authentication you want to delete.
" + } + } + }, + "ModifyCertificateBasedAuthPropertiesResult":{ + "type":"structure", + "members":{ + } + }, + "ModifyClientPropertiesRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "ClientProperties" + ], + "members":{ + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"The resource identifiers, in the form of directory IDs.
" + }, + "ClientProperties":{ + "shape":"ClientProperties", + "documentation":"Information about the Amazon WorkSpaces client.
" + } + } + }, + "ModifyClientPropertiesResult":{ + "type":"structure", + "members":{ + } + }, + "ModifySamlPropertiesRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "ResourceId":{ + "shape":"DirectoryId", + "documentation":"The directory identifier for which you want to configure SAML properties.
" + }, + "SamlProperties":{ + "shape":"SamlProperties", + "documentation":"The properties for configuring SAML 2.0 authentication.
" + }, + "PropertiesToDelete":{ + "shape":"DeletableSamlPropertiesList", + "documentation":"The SAML properties to delete as part of your request.
Specify one of the following options:
SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.
SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name.
The identifier of the directory.
" + }, + "SelfservicePermissions":{ + "shape":"SelfservicePermissions", + "documentation":"The permissions to enable or disable self-service capabilities.
" + } + } + }, + "ModifySelfservicePermissionsResult":{ + "type":"structure", + "members":{ + } + }, + "ModifyStreamingPropertiesRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "ResourceId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the resource.
" + }, + "StreamingProperties":{ + "shape":"StreamingProperties", + "documentation":"The streaming properties to configure.
" + } + } + }, + "ModifyStreamingPropertiesResult":{ + "type":"structure", + "members":{ + } + }, + "ModifyWorkspaceAccessPropertiesRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "WorkspaceAccessProperties" + ], + "members":{ + "ResourceId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the directory.
" + }, + "WorkspaceAccessProperties":{ + "shape":"WorkspaceAccessProperties", + "documentation":"The device types and operating systems to enable or disable for access.
" + } + } + }, + "ModifyWorkspaceAccessPropertiesResult":{ + "type":"structure", + "members":{ + } + }, + "ModifyWorkspaceCreationPropertiesRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "WorkspaceCreationProperties" + ], + "members":{ + "ResourceId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the directory.
" + }, + "WorkspaceCreationProperties":{ + "shape":"WorkspaceCreationProperties", + "documentation":"The default properties for creating WorkSpaces.
" + } + } + }, + "ModifyWorkspaceCreationPropertiesResult":{ + "type":"structure", + "members":{ + } + }, + "ModifyWorkspacePropertiesRequest":{ + "type":"structure", + "required":["WorkspaceId"], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + }, + "WorkspaceProperties":{ + "shape":"WorkspaceProperties", + "documentation":"The properties of the WorkSpace.
" + }, + "DataReplication":{ + "shape":"DataReplication", + "documentation":"Indicates the data replication status.
" + } + } + }, + "ModifyWorkspacePropertiesResult":{ + "type":"structure", + "members":{ + } + }, + "ModifyWorkspaceStateRequest":{ + "type":"structure", + "required":[ + "WorkspaceId", + "WorkspaceState" + ], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + }, + "WorkspaceState":{ + "shape":"TargetWorkspaceState", + "documentation":"The WorkSpace state.
" + } + } + }, + "ModifyWorkspaceStateResult":{ + "type":"structure", + "members":{ + } + }, + "NetworkAccessConfiguration":{ + "type":"structure", + "members":{ + "EniPrivateIpAddress":{ + "shape":"NonEmptyString", + "documentation":"The private IP address of the elastic network interface that is attached to instances in your VPC.
" + }, + "EniId":{ + "shape":"NonEmptyString", + "documentation":"The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
" + } + }, + "documentation":"Describes the network details of a WorkSpaces Pool.
" + }, + "NonEmptyString":{ + "type":"string", + "min":1 + }, + "OperatingSystem":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"OperatingSystemType", + "documentation":"The operating system.
" + } + }, + "documentation":"The operating system that the image is running.
" + }, + "OperatingSystemName":{ + "type":"string", + "enum":[ + "AMAZON_LINUX_2", + "UBUNTU_18_04", + "UBUNTU_20_04", + "UBUNTU_22_04", + "UNKNOWN", + "WINDOWS_10", + "WINDOWS_11", + "WINDOWS_7", + "WINDOWS_SERVER_2016", + "WINDOWS_SERVER_2019", + "WINDOWS_SERVER_2022", + "RHEL_8" + ] + }, + "OperatingSystemNameList":{ + "type":"list", + "member":{"shape":"OperatingSystemName"} + }, + "OperatingSystemNotCompatibleException":{ + "type":"structure", + "members":{ + }, + "documentation":"The operating system of the WorkSpace is not compatible with the application.
", + "exception":true + }, + "OperatingSystemType":{ + "type":"string", + "enum":[ + "WINDOWS", + "LINUX" + ] + }, + "OperationInProgressException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"The properties of this WorkSpace are currently being modified. Try again in a moment.
", + "exception":true + }, + "OperationNotSupportedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The exception error message.
" + }, + "reason":{ + "shape":"ExceptionErrorCode", + "documentation":"The exception error reason.
" + } + }, + "documentation":"This operation is not supported.
", + "exception":true + }, + "PaginationToken":{ + "type":"string", + "max":2048, + "min":1 + }, + "PendingCreateStandbyWorkspacesRequest":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"UserName", + "documentation":"Describes the standby WorkSpace that was created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
" + }, + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the directory for the standby WorkSpace.
" + }, + "State":{ + "shape":"WorkspaceState", + "documentation":"The operational state of the standby WorkSpace.
" + }, + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the standby WorkSpace.
" + } + }, + "documentation":"Information about the standby WorkSpace.
" + }, + "PendingCreateStandbyWorkspacesRequestList":{ + "type":"list", + "member":{"shape":"PendingCreateStandbyWorkspacesRequest"} + }, + "Protocol":{ + "type":"string", + "enum":[ + "PCOIP", + "WSP" + ] + }, + "ProtocolList":{ + "type":"list", + "member":{"shape":"Protocol"} + }, + "RebootRequest":{ + "type":"structure", + "required":["WorkspaceId"], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + } + }, + "documentation":"Describes the information used to reboot a WorkSpace.
" + }, + "RebootWorkspaceRequests":{ + "type":"list", + "member":{"shape":"RebootRequest"}, + "max":25, + "min":1 + }, + "RebootWorkspacesRequest":{ + "type":"structure", + "required":["RebootWorkspaceRequests"], + "members":{ + "RebootWorkspaceRequests":{ + "shape":"RebootWorkspaceRequests", + "documentation":"The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
" + } + } + }, + "RebootWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{ + "shape":"FailedRebootWorkspaceRequests", + "documentation":"Information about the WorkSpaces that could not be rebooted.
" + } + } + }, + "RebuildRequest":{ + "type":"structure", + "required":["WorkspaceId"], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + } + }, + "documentation":"Describes the information used to rebuild a WorkSpace.
" + }, + "RebuildWorkspaceRequests":{ + "type":"list", + "member":{"shape":"RebuildRequest"}, + "max":1, + "min":1 + }, + "RebuildWorkspacesRequest":{ + "type":"structure", + "required":["RebuildWorkspaceRequests"], + "members":{ + "RebuildWorkspaceRequests":{ + "shape":"RebuildWorkspaceRequests", + "documentation":"The WorkSpace to rebuild. You can specify a single WorkSpace.
" + } + } + }, + "RebuildWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{ + "shape":"FailedRebuildWorkspaceRequests", + "documentation":"Information about the WorkSpace that could not be rebuilt.
" + } + } + }, + "ReconnectEnum":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "Region":{ + "type":"string", + "max":31, + "min":1, + "pattern":"^[-0-9a-z]{1,31}$" + }, + "RegisterWorkspaceDirectoryRequest":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.
" + }, + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.
" + }, + "EnableWorkDocs":{ + "shape":"BooleanObject", + "documentation":"Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.
Indicates whether self-service capabilities are enabled or disabled.
" + }, + "Tenancy":{ + "shape":"Tenancy", + "documentation":"Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.
The tags associated with the directory.
" + }, + "WorkspaceDirectoryName":{ + "shape":"WorkspaceDirectoryName", + "documentation":"The name of the directory to register.
" + }, + "WorkspaceDirectoryDescription":{ + "shape":"WorkspaceDirectoryDescription", + "documentation":"Description of the directory to register.
" + }, + "UserIdentityType":{ + "shape":"UserIdentityType", + "documentation":"The type of identity management the user is using.
" + }, + "IdcInstanceArn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the identity center instance.
" + }, + "MicrosoftEntraConfig":{ + "shape":"MicrosoftEntraConfig", + "documentation":"The details about Microsoft Entra config.
" + }, + "WorkspaceType":{ + "shape":"WorkspaceType", + "documentation":"Indicates whether the directory's WorkSpace type is personal or pools.
" + }, + "ActiveDirectoryConfig":{ + "shape":"ActiveDirectoryConfig", + "documentation":"The active directory config of the directory.
" + } + } + }, + "RegisterWorkspaceDirectoryResult":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the directory.
" + }, + "State":{ + "shape":"WorkspaceDirectoryState", + "documentation":"The registration status of the WorkSpace directory.
" + } + } + }, + "RegistrationCode":{ + "type":"string", + "max":20, + "min":1 + }, + "RejectAccountLinkInvitationRequest":{ + "type":"structure", + "required":["LinkId"], + "members":{ + "LinkId":{ + "shape":"LinkId", + "documentation":"The identifier of the account link
" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"The client token of the account link invitation to reject.
" + } + } + }, + "RejectAccountLinkInvitationResult":{ + "type":"structure", + "members":{ + "AccountLink":{ + "shape":"AccountLink", + "documentation":"Information about the account link.
" + } + } + }, + "RelatedWorkspaceProperties":{ + "type":"structure", + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the related WorkSpace.
" + }, + "Region":{ + "shape":"Region", + "documentation":"The Region of the related WorkSpace.
" + }, + "State":{ + "shape":"WorkspaceState", + "documentation":"Indicates the state of the WorkSpace.
" + }, + "Type":{ + "shape":"StandbyWorkspaceRelationshipType", + "documentation":"Indicates the type of WorkSpace.
" + } + }, + "documentation":"Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
" + }, + "RelatedWorkspaces":{ + "type":"list", + "member":{"shape":"RelatedWorkspaceProperties"} + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"The specified resource already exists.
", + "exception":true + }, + "ResourceAssociatedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"The resource is associated with a directory.
", + "exception":true + }, + "ResourceCreationFailedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"The resource could not be created.
", + "exception":true + }, + "ResourceIdList":{ + "type":"list", + "member":{"shape":"NonEmptyString"}, + "max":25, + "min":1 + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"The ID of the resource that is in use.
" + } + }, + "documentation":"The specified resource is currently in use.
", + "exception":true + }, + "ResourceLimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The exception error message.
" + } + }, + "documentation":"Your resource limits have been exceeded.
", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The resource could not be found.
" + }, + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"The ID of the resource that could not be found.
" + } + }, + "documentation":"The resource could not be found.
", + "exception":true + }, + "ResourceUnavailableException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The exception error message.
" + }, + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the resource that is not available.
" + } + }, + "documentation":"The specified resource is not available.
", + "exception":true + }, + "RestoreWorkspaceRequest":{ + "type":"structure", + "required":["WorkspaceId"], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + } + } + }, + "RestoreWorkspaceResult":{ + "type":"structure", + "members":{ + } + }, + "RevokeIpRulesRequest":{ + "type":"structure", + "required":[ + "GroupId", + "UserRules" + ], + "members":{ + "GroupId":{ + "shape":"IpGroupId", + "documentation":"The identifier of the group.
" + }, + "UserRules":{ + "shape":"IpRevokedRuleList", + "documentation":"The rules to remove from the group.
" + } + } + }, + "RevokeIpRulesResult":{ + "type":"structure", + "members":{ + } + }, + "RootStorage":{ + "type":"structure", + "required":["Capacity"], + "members":{ + "Capacity":{ + "shape":"NonEmptyString", + "documentation":"The size of the root volume.
" + } + }, + "documentation":"Describes the root volume for a WorkSpace bundle.
" + }, + "RootVolumeSizeGib":{"type":"integer"}, + "RunningMode":{ + "type":"string", + "enum":[ + "AUTO_STOP", + "ALWAYS_ON", + "MANUAL" + ] + }, + "RunningModeAutoStopTimeoutInMinutes":{"type":"integer"}, + "S3BucketName":{ + "type":"string", + "max":63, + "min":3, + "pattern":"^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + }, + "SamlProperties":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"SamlStatusEnum", + "documentation":"Indicates the status of SAML 2.0 authentication. These statuses include the following.
If the setting is DISABLED, end users will be directed to login with their directory credentials.
If the setting is ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.
If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.
The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.
" + }, + "RelayStateParameterName":{ + "shape":"NonEmptyString", + "documentation":"The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.
To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.
" + } + }, + "documentation":"Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
" + }, + "SamlStatusEnum":{ + "type":"string", + "enum":[ + "DISABLED", + "ENABLED", + "ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK" + ] + }, + "SamlUserAccessUrl":{ + "type":"string", + "max":200, + "min":8, + "pattern":"^(http|https)\\://\\S+$" + }, + "SecretsManagerArn":{ + "type":"string", + "pattern":"^arn:aws[a-z-]{0,7}:secretsmanager:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:secret:[A-Za-z0-9][A-za-z0-9_/.-]{8,519}$" + }, + "SecurityGroupId":{ + "type":"string", + "max":20, + "min":11, + "pattern":"^(sg-([0-9a-f]{8}|[0-9a-f]{17}))$" + }, + "SelfservicePermissions":{ + "type":"structure", + "members":{ + "RestartWorkspace":{ + "shape":"ReconnectEnum", + "documentation":"Specifies whether users can restart their WorkSpace.
" + }, + "IncreaseVolumeSize":{ + "shape":"ReconnectEnum", + "documentation":"Specifies whether users can increase the volume size of the drives on their WorkSpace.
" + }, + "ChangeComputeType":{ + "shape":"ReconnectEnum", + "documentation":"Specifies whether users can change the compute type (bundle) for their WorkSpace.
" + }, + "SwitchRunningMode":{ + "shape":"ReconnectEnum", + "documentation":"Specifies whether users can switch the running mode of their WorkSpace.
" + }, + "RebuildWorkspace":{ + "shape":"ReconnectEnum", + "documentation":"Specifies whether users can rebuild the operating system of a WorkSpace to its original state.
" + } + }, + "documentation":"Describes the self-service permissions for a directory. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
" + }, + "SessionConnectionState":{ + "type":"string", + "enum":[ + "CONNECTED", + "NOT_CONNECTED" + ] + }, + "SessionInstanceId":{ + "type":"string", + "pattern":"^i-[a-f0-9]{8}(?:[a-f0-9]{9})?$" + }, + "SettingsGroup":{ + "type":"string", + "max":100, + "pattern":"^[A-Za-z0-9_./()!*'-]+$" + }, + "Snapshot":{ + "type":"structure", + "members":{ + "SnapshotTime":{ + "shape":"Timestamp", + "documentation":"The time when the snapshot was created.
" + } + }, + "documentation":"Describes a snapshot.
" + }, + "SnapshotList":{ + "type":"list", + "member":{"shape":"Snapshot"} + }, + "StandbyWorkspace":{ + "type":"structure", + "required":[ + "PrimaryWorkspaceId", + "DirectoryId" + ], + "members":{ + "PrimaryWorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the standby WorkSpace.
" + }, + "VolumeEncryptionKey":{ + "shape":"VolumeEncryptionKey", + "documentation":"The volume encryption key of the standby WorkSpace.
" + }, + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the directory for the standby WorkSpace.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags associated with the standby WorkSpace.
" + }, + "DataReplication":{ + "shape":"DataReplication", + "documentation":"Indicates whether data replication is enabled, and if enabled, the type of data replication.
" + } + }, + "documentation":"Describes a standby WorkSpace.
" + }, + "StandbyWorkspaceRelationshipType":{ + "type":"string", + "enum":[ + "PRIMARY", + "STANDBY" + ] + }, + "StandbyWorkspacesList":{ + "type":"list", + "member":{"shape":"StandbyWorkspace"} + }, + "StandbyWorkspacesProperties":{ + "type":"structure", + "members":{ + "StandbyWorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the standby WorkSpace
" + }, + "DataReplication":{ + "shape":"DataReplication", + "documentation":"Indicates whether data replication is enabled, and if enabled, the type of data replication.
" + }, + "RecoverySnapshotTime":{ + "shape":"Timestamp", + "documentation":"The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.
" + } + }, + "documentation":"Describes the properties of the related standby WorkSpaces.
" + }, + "StandbyWorkspacesPropertiesList":{ + "type":"list", + "member":{"shape":"StandbyWorkspacesProperties"} + }, + "StartRequest":{ + "type":"structure", + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + } + }, + "documentation":"Information used to start a WorkSpace.
" + }, + "StartWorkspaceRequests":{ + "type":"list", + "member":{"shape":"StartRequest"}, + "max":25, + "min":1 + }, + "StartWorkspacesPoolRequest":{ + "type":"structure", + "required":["PoolId"], + "members":{ + "PoolId":{ + "shape":"WorkspacesPoolId", + "documentation":"The identifier of the pool.
" + } + } + }, + "StartWorkspacesPoolResult":{ + "type":"structure", + "members":{ + } + }, + "StartWorkspacesRequest":{ + "type":"structure", + "required":["StartWorkspaceRequests"], + "members":{ + "StartWorkspaceRequests":{ + "shape":"StartWorkspaceRequests", + "documentation":"The WorkSpaces to start. You can specify up to 25 WorkSpaces.
" + } + } + }, + "StartWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{ + "shape":"FailedStartWorkspaceRequests", + "documentation":"Information about the WorkSpaces that could not be started.
" + } + } + }, + "StopRequest":{ + "type":"structure", + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + } + }, + "documentation":"Describes the information used to stop a WorkSpace.
" + }, + "StopWorkspaceRequests":{ + "type":"list", + "member":{"shape":"StopRequest"}, + "max":25, + "min":1 + }, + "StopWorkspacesPoolRequest":{ + "type":"structure", + "required":["PoolId"], + "members":{ + "PoolId":{ + "shape":"WorkspacesPoolId", + "documentation":"The identifier of the pool.
" + } + } + }, + "StopWorkspacesPoolResult":{ + "type":"structure", + "members":{ + } + }, + "StopWorkspacesRequest":{ + "type":"structure", + "required":["StopWorkspaceRequests"], + "members":{ + "StopWorkspaceRequests":{ + "shape":"StopWorkspaceRequests", + "documentation":"The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
" + } + } + }, + "StopWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{ + "shape":"FailedStopWorkspaceRequests", + "documentation":"Information about the WorkSpaces that could not be stopped.
" + } + } + }, + "StorageConnector":{ + "type":"structure", + "required":[ + "ConnectorType", + "Status" + ], + "members":{ + "ConnectorType":{ + "shape":"StorageConnectorTypeEnum", + "documentation":"The type of connector used to save user files.
" + }, + "Status":{ + "shape":"StorageConnectorStatusEnum", + "documentation":"Indicates if the storage connetor is enabled or disabled.
" + } + }, + "documentation":"Describes the storage connector.
" + }, + "StorageConnectorStatusEnum":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "StorageConnectorTypeEnum":{ + "type":"string", + "enum":["HOME_FOLDER"] + }, + "StorageConnectors":{ + "type":"list", + "member":{"shape":"StorageConnector"}, + "min":1 + }, + "StreamingExperiencePreferredProtocolEnum":{ + "type":"string", + "enum":[ + "TCP", + "UDP" + ] + }, + "StreamingProperties":{ + "type":"structure", + "members":{ + "StreamingExperiencePreferredProtocol":{ + "shape":"StreamingExperiencePreferredProtocolEnum", + "documentation":"Indicates the type of preferred protocol for the streaming experience.
" + }, + "UserSettings":{ + "shape":"UserSettings", + "documentation":"Indicates the permission settings asscoiated with the user.
" + }, + "StorageConnectors":{ + "shape":"StorageConnectors", + "documentation":"Indicates the storage connector used
" + } + }, + "documentation":"Describes the streaming properties.
" + }, + "String2048":{ + "type":"string", + "max":2048, + "min":0 + }, + "SubnetId":{ + "type":"string", + "max":24, + "min":15, + "pattern":"^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$" + }, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"}, + "max":2 + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"The key of the tag.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The value of the tag.
" + } + }, + "documentation":"Describes a tag.
" + }, + "TagKey":{ + "type":"string", + "max":127, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"NonEmptyString"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagValue":{ + "type":"string", + "max":255 + }, + "TargetWorkspaceState":{ + "type":"string", + "enum":[ + "AVAILABLE", + "ADMIN_MAINTENANCE" + ] + }, + "Tenancy":{ + "type":"string", + "enum":[ + "DEDICATED", + "SHARED" + ] + }, + "TerminateRequest":{ + "type":"structure", + "required":["WorkspaceId"], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + } + }, + "documentation":"Describes the information used to terminate a WorkSpace.
" + }, + "TerminateWorkspaceRequests":{ + "type":"list", + "member":{"shape":"TerminateRequest"}, + "max":25, + "min":1 + }, + "TerminateWorkspacesPoolRequest":{ + "type":"structure", + "required":["PoolId"], + "members":{ + "PoolId":{ + "shape":"WorkspacesPoolId", + "documentation":"The identifier of the pool.
" + } + } + }, + "TerminateWorkspacesPoolResult":{ + "type":"structure", + "members":{ + } + }, + "TerminateWorkspacesPoolSessionRequest":{ + "type":"structure", + "required":["SessionId"], + "members":{ + "SessionId":{ + "shape":"AmazonUuid", + "documentation":"The identifier of the pool session.
" + } + } + }, + "TerminateWorkspacesPoolSessionResult":{ + "type":"structure", + "members":{ + } + }, + "TerminateWorkspacesRequest":{ + "type":"structure", + "required":["TerminateWorkspaceRequests"], + "members":{ + "TerminateWorkspaceRequests":{ + "shape":"TerminateWorkspaceRequests", + "documentation":"The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
" + } + } + }, + "TerminateWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{ + "shape":"FailedTerminateWorkspaceRequests", + "documentation":"Information about the WorkSpaces that could not be terminated.
" + } + } + }, + "TimeoutSettings":{ + "type":"structure", + "members":{ + "DisconnectTimeoutInSeconds":{ + "shape":"DisconnectTimeoutInSeconds", + "documentation":"Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
" + }, + "IdleDisconnectTimeoutInSeconds":{ + "shape":"IdleDisconnectTimeoutInSeconds", + "documentation":"The amount of time in seconds a connection will stay active while idle.
" + }, + "MaxUserDurationInSeconds":{ + "shape":"MaxUserDurationInSeconds", + "documentation":"Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
" + } + }, + "documentation":"Describes the timeout settings for a pool of WorkSpaces.
" + }, + "Timestamp":{"type":"timestamp"}, + "UnsupportedNetworkConfigurationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"The configuration of this network is not supported for this operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP range. For more information, see Configure a VPC for Amazon WorkSpaces.
", + "exception":true + }, + "UnsupportedWorkspaceConfigurationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"The configuration of this WorkSpace is not supported for this operation. For more information, see Required Configuration and Service Components for WorkSpaces .
", + "exception":true + }, + "UpdateConnectClientAddInRequest":{ + "type":"structure", + "required":[ + "AddInId", + "ResourceId" + ], + "members":{ + "AddInId":{ + "shape":"AmazonUuid", + "documentation":"The identifier of the client add-in to update.
" + }, + "ResourceId":{ + "shape":"DirectoryId", + "documentation":"The directory identifier for which the client add-in is configured.
" + }, + "Name":{ + "shape":"AddInName", + "documentation":"The name of the client add-in.
" + }, + "URL":{ + "shape":"AddInUrl", + "documentation":"The endpoint URL of the Amazon Connect client add-in.
" + } + } + }, + "UpdateConnectClientAddInResult":{ + "type":"structure", + "members":{ + } + }, + "UpdateConnectionAliasPermissionRequest":{ + "type":"structure", + "required":[ + "AliasId", + "ConnectionAliasPermission" + ], + "members":{ + "AliasId":{ + "shape":"ConnectionAliasId", + "documentation":"The identifier of the connection alias that you want to update permissions for.
" + }, + "ConnectionAliasPermission":{ + "shape":"ConnectionAliasPermission", + "documentation":"Indicates whether to share or unshare the connection alias with the specified Amazon Web Services account.
" + } + } + }, + "UpdateConnectionAliasPermissionResult":{ + "type":"structure", + "members":{ + } + }, + "UpdateDescription":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9_./() -]+$" + }, + "UpdateResult":{ + "type":"structure", + "members":{ + "UpdateAvailable":{ + "shape":"BooleanObject", + "documentation":"Indicates whether updated drivers or other components are available for the specified WorkSpace image.
" + }, + "Description":{ + "shape":"UpdateDescription", + "documentation":"A description of whether updates for the WorkSpace image are pending or available.
" + } + }, + "documentation":"Describes whether a WorkSpace image needs to be updated with the latest drivers and other components required by Amazon WorkSpaces.
Only Windows 10 WorkSpace images can be programmatically updated at this time.
The identifier of the group.
" + }, + "UserRules":{ + "shape":"IpRuleList", + "documentation":"One or more rules.
" + } + } + }, + "UpdateRulesOfIpGroupResult":{ + "type":"structure", + "members":{ + } + }, + "UpdateWorkspaceBundleRequest":{ + "type":"structure", + "members":{ + "BundleId":{ + "shape":"BundleId", + "documentation":"The identifier of the bundle.
" + }, + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the image.
" + } + } + }, + "UpdateWorkspaceBundleResult":{ + "type":"structure", + "members":{ + } + }, + "UpdateWorkspaceImagePermissionRequest":{ + "type":"structure", + "required":[ + "ImageId", + "AllowCopyImage", + "SharedAccountId" + ], + "members":{ + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the image.
" + }, + "AllowCopyImage":{ + "shape":"BooleanObject", + "documentation":"The permission to copy the image. This permission can be revoked only after an image has been shared.
" + }, + "SharedAccountId":{ + "shape":"AwsAccount", + "documentation":"The identifier of the Amazon Web Services account to share or unshare the image with.
Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.
The identifier of the specified pool to update.
" + }, + "Description":{ + "shape":"UpdateDescription", + "documentation":"Describes the specified pool to update.
" + }, + "BundleId":{ + "shape":"BundleId", + "documentation":"The identifier of the bundle.
" + }, + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the directory.
" + }, + "Capacity":{ + "shape":"Capacity", + "documentation":"The desired capacity for the pool.
" + }, + "ApplicationSettings":{ + "shape":"ApplicationSettingsRequest", + "documentation":"The persistent application settings for users in the pool.
" + }, + "TimeoutSettings":{ + "shape":"TimeoutSettings", + "documentation":"Indicates the timeout settings of the specified pool.
" + } + } + }, + "UpdateWorkspacesPoolResult":{ + "type":"structure", + "members":{ + "WorkspacesPool":{ + "shape":"WorkspacesPool", + "documentation":"Describes the specified pool.
" + } + } + }, + "UserIdentityType":{ + "type":"string", + "enum":[ + "CUSTOMER_MANAGED", + "AWS_DIRECTORY_SERVICE", + "AWS_IAM_IDENTITY_CENTER" + ] + }, + "UserName":{ + "type":"string", + "max":63, + "min":1 + }, + "UserSetting":{ + "type":"structure", + "required":[ + "Action", + "Permission" + ], + "members":{ + "Action":{ + "shape":"UserSettingActionEnum", + "documentation":"Indicates the type of action.
" + }, + "Permission":{ + "shape":"UserSettingPermissionEnum", + "documentation":"Indicates if the setting is enabled or disabled.
" + }, + "MaximumLength":{ + "shape":"MaximumLength", + "documentation":"Indicates the maximum character length for the specified user setting.
" + } + }, + "documentation":"Information about the user's permission settings.
" + }, + "UserSettingActionEnum":{ + "type":"string", + "enum":[ + "CLIPBOARD_COPY_FROM_LOCAL_DEVICE", + "CLIPBOARD_COPY_TO_LOCAL_DEVICE", + "PRINTING_TO_LOCAL_DEVICE", + "SMART_CARD" + ] + }, + "UserSettingPermissionEnum":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "UserSettings":{ + "type":"list", + "member":{"shape":"UserSetting"}, + "min":1 + }, + "UserStorage":{ + "type":"structure", + "required":["Capacity"], + "members":{ + "Capacity":{ + "shape":"NonEmptyString", + "documentation":"The size of the user volume.
" + } + }, + "documentation":"Describes the user volume for a WorkSpace bundle.
" + }, + "UserVolumeSizeGib":{"type":"integer"}, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
The identifier of the application.
" + }, + "Created":{ + "shape":"Timestamp", + "documentation":"The time the application is created.
" + }, + "Description":{ + "shape":"String2048", + "documentation":"The description of the WorkSpace application.
" + }, + "LicenseType":{ + "shape":"WorkSpaceApplicationLicenseType", + "documentation":"The license availability for the applications.
" + }, + "Name":{ + "shape":"NonEmptyString", + "documentation":"The name of the WorkSpace application.
" + }, + "Owner":{ + "shape":"WorkSpaceApplicationOwner", + "documentation":"The owner of the WorkSpace application.
" + }, + "State":{ + "shape":"WorkSpaceApplicationState", + "documentation":"The status of WorkSpace application.
" + }, + "SupportedComputeTypeNames":{ + "shape":"ComputeList", + "documentation":"The supported compute types of the WorkSpace application.
" + }, + "SupportedOperatingSystemNames":{ + "shape":"OperatingSystemNameList", + "documentation":"The supported operating systems of the WorkSpace application.
" + } + }, + "documentation":"Describes the WorkSpace application.
" + }, + "WorkSpaceApplicationDeployment":{ + "type":"structure", + "members":{ + "Associations":{ + "shape":"WorkspaceResourceAssociationList", + "documentation":"The associations between the applications and the associated resources.
" + } + }, + "documentation":"Describes the WorkSpace application deployment.
" + }, + "WorkSpaceApplicationId":{ + "type":"string", + "pattern":"^wsa-[0-9a-z]{8,63}$" + }, + "WorkSpaceApplicationIdList":{ + "type":"list", + "member":{"shape":"WorkSpaceApplicationId"}, + "max":25, + "min":1 + }, + "WorkSpaceApplicationLicenseType":{ + "type":"string", + "enum":[ + "LICENSED", + "UNLICENSED" + ] + }, + "WorkSpaceApplicationList":{ + "type":"list", + "member":{"shape":"WorkSpaceApplication"} + }, + "WorkSpaceApplicationOwner":{ + "type":"string", + "pattern":"^\\d{12}|AMAZON$" + }, + "WorkSpaceApplicationState":{ + "type":"string", + "enum":[ + "PENDING", + "ERROR", + "AVAILABLE", + "UNINSTALL_ONLY" + ] + }, + "WorkSpaceAssociatedResourceType":{ + "type":"string", + "enum":["APPLICATION"] + }, + "WorkSpaceAssociatedResourceTypeList":{ + "type":"list", + "member":{"shape":"WorkSpaceAssociatedResourceType"} + }, + "Workspace":{ + "type":"structure", + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + }, + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the Directory Service directory for the WorkSpace.
" + }, + "UserName":{ + "shape":"UserName", + "documentation":"The user for the WorkSpace.
" + }, + "IpAddress":{ + "shape":"IpAddress", + "documentation":"The IP address of the WorkSpace.
" + }, + "State":{ + "shape":"WorkspaceState", + "documentation":"The operational state of the WorkSpace.
PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).
AVAILABLE – The WorkSpace is running and has passed the health checks.
IMPAIRED – Refer to UNHEALTHY state.
UNHEALTHY – The WorkSpace is not responding to health checks.
REBOOTING – The WorkSpace is being rebooted (restarted).
STARTING – The WorkSpace is starting up and health checks are being run.
REBUILDING – The WorkSpace is being rebuilt.
RESTORING – The WorkSpace is being restored.
MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.
ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.
TERMINATING – The WorkSpace is being deleted.
TERMINATED – The WorkSpace has been deleted.
SUSPENDED – The WorkSpace has been suspended for image creation.
UPDATING – The WorkSpace is undergoing an update.
STOPPING – The WorkSpace is being stopped.
STOPPED – The WorkSpace has been stopped.
ERROR – The WorkSpace is an error state (for example, an error occurred during startup).
After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
The identifier of the bundle used to create the WorkSpace.
" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"The identifier of the subnet for the WorkSpace.
" + }, + "ErrorMessage":{ + "shape":"Description", + "documentation":"The text of the error message that is returned if the WorkSpace cannot be created.
" + }, + "ErrorCode":{ + "shape":"WorkspaceErrorCode", + "documentation":"The error code that is returned if the WorkSpace cannot be created.
" + }, + "ComputerName":{ + "shape":"ComputerName", + "documentation":"The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
" + }, + "VolumeEncryptionKey":{ + "shape":"VolumeEncryptionKey", + "documentation":"The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
" + }, + "UserVolumeEncryptionEnabled":{ + "shape":"BooleanObject", + "documentation":"Indicates whether the data stored on the user volume is encrypted.
" + }, + "RootVolumeEncryptionEnabled":{ + "shape":"BooleanObject", + "documentation":"Indicates whether the data stored on the root volume is encrypted.
" + }, + "WorkspaceName":{ + "shape":"WorkspaceName", + "documentation":"The name of the user-decoupled WorkSpace.
" + }, + "WorkspaceProperties":{ + "shape":"WorkspaceProperties", + "documentation":"The properties of the WorkSpace.
" + }, + "ModificationStates":{ + "shape":"ModificationStateList", + "documentation":"The modification states of the WorkSpace.
" + }, + "RelatedWorkspaces":{ + "shape":"RelatedWorkspaces", + "documentation":"The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
" + }, + "DataReplicationSettings":{ + "shape":"DataReplicationSettings", + "documentation":"Indicates the settings of the data replication.
" + }, + "StandbyWorkspacesProperties":{ + "shape":"StandbyWorkspacesPropertiesList", + "documentation":"The properties of the standby WorkSpace
" + } + }, + "documentation":"Describes a WorkSpace.
" + }, + "WorkspaceAccessProperties":{ + "type":"structure", + "members":{ + "DeviceTypeWindows":{ + "shape":"AccessPropertyValue", + "documentation":"Indicates whether users can use Windows clients to access their WorkSpaces.
" + }, + "DeviceTypeOsx":{ + "shape":"AccessPropertyValue", + "documentation":"Indicates whether users can use macOS clients to access their WorkSpaces.
" + }, + "DeviceTypeWeb":{ + "shape":"AccessPropertyValue", + "documentation":"Indicates whether users can access their WorkSpaces through a web browser.
" + }, + "DeviceTypeIos":{ + "shape":"AccessPropertyValue", + "documentation":"Indicates whether users can use iOS devices to access their WorkSpaces.
" + }, + "DeviceTypeAndroid":{ + "shape":"AccessPropertyValue", + "documentation":"Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.
" + }, + "DeviceTypeChromeOs":{ + "shape":"AccessPropertyValue", + "documentation":"Indicates whether users can use Chromebooks to access their WorkSpaces.
" + }, + "DeviceTypeZeroClient":{ + "shape":"AccessPropertyValue", + "documentation":"Indicates whether users can use zero client devices to access their WorkSpaces.
" + }, + "DeviceTypeLinux":{ + "shape":"AccessPropertyValue", + "documentation":"Indicates whether users can use Linux clients to access their WorkSpaces.
" + } + }, + "documentation":"The device types and operating systems that can be used to access a WorkSpace. For more information, see Amazon WorkSpaces Client Network Requirements.
" + }, + "WorkspaceBundle":{ + "type":"structure", + "members":{ + "BundleId":{ + "shape":"BundleId", + "documentation":"The identifier of the bundle.
" + }, + "Name":{ + "shape":"NonEmptyString", + "documentation":"The name of the bundle.
" + }, + "Owner":{ + "shape":"BundleOwner", + "documentation":"The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by Amazon Web Services.
The description of the bundle.
" + }, + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the image that was used to create the bundle.
" + }, + "RootStorage":{ + "shape":"RootStorage", + "documentation":"The size of the root volume.
" + }, + "UserStorage":{ + "shape":"UserStorage", + "documentation":"The size of the user volume.
" + }, + "ComputeType":{ + "shape":"ComputeType", + "documentation":"The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.
" + }, + "LastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"The last time that the bundle was updated.
" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"The time when the bundle was created.
" + }, + "State":{ + "shape":"WorkspaceBundleState", + "documentation":"The state of the WorkSpace bundle.
" + }, + "BundleType":{ + "shape":"BundleType", + "documentation":"The type of WorkSpace bundle.
" + } + }, + "documentation":"Describes a WorkSpace bundle.
" + }, + "WorkspaceBundleDescription":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9_./() -]+$" + }, + "WorkspaceBundleName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9_./()\\\\-]+$" + }, + "WorkspaceBundleState":{ + "type":"string", + "enum":[ + "AVAILABLE", + "PENDING", + "ERROR" + ] + }, + "WorkspaceConnectionStatus":{ + "type":"structure", + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + }, + "ConnectionState":{ + "shape":"ConnectionState", + "documentation":"The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.
" + }, + "ConnectionStateCheckTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of the connection status check.
" + }, + "LastKnownUserConnectionTimestamp":{ + "shape":"Timestamp", + "documentation":"The timestamp of the last known user connection.
" + } + }, + "documentation":"Describes the connection status of a WorkSpace.
" + }, + "WorkspaceConnectionStatusList":{ + "type":"list", + "member":{"shape":"WorkspaceConnectionStatus"} + }, + "WorkspaceCreationProperties":{ + "type":"structure", + "members":{ + "EnableWorkDocs":{ + "shape":"BooleanObject", + "documentation":"Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.
If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
Indicates whether internet access is enabled for your WorkSpaces.
" + }, + "DefaultOu":{ + "shape":"DefaultOu", + "documentation":"The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form \"OU=value,DC=value,DC=value\", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.
To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.
The API doesn't validate whether the OU exists.
The identifier of your custom security group.
" + }, + "UserEnabledAsLocalAdministrator":{ + "shape":"BooleanObject", + "documentation":"Indicates whether users are local administrators of their WorkSpaces.
" + }, + "EnableMaintenanceMode":{ + "shape":"BooleanObject", + "documentation":"Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
" + }, + "InstanceIamRoleArn":{ + "shape":"ARN", + "documentation":"Indicates the IAM role ARN of the instance.
" + } + }, + "documentation":"Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.
" + }, + "WorkspaceDirectory":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"The directory identifier.
" + }, + "Alias":{ + "shape":"Alias", + "documentation":"The directory alias.
" + }, + "DirectoryName":{ + "shape":"DirectoryName", + "documentation":"The name of the directory.
" + }, + "RegistrationCode":{ + "shape":"RegistrationCode", + "documentation":"The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
" + }, + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"The identifiers of the subnets used with the directory.
" + }, + "DnsIpAddresses":{ + "shape":"DnsIpAddresses", + "documentation":"The IP addresses of the DNS servers for the directory.
" + }, + "CustomerUserName":{ + "shape":"UserName", + "documentation":"The user name for the service account.
" + }, + "IamRoleId":{ + "shape":"ARN", + "documentation":"The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
" + }, + "DirectoryType":{ + "shape":"WorkspaceDirectoryType", + "documentation":"The directory type.
" + }, + "WorkspaceSecurityGroupId":{ + "shape":"SecurityGroupId", + "documentation":"The identifier of the security group that is assigned to new WorkSpaces.
" + }, + "State":{ + "shape":"WorkspaceDirectoryState", + "documentation":"The state of the directory's registration with Amazon WorkSpaces. After a directory is deregistered, the DEREGISTERED state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been successfully deregistered.
The default creation properties for all WorkSpaces in the directory.
" + }, + "ipGroupIds":{ + "shape":"IpGroupIdList", + "documentation":"The identifiers of the IP access control groups associated with the directory.
" + }, + "WorkspaceAccessProperties":{ + "shape":"WorkspaceAccessProperties", + "documentation":"The devices and operating systems that users can use to access WorkSpaces.
" + }, + "Tenancy":{ + "shape":"Tenancy", + "documentation":"Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
The default self-service permissions for WorkSpaces in the directory.
" + }, + "SamlProperties":{ + "shape":"SamlProperties", + "documentation":"Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
" + }, + "CertificateBasedAuthProperties":{ + "shape":"CertificateBasedAuthProperties", + "documentation":"The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
" + }, + "MicrosoftEntraConfig":{ + "shape":"MicrosoftEntraConfig", + "documentation":"Specifies details about Microsoft Entra configurations.
" + }, + "WorkspaceDirectoryName":{ + "shape":"WorkspaceDirectoryName", + "documentation":"The name fo the WorkSpace directory.
" + }, + "WorkspaceDirectoryDescription":{ + "shape":"WorkspaceDirectoryDescription", + "documentation":"The description of the WorkSpace directory
" + }, + "UserIdentityType":{ + "shape":"UserIdentityType", + "documentation":"Indicates the identity type of the specifired user.
" + }, + "WorkspaceType":{ + "shape":"WorkspaceType", + "documentation":"Indicates whether the directory's WorkSpace type is personal or pools.
" + }, + "IDCConfig":{ + "shape":"IDCConfig", + "documentation":"Specifies details about identity center configurations.
" + }, + "ActiveDirectoryConfig":{ + "shape":"ActiveDirectoryConfig", + "documentation":"Information about the Active Directory config.
" + }, + "StreamingProperties":{ + "shape":"StreamingProperties", + "documentation":"The streaming properties to configure.
" + }, + "ErrorMessage":{ + "shape":"Description", + "documentation":"The error message returned.
" + } + }, + "documentation":"Describes a directory that is used with Amazon WorkSpaces.
" + }, + "WorkspaceDirectoryDescription":{ + "type":"string", + "pattern":"^([a-zA-Z0-9_])[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]{1,255}$" + }, + "WorkspaceDirectoryName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_.\\s-]{1,64}$" + }, + "WorkspaceDirectoryNameList":{ + "type":"list", + "member":{"shape":"WorkspaceDirectoryName"}, + "max":25, + "min":1 + }, + "WorkspaceDirectoryState":{ + "type":"string", + "enum":[ + "REGISTERING", + "REGISTERED", + "DEREGISTERING", + "DEREGISTERED", + "ERROR" + ] + }, + "WorkspaceDirectoryType":{ + "type":"string", + "enum":[ + "SIMPLE_AD", + "AD_CONNECTOR", + "CUSTOMER_MANAGED", + "AWS_IAM_IDENTITY_CENTER" + ] + }, + "WorkspaceErrorCode":{"type":"string"}, + "WorkspaceId":{ + "type":"string", + "pattern":"^ws-[0-9a-z]{8,63}$" + }, + "WorkspaceIdList":{ + "type":"list", + "member":{"shape":"WorkspaceId"}, + "max":25, + "min":1 + }, + "WorkspaceImage":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the image.
" + }, + "Name":{ + "shape":"WorkspaceImageName", + "documentation":"The name of the image.
" + }, + "Description":{ + "shape":"WorkspaceImageDescription", + "documentation":"The description of the image.
" + }, + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"The operating system that the image is running.
" + }, + "State":{ + "shape":"WorkspaceImageState", + "documentation":"The status of the image.
" + }, + "RequiredTenancy":{ + "shape":"WorkspaceImageRequiredTenancy", + "documentation":"Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
The error code that is returned for the image.
" + }, + "ErrorMessage":{ + "shape":"Description", + "documentation":"The text of the error message that is returned for the image.
" + }, + "Created":{ + "shape":"Timestamp", + "documentation":"The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.
" + }, + "OwnerAccountId":{ + "shape":"AwsAccount", + "documentation":"The identifier of the Amazon Web Services account that owns the image.
" + }, + "Updates":{ + "shape":"UpdateResult", + "documentation":"The updates (if any) that are available for the specified image.
" + }, + "ErrorDetails":{ + "shape":"ErrorDetailsList", + "documentation":"Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.
" + } + }, + "documentation":"Describes a WorkSpace image.
" + }, + "WorkspaceImageDescription":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z0-9_./() -]+$" + }, + "WorkspaceImageErrorCode":{"type":"string"}, + "WorkspaceImageErrorDetailCode":{ + "type":"string", + "enum":[ + "OutdatedPowershellVersion", + "OfficeInstalled", + "PCoIPAgentInstalled", + "WindowsUpdatesEnabled", + "AutoMountDisabled", + "WorkspacesBYOLAccountNotFound", + "WorkspacesBYOLAccountDisabled", + "DHCPDisabled", + "DiskFreeSpace", + "AdditionalDrivesAttached", + "OSNotSupported", + "DomainJoined", + "AzureDomainJoined", + "FirewallEnabled", + "VMWareToolsInstalled", + "DiskSizeExceeded", + "IncompatiblePartitioning", + "PendingReboot", + "AutoLogonEnabled", + "RealTimeUniversalDisabled", + "MultipleBootPartition", + "Requires64BitOS", + "ZeroRearmCount", + "InPlaceUpgrade", + "AntiVirusInstalled", + "UEFINotSupported", + "UnknownError", + "AppXPackagesInstalled", + "ReservedStorageInUse" + ] + }, + "WorkspaceImageId":{ + "type":"string", + "pattern":"wsi-[0-9a-z]{9,63}$" + }, + "WorkspaceImageIdList":{ + "type":"list", + "member":{"shape":"WorkspaceImageId"}, + "max":25, + "min":1 + }, + "WorkspaceImageIngestionProcess":{ + "type":"string", + "enum":[ + "BYOL_REGULAR", + "BYOL_GRAPHICS", + "BYOL_GRAPHICSPRO", + "BYOL_GRAPHICS_G4DN", + "BYOL_REGULAR_WSP", + "BYOL_GRAPHICS_G4DN_WSP", + "BYOL_REGULAR_BYOP", + "BYOL_GRAPHICS_G4DN_BYOP" + ] + }, + "WorkspaceImageList":{ + "type":"list", + "member":{"shape":"WorkspaceImage"} + }, + "WorkspaceImageName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9_./()\\\\-]+$" + }, + "WorkspaceImageRequiredTenancy":{ + "type":"string", + "enum":[ + "DEFAULT", + "DEDICATED" + ] + }, + "WorkspaceImageState":{ + "type":"string", + "enum":[ + "AVAILABLE", + "PENDING", + "ERROR" + ] + }, + "WorkspaceList":{ + "type":"list", + "member":{"shape":"Workspace"} + }, + "WorkspaceName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_()][a-zA-Z0-9_.()-]{1,63}$" + }, + "WorkspaceProperties":{ + "type":"structure", + "members":{ + "RunningMode":{ + "shape":"RunningMode", + "documentation":"The running mode. For more information, see Manage the WorkSpace Running Mode.
The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
" + }, + "RunningModeAutoStopTimeoutInMinutes":{ + "shape":"RunningModeAutoStopTimeoutInMinutes", + "documentation":"The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
" + }, + "RootVolumeSizeGib":{ + "shape":"RootVolumeSizeGib", + "documentation":"The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
" + }, + "UserVolumeSizeGib":{ + "shape":"UserVolumeSizeGib", + "documentation":"The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
" + }, + "ComputeTypeName":{ + "shape":"Compute", + "documentation":"The compute type. For more information, see Amazon WorkSpaces Bundles.
" + }, + "Protocols":{ + "shape":"ProtocolList", + "documentation":"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 WSP.
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
The name of the operating system.
" + } + }, + "documentation":"Describes a WorkSpace.
" + }, + "WorkspaceRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "UserName", + "BundleId" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
" + }, + "UserName":{ + "shape":"UserName", + "documentation":"The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
The reserved keyword, [UNDEFINED], is used when creating user-decoupled WorkSpaces.
The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
" + }, + "VolumeEncryptionKey":{ + "shape":"VolumeEncryptionKey", + "documentation":"The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
" + }, + "UserVolumeEncryptionEnabled":{ + "shape":"BooleanObject", + "documentation":"Indicates whether the data stored on the user volume is encrypted.
" + }, + "RootVolumeEncryptionEnabled":{ + "shape":"BooleanObject", + "documentation":"Indicates whether the data stored on the root volume is encrypted.
" + }, + "WorkspaceProperties":{ + "shape":"WorkspaceProperties", + "documentation":"The WorkSpace properties.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags for the WorkSpace.
" + }, + "WorkspaceName":{ + "shape":"WorkspaceName", + "documentation":"The name of the user-decoupled WorkSpace.
WorkspaceName is required if UserName is [UNDEFINED] for user-decoupled WorkSpaces. WorkspaceName is not applicable if UserName is specified for user-assigned WorkSpaces.
Describes the information used to create a WorkSpace.
" + }, + "WorkspaceRequestList":{ + "type":"list", + "member":{"shape":"WorkspaceRequest"}, + "max":25, + "min":1 + }, + "WorkspaceResourceAssociation":{ + "type":"structure", + "members":{ + "AssociatedResourceId":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the associated resource.
" + }, + "AssociatedResourceType":{ + "shape":"WorkSpaceAssociatedResourceType", + "documentation":"The resource types of the associated resource.
" + }, + "Created":{ + "shape":"Timestamp", + "documentation":"The time the association is created.
" + }, + "LastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"The time the association status was last updated.
" + }, + "State":{ + "shape":"AssociationState", + "documentation":"The status of the WorkSpace resource association.
" + }, + "StateReason":{ + "shape":"AssociationStateReason", + "documentation":"The reason the association deployment failed.
" + }, + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"The identifier of the WorkSpace.
" + } + }, + "documentation":"Describes the association between an application and a WorkSpace resource.
" + }, + "WorkspaceResourceAssociationList":{ + "type":"list", + "member":{"shape":"WorkspaceResourceAssociation"} + }, + "WorkspaceState":{ + "type":"string", + "enum":[ + "PENDING", + "AVAILABLE", + "IMPAIRED", + "UNHEALTHY", + "REBOOTING", + "STARTING", + "REBUILDING", + "RESTORING", + "MAINTENANCE", + "ADMIN_MAINTENANCE", + "TERMINATING", + "TERMINATED", + "SUSPENDED", + "UPDATING", + "STOPPING", + "STOPPED", + "ERROR" + ] + }, + "WorkspaceType":{ + "type":"string", + "enum":[ + "PERSONAL", + "POOLS" + ] + }, + "WorkspacesDefaultRoleNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
", + "exception":true + }, + "WorkspacesIpGroup":{ + "type":"structure", + "members":{ + "groupId":{ + "shape":"IpGroupId", + "documentation":"The identifier of the group.
" + }, + "groupName":{ + "shape":"IpGroupName", + "documentation":"The name of the group.
" + }, + "groupDesc":{ + "shape":"IpGroupDesc", + "documentation":"The description of the group.
" + }, + "userRules":{ + "shape":"IpRuleList", + "documentation":"The rules.
" + } + }, + "documentation":"Describes an IP access control group.
" + }, + "WorkspacesIpGroupsList":{ + "type":"list", + "member":{"shape":"WorkspacesIpGroup"} + }, + "WorkspacesPool":{ + "type":"structure", + "required":[ + "PoolId", + "PoolArn", + "CapacityStatus", + "PoolName", + "State", + "CreatedAt", + "BundleId", + "DirectoryId" + ], + "members":{ + "PoolId":{ + "shape":"WorkspacesPoolId", + "documentation":"The identifier of a pool.
" + }, + "PoolArn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) for the pool.
" + }, + "CapacityStatus":{ + "shape":"CapacityStatus", + "documentation":"The capacity status for the pool
" + }, + "PoolName":{ + "shape":"WorkspacesPoolName", + "documentation":"The name of the pool,
" + }, + "Description":{ + "shape":"UpdateDescription", + "documentation":"The description of the pool.
" + }, + "State":{ + "shape":"WorkspacesPoolState", + "documentation":"The current state of the pool.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The time the pool was created.
" + }, + "BundleId":{ + "shape":"BundleId", + "documentation":"The identifier of the bundle used by the pool.
" + }, + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"The identifier of the directory used by the pool.
" + }, + "Errors":{ + "shape":"WorkspacesPoolErrors", + "documentation":"The pool errors.
" + }, + "ApplicationSettings":{ + "shape":"ApplicationSettingsResponse", + "documentation":"The persistent application settings for users of the pool.
" + }, + "TimeoutSettings":{ + "shape":"TimeoutSettings", + "documentation":"The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.
" + } + }, + "documentation":"Describes a pool of WorkSpaces.
" + }, + "WorkspacesPoolError":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"WorkspacesPoolErrorCode", + "documentation":"The error code.
" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"The error message.
" + } + }, + "documentation":"Describes a pool error.
" + }, + "WorkspacesPoolErrorCode":{ + "type":"string", + "enum":[ + "IAM_SERVICE_ROLE_IS_MISSING", + "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", + "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION", + "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION", + "NETWORK_INTERFACE_LIMIT_EXCEEDED", + "INTERNAL_SERVICE_ERROR", + "MACHINE_ROLE_IS_MISSING", + "STS_DISABLED_IN_REGION", + "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES", + "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION", + "SUBNET_NOT_FOUND", + "IMAGE_NOT_FOUND", + "INVALID_SUBNET_CONFIGURATION", + "SECURITY_GROUPS_NOT_FOUND", + "IGW_NOT_ATTACHED", + "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION", + "WORKSPACES_POOL_STOPPED", + "WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE", + "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND", + "DOMAIN_JOIN_ERROR_ACCESS_DENIED", + "DOMAIN_JOIN_ERROR_LOGON_FAILURE", + "DOMAIN_JOIN_ERROR_INVALID_PARAMETER", + "DOMAIN_JOIN_ERROR_MORE_DATA", + "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN", + "DOMAIN_JOIN_ERROR_NOT_SUPPORTED", + "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME", + "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED", + "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED", + "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED", + "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR", + "DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING", + "DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE", + "DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID", + "DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND", + "DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND", + "DOMAIN_JOIN_ERROR_SECRET_INVALID", + "BUNDLE_NOT_FOUND", + "DIRECTORY_NOT_FOUND", + "INSUFFICIENT_PERMISSIONS_ERROR", + "DEFAULT_OU_IS_MISSING" + ] + }, + "WorkspacesPoolErrors":{ + "type":"list", + "member":{"shape":"WorkspacesPoolError"} + }, + "WorkspacesPoolId":{ + "type":"string", + "pattern":"^wspool-[0-9a-z]{9}$" + }, + "WorkspacesPoolIds":{ + "type":"list", + "member":{"shape":"WorkspacesPoolId"}, + "max":25, + "min":1 + }, + "WorkspacesPoolName":{ + "type":"string", + "pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$" + }, + "WorkspacesPoolSession":{ + "type":"structure", + "required":[ + "SessionId", + "PoolId", + "UserId" + ], + "members":{ + "AuthenticationType":{ + "shape":"AuthenticationType", + "documentation":"The authentication method. The user is authenticated using a WorkSpaces Pools URL (API) or SAML 2.0 federation (SAML).
" + }, + "ConnectionState":{ + "shape":"SessionConnectionState", + "documentation":"Specifies whether a user is connected to the pool session.
" + }, + "SessionId":{ + "shape":"AmazonUuid", + "documentation":"The identifier of the session.
" + }, + "InstanceId":{ + "shape":"SessionInstanceId", + "documentation":"The identifier for the instance hosting the session.
" + }, + "PoolId":{ + "shape":"WorkspacesPoolId", + "documentation":"The identifier of the pool.
" + }, + "ExpirationTime":{ + "shape":"Timestamp", + "documentation":"The time that the pool session ended.
" + }, + "NetworkAccessConfiguration":{ + "shape":"NetworkAccessConfiguration", + "documentation":"Describes the network details of the pool.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The time that the pool sission started.
" + }, + "UserId":{ + "shape":"WorkspacesPoolUserId", + "documentation":"The identifier of the user.
" + } + }, + "documentation":"Describes a pool session.
" + }, + "WorkspacesPoolSessions":{ + "type":"list", + "member":{"shape":"WorkspacesPoolSession"} + }, + "WorkspacesPoolState":{ + "type":"string", + "enum":[ + "CREATING", + "DELETING", + "RUNNING", + "STARTING", + "STOPPED", + "STOPPING", + "UPDATING" + ] + }, + "WorkspacesPoolUserId":{ + "type":"string", + "max":128, + "min":2 + }, + "WorkspacesPools":{ + "type":"list", + "member":{"shape":"WorkspacesPool"} + } + }, + "documentation":"Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services General Reference.
You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference.
" +} diff --git a/testbed/boto__botocore/botocore/data/xray/2016-04-12/endpoint-rule-set-1.json b/testbed/boto__botocore/botocore/data/xray/2016-04-12/endpoint-rule-set-1.json new file mode 100644 index 0000000000000000000000000000000000000000..1d5bbea62ccd93c79a0b343d0c6e552149c6b5a8 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/xray/2016-04-12/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://xray-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://xray-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://xray.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://xray.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/testbed/boto__botocore/botocore/data/xray/2016-04-12/examples-1.json b/testbed/boto__botocore/botocore/data/xray/2016-04-12/examples-1.json new file mode 100644 index 0000000000000000000000000000000000000000..0ea7e3b0bbe917eb027880396ac01509becd1fa0 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/xray/2016-04-12/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/testbed/boto__botocore/botocore/data/xray/2016-04-12/paginators-1.json b/testbed/boto__botocore/botocore/data/xray/2016-04-12/paginators-1.json new file mode 100644 index 0000000000000000000000000000000000000000..0f65898f26406133ddc20a8f520dbb5aeee3f724 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/xray/2016-04-12/paginators-1.json @@ -0,0 +1,69 @@ +{ + "pagination": { + "BatchGetTraces": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Traces", + "non_aggregate_keys": [ + "UnprocessedTraceIds" + ] + }, + "GetServiceGraph": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Services", + "non_aggregate_keys": [ + "StartTime", + "EndTime", + "ContainsOldGroupVersions" + ] + }, + "GetTraceGraph": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Services" + }, + "GetTraceSummaries": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "TraceSummaries", + "non_aggregate_keys": [ + "TracesProcessedCount", + "ApproximateTime" + ] + }, + "GetGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Groups" + }, + "GetSamplingRules": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "SamplingRuleRecords" + }, + "GetSamplingStatisticSummaries": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "SamplingStatisticSummaries" + }, + "GetTimeSeriesServiceStatistics": { + "input_token": "NextToken", + "non_aggregate_keys": [ + "ContainsOldGroupVersions" + ], + "output_token": "NextToken", + "result_key": "TimeSeriesServiceStatistics" + }, + "ListResourcePolicies": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "ResourcePolicies" + }, + "ListTagsForResource": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Tags" + } + } +} diff --git a/testbed/boto__botocore/botocore/data/xray/2016-04-12/service-2.json b/testbed/boto__botocore/botocore/data/xray/2016-04-12/service-2.json new file mode 100644 index 0000000000000000000000000000000000000000..3a774146247641779b34c5fce960ee38e3b91450 --- /dev/null +++ b/testbed/boto__botocore/botocore/data/xray/2016-04-12/service-2.json @@ -0,0 +1,3187 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-04-12", + "endpointPrefix":"xray", + "protocol":"rest-json", + "serviceFullName":"AWS X-Ray", + "serviceId":"XRay", + "signatureVersion":"v4", + "uid":"xray-2016-04-12" + }, + "operations":{ + "BatchGetTraces":{ + "name":"BatchGetTraces", + "http":{ + "method":"POST", + "requestUri":"/Traces" + }, + "input":{"shape":"BatchGetTracesRequest"}, + "output":{"shape":"BatchGetTracesResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.
Creates a group resource with a name and a filter expression.
" + }, + "CreateSamplingRule":{ + "name":"CreateSamplingRule", + "http":{ + "method":"POST", + "requestUri":"/CreateSamplingRule" + }, + "input":{"shape":"CreateSamplingRuleRequest"}, + "output":{"shape":"CreateSamplingRuleResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"}, + {"shape":"RuleLimitExceededException"} + ], + "documentation":"Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.
" + }, + "DeleteGroup":{ + "name":"DeleteGroup", + "http":{ + "method":"POST", + "requestUri":"/DeleteGroup" + }, + "input":{"shape":"DeleteGroupRequest"}, + "output":{"shape":"DeleteGroupResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Deletes a group resource.
" + }, + "DeleteResourcePolicy":{ + "name":"DeleteResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/DeleteResourcePolicy" + }, + "input":{"shape":"DeleteResourcePolicyRequest"}, + "output":{"shape":"DeleteResourcePolicyResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidPolicyRevisionIdException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Deletes a resource policy from the target Amazon Web Services account.
" + }, + "DeleteSamplingRule":{ + "name":"DeleteSamplingRule", + "http":{ + "method":"POST", + "requestUri":"/DeleteSamplingRule" + }, + "input":{"shape":"DeleteSamplingRuleRequest"}, + "output":{"shape":"DeleteSamplingRuleResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Deletes a sampling rule.
" + }, + "GetEncryptionConfig":{ + "name":"GetEncryptionConfig", + "http":{ + "method":"POST", + "requestUri":"/EncryptionConfig" + }, + "input":{"shape":"GetEncryptionConfigRequest"}, + "output":{"shape":"GetEncryptionConfigResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Retrieves the current encryption configuration for X-Ray data.
" + }, + "GetGroup":{ + "name":"GetGroup", + "http":{ + "method":"POST", + "requestUri":"/GetGroup" + }, + "input":{"shape":"GetGroupRequest"}, + "output":{"shape":"GetGroupResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Retrieves group resource details.
" + }, + "GetGroups":{ + "name":"GetGroups", + "http":{ + "method":"POST", + "requestUri":"/Groups" + }, + "input":{"shape":"GetGroupsRequest"}, + "output":{"shape":"GetGroupsResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Retrieves all active group details.
" + }, + "GetInsight":{ + "name":"GetInsight", + "http":{ + "method":"POST", + "requestUri":"/Insight" + }, + "input":{"shape":"GetInsightRequest"}, + "output":{"shape":"GetInsightResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.
" + }, + "GetInsightEvents":{ + "name":"GetInsightEvents", + "http":{ + "method":"POST", + "requestUri":"/InsightEvents" + }, + "input":{"shape":"GetInsightEventsRequest"}, + "output":{"shape":"GetInsightEventsResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.
" + }, + "GetInsightImpactGraph":{ + "name":"GetInsightImpactGraph", + "http":{ + "method":"POST", + "requestUri":"/InsightImpactGraph" + }, + "input":{"shape":"GetInsightImpactGraphRequest"}, + "output":{"shape":"GetInsightImpactGraphResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.
" + }, + "GetInsightSummaries":{ + "name":"GetInsightSummaries", + "http":{ + "method":"POST", + "requestUri":"/InsightSummaries" + }, + "input":{"shape":"GetInsightSummariesRequest"}, + "output":{"shape":"GetInsightSummariesResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Retrieves the summaries of all insights in the specified group matching the provided filter values.
" + }, + "GetSamplingRules":{ + "name":"GetSamplingRules", + "http":{ + "method":"POST", + "requestUri":"/GetSamplingRules" + }, + "input":{"shape":"GetSamplingRulesRequest"}, + "output":{"shape":"GetSamplingRulesResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Retrieves all sampling rules.
" + }, + "GetSamplingStatisticSummaries":{ + "name":"GetSamplingStatisticSummaries", + "http":{ + "method":"POST", + "requestUri":"/SamplingStatisticSummaries" + }, + "input":{"shape":"GetSamplingStatisticSummariesRequest"}, + "output":{"shape":"GetSamplingStatisticSummariesResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Retrieves information about recent sampling results for all sampling rules.
" + }, + "GetSamplingTargets":{ + "name":"GetSamplingTargets", + "http":{ + "method":"POST", + "requestUri":"/SamplingTargets" + }, + "input":{"shape":"GetSamplingTargetsRequest"}, + "output":{"shape":"GetSamplingTargetsResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Requests a sampling quota for rules that the service is using to sample requests.
" + }, + "GetServiceGraph":{ + "name":"GetServiceGraph", + "http":{ + "method":"POST", + "requestUri":"/ServiceGraph" + }, + "input":{"shape":"GetServiceGraphRequest"}, + "output":{"shape":"GetServiceGraphResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.
" + }, + "GetTimeSeriesServiceStatistics":{ + "name":"GetTimeSeriesServiceStatistics", + "http":{ + "method":"POST", + "requestUri":"/TimeSeriesServiceStatistics" + }, + "input":{"shape":"GetTimeSeriesServiceStatisticsRequest"}, + "output":{"shape":"GetTimeSeriesServiceStatisticsResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Get an aggregation of service statistics defined by a specific time range.
" + }, + "GetTraceGraph":{ + "name":"GetTraceGraph", + "http":{ + "method":"POST", + "requestUri":"/TraceGraph" + }, + "input":{"shape":"GetTraceGraphRequest"}, + "output":{"shape":"GetTraceGraphResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Retrieves a service graph for one or more specific trace IDs.
" + }, + "GetTraceSummaries":{ + "name":"GetTraceSummaries", + "http":{ + "method":"POST", + "requestUri":"/TraceSummaries" + }, + "input":{"shape":"GetTraceSummariesRequest"}, + "output":{"shape":"GetTraceSummariesResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces.
A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com:
service(\"api.example.com\")
This filter expression finds traces that have an annotation named account with the value 12345:
annotation.account = \"12345\"
For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the Amazon Web Services X-Ray Developer Guide.
" + }, + "ListResourcePolicies":{ + "name":"ListResourcePolicies", + "http":{ + "method":"POST", + "requestUri":"/ListResourcePolicies" + }, + "input":{"shape":"ListResourcePoliciesRequest"}, + "output":{"shape":"ListResourcePoliciesResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Returns the list of resource policies in the target Amazon Web Services account.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/ListTagsForResource" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
" + }, + "PutEncryptionConfig":{ + "name":"PutEncryptionConfig", + "http":{ + "method":"POST", + "requestUri":"/PutEncryptionConfig" + }, + "input":{"shape":"PutEncryptionConfigRequest"}, + "output":{"shape":"PutEncryptionConfigResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Updates the encryption configuration for X-Ray data.
" + }, + "PutResourcePolicy":{ + "name":"PutResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/PutResourcePolicy" + }, + "input":{"shape":"PutResourcePolicyRequest"}, + "output":{"shape":"PutResourcePolicyResult"}, + "errors":[ + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"LockoutPreventionException"}, + {"shape":"InvalidPolicyRevisionIdException"}, + {"shape":"PolicySizeLimitExceededException"}, + {"shape":"PolicyCountLimitExceededException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.
" + }, + "PutTelemetryRecords":{ + "name":"PutTelemetryRecords", + "http":{ + "method":"POST", + "requestUri":"/TelemetryRecords" + }, + "input":{"shape":"PutTelemetryRecordsRequest"}, + "output":{"shape":"PutTelemetryRecordsResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Used by the Amazon Web Services X-Ray daemon to upload telemetry.
" + }, + "PutTraceSegments":{ + "name":"PutTraceSegments", + "http":{ + "method":"POST", + "requestUri":"/TraceSegments" + }, + "input":{"shape":"PutTraceSegmentsRequest"}, + "output":{"shape":"PutTraceSegmentsResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Uploads segment documents to Amazon Web Services X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.
Segments must include the following fields. For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide.
Required segment document fields
name - The name of the service that handled the request.
id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits.
trace_id - A unique identifier that connects all segments and subsegments originating from a single client request.
start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9.
end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress.
in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in-progress segment when your application receives a request that will take a long time to serve, to trace that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment.
A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes:
Trace ID Format
The version number, for instance, 1.
The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal.
A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.
Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/UntagResource" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).
Updates a group resource.
" + }, + "UpdateSamplingRule":{ + "name":"UpdateSamplingRule", + "http":{ + "method":"POST", + "requestUri":"/UpdateSamplingRule" + }, + "input":{"shape":"UpdateSamplingRuleRequest"}, + "output":{"shape":"UpdateSamplingRuleResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Modifies a sampling rule's configuration.
" + } + }, + "shapes":{ + "Alias":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"The canonical name of the alias.
" + }, + "Names":{ + "shape":"AliasNames", + "documentation":"A list of names for the alias, including the canonical name.
" + }, + "Type":{ + "shape":"String", + "documentation":"The type of the alias.
" + } + }, + "documentation":"An alias for an edge.
" + }, + "AliasList":{ + "type":"list", + "member":{"shape":"Alias"} + }, + "AliasNames":{ + "type":"list", + "member":{"shape":"String"} + }, + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1 + }, + "AnnotationKey":{"type":"string"}, + "AnnotationValue":{ + "type":"structure", + "members":{ + "NumberValue":{ + "shape":"NullableDouble", + "documentation":"Value for a Number annotation.
" + }, + "BooleanValue":{ + "shape":"NullableBoolean", + "documentation":"Value for a Boolean annotation.
" + }, + "StringValue":{ + "shape":"String", + "documentation":"Value for a String annotation.
" + } + }, + "documentation":"Value of a segment annotation. Has one of three value types: Number, Boolean, or String.
" + }, + "Annotations":{ + "type":"map", + "key":{"shape":"AnnotationKey"}, + "value":{"shape":"ValuesWithServiceIds"} + }, + "AnomalousService":{ + "type":"structure", + "members":{ + "ServiceId":{"shape":"ServiceId"} + }, + "documentation":"The service within the service graph that has anomalously high fault rates.
" + }, + "AnomalousServiceList":{ + "type":"list", + "member":{"shape":"AnomalousService"} + }, + "AttributeKey":{ + "type":"string", + "max":32, + "min":1 + }, + "AttributeMap":{ + "type":"map", + "key":{"shape":"AttributeKey"}, + "value":{"shape":"AttributeValue"}, + "max":5 + }, + "AttributeValue":{ + "type":"string", + "max":32, + "min":1 + }, + "AvailabilityZoneDetail":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of a corresponding Availability Zone.
" + } + }, + "documentation":"A list of Availability Zones corresponding to the segments in a trace.
" + }, + "BackendConnectionErrors":{ + "type":"structure", + "members":{ + "TimeoutCount":{ + "shape":"NullableInteger", + "documentation":"" + }, + "ConnectionRefusedCount":{ + "shape":"NullableInteger", + "documentation":"" + }, + "HTTPCode4XXCount":{ + "shape":"NullableInteger", + "documentation":"" + }, + "HTTPCode5XXCount":{ + "shape":"NullableInteger", + "documentation":"" + }, + "UnknownHostCount":{ + "shape":"NullableInteger", + "documentation":"" + }, + "OtherCount":{ + "shape":"NullableInteger", + "documentation":"" + } + }, + "documentation":"" + }, + "BatchGetTracesRequest":{ + "type":"structure", + "required":["TraceIds"], + "members":{ + "TraceIds":{ + "shape":"TraceIdList", + "documentation":"Specify the trace IDs of requests for which to retrieve segments.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Pagination token.
" + } + } + }, + "BatchGetTracesResult":{ + "type":"structure", + "members":{ + "Traces":{ + "shape":"TraceList", + "documentation":"Full traces for the specified requests.
" + }, + "UnprocessedTraceIds":{ + "shape":"UnprocessedTraceIdList", + "documentation":"Trace IDs of requests that haven't been processed.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Pagination token.
" + } + } + }, + "Boolean":{"type":"boolean"}, + "BorrowCount":{ + "type":"integer", + "min":0 + }, + "ClientID":{ + "type":"string", + "max":24, + "min":24 + }, + "CreateGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"The case-sensitive name of the new group. Default is a reserved name and names must be unique.
" + }, + "FilterExpression":{ + "shape":"FilterExpression", + "documentation":"The filter expression defining criteria by which to group traces.
" + }, + "InsightsConfiguration":{ + "shape":"InsightsConfiguration", + "documentation":"The structure containing configurations related to insights.
The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.
The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.
A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
The following restrictions apply to tags:
Maximum number of user-applied tags per resource: 50
Maximum tag key length: 128 Unicode characters
Maximum tag value length: 256 Unicode characters
Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
Tag keys and values are case sensitive.
Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.
The group that was created. Contains the name of the group that was created, the Amazon Resource Name (ARN) of the group that was generated based on the group name, the filter expression, and the insight configuration that was assigned to the group.
" + } + } + }, + "CreateSamplingRuleRequest":{ + "type":"structure", + "required":["SamplingRule"], + "members":{ + "SamplingRule":{ + "shape":"SamplingRule", + "documentation":"The rule definition.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
The following restrictions apply to tags:
Maximum number of user-applied tags per resource: 50
Maximum tag key length: 128 Unicode characters
Maximum tag value length: 256 Unicode characters
Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
Tag keys and values are case sensitive.
Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.
The saved rule definition and metadata.
" + } + } + }, + "DeleteGroupRequest":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"The case-sensitive name of the group.
" + }, + "GroupARN":{ + "shape":"GroupARN", + "documentation":"The ARN of the group that was generated on creation.
" + } + } + }, + "DeleteGroupResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteResourcePolicyRequest":{ + "type":"structure", + "required":["PolicyName"], + "members":{ + "PolicyName":{ + "shape":"PolicyName", + "documentation":"The name of the resource policy to delete.
" + }, + "PolicyRevisionId":{ + "shape":"PolicyRevisionId", + "documentation":"Specifies a specific policy revision to delete. Provide a PolicyRevisionId to ensure an atomic delete operation. If the provided revision id does not match the latest policy revision id, an InvalidPolicyRevisionIdException exception is returned.
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
" + }, + "RuleARN":{ + "shape":"String", + "documentation":"The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
" + } + } + }, + "DeleteSamplingRuleResult":{ + "type":"structure", + "members":{ + "SamplingRuleRecord":{ + "shape":"SamplingRuleRecord", + "documentation":"The deleted rule definition and metadata.
" + } + } + }, + "Double":{"type":"double"}, + "EC2InstanceId":{ + "type":"string", + "max":20 + }, + "Edge":{ + "type":"structure", + "members":{ + "ReferenceId":{ + "shape":"NullableInteger", + "documentation":"Identifier of the edge. Unique within a service map.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start time of the first segment on the edge.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end time of the last segment on the edge.
" + }, + "SummaryStatistics":{ + "shape":"EdgeStatistics", + "documentation":"Response statistics for segments on the edge.
" + }, + "ResponseTimeHistogram":{ + "shape":"Histogram", + "documentation":"A histogram that maps the spread of client response times on an edge. Only populated for synchronous edges.
" + }, + "Aliases":{ + "shape":"AliasList", + "documentation":"Aliases for the edge.
" + }, + "EdgeType":{ + "shape":"String", + "documentation":"Describes an asynchronous connection, with a value of link.
A histogram that maps the spread of event age when received by consumers. Age is calculated each time an event is received. Only populated when EdgeType is link.
Information about a connection between two services. An edge can be a synchronous connection, such as typical call between client and service, or an asynchronous link, such as a Lambda function which retrieves an event from an SNS queue.
" + }, + "EdgeList":{ + "type":"list", + "member":{"shape":"Edge"} + }, + "EdgeStatistics":{ + "type":"structure", + "members":{ + "OkCount":{ + "shape":"NullableLong", + "documentation":"The number of requests that completed with a 2xx Success status code.
" + }, + "ErrorStatistics":{ + "shape":"ErrorStatistics", + "documentation":"Information about requests that failed with a 4xx Client Error status code.
" + }, + "FaultStatistics":{ + "shape":"FaultStatistics", + "documentation":"Information about requests that failed with a 5xx Server Error status code.
" + }, + "TotalCount":{ + "shape":"NullableLong", + "documentation":"The total number of completed requests.
" + }, + "TotalResponseTime":{ + "shape":"NullableDouble", + "documentation":"The aggregate response time of completed requests.
" + } + }, + "documentation":"Response statistics for an edge.
" + }, + "EncryptionConfig":{ + "type":"structure", + "members":{ + "KeyId":{ + "shape":"String", + "documentation":"The ID of the KMS key used for encryption, if applicable.
" + }, + "Status":{ + "shape":"EncryptionStatus", + "documentation":"The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.
The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption.
A configuration document that specifies encryption configuration settings.
" + }, + "EncryptionKeyId":{ + "type":"string", + "max":3000, + "min":1 + }, + "EncryptionStatus":{ + "type":"string", + "enum":[ + "UPDATING", + "ACTIVE" + ] + }, + "EncryptionType":{ + "type":"string", + "enum":[ + "NONE", + "KMS" + ] + }, + "EntitySelectorExpression":{ + "type":"string", + "max":500, + "min":1 + }, + "ErrorMessage":{"type":"string"}, + "ErrorRootCause":{ + "type":"structure", + "members":{ + "Services":{ + "shape":"ErrorRootCauseServices", + "documentation":"A list of services corresponding to an error. A service identifies a segment and it contains a name, account ID, type, and inferred flag.
" + }, + "ClientImpacting":{ + "shape":"NullableBoolean", + "documentation":"A flag that denotes that the root cause impacts the trace client.
" + } + }, + "documentation":"The root cause of a trace summary error.
" + }, + "ErrorRootCauseEntity":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the entity.
" + }, + "Exceptions":{ + "shape":"RootCauseExceptions", + "documentation":"The types and messages of the exceptions.
" + }, + "Remote":{ + "shape":"NullableBoolean", + "documentation":"A flag that denotes a remote subsegment.
" + } + }, + "documentation":"A collection of segments and corresponding subsegments associated to a trace summary error.
" + }, + "ErrorRootCauseEntityPath":{ + "type":"list", + "member":{"shape":"ErrorRootCauseEntity"} + }, + "ErrorRootCauseService":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"The service name.
" + }, + "Names":{ + "shape":"ServiceNames", + "documentation":"A collection of associated service names.
" + }, + "Type":{ + "shape":"String", + "documentation":"The type associated to the service.
" + }, + "AccountId":{ + "shape":"String", + "documentation":"The account ID associated to the service.
" + }, + "EntityPath":{ + "shape":"ErrorRootCauseEntityPath", + "documentation":"The path of root cause entities found on the service.
" + }, + "Inferred":{ + "shape":"NullableBoolean", + "documentation":"A Boolean value indicating if the service is inferred from the trace.
" + } + }, + "documentation":"A collection of fields identifying the services in a trace summary error.
" + }, + "ErrorRootCauseServices":{ + "type":"list", + "member":{"shape":"ErrorRootCauseService"} + }, + "ErrorRootCauses":{ + "type":"list", + "member":{"shape":"ErrorRootCause"} + }, + "ErrorStatistics":{ + "type":"structure", + "members":{ + "ThrottleCount":{ + "shape":"NullableLong", + "documentation":"The number of requests that failed with a 419 throttling status code.
" + }, + "OtherCount":{ + "shape":"NullableLong", + "documentation":"The number of requests that failed with untracked 4xx Client Error status codes.
" + }, + "TotalCount":{ + "shape":"NullableLong", + "documentation":"The total number of requests that failed with a 4xx Client Error status code.
" + } + }, + "documentation":"Information about requests that failed with a 4xx Client Error status code.
" + }, + "EventSummaryText":{"type":"string"}, + "FaultRootCause":{ + "type":"structure", + "members":{ + "Services":{ + "shape":"FaultRootCauseServices", + "documentation":"A list of corresponding services. A service identifies a segment and it contains a name, account ID, type, and inferred flag.
" + }, + "ClientImpacting":{ + "shape":"NullableBoolean", + "documentation":"A flag that denotes that the root cause impacts the trace client.
" + } + }, + "documentation":"The root cause information for a trace summary fault.
" + }, + "FaultRootCauseEntity":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the entity.
" + }, + "Exceptions":{ + "shape":"RootCauseExceptions", + "documentation":"The types and messages of the exceptions.
" + }, + "Remote":{ + "shape":"NullableBoolean", + "documentation":"A flag that denotes a remote subsegment.
" + } + }, + "documentation":"A collection of segments and corresponding subsegments associated to a trace summary fault error.
" + }, + "FaultRootCauseEntityPath":{ + "type":"list", + "member":{"shape":"FaultRootCauseEntity"} + }, + "FaultRootCauseService":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"The service name.
" + }, + "Names":{ + "shape":"ServiceNames", + "documentation":"A collection of associated service names.
" + }, + "Type":{ + "shape":"String", + "documentation":"The type associated to the service.
" + }, + "AccountId":{ + "shape":"String", + "documentation":"The account ID associated to the service.
" + }, + "EntityPath":{ + "shape":"FaultRootCauseEntityPath", + "documentation":"The path of root cause entities found on the service.
" + }, + "Inferred":{ + "shape":"NullableBoolean", + "documentation":"A Boolean value indicating if the service is inferred from the trace.
" + } + }, + "documentation":"A collection of fields identifying the services in a trace summary fault.
" + }, + "FaultRootCauseServices":{ + "type":"list", + "member":{"shape":"FaultRootCauseService"} + }, + "FaultRootCauses":{ + "type":"list", + "member":{"shape":"FaultRootCause"} + }, + "FaultStatistics":{ + "type":"structure", + "members":{ + "OtherCount":{ + "shape":"NullableLong", + "documentation":"The number of requests that failed with untracked 5xx Server Error status codes.
" + }, + "TotalCount":{ + "shape":"NullableLong", + "documentation":"The total number of requests that failed with a 5xx Server Error status code.
" + } + }, + "documentation":"Information about requests that failed with a 5xx Server Error status code.
" + }, + "FilterExpression":{"type":"string"}, + "FixedRate":{ + "type":"double", + "max":1, + "min":0 + }, + "ForecastStatistics":{ + "type":"structure", + "members":{ + "FaultCountHigh":{ + "shape":"NullableLong", + "documentation":"The upper limit of fault counts for a service.
" + }, + "FaultCountLow":{ + "shape":"NullableLong", + "documentation":"The lower limit of fault counts for a service.
" + } + }, + "documentation":"The predicted high and low fault count. This is used to determine if a service has become anomalous and if an insight should be created.
" + }, + "GetEncryptionConfigRequest":{ + "type":"structure", + "members":{ + } + }, + "GetEncryptionConfigResult":{ + "type":"structure", + "members":{ + "EncryptionConfig":{ + "shape":"EncryptionConfig", + "documentation":"The encryption configuration document.
" + } + } + }, + "GetGroupRequest":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"The case-sensitive name of the group.
" + }, + "GroupARN":{ + "shape":"GroupARN", + "documentation":"The ARN of the group that was generated on creation.
" + } + } + }, + "GetGroupResult":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"Group", + "documentation":"The group that was requested. Contains the name of the group, the ARN of the group, the filter expression, and the insight configuration assigned to the group.
" + } + } + }, + "GetGroupsNextToken":{ + "type":"string", + "max":100, + "min":1 + }, + "GetGroupsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"GetGroupsNextToken", + "documentation":"Pagination token.
" + } + } + }, + "GetGroupsResult":{ + "type":"structure", + "members":{ + "Groups":{ + "shape":"GroupSummaryList", + "documentation":"The collection of all active groups.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Pagination token.
" + } + } + }, + "GetInsightEventsMaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "GetInsightEventsRequest":{ + "type":"structure", + "required":["InsightId"], + "members":{ + "InsightId":{ + "shape":"InsightId", + "documentation":"The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
" + }, + "MaxResults":{ + "shape":"GetInsightEventsMaxResults", + "documentation":"Used to retrieve at most the specified value of events.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"Specify the pagination token returned by a previous request to retrieve the next page of events.
" + } + } + }, + "GetInsightEventsResult":{ + "type":"structure", + "members":{ + "InsightEvents":{ + "shape":"InsightEventList", + "documentation":"A detailed description of the event. This includes the time of the event, client and root cause impact statistics, and the top anomalous service at the time of the event.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"Use this token to retrieve the next page of insight events.
" + } + } + }, + "GetInsightImpactGraphRequest":{ + "type":"structure", + "required":[ + "InsightId", + "StartTime", + "EndTime" + ], + "members":{ + "InsightId":{ + "shape":"InsightId", + "documentation":"The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value provided and can't be more than 30 days old.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided. The time range between the start time and end time can't be more than six hours.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"Specify the pagination token returned by a previous request to retrieve the next page of results.
" + } + } + }, + "GetInsightImpactGraphResult":{ + "type":"structure", + "members":{ + "InsightId":{ + "shape":"InsightId", + "documentation":"The insight's unique identifier.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The provided start time.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The provided end time.
" + }, + "ServiceGraphStartTime":{ + "shape":"Timestamp", + "documentation":"The time, in Unix seconds, at which the service graph started.
" + }, + "ServiceGraphEndTime":{ + "shape":"Timestamp", + "documentation":"The time, in Unix seconds, at which the service graph ended.
" + }, + "Services":{ + "shape":"InsightImpactGraphServiceList", + "documentation":"The Amazon Web Services instrumented services related to the insight.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"Pagination token.
" + } + } + }, + "GetInsightRequest":{ + "type":"structure", + "required":["InsightId"], + "members":{ + "InsightId":{ + "shape":"InsightId", + "documentation":"The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
" + } + } + }, + "GetInsightResult":{ + "type":"structure", + "members":{ + "Insight":{ + "shape":"Insight", + "documentation":"The summary information of an insight.
" + } + } + }, + "GetInsightSummariesMaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "GetInsightSummariesRequest":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime" + ], + "members":{ + "States":{ + "shape":"InsightStateList", + "documentation":"The list of insight states.
" + }, + "GroupARN":{ + "shape":"GroupARN", + "documentation":"The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.
" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"The name of the group. Required if the GroupARN isn't provided.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end of the time frame in which the insights ended. The end time can't be more than 30 days old.
" + }, + "MaxResults":{ + "shape":"GetInsightSummariesMaxResults", + "documentation":"The maximum number of results to display.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"Pagination token.
" + } + } + }, + "GetInsightSummariesResult":{ + "type":"structure", + "members":{ + "InsightSummaries":{ + "shape":"InsightSummaryList", + "documentation":"The summary of each insight within the group matching the provided filters. The summary contains the InsightID, start and end time, the root cause service, the root cause and client impact statistics, the top anomalous services, and the status of the insight.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"Pagination token.
" + } + } + }, + "GetSamplingRulesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"Pagination token.
" + } + } + }, + "GetSamplingRulesResult":{ + "type":"structure", + "members":{ + "SamplingRuleRecords":{ + "shape":"SamplingRuleRecordList", + "documentation":"Rule definitions and metadata.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Pagination token.
" + } + } + }, + "GetSamplingStatisticSummariesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"Pagination token.
" + } + } + }, + "GetSamplingStatisticSummariesResult":{ + "type":"structure", + "members":{ + "SamplingStatisticSummaries":{ + "shape":"SamplingStatisticSummaryList", + "documentation":"Information about the number of requests instrumented for each sampling rule.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Pagination token.
" + } + } + }, + "GetSamplingTargetsRequest":{ + "type":"structure", + "required":["SamplingStatisticsDocuments"], + "members":{ + "SamplingStatisticsDocuments":{ + "shape":"SamplingStatisticsDocumentList", + "documentation":"Information about rules that the service is using to sample requests.
" + } + } + }, + "GetSamplingTargetsResult":{ + "type":"structure", + "members":{ + "SamplingTargetDocuments":{ + "shape":"SamplingTargetDocumentList", + "documentation":"Updated rules that the service should use to sample requests.
" + }, + "LastRuleModification":{ + "shape":"Timestamp", + "documentation":"The last time a user changed the sampling rule configuration. If the sampling rule configuration changed since the service last retrieved it, the service should call GetSamplingRules to get the latest version.
" + }, + "UnprocessedStatistics":{ + "shape":"UnprocessedStatisticsList", + "documentation":"Information about SamplingStatisticsDocument that X-Ray could not process.
" + } + } + }, + "GetServiceGraphRequest":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start of the time frame for which to generate a graph.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end of the timeframe for which to generate a graph.
" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"The name of a group based on which you want to generate a graph.
" + }, + "GroupARN":{ + "shape":"GroupARN", + "documentation":"The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Pagination token.
" + } + } + }, + "GetServiceGraphResult":{ + "type":"structure", + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start of the time frame for which the graph was generated.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end of the time frame for which the graph was generated.
" + }, + "Services":{ + "shape":"ServiceList", + "documentation":"The services that have processed a traced request during the specified time frame.
" + }, + "ContainsOldGroupVersions":{ + "shape":"Boolean", + "documentation":"A flag indicating whether the group's filter expression has been consistent, or if the returned service graph may show traces from an older version of the group's filter expression.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Pagination token.
" + } + } + }, + "GetTimeSeriesServiceStatisticsRequest":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start of the time frame for which to aggregate statistics.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end of the time frame for which to aggregate statistics.
" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"The case-sensitive name of the group for which to pull statistics from.
" + }, + "GroupARN":{ + "shape":"GroupARN", + "documentation":"The Amazon Resource Name (ARN) of the group for which to pull statistics from.
" + }, + "EntitySelectorExpression":{ + "shape":"EntitySelectorExpression", + "documentation":"A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.
" + }, + "Period":{ + "shape":"NullableInteger", + "documentation":"Aggregation period in seconds.
" + }, + "ForecastStatistics":{ + "shape":"NullableBoolean", + "documentation":"The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Pagination token.
" + } + } + }, + "GetTimeSeriesServiceStatisticsResult":{ + "type":"structure", + "members":{ + "TimeSeriesServiceStatistics":{ + "shape":"TimeSeriesServiceStatisticsList", + "documentation":"The collection of statistics.
" + }, + "ContainsOldGroupVersions":{ + "shape":"Boolean", + "documentation":"A flag indicating whether or not a group's filter expression has been consistent, or if a returned aggregation might show statistics from an older version of the group's filter expression.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Pagination token.
" + } + } + }, + "GetTraceGraphRequest":{ + "type":"structure", + "required":["TraceIds"], + "members":{ + "TraceIds":{ + "shape":"TraceIdList", + "documentation":"Trace IDs of requests for which to generate a service graph.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Pagination token.
" + } + } + }, + "GetTraceGraphResult":{ + "type":"structure", + "members":{ + "Services":{ + "shape":"ServiceList", + "documentation":"The services that have processed one of the specified requests.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Pagination token.
" + } + } + }, + "GetTraceSummariesRequest":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start of the time frame for which to retrieve traces.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end of the time frame for which to retrieve traces.
" + }, + "TimeRangeType":{ + "shape":"TimeRangeType", + "documentation":"A parameter to indicate whether to query trace summaries by TraceId, Event (trace update time), or Service (segment end time).
" + }, + "Sampling":{ + "shape":"NullableBoolean", + "documentation":"Set to true to get summaries for only a subset of available traces.
A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.
" + }, + "FilterExpression":{ + "shape":"FilterExpression", + "documentation":"Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"Specify the pagination token returned by a previous request to retrieve the next page of results.
" + } + } + }, + "GetTraceSummariesResult":{ + "type":"structure", + "members":{ + "TraceSummaries":{ + "shape":"TraceSummaryList", + "documentation":"Trace IDs and annotations for traces that were found in the specified time frame.
" + }, + "ApproximateTime":{ + "shape":"Timestamp", + "documentation":"The start time of this page of results.
" + }, + "TracesProcessedCount":{ + "shape":"NullableLong", + "documentation":"The total number of traces processed, including traces that did not match the specified filter expression.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most recent results, closest to the end of the time frame.
" + } + } + }, + "Group":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"The unique case-sensitive name of the group.
" + }, + "GroupARN":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the group generated based on the GroupName.
" + }, + "FilterExpression":{ + "shape":"String", + "documentation":"The filter expression defining the parameters to include traces.
" + }, + "InsightsConfiguration":{ + "shape":"InsightsConfiguration", + "documentation":"The structure containing configurations related to insights.
The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
Details and metadata for a group.
" + }, + "GroupARN":{ + "type":"string", + "max":400, + "min":1 + }, + "GroupName":{ + "type":"string", + "max":32, + "min":1 + }, + "GroupSummary":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"The unique case-sensitive name of the group.
" + }, + "GroupARN":{ + "shape":"String", + "documentation":"The ARN of the group generated based on the GroupName.
" + }, + "FilterExpression":{ + "shape":"String", + "documentation":"The filter expression defining the parameters to include traces.
" + }, + "InsightsConfiguration":{ + "shape":"InsightsConfiguration", + "documentation":"The structure containing configurations related to insights.
The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
The NotificationsEnabled boolean can be set to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
Details for a group without metadata.
" + }, + "GroupSummaryList":{ + "type":"list", + "member":{"shape":"GroupSummary"} + }, + "HTTPMethod":{ + "type":"string", + "max":10 + }, + "Histogram":{ + "type":"list", + "member":{"shape":"HistogramEntry"} + }, + "HistogramEntry":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Double", + "documentation":"The value of the entry.
" + }, + "Count":{ + "shape":"Integer", + "documentation":"The prevalence of the entry.
" + } + }, + "documentation":"An entry in a histogram for a statistic. A histogram maps the range of observed values on the X axis, and the prevalence of each value on the Y axis.
" + }, + "Host":{ + "type":"string", + "max":64 + }, + "Hostname":{ + "type":"string", + "max":255 + }, + "Http":{ + "type":"structure", + "members":{ + "HttpURL":{ + "shape":"String", + "documentation":"The request URL.
" + }, + "HttpStatus":{ + "shape":"NullableInteger", + "documentation":"The response status.
" + }, + "HttpMethod":{ + "shape":"String", + "documentation":"The request method.
" + }, + "UserAgent":{ + "shape":"String", + "documentation":"The request's user agent string.
" + }, + "ClientIp":{ + "shape":"String", + "documentation":"The IP address of the requestor.
" + } + }, + "documentation":"Information about an HTTP request.
" + }, + "Insight":{ + "type":"structure", + "members":{ + "InsightId":{ + "shape":"InsightId", + "documentation":"The insights unique identifier.
" + }, + "GroupARN":{ + "shape":"GroupARN", + "documentation":"The Amazon Resource Name (ARN) of the group that the insight belongs to.
" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"The name of the group that the insight belongs to.
" + }, + "RootCauseServiceId":{"shape":"ServiceId"}, + "Categories":{ + "shape":"InsightCategoryList", + "documentation":"The categories that label and describe the type of insight.
" + }, + "State":{ + "shape":"InsightState", + "documentation":"The current state of the insight.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The time, in Unix seconds, at which the insight began.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The time, in Unix seconds, at which the insight ended.
" + }, + "Summary":{ + "shape":"InsightSummaryText", + "documentation":"A brief description of the insight.
" + }, + "ClientRequestImpactStatistics":{ + "shape":"RequestImpactStatistics", + "documentation":"The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.
" + }, + "RootCauseServiceRequestImpactStatistics":{ + "shape":"RequestImpactStatistics", + "documentation":"The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.
" + }, + "TopAnomalousServices":{ + "shape":"AnomalousServiceList", + "documentation":"The service within the insight that is most impacted by the incident.
" + } + }, + "documentation":"When fault rates go outside of the expected range, X-Ray creates an insight. Insights tracks emergent issues within your applications.
" + }, + "InsightCategory":{ + "type":"string", + "enum":["FAULT"] + }, + "InsightCategoryList":{ + "type":"list", + "member":{"shape":"InsightCategory"} + }, + "InsightEvent":{ + "type":"structure", + "members":{ + "Summary":{ + "shape":"EventSummaryText", + "documentation":"A brief description of the event.
" + }, + "EventTime":{ + "shape":"Timestamp", + "documentation":"The time, in Unix seconds, at which the event was recorded.
" + }, + "ClientRequestImpactStatistics":{ + "shape":"RequestImpactStatistics", + "documentation":"The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.
" + }, + "RootCauseServiceRequestImpactStatistics":{ + "shape":"RequestImpactStatistics", + "documentation":"The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.
" + }, + "TopAnomalousServices":{ + "shape":"AnomalousServiceList", + "documentation":"The service during the event that is most impacted by the incident.
" + } + }, + "documentation":"X-Ray reevaluates insights periodically until they are resolved, and records each intermediate state in an event. You can review incident events in the Impact Timeline on the Inspect page in the X-Ray console.
" + }, + "InsightEventList":{ + "type":"list", + "member":{"shape":"InsightEvent"} + }, + "InsightId":{ + "type":"string", + "pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}" + }, + "InsightImpactGraphEdge":{ + "type":"structure", + "members":{ + "ReferenceId":{ + "shape":"NullableInteger", + "documentation":"Identifier of the edge. Unique within a service map.
" + } + }, + "documentation":"The connection between two service in an insight impact graph.
" + }, + "InsightImpactGraphEdgeList":{ + "type":"list", + "member":{"shape":"InsightImpactGraphEdge"} + }, + "InsightImpactGraphService":{ + "type":"structure", + "members":{ + "ReferenceId":{ + "shape":"NullableInteger", + "documentation":"Identifier for the service. Unique within the service map.
" + }, + "Type":{ + "shape":"String", + "documentation":"Identifier for the service. Unique within the service map.
Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.
Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.
remote - A downstream service of indeterminate type.
The canonical name of the service.
" + }, + "Names":{ + "shape":"ServiceNames", + "documentation":"A list of names for the service, including the canonical name.
" + }, + "AccountId":{ + "shape":"String", + "documentation":"Identifier of the Amazon Web Services account in which the service runs.
" + }, + "Edges":{ + "shape":"InsightImpactGraphEdgeList", + "documentation":"Connections to downstream services.
" + } + }, + "documentation":"Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.
" + }, + "InsightImpactGraphServiceList":{ + "type":"list", + "member":{"shape":"InsightImpactGraphService"} + }, + "InsightState":{ + "type":"string", + "enum":[ + "ACTIVE", + "CLOSED" + ] + }, + "InsightStateList":{ + "type":"list", + "member":{"shape":"InsightState"}, + "max":1, + "min":0 + }, + "InsightSummary":{ + "type":"structure", + "members":{ + "InsightId":{ + "shape":"InsightId", + "documentation":"The insights unique identifier.
" + }, + "GroupARN":{ + "shape":"GroupARN", + "documentation":"The Amazon Resource Name (ARN) of the group that the insight belongs to.
" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"The name of the group that the insight belongs to.
" + }, + "RootCauseServiceId":{"shape":"ServiceId"}, + "Categories":{ + "shape":"InsightCategoryList", + "documentation":"Categories The categories that label and describe the type of insight.
" + }, + "State":{ + "shape":"InsightState", + "documentation":"The current state of the insight.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The time, in Unix seconds, at which the insight began.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The time, in Unix seconds, at which the insight ended.
" + }, + "Summary":{ + "shape":"InsightSummaryText", + "documentation":"A brief description of the insight.
" + }, + "ClientRequestImpactStatistics":{ + "shape":"RequestImpactStatistics", + "documentation":"The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.
" + }, + "RootCauseServiceRequestImpactStatistics":{ + "shape":"RequestImpactStatistics", + "documentation":"The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.
" + }, + "TopAnomalousServices":{ + "shape":"AnomalousServiceList", + "documentation":"The service within the insight that is most impacted by the incident.
" + }, + "LastUpdateTime":{ + "shape":"Timestamp", + "documentation":"The time, in Unix seconds, that the insight was last updated.
" + } + }, + "documentation":"Information that describes an insight.
" + }, + "InsightSummaryList":{ + "type":"list", + "member":{"shape":"InsightSummary"} + }, + "InsightSummaryText":{"type":"string"}, + "InsightsConfiguration":{ + "type":"structure", + "members":{ + "InsightsEnabled":{ + "shape":"NullableBoolean", + "documentation":"Set the InsightsEnabled value to true to enable insights or false to disable insights.
" + }, + "NotificationsEnabled":{ + "shape":"NullableBoolean", + "documentation":"Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
" + } + }, + "documentation":"The structure containing configurations related to insights.
" + }, + "InstanceIdDetail":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"String", + "documentation":"The ID of a corresponding EC2 instance.
" + } + }, + "documentation":"A list of EC2 instance IDs corresponding to the segments in a trace.
" + }, + "Integer":{"type":"integer"}, + "InvalidPolicyRevisionIdException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"A policy revision id was provided which does not match the latest policy revision. This exception is also if a policy revision id of 0 is provided via PutResourcePolicy and a policy with the same name already exists.
The request is missing required parameters or has invalid parameters.
", + "exception":true + }, + "ListResourcePoliciesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"ResourcePolicyNextToken", + "documentation":"Not currently supported.
" + } + } + }, + "ListResourcePoliciesResult":{ + "type":"structure", + "members":{ + "ResourcePolicies":{ + "shape":"ResourcePolicyList", + "documentation":"The list of resource policies in the target Amazon Web Services account.
" + }, + "NextToken":{ + "shape":"ResourcePolicyNextToken", + "documentation":"Pagination token. Not currently supported.
" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"A pagination token. If multiple pages of results are returned, use the NextToken value returned with the current page of results as the value of this parameter to get the next page of results.
A list of tags, as key and value pairs, that is associated with the specified X-Ray group or sampling rule.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"A pagination token. If multiple pages of results are returned, use the NextToken value returned with the current page of results to get the next page of results.
The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in the future.
", + "error":{"httpStatusCode":400}, + "exception":true + }, + "MalformedPolicyDocumentException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"Invalid policy document provided in request.
", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NullableBoolean":{"type":"boolean"}, + "NullableDouble":{"type":"double"}, + "NullableInteger":{"type":"integer"}, + "NullableLong":{"type":"long"}, + "PolicyCountLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"Exceeded the maximum number of resource policies for a target Amazon Web Services account.
", + "error":{"httpStatusCode":400}, + "exception":true + }, + "PolicyDocument":{"type":"string"}, + "PolicyName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "PolicyRevisionId":{"type":"string"}, + "PolicySizeLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"Exceeded the maximum size for a resource policy.
", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Priority":{ + "type":"integer", + "max":9999, + "min":1 + }, + "PutEncryptionConfigRequest":{ + "type":"structure", + "required":["Type"], + "members":{ + "KeyId":{ + "shape":"EncryptionKeyId", + "documentation":"An Amazon Web Services KMS key in one of the following formats:
Alias - The name of the key. For example, alias/MyKey.
Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Amazon Web Services X-Ray does not support asymmetric KMS keys.
ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.
Omit this key if you set Type to NONE.
The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.
The new encryption configuration.
" + } + } + }, + "PutResourcePolicyRequest":{ + "type":"structure", + "required":[ + "PolicyName", + "PolicyDocument" + ], + "members":{ + "PolicyName":{ + "shape":"PolicyName", + "documentation":"The name of the resource policy. Must be unique within a specific Amazon Web Services account.
" + }, + "PolicyDocument":{ + "shape":"PolicyDocument", + "documentation":"The resource policy document, which can be up to 5kb in size.
" + }, + "PolicyRevisionId":{ + "shape":"PolicyRevisionId", + "documentation":"Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account.
If the policy revision id does not match the latest revision id, the operation will fail with an InvalidPolicyRevisionIdException exception. You can also provide a PolicyRevisionId of 0. In this case, the operation will fail with an InvalidPolicyRevisionIdException exception if a resource policy with the same name already exists.
A flag to indicate whether to bypass the resource policy lockout safety check.
Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutResourcePolicy request.
The default value is false.
" + } + } + }, + "PutResourcePolicyResult":{ + "type":"structure", + "members":{ + "ResourcePolicy":{ + "shape":"ResourcePolicy", + "documentation":"The resource policy document, as provided in the PutResourcePolicyRequest.
A string containing a JSON document defining one or more segments or subsegments.
" + } + } + }, + "PutTraceSegmentsResult":{ + "type":"structure", + "members":{ + "UnprocessedTraceSegments":{ + "shape":"UnprocessedTraceSegmentList", + "documentation":"Segments that failed processing.
" + } + } + }, + "RequestCount":{ + "type":"integer", + "min":0 + }, + "RequestImpactStatistics":{ + "type":"structure", + "members":{ + "FaultCount":{ + "shape":"NullableLong", + "documentation":"The number of requests that have resulted in a fault,
" + }, + "OkCount":{ + "shape":"NullableLong", + "documentation":"The number of successful requests.
" + }, + "TotalCount":{ + "shape":"NullableLong", + "documentation":"The total number of requests to the service.
" + } + }, + "documentation":"Statistics that describe how the incident has impacted a service.
" + }, + "ReservoirSize":{ + "type":"integer", + "min":0 + }, + "ResourceARN":{ + "type":"string", + "max":500 + }, + "ResourceARNDetail":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"String", + "documentation":"The ARN of a corresponding resource.
" + } + }, + "documentation":"A list of resources ARNs corresponding to the segments in a trace.
" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "ResourceName":{"shape":"AmazonResourceName"} + }, + "documentation":"The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ResourcePolicy":{ + "type":"structure", + "members":{ + "PolicyName":{ + "shape":"PolicyName", + "documentation":"The name of the resource policy. Must be unique within a specific Amazon Web Services account.
" + }, + "PolicyDocument":{ + "shape":"PolicyDocument", + "documentation":"The resource policy document, which can be up to 5kb in size.
" + }, + "PolicyRevisionId":{ + "shape":"PolicyRevisionId", + "documentation":"Returns the current policy revision id for this policy name.
" + }, + "LastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"When the policy was last updated, in Unix time seconds.
" + } + }, + "documentation":"A resource policy grants one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy is associated with a specific Amazon Web Services account.
" + }, + "ResourcePolicyList":{ + "type":"list", + "member":{"shape":"ResourcePolicy"} + }, + "ResourcePolicyNextToken":{ + "type":"string", + "max":100, + "min":1 + }, + "ResponseTimeRootCause":{ + "type":"structure", + "members":{ + "Services":{ + "shape":"ResponseTimeRootCauseServices", + "documentation":"A list of corresponding services. A service identifies a segment and contains a name, account ID, type, and inferred flag.
" + }, + "ClientImpacting":{ + "shape":"NullableBoolean", + "documentation":"A flag that denotes that the root cause impacts the trace client.
" + } + }, + "documentation":"The root cause information for a response time warning.
" + }, + "ResponseTimeRootCauseEntity":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the entity.
" + }, + "Coverage":{ + "shape":"NullableDouble", + "documentation":"The type and messages of the exceptions.
" + }, + "Remote":{ + "shape":"NullableBoolean", + "documentation":"A flag that denotes a remote subsegment.
" + } + }, + "documentation":"A collection of segments and corresponding subsegments associated to a response time warning.
" + }, + "ResponseTimeRootCauseEntityPath":{ + "type":"list", + "member":{"shape":"ResponseTimeRootCauseEntity"} + }, + "ResponseTimeRootCauseService":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"The service name.
" + }, + "Names":{ + "shape":"ServiceNames", + "documentation":"A collection of associated service names.
" + }, + "Type":{ + "shape":"String", + "documentation":"The type associated to the service.
" + }, + "AccountId":{ + "shape":"String", + "documentation":"The account ID associated to the service.
" + }, + "EntityPath":{ + "shape":"ResponseTimeRootCauseEntityPath", + "documentation":"The path of root cause entities found on the service.
" + }, + "Inferred":{ + "shape":"NullableBoolean", + "documentation":"A Boolean value indicating if the service is inferred from the trace.
" + } + }, + "documentation":"A collection of fields identifying the service in a response time warning.
" + }, + "ResponseTimeRootCauseServices":{ + "type":"list", + "member":{"shape":"ResponseTimeRootCauseService"} + }, + "ResponseTimeRootCauses":{ + "type":"list", + "member":{"shape":"ResponseTimeRootCause"} + }, + "RootCauseException":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the exception.
" + }, + "Message":{ + "shape":"String", + "documentation":"The message of the exception.
" + } + }, + "documentation":"The exception associated with a root cause.
" + }, + "RootCauseExceptions":{ + "type":"list", + "member":{"shape":"RootCauseException"} + }, + "RuleLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"You have reached the maximum number of sampling rules.
", + "exception":true + }, + "RuleName":{ + "type":"string", + "max":32, + "min":1 + }, + "SampledCount":{ + "type":"integer", + "min":0 + }, + "SamplingRule":{ + "type":"structure", + "required":[ + "ResourceARN", + "Priority", + "FixedRate", + "ReservoirSize", + "ServiceName", + "ServiceType", + "Host", + "HTTPMethod", + "URLPath", + "Version" + ], + "members":{ + "RuleName":{ + "shape":"RuleName", + "documentation":"The name of the sampling rule. Specify a rule by either name or ARN, but not both.
" + }, + "RuleARN":{ + "shape":"String", + "documentation":"The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
" + }, + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"Matches the ARN of the Amazon Web Services resource on which the service runs.
" + }, + "Priority":{ + "shape":"Priority", + "documentation":"The priority of the sampling rule.
" + }, + "FixedRate":{ + "shape":"FixedRate", + "documentation":"The percentage of matching requests to instrument, after the reservoir is exhausted.
" + }, + "ReservoirSize":{ + "shape":"ReservoirSize", + "documentation":"A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
" + }, + "ServiceName":{ + "shape":"ServiceName", + "documentation":"Matches the name that the service uses to identify itself in segments.
Matches the origin that the service uses to identify its type in segments.
Matches the hostname from a request URL.
" + }, + "HTTPMethod":{ + "shape":"HTTPMethod", + "documentation":"Matches the HTTP method of a request.
" + }, + "URLPath":{ + "shape":"URLPath", + "documentation":"Matches the path from a request URL.
" + }, + "Version":{ + "shape":"Version", + "documentation":"The version of the sampling rule format (1).
Matches attributes derived from the request.
" + } + }, + "documentation":"A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.
" + }, + "SamplingRuleRecord":{ + "type":"structure", + "members":{ + "SamplingRule":{ + "shape":"SamplingRule", + "documentation":"The sampling rule.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"When the rule was created.
" + }, + "ModifiedAt":{ + "shape":"Timestamp", + "documentation":"When the rule was last modified.
" + } + }, + "documentation":"A SamplingRule and its metadata.
" + }, + "SamplingRuleRecordList":{ + "type":"list", + "member":{"shape":"SamplingRuleRecord"} + }, + "SamplingRuleUpdate":{ + "type":"structure", + "members":{ + "RuleName":{ + "shape":"RuleName", + "documentation":"The name of the sampling rule. Specify a rule by either name or ARN, but not both.
" + }, + "RuleARN":{ + "shape":"String", + "documentation":"The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
" + }, + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"Matches the ARN of the Amazon Web Services resource on which the service runs.
" + }, + "Priority":{ + "shape":"NullableInteger", + "documentation":"The priority of the sampling rule.
" + }, + "FixedRate":{ + "shape":"NullableDouble", + "documentation":"The percentage of matching requests to instrument, after the reservoir is exhausted.
" + }, + "ReservoirSize":{ + "shape":"NullableInteger", + "documentation":"A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
" + }, + "Host":{ + "shape":"Host", + "documentation":"Matches the hostname from a request URL.
" + }, + "ServiceName":{ + "shape":"ServiceName", + "documentation":"Matches the name that the service uses to identify itself in segments.
Matches the origin that the service uses to identify its type in segments.
Matches the HTTP method of a request.
" + }, + "URLPath":{ + "shape":"URLPath", + "documentation":"Matches the path from a request URL.
" + }, + "Attributes":{ + "shape":"AttributeMap", + "documentation":"Matches attributes derived from the request.
" + } + }, + "documentation":"A document specifying changes to a sampling rule's configuration.
" + }, + "SamplingStatisticSummary":{ + "type":"structure", + "members":{ + "RuleName":{ + "shape":"String", + "documentation":"The name of the sampling rule.
" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"The start time of the reporting window.
" + }, + "RequestCount":{ + "shape":"Integer", + "documentation":"The number of requests that matched the rule.
" + }, + "BorrowCount":{ + "shape":"Integer", + "documentation":"The number of requests recorded with borrowed reservoir quota.
" + }, + "SampledCount":{ + "shape":"Integer", + "documentation":"The number of requests recorded.
" + } + }, + "documentation":"Aggregated request sampling data for a sampling rule across all services for a 10-second window.
" + }, + "SamplingStatisticSummaryList":{ + "type":"list", + "member":{"shape":"SamplingStatisticSummary"} + }, + "SamplingStatisticsDocument":{ + "type":"structure", + "required":[ + "RuleName", + "ClientID", + "Timestamp", + "RequestCount", + "SampledCount" + ], + "members":{ + "RuleName":{ + "shape":"RuleName", + "documentation":"The name of the sampling rule.
" + }, + "ClientID":{ + "shape":"ClientID", + "documentation":"A unique identifier for the service in hexadecimal.
" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"The current time.
" + }, + "RequestCount":{ + "shape":"RequestCount", + "documentation":"The number of requests that matched the rule.
" + }, + "SampledCount":{ + "shape":"SampledCount", + "documentation":"The number of requests recorded.
" + }, + "BorrowCount":{ + "shape":"BorrowCount", + "documentation":"The number of requests recorded with borrowed reservoir quota.
" + } + }, + "documentation":"Request sampling results for a single rule from a service. Results are for the last 10 seconds unless the service has been assigned a longer reporting interval after a previous call to GetSamplingTargets.
" + }, + "SamplingStatisticsDocumentList":{ + "type":"list", + "member":{"shape":"SamplingStatisticsDocument"}, + "max":25 + }, + "SamplingStrategy":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"SamplingStrategyName", + "documentation":"The name of a sampling rule.
" + }, + "Value":{ + "shape":"NullableDouble", + "documentation":"The value of a sampling rule.
" + } + }, + "documentation":"The name and value of a sampling rule to apply to a trace summary.
" + }, + "SamplingStrategyName":{ + "type":"string", + "enum":[ + "PartialScan", + "FixedRate" + ] + }, + "SamplingTargetDocument":{ + "type":"structure", + "members":{ + "RuleName":{ + "shape":"String", + "documentation":"The name of the sampling rule.
" + }, + "FixedRate":{ + "shape":"Double", + "documentation":"The percentage of matching requests to instrument, after the reservoir is exhausted.
" + }, + "ReservoirQuota":{ + "shape":"NullableInteger", + "documentation":"The number of requests per second that X-Ray allocated for this service.
" + }, + "ReservoirQuotaTTL":{ + "shape":"Timestamp", + "documentation":"When the reservoir quota expires.
" + }, + "Interval":{ + "shape":"NullableInteger", + "documentation":"The number of seconds for the service to wait before getting sampling targets again.
" + } + }, + "documentation":"Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called GetSamplingTargets.
" + }, + "SamplingTargetDocumentList":{ + "type":"list", + "member":{"shape":"SamplingTargetDocument"} + }, + "Segment":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"SegmentId", + "documentation":"The segment's ID.
" + }, + "Document":{ + "shape":"SegmentDocument", + "documentation":"The segment document.
" + } + }, + "documentation":"A segment from a trace that has been ingested by the X-Ray service. The segment can be compiled from documents uploaded with PutTraceSegments, or an inferred segment for a downstream service, generated from a subsegment sent by the service that called it.
For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide.
" + }, + "SegmentDocument":{ + "type":"string", + "min":1 + }, + "SegmentId":{"type":"string"}, + "SegmentList":{ + "type":"list", + "member":{"shape":"Segment"} + }, + "Service":{ + "type":"structure", + "members":{ + "ReferenceId":{ + "shape":"NullableInteger", + "documentation":"Identifier for the service. Unique within the service map.
" + }, + "Name":{ + "shape":"String", + "documentation":"The canonical name of the service.
" + }, + "Names":{ + "shape":"ServiceNames", + "documentation":"A list of names for the service, including the canonical name.
" + }, + "Root":{ + "shape":"NullableBoolean", + "documentation":"Indicates that the service was the first service to process a request.
" + }, + "AccountId":{ + "shape":"String", + "documentation":"Identifier of the Amazon Web Services account in which the service runs.
" + }, + "Type":{ + "shape":"String", + "documentation":"The type of service.
Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.
client - Represents the clients that sent requests to a root service.
remote - A downstream service of indeterminate type.
The service's state.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start time of the first segment that the service generated.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The end time of the last segment that the service generated.
" + }, + "Edges":{ + "shape":"EdgeList", + "documentation":"Connections to downstream services.
" + }, + "SummaryStatistics":{ + "shape":"ServiceStatistics", + "documentation":"Aggregated statistics for the service.
" + }, + "DurationHistogram":{ + "shape":"Histogram", + "documentation":"A histogram that maps the spread of service durations.
" + }, + "ResponseTimeHistogram":{ + "shape":"Histogram", + "documentation":"A histogram that maps the spread of service response times.
" + } + }, + "documentation":"Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.
" + }, + "ServiceId":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"" + }, + "Names":{ + "shape":"ServiceNames", + "documentation":"" + }, + "AccountId":{ + "shape":"String", + "documentation":"" + }, + "Type":{ + "shape":"String", + "documentation":"" + } + }, + "documentation":"" + }, + "ServiceIds":{ + "type":"list", + "member":{"shape":"ServiceId"} + }, + "ServiceList":{ + "type":"list", + "member":{"shape":"Service"} + }, + "ServiceName":{ + "type":"string", + "max":64 + }, + "ServiceNames":{ + "type":"list", + "member":{"shape":"String"} + }, + "ServiceStatistics":{ + "type":"structure", + "members":{ + "OkCount":{ + "shape":"NullableLong", + "documentation":"The number of requests that completed with a 2xx Success status code.
" + }, + "ErrorStatistics":{ + "shape":"ErrorStatistics", + "documentation":"Information about requests that failed with a 4xx Client Error status code.
" + }, + "FaultStatistics":{ + "shape":"FaultStatistics", + "documentation":"Information about requests that failed with a 5xx Server Error status code.
" + }, + "TotalCount":{ + "shape":"NullableLong", + "documentation":"The total number of completed requests.
" + }, + "TotalResponseTime":{ + "shape":"NullableDouble", + "documentation":"The aggregate response time of completed requests.
" + } + }, + "documentation":"Response statistics for a service.
" + }, + "ServiceType":{ + "type":"string", + "max":64 + }, + "String":{"type":"string"}, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
An optional tag value, such as Production or test-only. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
A map that contains tag keys and tag values to attach to an Amazon Web Services X-Ray group or sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
The following restrictions apply to tags:
Maximum number of user-applied tags per resource: 50
Tag keys and values are case sensitive.
Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.
The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
The following restrictions apply to tags:
Maximum number of user-applied tags per resource: 50
Maximum tag key length: 128 Unicode characters
Maximum tag value length: 256 Unicode characters
Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
Tag keys and values are case sensitive.
Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.
The request exceeds the maximum number of requests per second.
", + "error":{"httpStatusCode":429}, + "exception":true + }, + "TimeRangeType":{ + "type":"string", + "enum":[ + "TraceId", + "Event", + "Service" + ] + }, + "TimeSeriesServiceStatistics":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"Timestamp of the window for which statistics are aggregated.
" + }, + "EdgeSummaryStatistics":{"shape":"EdgeStatistics"}, + "ServiceSummaryStatistics":{"shape":"ServiceStatistics"}, + "ServiceForecastStatistics":{ + "shape":"ForecastStatistics", + "documentation":"The forecasted high and low fault count values.
" + }, + "ResponseTimeHistogram":{ + "shape":"Histogram", + "documentation":"The response time histogram for the selected entities.
" + } + }, + "documentation":"A list of TimeSeriesStatistic structures.
" + }, + "TimeSeriesServiceStatisticsList":{ + "type":"list", + "member":{"shape":"TimeSeriesServiceStatistics"} + }, + "Timestamp":{"type":"timestamp"}, + "Token":{ + "type":"string", + "max":2000, + "min":1 + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "ResourceName":{"shape":"AmazonResourceName"} + }, + "documentation":"You have exceeded the maximum number of tags you can apply to this resource.
", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Trace":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"TraceId", + "documentation":"The unique identifier for the request that generated the trace's segments and subsegments.
" + }, + "Duration":{ + "shape":"NullableDouble", + "documentation":"The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
" + }, + "LimitExceeded":{ + "shape":"NullableBoolean", + "documentation":"LimitExceeded is set to true when the trace has exceeded the Trace document size limit. For more information about this limit and other X-Ray limits and quotas, see Amazon Web Services X-Ray endpoints and quotas.
Segment documents for the segments and subsegments that comprise the trace.
" + } + }, + "documentation":"A collection of segment documents with matching trace IDs.
" + }, + "TraceAvailabilityZones":{ + "type":"list", + "member":{"shape":"AvailabilityZoneDetail"} + }, + "TraceId":{ + "type":"string", + "max":35, + "min":1 + }, + "TraceIdList":{ + "type":"list", + "member":{"shape":"TraceId"} + }, + "TraceInstanceIds":{ + "type":"list", + "member":{"shape":"InstanceIdDetail"} + }, + "TraceList":{ + "type":"list", + "member":{"shape":"Trace"} + }, + "TraceResourceARNs":{ + "type":"list", + "member":{"shape":"ResourceARNDetail"} + }, + "TraceSegmentDocument":{"type":"string"}, + "TraceSegmentDocumentList":{ + "type":"list", + "member":{"shape":"TraceSegmentDocument"} + }, + "TraceSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"TraceId", + "documentation":"The unique identifier for the request that generated the trace's segments and subsegments.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The start time of a trace, based on the earliest trace segment start time.
" + }, + "Duration":{ + "shape":"NullableDouble", + "documentation":"The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
" + }, + "ResponseTime":{ + "shape":"NullableDouble", + "documentation":"The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.
" + }, + "HasFault":{ + "shape":"NullableBoolean", + "documentation":"The root segment document has a 500 series error.
" + }, + "HasError":{ + "shape":"NullableBoolean", + "documentation":"The root segment document has a 400 series error.
" + }, + "HasThrottle":{ + "shape":"NullableBoolean", + "documentation":"One or more of the segment documents has a 429 throttling error.
" + }, + "IsPartial":{ + "shape":"NullableBoolean", + "documentation":"One or more of the segment documents is in progress.
" + }, + "Http":{ + "shape":"Http", + "documentation":"Information about the HTTP request served by the trace.
" + }, + "Annotations":{ + "shape":"Annotations", + "documentation":"Annotations from the trace's segment documents.
" + }, + "Users":{ + "shape":"TraceUsers", + "documentation":"Users from the trace's segment documents.
" + }, + "ServiceIds":{ + "shape":"ServiceIds", + "documentation":"Service IDs from the trace's segment documents.
" + }, + "ResourceARNs":{ + "shape":"TraceResourceARNs", + "documentation":"A list of resource ARNs for any resource corresponding to the trace segments.
" + }, + "InstanceIds":{ + "shape":"TraceInstanceIds", + "documentation":"A list of EC2 instance IDs for any instance corresponding to the trace segments.
" + }, + "AvailabilityZones":{ + "shape":"TraceAvailabilityZones", + "documentation":"A list of Availability Zones for any zone corresponding to the trace segments.
" + }, + "EntryPoint":{ + "shape":"ServiceId", + "documentation":"The root of a trace.
" + }, + "FaultRootCauses":{ + "shape":"FaultRootCauses", + "documentation":"A collection of FaultRootCause structures corresponding to the trace segments.
" + }, + "ErrorRootCauses":{ + "shape":"ErrorRootCauses", + "documentation":"A collection of ErrorRootCause structures corresponding to the trace segments.
" + }, + "ResponseTimeRootCauses":{ + "shape":"ResponseTimeRootCauses", + "documentation":"A collection of ResponseTimeRootCause structures corresponding to the trace segments.
" + }, + "Revision":{ + "shape":"Integer", + "documentation":"The revision number of a trace.
" + }, + "MatchedEventTime":{ + "shape":"Timestamp", + "documentation":"The matched time stamp of a defined event.
" + } + }, + "documentation":"Metadata generated from the segment documents in a trace.
" + }, + "TraceSummaryList":{ + "type":"list", + "member":{"shape":"TraceSummary"} + }, + "TraceUser":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"String", + "documentation":"The user's name.
" + }, + "ServiceIds":{ + "shape":"ServiceIds", + "documentation":"Services that the user's request hit.
" + } + }, + "documentation":"Information about a user recorded in segment documents.
" + }, + "TraceUsers":{ + "type":"list", + "member":{"shape":"TraceUser"} + }, + "URLPath":{ + "type":"string", + "max":128 + }, + "UnprocessedStatistics":{ + "type":"structure", + "members":{ + "RuleName":{ + "shape":"String", + "documentation":"The name of the sampling rule.
" + }, + "ErrorCode":{ + "shape":"String", + "documentation":"The error code.
" + }, + "Message":{ + "shape":"String", + "documentation":"The error message.
" + } + }, + "documentation":"Sampling statistics from a call to GetSamplingTargets that X-Ray could not process.
" + }, + "UnprocessedStatisticsList":{ + "type":"list", + "member":{"shape":"UnprocessedStatistics"} + }, + "UnprocessedTraceIdList":{ + "type":"list", + "member":{"shape":"TraceId"} + }, + "UnprocessedTraceSegment":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"String", + "documentation":"The segment's ID.
" + }, + "ErrorCode":{ + "shape":"String", + "documentation":"The error that caused processing to fail.
" + }, + "Message":{ + "shape":"String", + "documentation":"The error message.
" + } + }, + "documentation":"Information about a segment that failed processing.
" + }, + "UnprocessedTraceSegmentList":{ + "type":"list", + "member":{"shape":"UnprocessedTraceSegment"} + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"Keys for one or more tags that you want to remove from an X-Ray group or sampling rule.
" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateGroupRequest":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"The case-sensitive name of the group.
" + }, + "GroupARN":{ + "shape":"GroupARN", + "documentation":"The ARN that was generated upon creation.
" + }, + "FilterExpression":{ + "shape":"FilterExpression", + "documentation":"The updated filter expression defining criteria by which to group traces.
" + }, + "InsightsConfiguration":{ + "shape":"InsightsConfiguration", + "documentation":"The structure containing configurations related to insights.
The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
The NotificationsEnabled boolean can be set to true to enable insights notifications for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.
The group that was updated. Contains the name of the group that was updated, the ARN of the group that was updated, the updated filter expression, and the updated insight configuration assigned to the group.
" + } + } + }, + "UpdateSamplingRuleRequest":{ + "type":"structure", + "required":["SamplingRuleUpdate"], + "members":{ + "SamplingRuleUpdate":{ + "shape":"SamplingRuleUpdate", + "documentation":"The rule and fields to change.
" + } + } + }, + "UpdateSamplingRuleResult":{ + "type":"structure", + "members":{ + "SamplingRuleRecord":{ + "shape":"SamplingRuleRecord", + "documentation":"The updated rule definition and metadata.
" + } + } + }, + "ValueWithServiceIds":{ + "type":"structure", + "members":{ + "AnnotationValue":{ + "shape":"AnnotationValue", + "documentation":"Values of the annotation.
" + }, + "ServiceIds":{ + "shape":"ServiceIds", + "documentation":"Services to which the annotation applies.
" + } + }, + "documentation":"Information about a segment annotation.
" + }, + "ValuesWithServiceIds":{ + "type":"list", + "member":{"shape":"ValueWithServiceIds"} + }, + "Version":{ + "type":"integer", + "min":1 + } + }, + "documentation":"Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
" +} diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_cm_80.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_cm_80.png new file mode 100644 index 0000000000000000000000000000000000000000..83b5aab9a71df6977ab375ae71905a0cd9affee1 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_cm_80.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c918c0de6fc494f786b7344ee3f445261f74433a896d9c736560816a36949787 +size 4059 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_cm_82.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_cm_82.png new file mode 100644 index 0000000000000000000000000000000000000000..e8ee48108bd26daa4ba74fc7568e859a31fb4b7f --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_cm_82.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:056a73a272c489665cc5f643711260d7350487b26ed723b56fcb3cdbf778a6bb +size 1805 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_00.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_00.png new file mode 100644 index 0000000000000000000000000000000000000000..62b05361a499817a93891f51eebdb2fc61d1acc1 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_00.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:359ada7701efb1d54f1b56a8c153bd6431152594c00fb74700e90d74bb36de75 +size 1759 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_01.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_01.png new file mode 100644 index 0000000000000000000000000000000000000000..b7d5dabd518be9a7ca208eb797223311fe2673b6 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_01.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:24299f6e4bcfdb47ffbe6b8678a354cb620dcfd4526e38f0b96075d7d586540c +size 1270 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_02.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_02.png new file mode 100644 index 0000000000000000000000000000000000000000..c3e023e209f7886e6642c225d4090aa8033f22d7 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_02.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:74bc958ffa2a0fb330c4819a49a291cf4008c8dbd347523e64f4805a7d1e6ee4 +size 1858 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_03.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_03.png new file mode 100644 index 0000000000000000000000000000000000000000..d0e5f7f094907fee2e857f8ae664609a9427b728 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_03.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0d3581d8612eadff4b910d0d4f4a0aeb91beb352de28f5d7ff6a41bea5b08574 +size 1326 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_04.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_04.png new file mode 100644 index 0000000000000000000000000000000000000000..6181c0343fa99d8c63fcc4f8b8eef871237dcadf --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_04.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1deaef04a0549c60eb0b43d6671bd6284628a2012dfc5699b4dd15c0769106c9 +size 1118 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_05.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_05.png new file mode 100644 index 0000000000000000000000000000000000000000..7fa3a9e5c47b1ec9b63a6f0d3747a6bc5a7e7b81 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_05.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c345d21bf5a174e77c164e2a93603645bbd765a7790996ddcabcc339bb1cf35c +size 2399 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_06.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_06.png new file mode 100644 index 0000000000000000000000000000000000000000..0b1ae5595892fb757adb1360a2297a7bec24303d --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_06.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9f1ea7606444a35e831e6db9165d432844c201235a6fa96379acb6f2c650a289 +size 2834 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_07.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_07.png new file mode 100644 index 0000000000000000000000000000000000000000..7d5c471e26e30485a885bff7af1230526e40d725 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_07.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a072555a5df7bb2607e4ac9422c25721f02ca278eaa9f762470d4627eca451b1 +size 1690 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_08.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_08.png new file mode 100644 index 0000000000000000000000000000000000000000..b773ac47fa3368c29f17c4752412002a658f33d0 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_08.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ab634da420f95672afbf05c97bd4bed725d275b771909d94869672182a3735ab +size 1650 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_09.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_09.png new file mode 100644 index 0000000000000000000000000000000000000000..7ec56700a643fad5c9dfd4446efa6a5d55299357 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_09.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b96fb06e246d3ede4a6b8da85b723e539cd0ed9e9c05a168961ab8628d1ac713 +size 1277 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_10.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_10.png new file mode 100644 index 0000000000000000000000000000000000000000..60d14f5235cf142fd7ff12b80b93979f72f82b9a --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_10.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:752db59f262eb306196c8b576425577ddc752ae55d5305ccb237caafc41ffbff +size 2476 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_11.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_11.png new file mode 100644 index 0000000000000000000000000000000000000000..0e7159e9c2314e317bb8031d0ef66deeff895f4b --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_11.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:733f86a6177b8298a523237e66bf37fee41c0bc354c157aeeb27eb8acd10e7d6 +size 2110 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_12.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_12.png new file mode 100644 index 0000000000000000000000000000000000000000..bc830090814b0db3f80455135c88793e6c2d4ffb --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_12.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:594e3e4da7f376c0a01d319d3806a9bd51ced197e7b3ddcc30d948ca1e6e1d54 +size 1238 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_13.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_13.png new file mode 100644 index 0000000000000000000000000000000000000000..7d2531396cc0a4e7d16154e3fe018d3c73695006 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_13.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e6248b9d4f714416d9665d99014be17f3d99a58de35dc77760d67c239fcee07 +size 1753 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_14.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_14.png new file mode 100644 index 0000000000000000000000000000000000000000..f5e1771e31bc2a0974b0a0272ada59375ab0522f --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_14.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ea2e5abb7606fdb4800a01bd03bd4df930ba7955279c8c49199d57509005c857 +size 981 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_15.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_15.png new file mode 100644 index 0000000000000000000000000000000000000000..5582113cbf8eb8042b5c32615d9bd6b7c70cfe8a --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_15.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e8684eef3d08739633c9c2d9048b9e343567ed4093cf77cb792ceac40640583 +size 982 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_16.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_16.png new file mode 100644 index 0000000000000000000000000000000000000000..072d3942bf5ae8904f576caee3f6eb74f8bd04f2 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_16.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ab7ece1acde5999420df5a59d331304c3713e121b3f9ae0e37647fb20fb2f641 +size 1198 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_17.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_17.png new file mode 100644 index 0000000000000000000000000000000000000000..072d3942bf5ae8904f576caee3f6eb74f8bd04f2 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_17.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ab7ece1acde5999420df5a59d331304c3713e121b3f9ae0e37647fb20fb2f641 +size 1198 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_19.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_19.png new file mode 100644 index 0000000000000000000000000000000000000000..e744b64c5587032df83a5b89e3a895a054f8c3e9 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_19.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b813f914e3f9329422540f511d46ee358e3c5b8e6a0b919aa62a031214b826a4 +size 1958 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_20.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_20.png new file mode 100644 index 0000000000000000000000000000000000000000..abf2489fb8470f77a3fa8c294a3f8a5a3e49db61 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_20.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c61547db1d691d346c1eaf4e5f15ac5dabfef0bca11a433185801f5d4e51476d +size 4473 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_21.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_21.png new file mode 100644 index 0000000000000000000000000000000000000000..a5ac87829c25ef383a458617088b0f7c441e69a7 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_21.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:239f97884ec1238a5a4fb497196bd551c17d42871b2e3ce83b3516785b68d92f +size 4762 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_23.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_23.png new file mode 100644 index 0000000000000000000000000000000000000000..068c25a962a1d0c20705a1c078e33cb3f8c574e4 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_23.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:167428025ae246a0af13655fba442afc0cea2cdbf6f616b08bd097f11e4a5ea0 +size 3122 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_24.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_24.png new file mode 100644 index 0000000000000000000000000000000000000000..48b5a1be269996ffa3b2edd40dd2ab460dc0944d --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_24.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7255946db929e4965d1a0954e4849490428fcef187bda73770ce66bfc4e57a60 +size 1065 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_25.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_25.png new file mode 100644 index 0000000000000000000000000000000000000000..eed48e2b2b530de66ed28d798d045429391ecb96 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_25.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:da457b4ff0f5f0940994e07276ed99ebc59e65c7ca69863227be93e1e3d8b53d +size 1290 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_26.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_26.png new file mode 100644 index 0000000000000000000000000000000000000000..9bd16103b6798a7e1a59be2003531630e91a4112 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_26.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3c9057a1c4cfe059fed172455bea62638dd8173c6cb905df16a67b7ff0f5aa60 +size 2716 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_27.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_27.png new file mode 100644 index 0000000000000000000000000000000000000000..5e3602687d034a226850b1c5534e2cce92e0fc03 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_27.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:51b12bbedd861fe94851b58d439d9ea38b2e7655529d3b1415c6a3cc962ffb40 +size 2464 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_28.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_28.png new file mode 100644 index 0000000000000000000000000000000000000000..2de566a973c86a6507c5ad4eed68df17581ec7ab --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_28.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1761453742bf282f47783ed5f9573dfe9e70c067a2b7586053562c917836b7b0 +size 2109 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_29.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_29.png new file mode 100644 index 0000000000000000000000000000000000000000..cdd73131412ea9a534e43b0afc5e4eaab5bbaf2d --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_29.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c3e3e4d51ddd16a5cfffb2e157f28daef95d8662efa7e8eec0ab4e6490785ded +size 2064 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_31.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_31.png new file mode 100644 index 0000000000000000000000000000000000000000..e1ad8176bc23cc4eae20770105499bbd0a3bc22e --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_31.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b30a801be0e4f7fb85d952ecb460a32240fa664cd4b7819efae4a455eb5e897b +size 2183 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_32.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_32.png new file mode 100644 index 0000000000000000000000000000000000000000..2036ac09d4fd57493a117e09e14803b21aa98ea7 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_32.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:452f8695e6171ba70cffd8c9e422c60b583f416ba23acec89db9d0d0044ebb98 +size 1291 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_33.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_33.png new file mode 100644 index 0000000000000000000000000000000000000000..da335717b67dda526420a4d59768df67603fceea --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_33.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:45e6618480d551fdbf46ea43cfcb1c6bb74c33d5f1a6a2d89be5bb421b8b7fcc +size 2110 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_35.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_35.png new file mode 100644 index 0000000000000000000000000000000000000000..efc73438e69589ad7ec4f4ce0749c3f22e9d58c7 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_35.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cc82a545f7e139b091b62d9fbca0a84c2896d4fe7d5fbefdb665fc4946f3bc18 +size 1614 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_36.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_36.png new file mode 100644 index 0000000000000000000000000000000000000000..664746fa31737ec8aafdaa71bc062e0856007f93 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_36.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b12fdb5821b51da493bf78a087b526211cecdce05b3188745b638b0dc49784a7 +size 987 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_37.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_37.png new file mode 100644 index 0000000000000000000000000000000000000000..8c3f969b475e1ab931edfcb257690c8f0af845e7 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_37.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3fcd23f4c7ebb6f7fbddb53eaea7502e30bdc0ca85d4ec84bfcfd899a9de2294 +size 7615 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_38.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_38.png new file mode 100644 index 0000000000000000000000000000000000000000..0035dee2cea3309ab3ff659e3619c8b2256b68d8 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_38.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b0dc38773b38f2c39bafa4f92c965456967477eefd2568b819351953e0b3fa0 +size 3547 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_39.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_39.png new file mode 100644 index 0000000000000000000000000000000000000000..da9fd1a78519285d4bc2b46f20caae9ba7a974b1 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_39.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3193e558e75523aaf7760febce0419d11b5b376c3796b076c191911a3f4f49b8 +size 2653 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_40.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_40.png new file mode 100644 index 0000000000000000000000000000000000000000..2bc6a9fed9366800f990f9a2fd5ddfd8566cf40e --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_40.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:299ae7c100bcc9b525799f4ed8ac49ede534d5a274b8c1b2c9b6f88fb3860f03 +size 3090 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_41.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_41.png new file mode 100644 index 0000000000000000000000000000000000000000..7fba0e133b9ecf25421e7faf6c8c6551f2ad35e8 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_41.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee70ad724b06f0f64ef5a4f14fd96bc340bbbe1f46a6825931d0c787275b7be5 +size 6324 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_42.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_42.png new file mode 100644 index 0000000000000000000000000000000000000000..7de046c44b53258819855dbc6f5525790fdfc926 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_42.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ac0d7efebfc545b473b8d73ce0b5dc91e43ff1a366ea5996e6934ecfa8fee924 +size 1315 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_43.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_43.png new file mode 100644 index 0000000000000000000000000000000000000000..872fa2e4e45b8d7161479b5c230610887e018652 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_43.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4b6f9c65e7423cd4bbfa1fcde1d07d358d3f717d52e9d7e8a58aa62cca77fdb2 +size 1096 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_44.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_44.png new file mode 100644 index 0000000000000000000000000000000000000000..093f39889bfd3e4c8605731b5827c17005773e8e --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_44.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e9ae60a9c85dac00329bacccd6b71fdb09b815b14eede2dea4f48605df6daf31 +size 1535 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_45.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_45.png new file mode 100644 index 0000000000000000000000000000000000000000..50f40765cbd4d9038aead727022ef3ab96092a2a --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_45.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c42130b1d20c166886b2a03d4fddba09e55f80122a2e7bc93ef28043779715e6 +size 1648 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_46.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_46.png new file mode 100644 index 0000000000000000000000000000000000000000..bbd8f65f56d73a7a6d3c2a14e7c5617a509539c5 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_46.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b6248438344b04f2984cd7463c14a39f525e1960ebd79b066a0c76d159ad668c +size 1266 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_47.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_47.png new file mode 100644 index 0000000000000000000000000000000000000000..06bbf96f60411e8cc226353e20230f94e7c78a46 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_47.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a23fb4e764df3fad565d86bf8c0e676b88c56a444d997685373277c749f76fdd +size 2458 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_48.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_48.png new file mode 100644 index 0000000000000000000000000000000000000000..06bbf96f60411e8cc226353e20230f94e7c78a46 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_48.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a23fb4e764df3fad565d86bf8c0e676b88c56a444d997685373277c749f76fdd +size 2458 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_49.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_49.png new file mode 100644 index 0000000000000000000000000000000000000000..37450c658f5ca9eb70d5a34c792c074400cc868c --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_49.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:77bf3781747164eadb77b097b63e004c0db404481c76dad4e06a643e4ae71bcd +size 1691 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_50.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_50.png new file mode 100644 index 0000000000000000000000000000000000000000..c9f0ec988c4d28c0c7c687dd77d31b10e3ed2225 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_50.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5728601e21ba383e176fec85a26f82f125644f009159dfb5d57e5e9fd71872db +size 2981 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_51.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_51.png new file mode 100644 index 0000000000000000000000000000000000000000..13c921276538b907bc634e8ab8cc5836abdb62ed --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_51.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0dd799524b1b552caa65865bc118cd04d5489e37179a80de71f0d367eb1dedeb +size 1214 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_53.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_53.png new file mode 100644 index 0000000000000000000000000000000000000000..105c27d6e13bf0473b8f8266bd8b5602b523cf70 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_53.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:81785abfdd82caa511a7e2ac887b78580ddf5ed1e36a9260772452ab218dc546 +size 4426 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_54.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_54.png new file mode 100644 index 0000000000000000000000000000000000000000..c1dab3c65f927717ba720273099b66f03d4a61b4 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_54.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4ca562acecce272122808be2f361b66d422b869989a82f4d7bcadac27fda7e23 +size 4581 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_55.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_55.png new file mode 100644 index 0000000000000000000000000000000000000000..b1a05c0d278518ba0afc27bd7365a6123ed42922 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_55.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:46deb1c1fd6d75c12046753d958c9f74f5ffcf6e6307b8a08c7753d8d444dbf3 +size 1171 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_56.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_56.png new file mode 100644 index 0000000000000000000000000000000000000000..3665763b0d8f129e6af922b164e427ddf8c55e83 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_56.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f7e8a4412b9af070ef459d506030e7fdeb5c81c772b0083749121117486c49dc +size 1599 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_57.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_57.png new file mode 100644 index 0000000000000000000000000000000000000000..2a4d1c1985dd53629d8783d41467fb13d63866b9 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_57.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:53eff262831bddc0bd0f25cb45744ad05587a8fe4c8c3630297902aa9346d6bb +size 2082 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_58.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_58.png new file mode 100644 index 0000000000000000000000000000000000000000..8130eff0a9a5bc2142eec9fbee16fc7d9bbc7d0e --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_58.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:96065ffc99abd455430195673a6a765a1cf2a75410105853f946c9c02ff3c748 +size 1111 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_59.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_59.png new file mode 100644 index 0000000000000000000000000000000000000000..106b69b5d94e174079840ff0f2adb5e0a8f8f967 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_59.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fd259e1402e6839ccaad3bd75233de84efbbe38705c959f5cfc48f7b2f843ad5 +size 1124 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_60.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_60.png new file mode 100644 index 0000000000000000000000000000000000000000..9d53987b0b913d14089b4bf5fc7a83299f1da731 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_60.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:399b7ec44ad3b2c3aba356ac69c71a88fffd13748e82b4574441f49b89669ad0 +size 2257 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_61.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_61.png new file mode 100644 index 0000000000000000000000000000000000000000..70be9f35ac0114eab1f4e3d1441c5e4a55763363 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_61.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2a6224257dd8b17f79877700ceaeeb12ae6d8839c7fab1df1a7c4e6f569848b6 +size 1634 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_62.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_62.png new file mode 100644 index 0000000000000000000000000000000000000000..e6b811908f48eae33d94dd959523dedfec6bdb83 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_62.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e84e0e4b7ebe160e8bfb16a360477a066219067e1d2863f93e57e35cd45eb5da +size 1148 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_63.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_63.png new file mode 100644 index 0000000000000000000000000000000000000000..9ba17880fcc6863eaea43875e068a1f94c3204fb --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_63.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6ad64f8ef1005e6713f506c03e8f840b1aec324461181e81ec79259e335aee25 +size 1591 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_64.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_64.png new file mode 100644 index 0000000000000000000000000000000000000000..9a7816847fea5cd5765dad82940e80fcb8211b6c --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_64.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e3bbecb201a7f8be0fd96fc7af0c9228819e2de0186adeed42b4078413320ca +size 2034 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_65.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_65.png new file mode 100644 index 0000000000000000000000000000000000000000..89adc773524af459cbe0bd92470c0fa0fa2df92e --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_65.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f75f1087ec356ed9f6a17bf8d7c81ab98c0d9fc883eee1770e5ffd6ba23ed8c3 +size 1302 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_70.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_70.png new file mode 100644 index 0000000000000000000000000000000000000000..f2adf2293714ae08a67dbb472cb00db5a1de1fa5 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_70.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:08af280f5e65e2723a82b11d54dfe66dfa6d69c65707cc8e15894dccad22aeb3 +size 1259 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_72.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_72.png new file mode 100644 index 0000000000000000000000000000000000000000..cbdfc48a6e0fe1d66baeeeba30b74ade6322999e --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_72.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eb2b46fee1c261cb16dac9efe24256447c6895b0b3a7004ee2909910f94c9551 +size 930 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_73.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_73.png new file mode 100644 index 0000000000000000000000000000000000000000..9ed1c80e94a7d951cded57efee035a7f38a331a6 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_73.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:de84573a2cdb06336d841b252d7b974ba7e9d7a1040642f857d011a5b8251116 +size 4018 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_74.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_74.png new file mode 100644 index 0000000000000000000000000000000000000000..9ed1c80e94a7d951cded57efee035a7f38a331a6 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_74.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:de84573a2cdb06336d841b252d7b974ba7e9d7a1040642f857d011a5b8251116 +size 4018 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_75.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_75.png new file mode 100644 index 0000000000000000000000000000000000000000..a091358549b3fbd470aa55b2600ff067e456590a --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_75.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ffa8448adba4137a8d86a4a771dfc09101a0f6b9d716576d49af5af9c9935ca3 +size 2714 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_76.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_76.png new file mode 100644 index 0000000000000000000000000000000000000000..50ae85f50f93a2cd4df2427446117c22cdf82fb8 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_76.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a0040619554fd3ba5b391685070870a3ec23864e8fd51062f36a0ebdfbbb47e7 +size 2353 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_78.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_78.png new file mode 100644 index 0000000000000000000000000000000000000000..21a56a284ab1bbf82959785ac56ca5ad76677045 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_78.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:49f1e94c4fc40ec57a961deb8f84491c6e84da7383701f02c31f26fac28490a0 +size 2458 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_79.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_79.png new file mode 100644 index 0000000000000000000000000000000000000000..cb27875306b2ce3eb407156adfbda9893356ecd7 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_79.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:801dff769e9ecefb4f20e3e199cf7b11a93ac945e865d2ffd814d6269e0ae195 +size 1672 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_80.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_80.png new file mode 100644 index 0000000000000000000000000000000000000000..8a6f36c9ab9423610714c9e0ecaa5369c34c2f7e --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_80.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0b438a75f7a25ce175bb8af026f9f70aeb417b6dff9f9ae11c8ed718d50fdf37 +size 4242 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_81.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_81.png new file mode 100644 index 0000000000000000000000000000000000000000..86c77bbefe964bcf7bdd7d9aa1ce76da687dd9b5 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_81.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9686bb48f186fe6606c832839d032466c86de6134f1e5efc7c9182ef3cbabfd5 +size 1857 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_82.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_82.png new file mode 100644 index 0000000000000000000000000000000000000000..70ddea4f449982289ad66dfff58e6a3ccd7eb89e --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavusans_82.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8b93e39a6e1073ecc9bde428c01219a8c13f4cbb51123daa416a6b4944ce0a2d +size 1892 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_00.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_00.png new file mode 100644 index 0000000000000000000000000000000000000000..18565c5e6ece61f419354c9856fdd3adf9b82341 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_00.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e4ca0eafb2686cb3ea0ba2849c8e77eee8b80edfe6fd203ec34157243a8f4548 +size 1700 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_01.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_01.png new file mode 100644 index 0000000000000000000000000000000000000000..919d0753aec4b8ba946f1a74b4678979cedf8e4b --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_01.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:11685e0bfd121336f7f2c683b78e0735687c9073b766a61a7e437f8f5b5de7c8 +size 1292 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_02.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_02.png new file mode 100644 index 0000000000000000000000000000000000000000..421fbf552ad73e1d32f3f775519ee7393ce2cb23 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_02.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fd875298ab01863d19c64a23b5a9b7313c66e266d3ddc91e94b8570f952cfdc1 +size 1824 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_03.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_03.png new file mode 100644 index 0000000000000000000000000000000000000000..3e5aae2896290b6996df372aac106252a9c16d2c --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_03.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a49e271a06552a791bf32d1ea7c527e27fdb0a9548e1e9c8ebd070ffaf89d283 +size 1404 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_04.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_04.png new file mode 100644 index 0000000000000000000000000000000000000000..62b94732b936ba9b71887a7e8de10b437a29c287 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_04.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aecd88b42e644d6f8c743ef1831dde757ff2591e5bf5198aa584da94e722ac6f +size 1080 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_05.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_05.png new file mode 100644 index 0000000000000000000000000000000000000000..b879d9840423e6714f79c052f9a6a584c1f76876 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_05.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:51e45af61f729b4231e46398cb5a2e6b9148ebe040a1c5c1d6ec9d5893150ad6 +size 2374 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_06.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_06.png new file mode 100644 index 0000000000000000000000000000000000000000..a078daf3f20615d5e3edc2d02b10649460a207c2 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_06.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f2eef3196fec9dd5a3c1fc8325e06c845dd016a315d605c654130ee8a84d835b +size 2968 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_07.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_07.png new file mode 100644 index 0000000000000000000000000000000000000000..58f1cb1887508cb92dfcd411f3fdf3b6680cabad --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_07.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3154c05ff9a6d3e16e5ccb5684cd30983fd3ca43ab1ccc7598660cf12906f02e +size 1574 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_08.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_08.png new file mode 100644 index 0000000000000000000000000000000000000000..2dd28e2bb139fc9a68c0bd257cc45310ab678930 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_08.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e41b738df7fabda642fbbd92a052ce8217f2b026cea041f4ca0fd3f7ba9621f2 +size 1827 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_09.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_09.png new file mode 100644 index 0000000000000000000000000000000000000000..0101079c6f767ea0760d3672d1c470199aa08ce9 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_09.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:93ef0b3b6c4e872bbe203e5a15bbfdd733f5127a2fca9130119ba9ac07a17856 +size 1209 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_10.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_10.png new file mode 100644 index 0000000000000000000000000000000000000000..4c259735d060a5b77482804d0136c135fe2f0a91 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_10.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe182ec125aeb4194549dafe83900ec557cfc55fa762470f4f1364f3264419ff +size 2379 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_11.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_11.png new file mode 100644 index 0000000000000000000000000000000000000000..f45e727ac03ca6136168e723e2af40a924b32b37 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_11.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1dd4c6b9b6f5f72d7b44f31cf0f52d194fad133a444798096bcc76069afcd3b1 +size 2071 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_12.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_12.png new file mode 100644 index 0000000000000000000000000000000000000000..1cd67445db1129e0a14137c0a87dfd58fa33dc4e --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_12.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d983523a3fb224abcf81f5c7620935ab9749b7f103cf3d6c6d4cc66a4ae7de27 +size 1194 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_13.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_13.png new file mode 100644 index 0000000000000000000000000000000000000000..b507e702764e9a45d07561050781abf8fdde4de5 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_13.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:da5f776b0e768b96c29b3aa13ccda885d4026eed957841d4d0129c2dbe3a9d06 +size 1736 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_14.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_14.png new file mode 100644 index 0000000000000000000000000000000000000000..09ff50bddc4b1ce182fc4f3879812f36245eea95 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_14.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bce0f389e5f66d8e20918315533a2b18cfd738e390efb1ca8ff705ba27cf7262 +size 943 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_15.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_15.png new file mode 100644 index 0000000000000000000000000000000000000000..b1fbf7e2f257b132b0feb3f32b7e9a4b7c3a644e --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_15.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f60dae4c64f2c078eb8546053c47190171f5d10f7ea409c9e1cd6f9eaef4acff +size 968 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_16.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_16.png new file mode 100644 index 0000000000000000000000000000000000000000..18bc13ba606421a8fe1222c98a8800a4a277935c --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_16.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c02816d149a6b62c989ef99a4725a55d07350a9419c4ceada36ea73b6ba1ce05 +size 1212 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_17.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_17.png new file mode 100644 index 0000000000000000000000000000000000000000..18bc13ba606421a8fe1222c98a8800a4a277935c --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_17.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c02816d149a6b62c989ef99a4725a55d07350a9419c4ceada36ea73b6ba1ce05 +size 1212 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_19.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_19.png new file mode 100644 index 0000000000000000000000000000000000000000..0d64fb036ad4e0e3559ab15f9bac206e4a3411b4 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_19.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:562f2ad71c49ba605597404d6b3ddb0a1dc776687f851e206681d7fb8f77a991 +size 1954 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_20.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_20.png new file mode 100644 index 0000000000000000000000000000000000000000..292d3ec92843f605886de6c534e64d5720006933 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_20.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:48248ac247918fbc1d55e9404a920bc9b61949d90556e5279b2110eef7d9627d +size 4462 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_21.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_21.png new file mode 100644 index 0000000000000000000000000000000000000000..669ce8c8359cd8f48c47cbca033f5c660f2880ae --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_21.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:933143892f83b0d53c1c8fbd4c13b13ee90805ed02406101c5309191c0d9de7a +size 4769 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_23.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_23.png new file mode 100644 index 0000000000000000000000000000000000000000..f0b9bbceda64a9c85c57a6c82580224b851bd9e3 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_23.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5943ab33a6c98a8ca8d22cf20b06cbe5e6ac10231e53cf1994637263f7aa779b +size 3125 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_24.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_24.png new file mode 100644 index 0000000000000000000000000000000000000000..1257b1e691f6ddd8157ff19e64f285aa057e374b --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_24.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:166c41772d44f5f39bf30210276252ef327d1ff54560109c98169c93c844f6dd +size 1083 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_25.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_25.png new file mode 100644 index 0000000000000000000000000000000000000000..0c846f5a99e9224497c76350356f0c1b32452fda --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_25.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b5d454888bba437932f4b4f2428be8ec903948f59aebf194737e67fda264b5b1 +size 1263 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_26.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_26.png new file mode 100644 index 0000000000000000000000000000000000000000..3d843ad270a4646d929edb912e70013911a6c58f --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_26.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:578c525d9d66d77d52e8d17e6a2b88efcafa2dfae387dfa6096d0156f0f85dcc +size 2671 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_27.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_27.png new file mode 100644 index 0000000000000000000000000000000000000000..5ae1c12362a0e33723bcc09a697b9c428e520ac1 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_27.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c77c2aef9c87695ddcfe3922943bbefe6f3fe68283db312fd6ae8ba503902b00 +size 2425 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_28.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_28.png new file mode 100644 index 0000000000000000000000000000000000000000..7ac4315ef6a82f0306d95e41cdb47008ec7fb981 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_28.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:11e06d714538270692230320827e895a65b0c5f5a590d5dedc6f4a9b196154d9 +size 2130 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_29.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_29.png new file mode 100644 index 0000000000000000000000000000000000000000..1f492fb2ff6edc45fbfea208e57a2fbbfc9067e2 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_29.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cb7c46e2fe9c9f6962ee2eeaf6210014ab445f0de2413d66cc8a3ac73db2b9a6 +size 2229 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_31.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_31.png new file mode 100644 index 0000000000000000000000000000000000000000..df7cde513fccf98c855247de72ba2eccd20c432d --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_31.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:87bbc3f744a01e9825a2a6526159a4a82fc670474a29c2b80717b3ba5fddf465 +size 2277 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_32.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_32.png new file mode 100644 index 0000000000000000000000000000000000000000..51921760ccd464306ae2c5b1d085b1e136f67e96 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_32.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5c980fab83f98f7fffd22ba6d98987a87a94bc90a7ec69aa52412a1a22c4f0a8 +size 1313 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_33.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_33.png new file mode 100644 index 0000000000000000000000000000000000000000..2c4fd0777741a511977d4f2a82987f0f7eeb70e6 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_33.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:47fa2ffe5db15378cbd8230b096af53725da22d821a8d72c44cc85ebe7057de5 +size 2179 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_35.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_35.png new file mode 100644 index 0000000000000000000000000000000000000000..c3743b15fe455af08b480caeb2ceb4470e3bdbc0 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_35.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:371fbbf32296f700e6a21a7e265013a69852ff346d94233c1db998795488a121 +size 1613 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_36.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_36.png new file mode 100644 index 0000000000000000000000000000000000000000..436484492bc122a9bee619138e6bcb0465cbc19c --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_36.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:74bb8a560b3934a76f1476e98ce93a89fc05867dad0cc71f43e339f89d71937f +size 1030 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_37.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_37.png new file mode 100644 index 0000000000000000000000000000000000000000..8eda4020af49b690e12fbfb5b55eb0120810c6d9 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_37.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7477012d3461a462845b5305fa2421722e1ce92df54b537440687da620560e71 +size 7570 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_38.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_38.png new file mode 100644 index 0000000000000000000000000000000000000000..b04457d31ce50e742e1503f6e8cec9ee8019269d --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_38.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:85d73b5a29177c6c51a843cef6d3384c15eff127fd9c34d9fbbba0a0980a8556 +size 3576 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_39.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_39.png new file mode 100644 index 0000000000000000000000000000000000000000..f659844f6104e714341910990e480122e3ffc58e --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_39.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c18db874e8accf55f2645f43b26106db5ea99034073f11c23c507dcfd5e87b93 +size 2681 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_40.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_40.png new file mode 100644 index 0000000000000000000000000000000000000000..f2a332a6c3e6d5b86b016f78db5c31964ed84535 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_40.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:db2eec88df0afe3ffb9d959ed5a085ce4c1d9d79b7d3de7d280b5ff9f3880485 +size 3373 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_41.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_41.png new file mode 100644 index 0000000000000000000000000000000000000000..16ad55f7fa6e8ea342817e0c2ca2c1fd12fdcc32 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_41.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1c2ef64b86b1285d55f6359952e2313ac3c5579c5881fcbe0d27fe4700f79b47 +size 6040 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_42.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_42.png new file mode 100644 index 0000000000000000000000000000000000000000..72753598169e633ba6eede27c4a53ba67f305a2f --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_42.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c0c4bde04fe99f8a87eeecc498be0f912e62ef03959c301e25cb1530d6398a55 +size 1325 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_43.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_43.png new file mode 100644 index 0000000000000000000000000000000000000000..5622c119be4239ea19aceaf4f8634cebe91ab7d1 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_43.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f7ccb9fe04512a5c2e84152573bd923f5ea7da6888d7a4ad41eb9a479ea0387 +size 1285 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_44.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_44.png new file mode 100644 index 0000000000000000000000000000000000000000..e3a31f79e9687f907abef1eebcdd81b36370f531 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_44.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:97845154a8636541bc2a92d3e5525b5a05e272e250ca9b08c43a9221edc69fa2 +size 1556 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_45.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_45.png new file mode 100644 index 0000000000000000000000000000000000000000..c91ca4d23911521733b674c1e650c4c76ec5b299 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_45.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:15e8d9713d45b05f325fa527e304916cfb15481bdb242014b6d5bb71bdc5f355 +size 1596 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_46.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_46.png new file mode 100644 index 0000000000000000000000000000000000000000..5188dacf8dfdd32aae441aea071d77bf847896b3 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_46.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e6465499a270a801e10ec4bc4e37e731982c0ffa1b89faf954498d37ac86b4a +size 1265 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_47.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_47.png new file mode 100644 index 0000000000000000000000000000000000000000..875be0bf40d2f686bc4577454459525dbd665205 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_47.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ef3817de9a37b39d8ff2d8e98ac6d0835693c59d38db295349086adbbfcd0a58 +size 2268 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_48.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_48.png new file mode 100644 index 0000000000000000000000000000000000000000..875be0bf40d2f686bc4577454459525dbd665205 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_48.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ef3817de9a37b39d8ff2d8e98ac6d0835693c59d38db295349086adbbfcd0a58 +size 2268 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_49.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_49.png new file mode 100644 index 0000000000000000000000000000000000000000..3e034d8241028bffbbbcdec248d2e5fbba8eb516 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_49.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:706814eb8258fd806f0eb54eb0150b3dba5fb34b4f810c2c70d3d247294bb407 +size 1725 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_50.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_50.png new file mode 100644 index 0000000000000000000000000000000000000000..2de21d9f2809632536d1d3fb96e8cc0cc31d39a1 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_50.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:27d4fd6effa45e9bfe5978ff16628dd0362c4c0f5a131392140be4ffb168c3cf +size 3054 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_51.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_51.png new file mode 100644 index 0000000000000000000000000000000000000000..85497b00a0a978fade451b4ce7dcbc1ff89cf1ce --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_51.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ae0f4f086f0c46288dcae1349e259dbcdfa8969fca5c76c4e5a0c230eca46cd7 +size 1191 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_53.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_53.png new file mode 100644 index 0000000000000000000000000000000000000000..8dc7181d290cf38bf79f1d8aec15a5866adbd6ea --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_53.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c31c17811795733aa8708d5e704d025f87dfd8446e658cf4fde74de183bf1745 +size 4356 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_54.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_54.png new file mode 100644 index 0000000000000000000000000000000000000000..6e5951c6d7eb12aacd8a56adb122ff893beff695 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_54.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c0d03a3738ad8efdd6b8afccac8a0b75d7f6096d3b8a05ba5c1506f34f4d30a5 +size 4533 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_55.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_55.png new file mode 100644 index 0000000000000000000000000000000000000000..0b2038e10a0242a011cf1037a7dbca4eead1076d --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_55.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e2a19159f76208475bf869db285c4e7470cfbcb03a36b2dd65bddc9f1c3b9bbd +size 1186 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_56.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_56.png new file mode 100644 index 0000000000000000000000000000000000000000..1671f1786260053dfa3e68e52626e90a16151503 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_56.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:65fa60617590e1207544d3ec74daec11e3e5814604e263845c0b1e30aa7dd2d2 +size 1664 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_57.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_57.png new file mode 100644 index 0000000000000000000000000000000000000000..3be42490db72add5ea040aaa24d818becd422cd0 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_57.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b66f795927abcf41b39a3ad0b9c3da68664d25d325db1eac9853a032258bc76e +size 2016 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_58.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_58.png new file mode 100644 index 0000000000000000000000000000000000000000..4ce057f8cf4493221257c47d6816a0f22c873065 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_58.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d13c2900a98da78812eae3ddb0759cfe30c05f32f9bcab5c3a092a96d0e48f08 +size 1097 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_59.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_59.png new file mode 100644 index 0000000000000000000000000000000000000000..0b0b9d0242a97a449da73af5d27e559ef4e1f857 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_59.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3959a5741ddea19fbecaaf70e4c8bfc2f0b5b64619f5d3ab9642ef4bb1f9fe53 +size 1094 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_60.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_60.png new file mode 100644 index 0000000000000000000000000000000000000000..4844708347fbd7fb75a21c5b8dcea770a9a5164b --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_60.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fb0012f8c9e37105ab5f0bac5b3d12b8a64c5d016c3a86720531dcb70343eaf9 +size 2245 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_61.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_61.png new file mode 100644 index 0000000000000000000000000000000000000000..e94ca31ef846447d8cf2eea79dd39df90e2a1e82 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_61.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:83ef3acb06d6dbe087c526aab921bb25ad8f7e34c963ced5585cf21e8fa89157 +size 1683 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_62.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_62.png new file mode 100644 index 0000000000000000000000000000000000000000..b7f626f7087c0d3a55a15f62118142058299ee92 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_62.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:44e98ad7748b5e2c7aa30d1f535605fda1770a9f6f4d195eccab2b2b3ab83444 +size 1207 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_63.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_63.png new file mode 100644 index 0000000000000000000000000000000000000000..e5ba66a2ab2eacedba2a3c828cce0fb94965ae93 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_63.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:04e0ab1c6d591533f0edaedcf6b3a4b1d61688726cec92db019bd7010b5a7fca +size 1549 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_64.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_64.png new file mode 100644 index 0000000000000000000000000000000000000000..47db84a2e02d60c233e1c4f4e152049fb8c9ad6d --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_64.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f1acd8feb0716c2f31ffaec9d9e4eee2392d01dfb49185cf046a9ad55a60ea76 +size 1981 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_65.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_65.png new file mode 100644 index 0000000000000000000000000000000000000000..bfd68cfb0093792412342b58392f300df88615bc --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_65.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b33ad96e4b00c24645d349bc9dd2b2f1d22ded8ad5f91aaf0a2819981bdd1a56 +size 1445 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_70.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_70.png new file mode 100644 index 0000000000000000000000000000000000000000..fc8f9826f629cb691e4aa783b206751ccc750d7d --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_70.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e9bde31da63c348ef3574249014977a45803d206f4fe0659d4b5ddd3c27c8d61 +size 1318 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_71.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_71.png new file mode 100644 index 0000000000000000000000000000000000000000..0a32bef5a0fc443d12f2387b2cb41a723a398477 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_71.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4ac67555e43d9da9d5eccd584f01a2d1c58a45106edb61b3c0b6a2446a7f11a8 +size 1576 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_72.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_72.png new file mode 100644 index 0000000000000000000000000000000000000000..d65db2bad026ffe2c5963fa6254dfdd19c5a8ae0 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_72.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:13d67bbca2a3afb7f586e9b8297a3ccf23afeee75e8112b5b71c5e4d10cb001e +size 1016 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_73.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_73.png new file mode 100644 index 0000000000000000000000000000000000000000..0e6a98212bfaf8321214868c49ded0bcdf91b9d5 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_73.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ab580bada1a2e8fd2f5a950a2c362611bfcbaab6958bea421cb0514d9ae85c71 +size 4283 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_74.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_74.png new file mode 100644 index 0000000000000000000000000000000000000000..0e6a98212bfaf8321214868c49ded0bcdf91b9d5 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_74.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ab580bada1a2e8fd2f5a950a2c362611bfcbaab6958bea421cb0514d9ae85c71 +size 4283 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_75.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_75.png new file mode 100644 index 0000000000000000000000000000000000000000..81ebd4bf718e2b0f133cce7be5619594a7aa93a6 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_75.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e3ee7ff5b61d292a2241b1e2f0c770027b3af275e91c1bb912d8e424b6d640e3 +size 3077 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_76.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_76.png new file mode 100644 index 0000000000000000000000000000000000000000..ad29459e68272092d63440d836ce0e3270d69915 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_76.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bd4d89769d27aa5148456dd258e8e99d892899e5636aaedb4a3d6b2a062f23b2 +size 2382 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_78.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_78.png new file mode 100644 index 0000000000000000000000000000000000000000..0441c11aa589332812b05c55fe77e97c14fa70b3 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_78.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:291da6b53e59f34d184fbbb5d8fffef4306b2a57d488528f14459a696e584848 +size 2407 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_79.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_79.png new file mode 100644 index 0000000000000000000000000000000000000000..ad9a06bba28bb785df9822e6522382a9af941712 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_79.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e2855d952b537954bebf3a792c7788559dc62ccaca693020cd49a83b2b03316c +size 1655 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_80.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_80.png new file mode 100644 index 0000000000000000000000000000000000000000..0995fd61fcd62b1c77ccd4684c602b4d98e40081 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_80.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:242652ce37f3e5386228f6b0ee03ec7901964273b409f54c7f673c6df3d9f472 +size 4289 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_81.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_81.png new file mode 100644 index 0000000000000000000000000000000000000000..60c7ba92cf3fe386e4b816bd569d83924a104da7 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_81.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:81f6c963ed182535843ca86caaaa67990b4c4cf660df2ac2ec6a614cf14aa162 +size 1860 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_82.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_82.png new file mode 100644 index 0000000000000000000000000000000000000000..0807ab2228b511e1a082785f784d5a0f4baaa61f --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_dejavuserif_82.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7a2a470a8cdfa789b812cc81a6d1e5c7c18e9257c877c607ea201e9deb32ccc6 +size 1917 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_00.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_00.png new file mode 100644 index 0000000000000000000000000000000000000000..40777584f3685d102408e15167e730fb9f46ddb0 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_00.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d2515d35649698d7b7fbf5e78129565ceb0b9d78bdd27dd3af9250592d950459 +size 1597 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_01.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_01.png new file mode 100644 index 0000000000000000000000000000000000000000..b047de2374de75263a6c576c9b319d47aab13d00 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_01.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:53c66cb186b958ebd07b0d6128be0a0e3108130ba0e224ab287a14331f91161c +size 1075 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_02.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_02.png new file mode 100644 index 0000000000000000000000000000000000000000..6aaa90034772ff12134c645b5fd95297d1306d22 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_02.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a45966e5c386f3f5a2e1493c298e7fc3b07be4d354719c23fe9f6856f515ec1a +size 1799 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_03.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_03.png new file mode 100644 index 0000000000000000000000000000000000000000..59921724b58be9f989e25f7a3cd9048a4b8961a5 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_03.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:64488cb9e45b7e5281223661a4aece0014d9039ba5537a6f2d57b5dd3cc0808c +size 1220 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_04.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_04.png new file mode 100644 index 0000000000000000000000000000000000000000..7e186fd3bf5c5ab20fdf99081e9a960dbd107ead --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_04.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:482dbc965f1760665857f31dfb2f543790fd5567fe2b2d3ebab2e519dbdf028a +size 932 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_05.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_05.png new file mode 100644 index 0000000000000000000000000000000000000000..e9d6a1b65907b29012afde95d3eeb313abd92129 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_05.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:59953fdf17eaf301d7e79f930331c6d1ee187c9838a6e1fb00a56a3db930e9f5 +size 2183 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_06.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_06.png new file mode 100644 index 0000000000000000000000000000000000000000..ca5a944cea91074fc577eea8edf844b4e326870c --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_06.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:05efbda42f98b2dc29aa805b111ee90feaa947cdd6a30efac8a591ac755966fb +size 2546 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_07.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_07.png new file mode 100644 index 0000000000000000000000000000000000000000..16706967da7ba2febb9e6732129b8df4a4c253c8 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_07.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:287a8fa7d16a4216c28d30a03f4145bbce42dbc6c2be933ec323ad20dbdb19ba +size 1493 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_08.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_08.png new file mode 100644 index 0000000000000000000000000000000000000000..9bd4ebc7dd2bfae395b6fe6ed57d400c06b046ca --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_08.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:409ad7b545e693caa100132a00f10f1e0f0bbc4363a684c488016b0d8488b5b7 +size 1670 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_09.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_09.png new file mode 100644 index 0000000000000000000000000000000000000000..ab65ffd1ab3666b2e9dc34ba3374b695f87f318a --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_09.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4feb962ae4e21877b08bacf256671e1e23e3d6843fd9effcd77dfa37be8a0fe9 +size 1065 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_10.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_10.png new file mode 100644 index 0000000000000000000000000000000000000000..4b6518e06e011ab5d259d61340227abb8d790a3d --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_10.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:368b3ae9bb6fe6f4ab05d663d867fe29b264de892152dd3d3627be6571b82300 +size 2029 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_11.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_11.png new file mode 100644 index 0000000000000000000000000000000000000000..34f61c6b88ee854b44ff787066861d191a1ae560 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_11.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:338540bdf042f086973386c95a627fcb37952f16395d8b75a19ea0c316aba599 +size 1904 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_12.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_12.png new file mode 100644 index 0000000000000000000000000000000000000000..2cf1fc6145f74d5797c012c89d9e0bea5c2ca20b --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_12.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d532968db4457825629582518233e4cd8b982c7b13d3281f76199541f0e72b4f +size 1118 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_13.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_13.png new file mode 100644 index 0000000000000000000000000000000000000000..3ecd863ae6fbdaf87efa9cdd2a1b34510f5b23a6 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_13.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dfeff7934c8f3754456dfcda7bbe05e6b47ff904096b457cf0f52992f85b6242 +size 1598 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_14.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_14.png new file mode 100644 index 0000000000000000000000000000000000000000..033db76bb3e03607f0ca20ab29ce477db2f4a8b4 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_14.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c7c717a7fe01ce2ef2f4736bdb904b48718b2588d7eb0e4dbefd05e2074e866c +size 875 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_15.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_15.png new file mode 100644 index 0000000000000000000000000000000000000000..e063ecff22a59727b9189991493f57b69bbbb99f --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_15.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f68a9d5180e10b7da293a72a62f2162291d7abbfb366acbe37b1cdb20202fe35 +size 892 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_16.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_16.png new file mode 100644 index 0000000000000000000000000000000000000000..1908a343bbe4aa85299793e2492063138eb9512f --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_16.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:10d9253a6961a9d5817c49d14f3e6ebfc25b38e05d51605ead3af8ed7dd57d45 +size 1082 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_17.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_17.png new file mode 100644 index 0000000000000000000000000000000000000000..1908a343bbe4aa85299793e2492063138eb9512f --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_17.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:10d9253a6961a9d5817c49d14f3e6ebfc25b38e05d51605ead3af8ed7dd57d45 +size 1082 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_19.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_19.png new file mode 100644 index 0000000000000000000000000000000000000000..bc69dd2a713a2b7aa0877b2d7a6152dbc11ccea8 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_19.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8cb6cce9c74ad687a4852cf08b4bc7631cfca5cec93d50296e3f4226c61293b8 +size 1795 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_20.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_20.png new file mode 100644 index 0000000000000000000000000000000000000000..ba5e1440b219869deee531d17c91c3732d53f75c --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_20.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5885cf4194143128725486ed2b79769f9f331b0f018cf6ed3ae63cbb21439586 +size 3943 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_21.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_21.png new file mode 100644 index 0000000000000000000000000000000000000000..a6615190ed852a7f0043101a825606ee1856677d --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_21.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0ba73e0e3c33cb384dd72bd40cded40ea941921fc9c22bb2b177822e974ceaa3 +size 4468 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_23.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_23.png new file mode 100644 index 0000000000000000000000000000000000000000..525cdc439589e6f364c5b9c482d9b12192021e19 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_23.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:96aa5dc4367dc624c57b778cb4cfa7258ed0a1f74acf0527dd407ef92dd5d5b8 +size 3135 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_24.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_24.png new file mode 100644 index 0000000000000000000000000000000000000000..ab4af5ca1f5df6a4edc41ade82728323f1dd0d1e --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_24.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:faeaf156fee64717a3f5165ba1eeb453706fe0970f2d1b0933696067480cc1c9 +size 1068 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_25.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_25.png new file mode 100644 index 0000000000000000000000000000000000000000..0358e23857fba1c26c179698abba475019f2571d --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_25.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2572fc34391c10c9e2944099c7dacf9a5df13dd38181ff71d8151a4bb8751286 +size 1273 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_26.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_26.png new file mode 100644 index 0000000000000000000000000000000000000000..7770d4527f0568357083b9a6824a4457c25261d5 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_26.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:63e8cbb516c870eff6a394b037e9419c5f00fede559503a010c5e7f9309f0b64 +size 2393 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_27.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_27.png new file mode 100644 index 0000000000000000000000000000000000000000..5526151e206d4e0374cbf43ed93213c25b049c08 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_27.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8363fff570b5e22746dd43e5e763648c9c6dae354912ce611b28a37fd816060d +size 2197 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_28.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_28.png new file mode 100644 index 0000000000000000000000000000000000000000..48ce4d3a9ecad07c4816148f38f3a23d849cbb55 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_28.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f96a8738ee8cf46feb1c6339f8af885a0600cdfb91da71526a0dab251d94a332 +size 1799 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_29.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_29.png new file mode 100644 index 0000000000000000000000000000000000000000..afe324a549218a33acaf6e3e507a77e1de3b0c84 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_29.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99be76780da90cfad1d7b73bedf8c67bbd9b0aff8d90e4fb046f1cf452ec8efb +size 1987 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_31.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_31.png new file mode 100644 index 0000000000000000000000000000000000000000..e380912adc82359df1d289c092bf8906413de1bc --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_31.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fb08e69a8de3c11bf3b85a5748f3e35b09c033e6868c1734c53132dcd55c4df6 +size 1993 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_32.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_32.png new file mode 100644 index 0000000000000000000000000000000000000000..ae375d2f263c7c9b1953212e0707be92fd04f311 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_32.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0b5e93e7678e24a5b95eb29dc0ab3a60a7604458f1295beb74b77a18efd7c3c0 +size 1235 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_33.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_33.png new file mode 100644 index 0000000000000000000000000000000000000000..cf384b1890155628c4e4e0d153d88c55e89da37d --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_33.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b3594236608d96e9b6c76ca587c29b6dc22359d27d513eefb194ffad75f2c91e +size 1984 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_35.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_35.png new file mode 100644 index 0000000000000000000000000000000000000000..1fbb82b708e9510c86e02ac60baa599ef7435e55 --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_35.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fa8ec666a837fc6c7913609d94ddfd9111bfb6502d50505a767feb03cc55ec59 +size 1665 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_36.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_36.png new file mode 100644 index 0000000000000000000000000000000000000000..35a16f09651d9d540e0dc346ee6418271294e76c --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_36.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a9682cd98e01c015bb5e8dcc93a3e19678851802d5454659ae2a552867af027d +size 985 diff --git a/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_37.png b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_37.png new file mode 100644 index 0000000000000000000000000000000000000000..09815c113b5930813236aa81b3d8d36616bd09ba --- /dev/null +++ b/testbed/matplotlib__matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_stix_37.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5c4da431b64f12713e6d092d79ae4bd480e106edb0f506d7903c4bd75b6b120b +size 6602