diff --git a/src/AWSServices.jl b/src/AWSServices.jl index 6b7f6819c8..fd957bb83e 100644 --- a/src/AWSServices.jl +++ b/src/AWSServices.jl @@ -28,6 +28,7 @@ const apigatewayv2 = AWS.RestJSONService("apigateway", "apigateway", "2018-11-29 const app_mesh = AWS.RestJSONService("appmesh", "appmesh", "2019-01-25") const appconfig = AWS.RestJSONService("appconfig", "appconfig", "2019-10-09") const appconfigdata = AWS.RestJSONService("appconfig", "appconfigdata", "2021-11-11") +const appfabric = AWS.RestJSONService("appfabric", "appfabric", "2023-05-19") const appflow = AWS.RestJSONService("appflow", "appflow", "2020-08-23") const appintegrations = AWS.RestJSONService( "app-integrations", "app-integrations", "2020-07-29" diff --git a/src/services/appfabric.jl b/src/services/appfabric.jl new file mode 100644 index 0000000000..f0e606cff0 --- /dev/null +++ b/src/services/appfabric.jl @@ -0,0 +1,1212 @@ +# This file is auto-generated by AWSMetadata.jl +using AWS +using AWS.AWSServices: appfabric +using AWS.Compat +using AWS.UUIDs + +""" + batch_get_user_access_tasks(app_bundle_identifier, task_id_list) + batch_get_user_access_tasks(app_bundle_identifier, task_id_list, params::Dict{String,<:Any}) + +Gets user access details in a batch request. This action polls data from the tasks that are +kicked off by the StartUserAccessTasks action. + +# Arguments +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. +- `task_id_list`: The tasks IDs to use for the request. + +""" +function batch_get_user_access_tasks( + appBundleIdentifier, taskIdList; aws_config::AbstractAWSConfig=global_aws_config() +) + return appfabric( + "POST", + "/useraccess/batchget", + Dict{String,Any}( + "appBundleIdentifier" => appBundleIdentifier, "taskIdList" => taskIdList + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function batch_get_user_access_tasks( + appBundleIdentifier, + taskIdList, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "POST", + "/useraccess/batchget", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "appBundleIdentifier" => appBundleIdentifier, "taskIdList" => taskIdList + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + connect_app_authorization(app_authorization_identifier, app_bundle_identifier) + connect_app_authorization(app_authorization_identifier, app_bundle_identifier, params::Dict{String,<:Any}) + +Establishes a connection between Amazon Web Services AppFabric and an application, which +allows AppFabric to call the APIs of the application. + +# Arguments +- `app_authorization_identifier`: The Amazon Resource Name (ARN) or Universal Unique + Identifier (UUID) of the app authorization to use for the request. +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle that contains the app authorization to use for the request. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"authRequest"`: Contains OAuth2 authorization information. This is required if the app + authorization for the request is configured with an OAuth2 (oauth2) authorization type. +""" +function connect_app_authorization( + appAuthorizationIdentifier, + appBundleIdentifier; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "POST", + "/appbundles/$(appBundleIdentifier)/appauthorizations/$(appAuthorizationIdentifier)/connect"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function connect_app_authorization( + appAuthorizationIdentifier, + appBundleIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "POST", + "/appbundles/$(appBundleIdentifier)/appauthorizations/$(appAuthorizationIdentifier)/connect", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + create_app_authorization(app, app_bundle_identifier, auth_type, credential, tenant) + create_app_authorization(app, app_bundle_identifier, auth_type, credential, tenant, params::Dict{String,<:Any}) + +Creates an app authorization within an app bundle, which allows AppFabric to connect to an +application. + +# Arguments +- `app`: The name of the application. Valid values are: SLACK ASANA JIRA + M365 M365AUDITLOGS ZOOM ZENDESK OKTA GOOGLE DROPBOX SMARTSHEET + CISCO +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. +- `auth_type`: The authorization type for the app authorization. +- `credential`: 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. +- `tenant`: Contains information about an application tenant, such as the application + display name and identifier. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"clientToken"`: 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. +- `"tags"`: A map of the key-value pairs of the tag or tags to assign to the resource. +""" +function create_app_authorization( + app, + appBundleIdentifier, + authType, + credential, + tenant; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "POST", + "/appbundles/$(appBundleIdentifier)/appauthorizations", + Dict{String,Any}( + "app" => app, + "authType" => authType, + "credential" => credential, + "tenant" => tenant, + "clientToken" => string(uuid4()), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function create_app_authorization( + app, + appBundleIdentifier, + authType, + credential, + tenant, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "POST", + "/appbundles/$(appBundleIdentifier)/appauthorizations", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "app" => app, + "authType" => authType, + "credential" => credential, + "tenant" => tenant, + "clientToken" => string(uuid4()), + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + create_app_bundle() + create_app_bundle(params::Dict{String,<:Any}) + +Creates an app bundle to collect data from an application using AppFabric. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"clientToken"`: 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. +- `"customerManagedKeyIdentifier"`: 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"`: A map of the key-value pairs of the tag or tags to assign to the resource. +""" +function create_app_bundle(; aws_config::AbstractAWSConfig=global_aws_config()) + return appfabric( + "POST", + "/appbundles", + Dict{String,Any}("clientToken" => string(uuid4())); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function create_app_bundle( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return appfabric( + "POST", + "/appbundles", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + create_ingestion(app, app_bundle_identifier, ingestion_type, tenant_id) + create_ingestion(app, app_bundle_identifier, ingestion_type, tenant_id, params::Dict{String,<:Any}) + +Creates a data ingestion for an application. + +# Arguments +- `app`: The name of the application. Valid values are: SLACK ASANA JIRA + M365 M365AUDITLOGS ZOOM ZENDESK OKTA GOOGLE DROPBOX SMARTSHEET + CISCO +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. +- `ingestion_type`: The ingestion type. +- `tenant_id`: The ID of the application tenant. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"clientToken"`: 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. +- `"tags"`: A map of the key-value pairs of the tag or tags to assign to the resource. +""" +function create_ingestion( + app, + appBundleIdentifier, + ingestionType, + tenantId; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "POST", + "/appbundles/$(appBundleIdentifier)/ingestions", + Dict{String,Any}( + "app" => app, + "ingestionType" => ingestionType, + "tenantId" => tenantId, + "clientToken" => string(uuid4()), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function create_ingestion( + app, + appBundleIdentifier, + ingestionType, + tenantId, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "POST", + "/appbundles/$(appBundleIdentifier)/ingestions", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "app" => app, + "ingestionType" => ingestionType, + "tenantId" => tenantId, + "clientToken" => string(uuid4()), + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + create_ingestion_destination(app_bundle_identifier, destination_configuration, ingestion_identifier, processing_configuration) + create_ingestion_destination(app_bundle_identifier, destination_configuration, ingestion_identifier, processing_configuration, params::Dict{String,<:Any}) + +Creates an ingestion destination, which specifies how an application's ingested data is +processed by Amazon Web Services AppFabric and where it's delivered. + +# Arguments +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. +- `destination_configuration`: Contains information about the destination of ingested data. +- `ingestion_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the ingestion to use for the request. +- `processing_configuration`: Contains information about how ingested data is processed. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"clientToken"`: 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. +- `"tags"`: A map of the key-value pairs of the tag or tags to assign to the resource. +""" +function create_ingestion_destination( + appBundleIdentifier, + destinationConfiguration, + ingestionIdentifier, + processingConfiguration; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "POST", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)/ingestiondestinations", + Dict{String,Any}( + "destinationConfiguration" => destinationConfiguration, + "processingConfiguration" => processingConfiguration, + "clientToken" => string(uuid4()), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function create_ingestion_destination( + appBundleIdentifier, + destinationConfiguration, + ingestionIdentifier, + processingConfiguration, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "POST", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)/ingestiondestinations", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "destinationConfiguration" => destinationConfiguration, + "processingConfiguration" => processingConfiguration, + "clientToken" => string(uuid4()), + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + delete_app_authorization(app_authorization_identifier, app_bundle_identifier) + delete_app_authorization(app_authorization_identifier, app_bundle_identifier, params::Dict{String,<:Any}) + +Deletes an app authorization. You must delete the associated ingestion before you can +delete an app authorization. + +# Arguments +- `app_authorization_identifier`: The Amazon Resource Name (ARN) or Universal Unique + Identifier (UUID) of the app authorization to use for the request. +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. + +""" +function delete_app_authorization( + appAuthorizationIdentifier, + appBundleIdentifier; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "DELETE", + "/appbundles/$(appBundleIdentifier)/appauthorizations/$(appAuthorizationIdentifier)"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function delete_app_authorization( + appAuthorizationIdentifier, + appBundleIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "DELETE", + "/appbundles/$(appBundleIdentifier)/appauthorizations/$(appAuthorizationIdentifier)", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + delete_app_bundle(app_bundle_identifier) + delete_app_bundle(app_bundle_identifier, params::Dict{String,<:Any}) + +Deletes an app bundle. You must delete all associated app authorizations before you can +delete an app bundle. + +# Arguments +- `app_bundle_identifier`: The ID or Amazon Resource Name (ARN) of the app bundle that + needs to be deleted. + +""" +function delete_app_bundle( + appBundleIdentifier; aws_config::AbstractAWSConfig=global_aws_config() +) + return appfabric( + "DELETE", + "/appbundles/$(appBundleIdentifier)"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function delete_app_bundle( + appBundleIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "DELETE", + "/appbundles/$(appBundleIdentifier)", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + delete_ingestion(app_bundle_identifier, ingestion_identifier) + delete_ingestion(app_bundle_identifier, ingestion_identifier, params::Dict{String,<:Any}) + +Deletes an ingestion. You must stop (disable) the ingestion and you must delete all +associated ingestion destinations before you can delete an app ingestion. + +# Arguments +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. +- `ingestion_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the ingestion to use for the request. + +""" +function delete_ingestion( + appBundleIdentifier, + ingestionIdentifier; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "DELETE", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function delete_ingestion( + appBundleIdentifier, + ingestionIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "DELETE", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + delete_ingestion_destination(app_bundle_identifier, ingestion_destination_identifier, ingestion_identifier) + delete_ingestion_destination(app_bundle_identifier, ingestion_destination_identifier, ingestion_identifier, params::Dict{String,<:Any}) + +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. + +# Arguments +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. +- `ingestion_destination_identifier`: The Amazon Resource Name (ARN) or Universal Unique + Identifier (UUID) of the ingestion destination to use for the request. +- `ingestion_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the ingestion to use for the request. + +""" +function delete_ingestion_destination( + appBundleIdentifier, + ingestionDestinationIdentifier, + ingestionIdentifier; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "DELETE", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)/ingestiondestinations/$(ingestionDestinationIdentifier)"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function delete_ingestion_destination( + appBundleIdentifier, + ingestionDestinationIdentifier, + ingestionIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "DELETE", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)/ingestiondestinations/$(ingestionDestinationIdentifier)", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + get_app_authorization(app_authorization_identifier, app_bundle_identifier) + get_app_authorization(app_authorization_identifier, app_bundle_identifier, params::Dict{String,<:Any}) + +Returns information about an app authorization. + +# Arguments +- `app_authorization_identifier`: The Amazon Resource Name (ARN) or Universal Unique + Identifier (UUID) of the app authorization to use for the request. +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. + +""" +function get_app_authorization( + appAuthorizationIdentifier, + appBundleIdentifier; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "GET", + "/appbundles/$(appBundleIdentifier)/appauthorizations/$(appAuthorizationIdentifier)"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_app_authorization( + appAuthorizationIdentifier, + appBundleIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "GET", + "/appbundles/$(appBundleIdentifier)/appauthorizations/$(appAuthorizationIdentifier)", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + get_app_bundle(app_bundle_identifier) + get_app_bundle(app_bundle_identifier, params::Dict{String,<:Any}) + +Returns information about an app bundle. + +# Arguments +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. + +""" +function get_app_bundle( + appBundleIdentifier; aws_config::AbstractAWSConfig=global_aws_config() +) + return appfabric( + "GET", + "/appbundles/$(appBundleIdentifier)"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_app_bundle( + appBundleIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "GET", + "/appbundles/$(appBundleIdentifier)", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + get_ingestion(app_bundle_identifier, ingestion_identifier) + get_ingestion(app_bundle_identifier, ingestion_identifier, params::Dict{String,<:Any}) + +Returns information about an ingestion. + +# Arguments +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. +- `ingestion_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the ingestion to use for the request. + +""" +function get_ingestion( + appBundleIdentifier, + ingestionIdentifier; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "GET", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_ingestion( + appBundleIdentifier, + ingestionIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "GET", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + get_ingestion_destination(app_bundle_identifier, ingestion_destination_identifier, ingestion_identifier) + get_ingestion_destination(app_bundle_identifier, ingestion_destination_identifier, ingestion_identifier, params::Dict{String,<:Any}) + +Returns information about an ingestion destination. + +# Arguments +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. +- `ingestion_destination_identifier`: The Amazon Resource Name (ARN) or Universal Unique + Identifier (UUID) of the ingestion destination to use for the request. +- `ingestion_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the ingestion to use for the request. + +""" +function get_ingestion_destination( + appBundleIdentifier, + ingestionDestinationIdentifier, + ingestionIdentifier; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "GET", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)/ingestiondestinations/$(ingestionDestinationIdentifier)"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_ingestion_destination( + appBundleIdentifier, + ingestionDestinationIdentifier, + ingestionIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "GET", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)/ingestiondestinations/$(ingestionDestinationIdentifier)", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + list_app_authorizations(app_bundle_identifier) + list_app_authorizations(app_bundle_identifier, params::Dict{String,<:Any}) + +Returns a list of all app authorizations configured for an app bundle. + +# Arguments +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"maxResults"`: 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. +- `"nextToken"`: 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. +""" +function list_app_authorizations( + appBundleIdentifier; aws_config::AbstractAWSConfig=global_aws_config() +) + return appfabric( + "GET", + "/appbundles/$(appBundleIdentifier)/appauthorizations"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function list_app_authorizations( + appBundleIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "GET", + "/appbundles/$(appBundleIdentifier)/appauthorizations", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + list_app_bundles() + list_app_bundles(params::Dict{String,<:Any}) + +Returns a list of app bundles. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"maxResults"`: 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. +- `"nextToken"`: 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. +""" +function list_app_bundles(; aws_config::AbstractAWSConfig=global_aws_config()) + return appfabric( + "GET", "/appbundles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET + ) +end +function list_app_bundles( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return appfabric( + "GET", "/appbundles", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET + ) +end + +""" + list_ingestion_destinations(app_bundle_identifier, ingestion_identifier) + list_ingestion_destinations(app_bundle_identifier, ingestion_identifier, params::Dict{String,<:Any}) + +Returns a list of all ingestion destinations configured for an ingestion. + +# Arguments +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. +- `ingestion_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the ingestion to use for the request. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"maxResults"`: 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. +- `"nextToken"`: 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. +""" +function list_ingestion_destinations( + appBundleIdentifier, + ingestionIdentifier; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "GET", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)/ingestiondestinations"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function list_ingestion_destinations( + appBundleIdentifier, + ingestionIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "GET", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)/ingestiondestinations", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + list_ingestions(app_bundle_identifier) + list_ingestions(app_bundle_identifier, params::Dict{String,<:Any}) + +Returns a list of all ingestions configured for an app bundle. + +# Arguments +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"maxResults"`: 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. +- `"nextToken"`: 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. +""" +function list_ingestions( + appBundleIdentifier; aws_config::AbstractAWSConfig=global_aws_config() +) + return appfabric( + "GET", + "/appbundles/$(appBundleIdentifier)/ingestions"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function list_ingestions( + appBundleIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "GET", + "/appbundles/$(appBundleIdentifier)/ingestions", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + list_tags_for_resource(resource_arn) + list_tags_for_resource(resource_arn, params::Dict{String,<:Any}) + +Returns a list of tags for a resource. + +# Arguments +- `resource_arn`: The Amazon Resource Name (ARN) of the resource for which you want to + retrieve tags. + +""" +function list_tags_for_resource( + resourceArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return appfabric( + "GET", + "/tags/$(resourceArn)"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function list_tags_for_resource( + resourceArn, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "GET", + "/tags/$(resourceArn)", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + start_ingestion(app_bundle_identifier, ingestion_identifier) + start_ingestion(app_bundle_identifier, ingestion_identifier, params::Dict{String,<:Any}) + +Starts (enables) an ingestion, which collects data from an application. + +# Arguments +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. +- `ingestion_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the ingestion to use for the request. + +""" +function start_ingestion( + appBundleIdentifier, + ingestionIdentifier; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "POST", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)/start"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function start_ingestion( + appBundleIdentifier, + ingestionIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "POST", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)/start", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + start_user_access_tasks(app_bundle_identifier, email) + start_user_access_tasks(app_bundle_identifier, email, params::Dict{String,<:Any}) + +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. + +# Arguments +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. +- `email`: The email address of the target user. + +""" +function start_user_access_tasks( + appBundleIdentifier, email; aws_config::AbstractAWSConfig=global_aws_config() +) + return appfabric( + "POST", + "/useraccess/start", + Dict{String,Any}("appBundleIdentifier" => appBundleIdentifier, "email" => email); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function start_user_access_tasks( + appBundleIdentifier, + email, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "POST", + "/useraccess/start", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "appBundleIdentifier" => appBundleIdentifier, "email" => email + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + stop_ingestion(app_bundle_identifier, ingestion_identifier) + stop_ingestion(app_bundle_identifier, ingestion_identifier, params::Dict{String,<:Any}) + +Stops (disables) an ingestion. + +# Arguments +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. +- `ingestion_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the ingestion to use for the request. + +""" +function stop_ingestion( + appBundleIdentifier, + ingestionIdentifier; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "POST", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)/stop"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function stop_ingestion( + appBundleIdentifier, + ingestionIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "POST", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)/stop", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + tag_resource(resource_arn, tags) + tag_resource(resource_arn, tags, params::Dict{String,<:Any}) + +Assigns one or more tags (key-value pairs) to the specified resource. + +# Arguments +- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to tag. +- `tags`: A map of the key-value pairs of the tag or tags to assign to the resource. + +""" +function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config()) + return appfabric( + "POST", + "/tags/$(resourceArn)", + Dict{String,Any}("tags" => tags); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function tag_resource( + resourceArn, + tags, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "POST", + "/tags/$(resourceArn)", + Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params)); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + untag_resource(resource_arn, tag_keys) + untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any}) + +Removes a tag or tags from a resource. + +# Arguments +- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to untag. +- `tag_keys`: The keys of the key-value pairs for the tag or tags you want to remove from + the specified resource. + +""" +function untag_resource( + resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config() +) + return appfabric( + "DELETE", + "/tags/$(resourceArn)", + Dict{String,Any}("tagKeys" => tagKeys); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function untag_resource( + resourceArn, + tagKeys, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "DELETE", + "/tags/$(resourceArn)", + Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params)); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + update_app_authorization(app_authorization_identifier, app_bundle_identifier) + update_app_authorization(app_authorization_identifier, app_bundle_identifier, params::Dict{String,<:Any}) + +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. + +# Arguments +- `app_authorization_identifier`: The Amazon Resource Name (ARN) or Universal Unique + Identifier (UUID) of the app authorization to use for the request. +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"credential"`: 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. +- `"tenant"`: Contains information about an application tenant, such as the application + display name and identifier. +""" +function update_app_authorization( + appAuthorizationIdentifier, + appBundleIdentifier; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "PATCH", + "/appbundles/$(appBundleIdentifier)/appauthorizations/$(appAuthorizationIdentifier)"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function update_app_authorization( + appAuthorizationIdentifier, + appBundleIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "PATCH", + "/appbundles/$(appBundleIdentifier)/appauthorizations/$(appAuthorizationIdentifier)", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + update_ingestion_destination(app_bundle_identifier, destination_configuration, ingestion_destination_identifier, ingestion_identifier) + update_ingestion_destination(app_bundle_identifier, destination_configuration, ingestion_destination_identifier, ingestion_identifier, params::Dict{String,<:Any}) + +Updates an ingestion destination, which specifies how an application's ingested data is +processed by Amazon Web Services AppFabric and where it's delivered. + +# Arguments +- `app_bundle_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the app bundle to use for the request. +- `destination_configuration`: Contains information about the destination of ingested data. +- `ingestion_destination_identifier`: The Amazon Resource Name (ARN) or Universal Unique + Identifier (UUID) of the ingestion destination to use for the request. +- `ingestion_identifier`: The Amazon Resource Name (ARN) or Universal Unique Identifier + (UUID) of the ingestion to use for the request. + +""" +function update_ingestion_destination( + appBundleIdentifier, + destinationConfiguration, + ingestionDestinationIdentifier, + ingestionIdentifier; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "PATCH", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)/ingestiondestinations/$(ingestionDestinationIdentifier)", + Dict{String,Any}("destinationConfiguration" => destinationConfiguration); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function update_ingestion_destination( + appBundleIdentifier, + destinationConfiguration, + ingestionDestinationIdentifier, + ingestionIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appfabric( + "PATCH", + "/appbundles/$(appBundleIdentifier)/ingestions/$(ingestionIdentifier)/ingestiondestinations/$(ingestionDestinationIdentifier)", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}("destinationConfiguration" => destinationConfiguration), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end diff --git a/src/services/appflow.jl b/src/services/appflow.jl index aa84d5f2c9..1afb75c8c7 100644 --- a/src/services/appflow.jl +++ b/src/services/appflow.jl @@ -768,6 +768,71 @@ function register_connector( ) end +""" + reset_connector_metadata_cache() + reset_connector_metadata_cache(params::Dict{String,<:Any}) + +Resets metadata about your connector entities that Amazon AppFlow stored in its cache. Use +this action when you want Amazon AppFlow to return the latest information about the data +that you have in a source application. Amazon AppFlow returns metadata about your entities +when you use the ListConnectorEntities or DescribeConnectorEntities actions. Following +these actions, Amazon AppFlow caches the metadata to reduce the number of API requests that +it must send to the source application. Amazon AppFlow automatically resets the cache once +every hour, but you can use this action when you want to get the latest metadata right away. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"apiVersion"`: The API version that you specified in the connector profile that you’re + resetting cached metadata for. You must use this parameter only if the connector supports + multiple API versions or if the connector type is CustomConnector. To look up how many + versions a connector supports, use the DescribeConnectors action. In the response, find the + value that Amazon AppFlow returns for the connectorVersion parameter. To look up the + connector type, use the DescribeConnectorProfiles action. In the response, find the value + that Amazon AppFlow returns for the connectorType parameter. To look up the API version + that you specified in a connector profile, use the DescribeConnectorProfiles action. +- `"connectorEntityName"`: Use this parameter if you want to reset cached metadata about + the details for an individual entity. If you don't include this parameter in your request, + Amazon AppFlow only resets cached metadata about entity names, not entity details. +- `"connectorProfileName"`: The name of the connector profile that you want to reset cached + metadata for. You can omit this parameter if you're resetting the cache for any of the + following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, + Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you must + include this parameter in your request. +- `"connectorType"`: The type of connector to reset cached metadata for. You must include + this parameter in your request if you're resetting the cache for any of the following + connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or + Upsolver. If you're resetting the cache for any other connector, you can omit this + parameter from your request. +- `"entitiesPath"`: Use this parameter only if you’re resetting the cached metadata about + a nested entity. Only some connectors support nested entities. A nested entity is one that + has another entity as a parent. To use this parameter, specify the name of the parent + entity. To look up the parent-child relationship of entities, you can send a + ListConnectorEntities request that omits the entitiesPath parameter. Amazon AppFlow will + return a list of top-level entities. For each one, it indicates whether the entity has + nested entities. Then, in a subsequent ListConnectorEntities request, you can specify a + parent entity name for the entitiesPath parameter. Amazon AppFlow will return a list of the + child entities for that parent. +""" +function reset_connector_metadata_cache(; aws_config::AbstractAWSConfig=global_aws_config()) + return appflow( + "POST", + "/reset-connector-metadata-cache"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function reset_connector_metadata_cache( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return appflow( + "POST", + "/reset-connector-metadata-cache", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ start_flow(flow_name) start_flow(flow_name, params::Dict{String,<:Any}) diff --git a/src/services/application_discovery_service.jl b/src/services/application_discovery_service.jl index a4ce003ec0..cabc439239 100644 --- a/src/services/application_discovery_service.jl +++ b/src/services/application_discovery_service.jl @@ -255,18 +255,18 @@ end describe_agents() describe_agents(params::Dict{String,<:Any}) -Lists agents or connectors as specified by ID or other filters. All agents/connectors -associated with your user account can be listed if you call DescribeAgents as is without -passing any parameters. +Lists agents or collectors as specified by ID or other filters. All agents/collectors +associated with your user can be listed if you call DescribeAgents as is without passing +any parameters. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"agentIds"`: The agent or the Connector IDs for which you want information. If you - specify no IDs, the system returns information about all agents/Connectors associated with - your Amazon Web Services user account. +- `"agentIds"`: The agent or the collector IDs for which you want information. If you + specify no IDs, the system returns information about all agents/collectors associated with + your user. - `"filters"`: You can filter the request using various logical operators and a key-value format. For example: {\"key\": \"collectionStatus\", \"value\": \"STARTED\"} -- `"maxResults"`: The total number of agents/Connectors to return in a single page of +- `"maxResults"`: The total number of agents/collectors to return in a single page of output. The maximum value is 100. - `"nextToken"`: Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequestagentIds but set DescribeAgentsRequestmaxResults @@ -333,8 +333,8 @@ end describe_continuous_exports() describe_continuous_exports(params::Dict{String,<:Any}) -Lists exports as specified by ID. All continuous exports associated with your user account -can be listed if you call DescribeContinuousExports as is without passing any parameters. +Lists exports as specified by ID. All continuous exports associated with your user can be +listed if you call DescribeContinuousExports as is without passing any parameters. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -466,8 +466,8 @@ end Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter filters. There are three valid tag filter names: tagKey tagValue configurationId Also, all configuration items associated -with your user account that have tags can be listed if you call DescribeTags as is without -passing any parameters. +with your user that have tags can be listed if you call DescribeTags as is without passing +any parameters. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -722,16 +722,15 @@ end start_data_collection_by_agent_ids(agent_ids) start_data_collection_by_agent_ids(agent_ids, params::Dict{String,<:Any}) -Instructs the specified agents or connectors to start collecting data. +Instructs the specified agents to start collecting data. # Arguments -- `agent_ids`: The IDs of the agents or connectors from which to start collecting data. If - you send a request to an agent/connector ID that you do not have permission to contact, - according to your Amazon Web Services account, the service does not throw an exception. - Instead, it returns the error in the Description field. If you send a request to multiple - agents/connectors and you do not have permission to contact some of those - agents/connectors, the system does not throw an exception. Instead, the system shows Failed - in the Description field. +- `agent_ids`: The IDs of the agents from which to start collecting data. If you send a + request to an agent ID that you do not have permission to contact, according to your Amazon + Web Services account, the service does not throw an exception. Instead, it returns the + error in the Description field. If you send a request to multiple agents and you do not + have permission to contact some of those agents, the system does not throw an exception. + Instead, the system shows Failed in the Description field. """ function start_data_collection_by_agent_ids( @@ -763,14 +762,22 @@ end start_export_task() start_export_task(params::Dict{String,<:Any}) - Begins the export of discovered data to an S3 bucket. If you specify agentIds in a -filter, the task exports up to 72 hours of detailed data collected by the identified -Application Discovery Agent, including network, process, and performance details. A time -range for exported agent data may be set by using startTime and endTime. Export of detailed -agent data is limited to five concurrently running exports. If you do not include an -agentIds filter, summary data is exported that includes both Amazon Web Services Agentless -Discovery Connector data and summary data from Amazon Web Services Discovery Agents. Export -of summary data is limited to two exports per day. +Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web +Services. Exports might provide an estimate of fees and savings based on certain +information that you provide. Fee estimates do not include any taxes that might apply. Your +actual fees and savings depend on a variety of factors, including your actual usage of +Amazon Web Services services, which might vary from the estimates provided in this report. +If you do not specify preferences or agentIds in the filter, a summary of all servers, +applications, tags, and performance is generated. This data is an aggregation of all server +data collected through on-premises tooling, file import, application grouping and applying +tags. If you specify agentIds in a filter, the task exports up to 72 hours of detailed data +collected by the identified Application Discovery Agent, including network, process, and +performance details. A time range for exported agent data may be set by using startTime and +endTime. Export of detailed agent data is limited to five concurrently running exports. +Export of detailed agent data is limited to two exports per day. If you enable +ec2RecommendationsPreferences in preferences , an Amazon EC2 instance matching the +characteristics of each server in Application Discovery Service is generated. Changing the +attributes of the ec2RecommendationsPreferences changes the criteria of the recommendation. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -782,8 +789,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"filters"`: If a filter is present, it selects the single agentId of the Application Discovery Agent for which data is exported. The agentId can be found in the results of the DescribeAgents API or CLI. If no filter is present, startTime and endTime are ignored and - exported data includes both Agentless Discovery Connector data and summary data from - Application Discovery agents. + exported data includes both Amazon Web Services Application Discovery Service Agentless + Collector collectors data and summary data from Application Discovery Agent agents. +- `"preferences"`: Indicates the type of data that needs to be exported. Only one + ExportPreferences can be enabled at any time. - `"startTime"`: The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent. @@ -806,12 +815,14 @@ end start_import_task(import_url, name, params::Dict{String,<:Any}) Starts an import task, which allows you to import details of your on-premises environment -directly into Amazon Web Services Migration Hub without having to use the Application -Discovery Service (ADS) tools such as the Discovery Connector or Discovery Agent. This -gives you the option to perform migration assessment and planning directly from your -imported data, including the ability to group your devices as applications and track their -migration status. To start an import request, do this: Download the specially formatted -comma separated value (CSV) import template, which you can find here: +directly into Amazon Web Services Migration Hub without having to use the Amazon Web +Services Application Discovery Service (Application Discovery Service) tools such as the +Amazon Web Services Application Discovery Service Agentless Collector or Application +Discovery Agent. This gives you the option to perform migration assessment and planning +directly from your imported data, including the ability to group your devices as +applications and track their migration status. To start an import request, do this: +Download the specially formatted comma separated value (CSV) import template, which you can +find here: https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_tem plate.csv. Fill out the template with your server and application data. Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. Your import file @@ -915,10 +926,10 @@ end stop_data_collection_by_agent_ids(agent_ids) stop_data_collection_by_agent_ids(agent_ids, params::Dict{String,<:Any}) -Instructs the specified agents or connectors to stop collecting data. +Instructs the specified agents to stop collecting data. # Arguments -- `agent_ids`: The IDs of the agents or connectors from which to stop collecting data. +- `agent_ids`: The IDs of the agents from which to stop collecting data. """ function stop_data_collection_by_agent_ids( diff --git a/src/services/appstream.jl b/src/services/appstream.jl index 1f15795c3f..eba7e68aad 100644 --- a/src/services/appstream.jl +++ b/src/services/appstream.jl @@ -4,6 +4,52 @@ using AWS.AWSServices: appstream using AWS.Compat using AWS.UUIDs +""" + associate_app_block_builder_app_block(app_block_arn, app_block_builder_name) + associate_app_block_builder_app_block(app_block_arn, app_block_builder_name, params::Dict{String,<:Any}) + +Associates the specified app block builder with the specified app block. + +# Arguments +- `app_block_arn`: The ARN of the app block. +- `app_block_builder_name`: The name of the app block builder. + +""" +function associate_app_block_builder_app_block( + AppBlockArn, AppBlockBuilderName; aws_config::AbstractAWSConfig=global_aws_config() +) + return appstream( + "AssociateAppBlockBuilderAppBlock", + Dict{String,Any}( + "AppBlockArn" => AppBlockArn, "AppBlockBuilderName" => AppBlockBuilderName + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function associate_app_block_builder_app_block( + AppBlockArn, + AppBlockBuilderName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appstream( + "AssociateAppBlockBuilderAppBlock", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "AppBlockArn" => AppBlockArn, + "AppBlockBuilderName" => AppBlockBuilderName, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ associate_application_fleet(application_arn, fleet_name) associate_application_fleet(application_arn, fleet_name, params::Dict{String,<:Any}) @@ -284,8 +330,8 @@ function copy_image( end """ - create_app_block(name, setup_script_details, source_s3_location) - create_app_block(name, setup_script_details, source_s3_location, params::Dict{String,<:Any}) + create_app_block(name, source_s3_location) + create_app_block(name, source_s3_location, params::Dict{String,<:Any}) Creates an app block. App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with @@ -296,48 +342,124 @@ fleets. # Arguments - `name`: The name of the app block. -- `setup_script_details`: The setup script details of the app block. - `source_s3_location`: The source S3 location of the app block. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"Description"`: The description of the app block. - `"DisplayName"`: The display name of the app block. This is not displayed to the user. +- `"PackagingType"`: The packaging type of the app block. +- `"PostSetupScriptDetails"`: The post setup script details of the app block. This can only + be provided for the APPSTREAM2 PackagingType. +- `"SetupScriptDetails"`: The setup script details of the app block. This must be provided + for the CUSTOM PackagingType. - `"Tags"`: The tags assigned to the app block. """ +function create_app_block( + Name, SourceS3Location; aws_config::AbstractAWSConfig=global_aws_config() +) + return appstream( + "CreateAppBlock", + Dict{String,Any}("Name" => Name, "SourceS3Location" => SourceS3Location); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end function create_app_block( Name, - SetupScriptDetails, - SourceS3Location; + SourceS3Location, + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config(), ) return appstream( "CreateAppBlock", Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}("Name" => Name, "SourceS3Location" => SourceS3Location), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + create_app_block_builder(instance_type, name, platform, vpc_config) + create_app_block_builder(instance_type, name, platform, vpc_config, params::Dict{String,<:Any}) + +Creates an app block builder. + +# Arguments +- `instance_type`: The instance type to use when launching the app block builder. The + following instance types are available: stream.standard.small stream.standard.medium + stream.standard.large stream.standard.xlarge stream.standard.2xlarge +- `name`: The unique name for the app block builder. +- `platform`: The platform of the app block builder. WINDOWS_SERVER_2019 is the only valid + value. +- `vpc_config`: The VPC configuration for the app block builder. App block builders require + that you specify at least two subnets in different availability zones. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"AccessEndpoints"`: The list of interface VPC endpoint (interface endpoint) objects. + Administrators can connect to the app block builder only through the specified endpoints. +- `"Description"`: The description of the app block builder. +- `"DisplayName"`: The display name of the app block builder. +- `"EnableDefaultInternetAccess"`: Enables or disables default internet access for the app + block builder. +- `"IamRoleArn"`: The Amazon Resource Name (ARN) of the IAM role to apply to the app block + builder. To assume a role, the app block builder calls the AWS Security Token Service (STS) + AssumeRole API operation and passes the ARN of the role to use. The operation creates a new + session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and + creates the appstream_machine_role credential profile on the instance. For more + information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running + on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide. +- `"Tags"`: The tags to associate with the app block builder. A tag is a key-value pair, + and the value is optional. For example, Environment=Test. If you do not specify a value, + Environment=. If you do not specify a value, the value is set to an empty string. + Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and + the following special characters: _ . : / = + - @ For more information, see Tagging Your + Resources in the Amazon AppStream 2.0 Administration Guide. +""" +function create_app_block_builder( + InstanceType, + Name, + Platform, + VpcConfig; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appstream( + "CreateAppBlockBuilder", + Dict{String,Any}( + "InstanceType" => InstanceType, "Name" => Name, - "SetupScriptDetails" => SetupScriptDetails, - "SourceS3Location" => SourceS3Location, + "Platform" => Platform, + "VpcConfig" => VpcConfig, ); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) end -function create_app_block( +function create_app_block_builder( + InstanceType, Name, - SetupScriptDetails, - SourceS3Location, + Platform, + VpcConfig, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config(), ) return appstream( - "CreateAppBlock", + "CreateAppBlockBuilder", Dict{String,Any}( mergewith( _merge, Dict{String,Any}( + "InstanceType" => InstanceType, "Name" => Name, - "SetupScriptDetails" => SetupScriptDetails, - "SourceS3Location" => SourceS3Location, + "Platform" => Platform, + "VpcConfig" => VpcConfig, ), params, ), @@ -347,6 +469,49 @@ function create_app_block( ) end +""" + create_app_block_builder_streaming_url(app_block_builder_name) + create_app_block_builder_streaming_url(app_block_builder_name, params::Dict{String,<:Any}) + +Creates a URL to start a create app block builder streaming session. + +# Arguments +- `app_block_builder_name`: The name of the app block builder. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"Validity"`: The time that the streaming URL will be valid, in seconds. Specify a value + between 1 and 604800 seconds. The default is 3600 seconds. +""" +function create_app_block_builder_streaming_url( + AppBlockBuilderName; aws_config::AbstractAWSConfig=global_aws_config() +) + return appstream( + "CreateAppBlockBuilderStreamingURL", + Dict{String,Any}("AppBlockBuilderName" => AppBlockBuilderName); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function create_app_block_builder_streaming_url( + AppBlockBuilderName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appstream( + "CreateAppBlockBuilderStreamingURL", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}("AppBlockBuilderName" => AppBlockBuilderName), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ create_application(app_block_arn, icon_s3_location, instance_families, launch_path, name, platforms) create_application(app_block_arn, icon_s3_location, instance_families, launch_path, name, platforms, params::Dict{String,<:Any}) @@ -1103,6 +1268,36 @@ function delete_app_block( ) end +""" + delete_app_block_builder(name) + delete_app_block_builder(name, params::Dict{String,<:Any}) + +Deletes an app block builder. An app block builder can only be deleted when it has no +association with an app block. + +# Arguments +- `name`: The name of the app block builder. + +""" +function delete_app_block_builder(Name; aws_config::AbstractAWSConfig=global_aws_config()) + return appstream( + "DeleteAppBlockBuilder", + Dict{String,Any}("Name" => Name); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function delete_app_block_builder( + Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return appstream( + "DeleteAppBlockBuilder", + Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params)); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ delete_application(name) delete_application(name, params::Dict{String,<:Any}) @@ -1442,6 +1637,69 @@ function delete_user( ) end +""" + describe_app_block_builder_app_block_associations() + describe_app_block_builder_app_block_associations(params::Dict{String,<:Any}) + +Retrieves a list that describes one or more app block builder associations. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"AppBlockArn"`: The ARN of the app block. +- `"AppBlockBuilderName"`: The name of the app block builder. +- `"MaxResults"`: The maximum size of each page of results. +- `"NextToken"`: The pagination token used to retrieve the next page of results for this + operation. +""" +function describe_app_block_builder_app_block_associations(; + aws_config::AbstractAWSConfig=global_aws_config() +) + return appstream( + "DescribeAppBlockBuilderAppBlockAssociations"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function describe_app_block_builder_app_block_associations( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return appstream( + "DescribeAppBlockBuilderAppBlockAssociations", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + describe_app_block_builders() + describe_app_block_builders(params::Dict{String,<:Any}) + +Retrieves a list that describes one or more app block builders. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"MaxResults"`: The maximum size of each page of results. The maximum value is 25. +- `"Names"`: The names of the app block builders. +- `"NextToken"`: The pagination token used to retrieve the next page of results for this + operation. +""" +function describe_app_block_builders(; aws_config::AbstractAWSConfig=global_aws_config()) + return appstream( + "DescribeAppBlockBuilders"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET + ) +end +function describe_app_block_builders( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return appstream( + "DescribeAppBlockBuilders", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ describe_app_blocks() describe_app_blocks(params::Dict{String,<:Any}) @@ -1969,6 +2227,52 @@ function disable_user( ) end +""" + disassociate_app_block_builder_app_block(app_block_arn, app_block_builder_name) + disassociate_app_block_builder_app_block(app_block_arn, app_block_builder_name, params::Dict{String,<:Any}) + +Disassociates a specified app block builder from a specified app block. + +# Arguments +- `app_block_arn`: The ARN of the app block. +- `app_block_builder_name`: The name of the app block builder. + +""" +function disassociate_app_block_builder_app_block( + AppBlockArn, AppBlockBuilderName; aws_config::AbstractAWSConfig=global_aws_config() +) + return appstream( + "DisassociateAppBlockBuilderAppBlock", + Dict{String,Any}( + "AppBlockArn" => AppBlockArn, "AppBlockBuilderName" => AppBlockBuilderName + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function disassociate_app_block_builder_app_block( + AppBlockArn, + AppBlockBuilderName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appstream( + "DisassociateAppBlockBuilderAppBlock", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "AppBlockArn" => AppBlockArn, + "AppBlockBuilderName" => AppBlockBuilderName, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ disassociate_application_fleet(application_arn, fleet_name) disassociate_application_fleet(application_arn, fleet_name, params::Dict{String,<:Any}) @@ -2353,6 +2657,37 @@ function list_tags_for_resource( ) end +""" + start_app_block_builder(name) + start_app_block_builder(name, params::Dict{String,<:Any}) + +Starts an app block builder. An app block builder can only be started when it's associated +with an app block. Starting an app block builder starts a new instance, which is equivalent +to an elastic fleet instance with application builder assistance functionality. + +# Arguments +- `name`: The name of the app block builder. + +""" +function start_app_block_builder(Name; aws_config::AbstractAWSConfig=global_aws_config()) + return appstream( + "StartAppBlockBuilder", + Dict{String,Any}("Name" => Name); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function start_app_block_builder( + Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return appstream( + "StartAppBlockBuilder", + Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params)); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ start_fleet(name) start_fleet(name, params::Dict{String,<:Any}) @@ -2415,6 +2750,36 @@ function start_image_builder( ) end +""" + stop_app_block_builder(name) + stop_app_block_builder(name, params::Dict{String,<:Any}) + +Stops an app block builder. Stopping an app block builder terminates the instance, and the +instance state is not persisted. + +# Arguments +- `name`: The name of the app block builder. + +""" +function stop_app_block_builder(Name; aws_config::AbstractAWSConfig=global_aws_config()) + return appstream( + "StopAppBlockBuilder", + Dict{String,Any}("Name" => Name); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function stop_app_block_builder( + Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return appstream( + "StopAppBlockBuilder", + Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params)); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ stop_fleet(name) stop_fleet(name, params::Dict{String,<:Any}) @@ -2564,6 +2929,61 @@ function untag_resource( ) end +""" + update_app_block_builder(name) + update_app_block_builder(name, params::Dict{String,<:Any}) + +Updates an app block builder. If the app block builder is in the STARTING or STOPPING +state, you can't update it. If the app block builder is in the RUNNING state, you can only +update the DisplayName and Description. If the app block builder is in the STOPPED state, +you can update any attribute except the Name. + +# Arguments +- `name`: The unique name for the app block builder. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"AccessEndpoints"`: The list of interface VPC endpoint (interface endpoint) objects. + Administrators can connect to the app block builder only through the specified endpoints. +- `"AttributesToDelete"`: The attributes to delete from the app block builder. +- `"Description"`: The description of the app block builder. +- `"DisplayName"`: The display name of the app block builder. +- `"EnableDefaultInternetAccess"`: Enables or disables default internet access for the app + block builder. +- `"IamRoleArn"`: The Amazon Resource Name (ARN) of the IAM role to apply to the app block + builder. To assume a role, the app block builder calls the AWS Security Token Service (STS) + AssumeRole API operation and passes the ARN of the role to use. The operation creates a new + session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and + creates the appstream_machine_role credential profile on the instance. For more + information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running + on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide. +- `"InstanceType"`: The instance type to use when launching the app block builder. The + following instance types are available: stream.standard.small stream.standard.medium + stream.standard.large stream.standard.xlarge stream.standard.2xlarge +- `"Platform"`: The platform of the app block builder. WINDOWS_SERVER_2019 is the only + valid value. +- `"VpcConfig"`: The VPC configuration for the app block builder. App block builders + require that you specify at least two subnets in different availability zones. +""" +function update_app_block_builder(Name; aws_config::AbstractAWSConfig=global_aws_config()) + return appstream( + "UpdateAppBlockBuilder", + Dict{String,Any}("Name" => Name); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function update_app_block_builder( + Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return appstream( + "UpdateAppBlockBuilder", + Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params)); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ update_application(name) update_application(name, params::Dict{String,<:Any}) @@ -2778,7 +3198,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys remain active, in seconds. 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. Specify a value between 600 and 360000. + new instance. Specify a value between 600 and 432000. - `"Name"`: A unique name for the fleet. - `"Platform"`: The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets. diff --git a/src/services/auditmanager.jl b/src/services/auditmanager.jl index 6b33ae45a8..c24660a730 100644 --- a/src/services/auditmanager.jl +++ b/src/services/auditmanager.jl @@ -238,15 +238,15 @@ end batch_import_evidence_to_assessment_control(assessment_id, control_id, control_set_id, manual_evidence) batch_import_evidence_to_assessment_control(assessment_id, control_id, control_set_id, manual_evidence, params::Dict{String,<:Any}) -Uploads one or more pieces of evidence to a control in an Audit Manager assessment. You can -upload manual evidence from any Amazon Simple Storage Service (Amazon S3) bucket by -specifying the S3 URI of the evidence. You must upload manual evidence to your S3 bucket -before you can upload it to your assessment. For instructions, see CreateBucket and -PutObject in the Amazon Simple Storage Service API Reference. The following restrictions -apply to this action: Maximum size of an individual evidence file: 100 MB Number of -daily manual evidence uploads per control: 100 Supported file formats: See Supported file -types for manual evidence in the Audit Manager User Guide For more information about -Audit Manager service restrictions, see Quotas and restrictions for Audit Manager. +Adds one or more pieces of evidence to a control in an Audit Manager assessment. You can +import manual evidence from any S3 bucket by specifying the S3 URI of the object. You can +also upload a file from your browser, or enter plain text in response to a risk assessment +question. The following restrictions apply to this action: manualEvidence can be only +one of the following: evidenceFileName, s3ResourcePath, or textResponse Maximum size of +an individual evidence file: 100 MB Number of daily manual evidence uploads per control: +100 Supported file formats: See Supported file types for manual evidence in the Audit +Manager User Guide For more information about Audit Manager service restrictions, see +Quotas and restrictions for Audit Manager. # Arguments - `assessment_id`: The identifier for the assessment. @@ -671,7 +671,11 @@ end delete_control(control_id) delete_control(control_id, params::Dict{String,<:Any}) - Deletes a custom control in Audit Manager. + Deletes a custom control in Audit Manager. When you invoke this operation, the custom +control is deleted from any frameworks or assessments that it’s currently part of. As a +result, Audit Manager will stop collecting evidence for that custom control in all of your +assessments. This includes assessments that you previously created before you deleted the +custom control. # Arguments - `control_id`: The unique identifier for the control. @@ -838,7 +842,7 @@ end get_account_status() get_account_status(params::Dict{String,<:Any}) - Returns the registration status of an account in Audit Manager. + Gets the registration status of an account in Audit Manager. """ function get_account_status(; aws_config::AbstractAWSConfig=global_aws_config()) @@ -862,7 +866,7 @@ end get_assessment(assessment_id) get_assessment(assessment_id, params::Dict{String,<:Any}) -Returns an assessment from Audit Manager. +Gets information about a specified assessment. # Arguments - `assessment_id`: The unique identifier for the assessment. @@ -894,7 +898,7 @@ end get_assessment_framework(framework_id) get_assessment_framework(framework_id, params::Dict{String,<:Any}) -Returns a framework from Audit Manager. +Gets information about a specified framework. # Arguments - `framework_id`: The identifier for the framework. @@ -928,7 +932,7 @@ end get_assessment_report_url(assessment_id, assessment_report_id) get_assessment_report_url(assessment_id, assessment_report_id, params::Dict{String,<:Any}) - Returns the URL of an assessment report in Audit Manager. + Gets the URL of an assessment report in Audit Manager. # Arguments - `assessment_id`: The unique identifier for the assessment. @@ -964,7 +968,7 @@ end get_change_logs(assessment_id) get_change_logs(assessment_id, params::Dict{String,<:Any}) - Returns a list of changelogs from Audit Manager. + Gets a list of changelogs from Audit Manager. # Arguments - `assessment_id`: The unique identifier for the assessment. @@ -1003,7 +1007,7 @@ end get_control(control_id) get_control(control_id, params::Dict{String,<:Any}) - Returns a control from Audit Manager. + Gets information about a specified control. # Arguments - `control_id`: The identifier for the control. @@ -1035,7 +1039,7 @@ end get_delegations() get_delegations(params::Dict{String,<:Any}) - Returns a list of delegations from an audit owner to a delegate. + Gets a list of delegations from an audit owner to a delegate. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -1064,7 +1068,7 @@ end get_evidence(assessment_id, control_set_id, evidence_folder_id, evidence_id) get_evidence(assessment_id, control_set_id, evidence_folder_id, evidence_id, params::Dict{String,<:Any}) - Returns evidence from Audit Manager. + Gets information about a specified evidence item. # Arguments - `assessment_id`: The unique identifier for the assessment. @@ -1109,7 +1113,7 @@ end get_evidence_by_evidence_folder(assessment_id, control_set_id, evidence_folder_id) get_evidence_by_evidence_folder(assessment_id, control_set_id, evidence_folder_id, params::Dict{String,<:Any}) - Returns all evidence from a specified evidence folder in Audit Manager. + Gets all evidence from a specified evidence folder in Audit Manager. # Arguments - `assessment_id`: The identifier for the assessment. @@ -1152,11 +1156,55 @@ function get_evidence_by_evidence_folder( ) end +""" + get_evidence_file_upload_url(file_name) + get_evidence_file_upload_url(file_name, params::Dict{String,<:Any}) + +Creates a presigned Amazon S3 URL that can be used to upload a file as manual evidence. For +instructions on how to use this operation, see Upload a file from your browser in the +Audit Manager User Guide. The following restrictions apply to this operation: Maximum +size of an individual evidence file: 100 MB Number of daily manual evidence uploads per +control: 100 Supported file formats: See Supported file types for manual evidence in the +Audit Manager User Guide For more information about Audit Manager service restrictions, +see Quotas and restrictions for Audit Manager. + +# Arguments +- `file_name`: The file that you want to upload. For a list of supported file formats, see + Supported file types for manual evidence in the Audit Manager User Guide. + +""" +function get_evidence_file_upload_url( + fileName; aws_config::AbstractAWSConfig=global_aws_config() +) + return auditmanager( + "GET", + "/evidenceFileUploadUrl", + Dict{String,Any}("fileName" => fileName); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_evidence_file_upload_url( + fileName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return auditmanager( + "GET", + "/evidenceFileUploadUrl", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("fileName" => fileName), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ get_evidence_folder(assessment_id, control_set_id, evidence_folder_id) get_evidence_folder(assessment_id, control_set_id, evidence_folder_id, params::Dict{String,<:Any}) - Returns an evidence folder from the specified assessment in Audit Manager. + Gets an evidence folder from a specified assessment in Audit Manager. # Arguments - `assessment_id`: The unique identifier for the assessment. @@ -1198,7 +1246,7 @@ end get_evidence_folders_by_assessment(assessment_id) get_evidence_folders_by_assessment(assessment_id, params::Dict{String,<:Any}) - Returns the evidence folders from a specified assessment in Audit Manager. + Gets the evidence folders from a specified assessment in Audit Manager. # Arguments - `assessment_id`: The unique identifier for the assessment. @@ -1237,8 +1285,8 @@ end get_evidence_folders_by_assessment_control(assessment_id, control_id, control_set_id) get_evidence_folders_by_assessment_control(assessment_id, control_id, control_set_id, params::Dict{String,<:Any}) - Returns a list of evidence folders that are associated with a specified control in an -Audit Manager assessment. + Gets a list of evidence folders that are associated with a specified control in an Audit +Manager assessment. # Arguments - `assessment_id`: The identifier for the assessment. @@ -1335,7 +1383,7 @@ end get_organization_admin_account() get_organization_admin_account(params::Dict{String,<:Any}) - Returns the name of the delegated Amazon Web Services administrator account for the + Gets the name of the delegated Amazon Web Services administrator account for a specified organization. """ @@ -1363,7 +1411,7 @@ end get_services_in_scope() get_services_in_scope(params::Dict{String,<:Any}) -Returns a list of all of the Amazon Web Services that you can choose to include in your +Gets a list of all of the Amazon Web Services that you can choose to include in your assessment. When you create an assessment, specify which of these services you want to include to narrow the assessment's scope. @@ -1385,7 +1433,7 @@ end get_settings(attribute) get_settings(attribute, params::Dict{String,<:Any}) - Returns the settings for the specified Amazon Web Services account. + Gets the settings for a specified Amazon Web Services account. # Arguments - `attribute`: The list of setting attribute enum values. @@ -2435,8 +2483,10 @@ end # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"defaultAssessmentReportsDestination"`: The default storage destination for assessment - reports. +- `"defaultAssessmentReportsDestination"`: The default S3 destination bucket for storing + assessment reports. +- `"defaultExportDestination"`: The default S3 destination bucket for storing evidence + finder exports. - `"defaultProcessOwners"`: A list of the default audit owners. - `"deregistrationPolicy"`: The deregistration policy for your Audit Manager data. You can use this attribute to determine how your data is handled when you deregister Audit Manager. diff --git a/src/services/batch.jl b/src/services/batch.jl index ea6bb61249..2b2024a8eb 100644 --- a/src/services/batch.jl +++ b/src/services/batch.jl @@ -10,9 +10,13 @@ using AWS.UUIDs Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED or PENDING are canceled. A job inRUNNABLE remains in RUNNABLE until it reaches the head of the job queue. -Then the job status is updated to FAILED. Jobs that progressed to the STARTING or RUNNING -state aren't canceled. However, the API operation still succeeds, even if no job is -canceled. These jobs must be terminated with the TerminateJob operation. +Then the job status is updated to FAILED. A PENDING job is canceled after all dependency +jobs are completed. Therefore, it may take longer than expected to cancel a job in PENDING +status. When you try to cancel an array parent job in PENDING, Batch attempts to cancel all +child jobs. The array parent job is canceled when all child jobs are completed. Jobs that +progressed to the STARTING or RUNNING state aren't canceled. However, the API operation +still succeeds, even if no job is canceled. These jobs must be terminated with the +TerminateJob operation. # Arguments - `job_id`: The Batch job ID of the job to cancel. @@ -88,11 +92,13 @@ updating of compute environments to update AMIs, follow these rules: Either do service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role. Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE or SPOT_CAPACITY_OPTIMIZED. Set the update to latest image version -(updateToLatestImageVersion) parameter to true. Don't specify an AMI ID in imageId, -imageIdOverride (in ec2Configuration ), or in the launch template (launchTemplate). In -that case, Batch selects the latest Amazon ECS optimized AMI that's supported by Batch at -the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID -in the imageId or imageIdOverride parameters, or the launch template identified by the +(updateToLatestImageVersion) parameter to true. The updateToLatestImageVersion parameter is +used when you update a compute environment. This parameter is ignored when you create a +compute environment. Don't specify an AMI ID in imageId, imageIdOverride (in +ec2Configuration ), or in the launch template (launchTemplate). In that case, Batch selects +the latest Amazon ECS optimized AMI that's supported by Batch at the time the +infrastructure update is initiated. Alternatively, you can specify the AMI ID in the +imageId or imageIdOverride parameters, or the launch template identified by the LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the imageId or imageIdOverride parameters. It can only be @@ -996,9 +1002,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys scheduled before jobs with a lower scheduling priority. This overrides any scheduling priority in the job definition. The minimum supported value is 0 and the maximum supported value is 9999. -- `"shareIdentifier"`: The share identifier for the job. If the job queue doesn't have a - scheduling policy, then this parameter must not be specified. If the job queue has a - scheduling policy, then this parameter must be specified. +- `"shareIdentifier"`: The share identifier for the job. Don't specify this parameter if + the job queue doesn't have a scheduling policy. If the job queue has a scheduling policy, + then this parameter must be specified. This string is limited to 255 alphanumeric + characters, and can be followed by an asterisk (*). - `"tags"`: The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference. diff --git a/src/services/chime.jl b/src/services/chime.jl index cd7d74bd2a..099728e69e 100644 --- a/src/services/chime.jl +++ b/src/services/chime.jl @@ -51,7 +51,11 @@ end associate_phone_numbers_with_voice_connector(e164_phone_numbers, voice_connector_id) associate_phone_numbers_with_voice_connector(e164_phone_numbers, voice_connector_id, params::Dict{String,<:Any}) -Associates phone numbers with the specified Amazon Chime Voice Connector. +Associates phone numbers with the specified Amazon Chime Voice Connector. This API is is +no longer supported and will not be updated. We recommend using the latest version, +AssociatePhoneNumbersWithVoiceConnector, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `e164_phone_numbers`: List of phone numbers, in E.164 format. @@ -97,7 +101,11 @@ end associate_phone_numbers_with_voice_connector_group(e164_phone_numbers, voice_connector_group_id) associate_phone_numbers_with_voice_connector_group(e164_phone_numbers, voice_connector_group_id, params::Dict{String,<:Any}) -Associates phone numbers with the specified Amazon Chime Voice Connector group. +Associates phone numbers with the specified Amazon Chime Voice Connector group. This API +is is no longer supported and will not be updated. We recommend using the latest version, +AssociatePhoneNumbersWithVoiceConnectorGroup, in the Amazon Chime SDK. Using the latest +version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `e164_phone_numbers`: List of phone numbers, in E.164 format. @@ -188,9 +196,12 @@ end batch_create_attendee(attendees, meeting_id) batch_create_attendee(attendees, meeting_id, params::Dict{String,<:Any}) - Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more -information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime -SDK Developer Guide. +Creates up to 100 new attendees for an active Amazon Chime SDK meeting. This API is is no +longer supported and will not be updated. We recommend using the latest version, +BatchCreateAttendee, in the Amazon Chime SDK. Using the latest version requires migrating +to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. For more information about the Amazon +Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide. # Arguments - `attendees`: The request containing the attendees to create. @@ -229,7 +240,11 @@ end batch_create_channel_membership(member_arns, channel_arn) batch_create_channel_membership(member_arns, channel_arn, params::Dict{String,<:Any}) -Adds a specified number of users to a channel. +Adds a specified number of users to a channel. This API is is no longer supported and +will not be updated. We recommend using the latest version, BatchCreateChannelMembership, +in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated +namespace. For more information, refer to Migrating from the Amazon Chime namespace in the +Amazon Chime SDK Developer Guide. # Arguments - `member_arns`: The ARNs of the members you want to add to the channel. @@ -409,9 +424,9 @@ end Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon -Chime Accounts in the account types, in the Amazon Chime Administration Guide. -Previously suspended users who are unsuspended using this action are returned to Registered -status. Users who are not previously suspended are ignored. +Chime Accounts in the account types, in the Amazon Chime Administration Guide. Previously +suspended users who are unsuspended using this action are returned to Registered status. +Users who are not previously suspended are ignored. # Arguments - `user_id_list`: The request containing the user IDs to unsuspend. @@ -580,7 +595,10 @@ end Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the -AWS API Standard. +AWS API Standard. This API is is no longer supported and will not be updated. We +recommend using the latest version, CreateAppInstance, in the Amazon Chime SDK. Using the +latest version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `client_request_token`: The ClientRequestToken of the AppInstance. @@ -630,9 +648,12 @@ end create_app_instance_admin(app_instance_admin_arn, app_instance_arn, params::Dict{String,<:Any}) Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the -following actions. ChannelModerator actions across all channels in the AppInstance. -DeleteChannelMessage actions. Only an AppInstanceUser can be promoted to an -AppInstanceAdmin role. +following actions. This API is is no longer supported and will not be updated. We +recommend using the latest version, CreateAppInstanceAdmin, in the Amazon Chime SDK. Using +the latest version requires migrating to a dedicated namespace. For more information, refer +to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. +ChannelModerator actions across all channels in the AppInstance. DeleteChannelMessage +actions. Only an AppInstanceUser can be promoted to an AppInstanceAdmin role. # Arguments - `app_instance_admin_arn`: The ARN of the administrator of the current AppInstance. @@ -676,7 +697,11 @@ end create_app_instance_user(app_instance_arn, app_instance_user_id, client_request_token, name, params::Dict{String,<:Any}) Creates a user under an Amazon Chime AppInstance. The request consists of a unique -appInstanceUserId and Name for that user. +appInstanceUserId and Name for that user. This API is is no longer supported and will not +be updated. We recommend using the latest version, CreateAppInstanceUser, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `app_instance_arn`: The ARN of the AppInstance request. @@ -743,7 +768,10 @@ end Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer -Guide. +Guide. This API is is no longer supported and will not be updated. We recommend using +the latest version, CreateAttendee, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `external_user_id`: The Amazon Chime SDK external user ID. An idempotency token. Links @@ -830,7 +858,11 @@ end Creates a channel to which you can add users and send messages. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the -AppInstanceUserArn of the user that makes the API call as the value in the header. +AppInstanceUserArn of the user that makes the API call as the value in the header. This +API is is no longer supported and will not be updated. We recommend using the latest +version, CreateChannel, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `app_instance_arn`: The ARN of the channel request. @@ -902,7 +934,10 @@ To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembers are cleaned up when you delete users or channels. If you ban a user who is already part of a channel, that user is automatically kicked from the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call -as the value in the header. +as the value in the header. This API is is no longer supported and will not be updated. +We recommend using the latest version, CreateChannelBan, in the Amazon Chime SDK. Using the +latest version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `member_arn`: The ARN of the member being banned. @@ -950,7 +985,11 @@ messages Leave the channel Privacy settings impact this action as follows: Channels: You do not need to be a member to list messages, but you must be a member to send messages. Private Channels: You must be a member to list or send messages. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that -makes the API call as the value in the header. +makes the API call as the value in the header. This API is is no longer supported and +will not be updated. We recommend using the latest version, CreateChannelMembership, in the +Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For +more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime +SDK Developer Guide. # Arguments - `member_arn`: The ARN of the member you want to add to the channel. @@ -1003,7 +1042,11 @@ Creates a new ChannelModerator. A channel moderator can: Add and remove other the channel. Add and remove other moderators of the channel. Add and remove user bans for the channel. Redact messages in the channel. List messages in the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that -makes the API call as the value in the header. +makes the API call as the value in the header. This API is is no longer supported and +will not be updated. We recommend using the latest version, CreateChannelModerator, in the +Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For +more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime +SDK Developer Guide. # Arguments - `channel_moderator_arn`: The ARN of the moderator. @@ -1049,7 +1092,11 @@ end create_media_capture_pipeline(sink_arn, sink_type, source_arn, source_type) create_media_capture_pipeline(sink_arn, sink_type, source_arn, source_type, params::Dict{String,<:Any}) -Creates a media capture pipeline. +Creates a media capture pipeline. This API is is no longer supported and will not be +updated. We recommend using the latest version, CreateMediaCapturePipeline, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `sink_arn`: The ARN of the sink type. @@ -1120,10 +1167,14 @@ end create_meeting(client_request_token) create_meeting(client_request_token, params::Dict{String,<:Any}) - Creates a new Amazon Chime SDK meeting in the specified media Region with no initial +Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime SDK Developer Guide . For more information about the Amazon -Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide . +Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide. This +API is is no longer supported and will not be updated. We recommend using the latest +version, CreateMeeting, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `client_request_token`: The unique identifier for the client request. Use a different @@ -1180,6 +1231,7 @@ forth) to initiate an outbound call to a public switched telephone network (PSTN them into a Chime meeting. Also ensures that the From number belongs to the customer. To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action with the corresponding SIP media application ID. +This API is is not available in a dedicated namespace. # Arguments - `from_phone_number`: Phone number used as the caller ID when the remote party receives a @@ -1243,7 +1295,11 @@ end Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see -Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide . +Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide . This API is is no +longer supported and will not be updated. We recommend using the latest version, +CreateMeetingWithAttendees, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `client_request_token`: The unique identifier for the client request. Use a different @@ -1347,7 +1403,10 @@ end create_proxy_session(capabilities, participant_phone_numbers, voice_connector_id, params::Dict{String,<:Any}) Creates a proxy session on the specified Amazon Chime Voice Connector for the specified -participant phone numbers. +participant phone numbers. This API is is no longer supported and will not be updated. We +recommend using the latest version, CreateProxySession, in the Amazon Chime SDK. Using the +latest version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `capabilities`: The proxy session capabilities. @@ -1500,7 +1559,11 @@ end create_sip_media_application(aws_region, endpoints, name) create_sip_media_application(aws_region, endpoints, name, params::Dict{String,<:Any}) -Creates a SIP media application. +Creates a SIP media application. This API is is no longer supported and will not be +updated. We recommend using the latest version, CreateSipMediaApplication, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `aws_region`: The AWS Region assigned to the SIP media application. @@ -1551,7 +1614,11 @@ end create_sip_media_application_call(from_phone_number, to_phone_number, sip_media_application_id, params::Dict{String,<:Any}) 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. +and it invokes the endpoint of the specified sipMediaApplicationId. This API is is no +longer supported and will not be updated. We recommend using the latest version, +CreateSipMediaApplicationCall, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `from_phone_number`: The phone number that a user calls from. This is a phone number in @@ -1608,7 +1675,10 @@ end create_sip_rule(name, target_applications, trigger_type, trigger_value, params::Dict{String,<:Any}) Creates a SIP rule which can be used to run a SIP media application as a target for a -specific trigger type. +specific trigger type. This API is is no longer supported and will not be updated. We +recommend using the latest version, CreateSipRule, in the Amazon Chime SDK. Using the +latest version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `name`: The name of the SIP rule. @@ -1718,10 +1788,14 @@ end create_voice_connector(name, require_encryption, params::Dict{String,<:Any}) Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can -choose to create an Amazon Chime Voice Connector in a specific AWS Region. Enabling +choose to create an Amazon Chime Voice Connector in a specific AWS Region. Enabling CreateVoiceConnectorRequestRequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use -TLS transport, and unencrypted outbound calls are blocked. +TLS transport, and unencrypted outbound calls are blocked. This API is is no longer +supported and will not be updated. We recommend using the latest version, +CreateVoiceConnector, in the Amazon Chime SDK. Using the latest version requires migrating +to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Arguments - `name`: The name of the Amazon Chime Voice Connector. @@ -1773,7 +1847,11 @@ Creates an Amazon Chime Voice Connector group under the administrator's AWS acco can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request. You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for -fallback in case of availability events. +fallback in case of availability events. This API is is no longer supported and will not +be updated. We recommend using the latest version, CreateVoiceConnectorGroup, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `name`: The name of the Amazon Chime Voice Connector group. @@ -1847,7 +1925,11 @@ end delete_app_instance(app_instance_arn) delete_app_instance(app_instance_arn, params::Dict{String,<:Any}) -Deletes an AppInstance and all associated data asynchronously. +Deletes an AppInstance and all associated data asynchronously. This API is is no longer +supported and will not be updated. We recommend using the latest version, +DeleteAppInstance, in the Amazon Chime SDK. Using the latest version requires migrating to +a dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Arguments - `app_instance_arn`: The ARN of the AppInstance. @@ -1882,6 +1964,10 @@ end delete_app_instance_admin(app_instance_admin_arn, app_instance_arn, params::Dict{String,<:Any}) Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user. +This API is is no longer supported and will not be updated. We recommend using the latest +version, DeleteAppInstanceAdmin, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `app_instance_admin_arn`: The ARN of the AppInstance's administrator. @@ -1917,7 +2003,11 @@ end delete_app_instance_streaming_configurations(app_instance_arn) delete_app_instance_streaming_configurations(app_instance_arn, params::Dict{String,<:Any}) -Deletes the streaming configurations of an AppInstance. +Deletes the streaming configurations of an AppInstance. This API is is no longer +supported and will not be updated. We recommend using the latest version, +DeleteAppInstanceStreamingConfigurations, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `app_instance_arn`: The ARN of the streaming configurations being deleted. @@ -1951,7 +2041,10 @@ end delete_app_instance_user(app_instance_user_arn) delete_app_instance_user(app_instance_user_arn, params::Dict{String,<:Any}) -Deletes an AppInstanceUser. +Deletes an AppInstanceUser. This API is is no longer supported and will not be updated. +We recommend using the latest version, DeleteAppInstanceUser, in the Amazon Chime SDK. +Using the latest version requires migrating to a dedicated namespace. For more information, +refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `app_instance_user_arn`: The ARN of the user request being deleted. @@ -1988,7 +2081,10 @@ end Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the -Amazon Chime SDK Developer Guide. +Amazon Chime SDK Developer Guide. This API is is no longer supported and will not be +updated. We recommend using the latest version, DeleteAttendee, in the Amazon Chime SDK. +Using the latest version requires migrating to a dedicated namespace. For more information, +refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `attendee_id`: The Amazon Chime SDK attendee ID. @@ -2027,6 +2123,10 @@ end Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. +This API is is no longer supported and will not be updated. We recommend using the latest +version, DeleteChannel, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `channel_arn`: The ARN of the channel being deleted. @@ -2063,7 +2163,10 @@ end Removes a user from a channel's ban list. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in -the header. +the header. This API is is no longer supported and will not be updated. We recommend +using the latest version, DeleteChannelBan, in the Amazon Chime SDK. Using the latest +version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `channel_arn`: The ARN of the channel from which the AppInstanceUser was banned. @@ -2104,6 +2207,10 @@ end Removes a member from a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. +This API is is no longer supported and will not be updated. We recommend using the latest +version, DeleteChannelMembership, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `channel_arn`: The ARN of the channel from which you want to remove the user. @@ -2145,7 +2252,11 @@ end Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage. The x-amz-chime-bearer request header is mandatory. Use the -AppInstanceUserArn of the user that makes the API call as the value in the header. +AppInstanceUserArn of the user that makes the API call as the value in the header. This +API is is no longer supported and will not be updated. We recommend using the latest +version, DeleteChannelMessage, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `channel_arn`: The ARN of the channel. @@ -2185,7 +2296,11 @@ end delete_channel_moderator(channel_arn, channel_moderator_arn, params::Dict{String,<:Any}) Deletes a channel moderator. The x-amz-chime-bearer request header is mandatory. Use the -AppInstanceUserArn of the user that makes the API call as the value in the header. +AppInstanceUserArn of the user that makes the API call as the value in the header. This +API is is no longer supported and will not be updated. We recommend using the latest +version, DeleteChannelModerator, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `channel_arn`: The ARN of the channel. @@ -2260,7 +2375,11 @@ end delete_media_capture_pipeline(media_pipeline_id) delete_media_capture_pipeline(media_pipeline_id, params::Dict{String,<:Any}) -Deletes the media capture pipeline. +Deletes the media capture pipeline. This API is is no longer supported and will not be +updated. We recommend using the latest version, DeleteMediaCapturePipeline, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `media_pipeline_id`: The ID of the media capture pipeline being deleted. @@ -2297,7 +2416,10 @@ end Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime -SDK Developer Guide. +SDK Developer Guide. This API is is no longer supported and will not be updated. We +recommend using the latest version, DeleteMeeting, in the Amazon Chime SDK. Using the +latest version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `meeting_id`: The Amazon Chime SDK meeting ID. @@ -2366,7 +2488,11 @@ end delete_proxy_session(proxy_session_id, voice_connector_id) delete_proxy_session(proxy_session_id, voice_connector_id, params::Dict{String,<:Any}) -Deletes the specified proxy session from the specified Amazon Chime Voice Connector. +Deletes the specified proxy session from the specified Amazon Chime Voice Connector. This +API is is no longer supported and will not be updated. We recommend using the latest +version, DeleteProxySession, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `proxy_session_id`: The proxy session ID. @@ -2474,7 +2600,11 @@ end delete_sip_media_application(sip_media_application_id) delete_sip_media_application(sip_media_application_id, params::Dict{String,<:Any}) -Deletes a SIP media application. +Deletes a SIP media application. This API is is no longer supported and will not be +updated. We recommend using the latest version, DeleteSipMediaApplication, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `sip_media_application_id`: The SIP media application ID. @@ -2508,7 +2638,11 @@ end delete_sip_rule(sip_rule_id) delete_sip_rule(sip_rule_id, params::Dict{String,<:Any}) -Deletes a SIP rule. You must disable a SIP rule before you can delete it. +Deletes a SIP rule. You must disable a SIP rule before you can delete it. This API is is +no longer supported and will not be updated. We recommend using the latest version, +DeleteSipRule, in the Amazon Chime SDK. Using the latest version requires migrating to a +dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Arguments - `sip_rule_id`: The SIP rule ID. @@ -2541,7 +2675,11 @@ end delete_voice_connector(voice_connector_id, params::Dict{String,<:Any}) Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the -Amazon Chime Voice Connector must be disassociated from it before it can be deleted. +Amazon Chime Voice Connector must be disassociated from it before it can be deleted. This +API is is no longer supported and will not be updated. We recommend using the latest +version, DeleteVoiceConnector, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime Voice Connector ID. @@ -2576,7 +2714,11 @@ end delete_voice_connector_emergency_calling_configuration(voice_connector_id, params::Dict{String,<:Any}) Deletes the emergency calling configuration details from the specified Amazon Chime Voice -Connector. +Connector. This API is is no longer supported and will not be updated. We recommend using +the latest version, DeleteVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime +SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime Voice Connector ID. @@ -2611,7 +2753,11 @@ end delete_voice_connector_group(voice_connector_group_id, params::Dict{String,<:Any}) Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone -numbers associated with the group must be removed before it can be deleted. +numbers associated with the group must be removed before it can be deleted. This API is +is no longer supported and will not be updated. We recommend using the latest version, +DeleteVoiceConnectorGroup, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `voice_connector_group_id`: The Amazon Chime Voice Connector group ID. @@ -2647,7 +2793,11 @@ end Deletes the origination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted -prior to deleting the origination settings. +prior to deleting the origination settings. This API is is no longer supported and will +not be updated. We recommend using the latest version, DeleteVoiceConnectorOrigination, in +the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. +For more information, refer to Migrating from the Amazon Chime namespace in the Amazon +Chime SDK Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime Voice Connector ID. @@ -2681,7 +2831,11 @@ end delete_voice_connector_proxy(voice_connector_id) delete_voice_connector_proxy(voice_connector_id, params::Dict{String,<:Any}) -Deletes the proxy configuration from the specified Amazon Chime Voice Connector. +Deletes the proxy configuration from the specified Amazon Chime Voice Connector. This API +is is no longer supported and will not be updated. We recommend using the latest version, +DeleteVoiceProxy, in the Amazon Chime SDK. Using the latest version requires migrating to a +dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime Voice Connector ID. @@ -2715,7 +2869,11 @@ end delete_voice_connector_streaming_configuration(voice_connector_id) delete_voice_connector_streaming_configuration(voice_connector_id, params::Dict{String,<:Any}) -Deletes the streaming configuration for the specified Amazon Chime Voice Connector. +Deletes the streaming configuration for the specified Amazon Chime Voice Connector. This +API is is no longer supported and will not be updated. We recommend using the latest +version, DeleteVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK. Using the +latest version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime Voice Connector ID. @@ -2751,7 +2909,11 @@ end Deletes the termination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted -prior to deleting the termination settings. +prior to deleting the termination settings. This API is is no longer supported and will +not be updated. We recommend using the latest version, DeleteVoiceConnectorTermination, in +the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. +For more information, refer to Migrating from the Amazon Chime namespace in the Amazon +Chime SDK Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime Voice Connector ID. @@ -2786,7 +2948,11 @@ end delete_voice_connector_termination_credentials(usernames, voice_connector_id, params::Dict{String,<:Any}) Deletes the specified SIP credentials used by your equipment to authenticate during call -termination. +termination. This API is is no longer supported and will not be updated. We recommend +using the latest version, DeleteVoiceConnectorTerminationCredentials, in the Amazon Chime +SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `usernames`: The RFC2617 compliant username associated with the SIP credentials, in @@ -2826,7 +2992,11 @@ end describe_app_instance(app_instance_arn) describe_app_instance(app_instance_arn, params::Dict{String,<:Any}) -Returns the full details of an AppInstance. +Returns the full details of an AppInstance. This API is is no longer supported and will +not be updated. We recommend using the latest version, DescribeAppInstance, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `app_instance_arn`: The ARN of the AppInstance. @@ -2860,7 +3030,11 @@ end describe_app_instance_admin(app_instance_admin_arn, app_instance_arn) describe_app_instance_admin(app_instance_admin_arn, app_instance_arn, params::Dict{String,<:Any}) -Returns the full details of an AppInstanceAdmin. +Returns the full details of an AppInstanceAdmin. This API is is no longer supported and +will not be updated. We recommend using the latest version, DescribeAppInstanceAdmin, in +the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. +For more information, refer to Migrating from the Amazon Chime namespace in the Amazon +Chime SDK Developer Guide. # Arguments - `app_instance_admin_arn`: The ARN of the AppInstanceAdmin. @@ -2896,7 +3070,11 @@ end describe_app_instance_user(app_instance_user_arn) describe_app_instance_user(app_instance_user_arn, params::Dict{String,<:Any}) -Returns the full details of an AppInstanceUser. +Returns the full details of an AppInstanceUser. This API is is no longer supported and +will not be updated. We recommend using the latest version, DescribeAppInstanceUser, in the +Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For +more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime +SDK Developer Guide. # Arguments - `app_instance_user_arn`: The ARN of the AppInstanceUser. @@ -2932,7 +3110,11 @@ end Returns the full details of a channel in an Amazon Chime AppInstance. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that -makes the API call as the value in the header. +makes the API call as the value in the header. This API is is no longer supported and +will not be updated. We recommend using the latest version, DescribeChannel, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `channel_arn`: The ARN of the channel. @@ -2969,7 +3151,10 @@ end Returns the full details of a channel ban. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in -the header. +the header. This API is is no longer supported and will not be updated. We recommend +using the latest version, DescribeChannelBan, in the Amazon Chime SDK. Using the latest +version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `channel_arn`: The ARN of the channel from which the user is banned. @@ -3010,7 +3195,10 @@ end Returns the full details of a user's channel membership. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the -value in the header. +value in the header. This API is is no longer supported and will not be updated. We +recommend using the latest version, DescribeChannelMembership, in the Amazon Chime SDK. +Using the latest version requires migrating to a dedicated namespace. For more information, +refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `channel_arn`: The ARN of the channel. @@ -3051,7 +3239,11 @@ end Returns the details of a channel based on the membership of the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user -that makes the API call as the value in the header. +that makes the API call as the value in the header. This API is is no longer supported +and will not be updated. We recommend using the latest version, +DescribeChannelMembershipForAppInstanceUser, in the Amazon Chime SDK. Using the latest +version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `app-instance-user-arn`: The ARN of the user in a channel. @@ -3099,7 +3291,11 @@ end Returns the full details of a channel moderated by the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that -makes the API call as the value in the header. +makes the API call as the value in the header. This API is is no longer supported and +will not be updated. We recommend using the latest version, +DescribeChannelModeratedByAppInstanceUser, in the Amazon Chime SDK. Using the latest +version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `app-instance-user-arn`: The ARN of the AppInstanceUser in the moderated channel. @@ -3147,7 +3343,10 @@ end Returns the full details of a single ChannelModerator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the -value in the header. +value in the header. This API is is no longer supported and will not be updated. We +recommend using the latest version, DescribeChannelModerator, in the Amazon Chime SDK. +Using the latest version requires migrating to a dedicated namespace. For more information, +refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `channel_arn`: The ARN of the channel. @@ -3223,6 +3422,10 @@ end disassociate_phone_numbers_from_voice_connector(e164_phone_numbers, voice_connector_id, params::Dict{String,<:Any}) Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector. + This API is is no longer supported and will not be updated. We recommend using the latest +version, DisassociatePhoneNumbersFromVoiceConnector, in the Amazon Chime SDK. Using the +latest version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `e164_phone_numbers`: List of phone numbers, in E.164 format. @@ -3264,7 +3467,10 @@ end disassociate_phone_numbers_from_voice_connector_group(e164_phone_numbers, voice_connector_group_id, params::Dict{String,<:Any}) Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector -group. +group. This API is is no longer supported and will not be updated. We recommend using the +latest version, DisassociatePhoneNumbersFromVoiceConnectorGroup, in the Amazon Chime SDK. +Using the latest version requires migrating to a dedicated namespace. For more information, +refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `e164_phone_numbers`: List of phone numbers, in E.164 format. @@ -3413,7 +3619,11 @@ end get_app_instance_retention_settings(app_instance_arn) get_app_instance_retention_settings(app_instance_arn, params::Dict{String,<:Any}) -Gets the retention settings for an AppInstance. +Gets the retention settings for an AppInstance. This API is is no longer supported and +will not be updated. We recommend using the latest version, GetMessagingRetentionSettings, +in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated +namespace. For more information, refer to Migrating from the Amazon Chime namespace in the +Amazon Chime SDK Developer Guide. # Arguments - `app_instance_arn`: The ARN of the AppInstance. @@ -3447,7 +3657,11 @@ end get_app_instance_streaming_configurations(app_instance_arn) get_app_instance_streaming_configurations(app_instance_arn, params::Dict{String,<:Any}) -Gets the streaming settings for an AppInstance. +Gets the streaming settings for an AppInstance. This API is is no longer supported and +will not be updated. We recommend using the latest version, +GetMessagingStreamingConfigurations, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `app_instance_arn`: The ARN of the AppInstance. @@ -3483,7 +3697,10 @@ end Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon -Chime SDK Developer Guide . +Chime SDK Developer Guide. This API is is no longer supported and will not be updated. +We recommend using the latest version, GetAttendee, in the Amazon Chime SDK. Using the +latest version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `attendee_id`: The Amazon Chime SDK attendee ID. @@ -3556,7 +3773,10 @@ end Gets the full details of a channel message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in -the header. +the header. This API is is no longer supported and will not be updated. We recommend +using the latest version, GetChannelMessage, in the Amazon Chime SDK. Using the latest +version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `channel_arn`: The ARN of the channel. @@ -3651,7 +3871,11 @@ end get_media_capture_pipeline(media_pipeline_id) get_media_capture_pipeline(media_pipeline_id, params::Dict{String,<:Any}) -Gets an existing media capture pipeline. +Gets an existing media capture pipeline. This API is is no longer supported and will not +be updated. We recommend using the latest version, GetMediaCapturePipeline, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `media_pipeline_id`: The ID of the pipeline that you want to get. @@ -3685,9 +3909,12 @@ end get_meeting(meeting_id) get_meeting(meeting_id, params::Dict{String,<:Any}) - Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more -information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime -SDK Developer Guide . + This API is is no longer supported and will not be updated. We recommend using the latest +version, GetMeeting, in the Amazon Chime SDK. Using the latest version requires migrating +to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. Gets the Amazon Chime SDK meeting +details for the specified meeting ID. For more information about the Amazon Chime SDK, see +Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide . # Arguments - `meeting_id`: The Amazon Chime SDK meeting ID. @@ -3719,7 +3946,11 @@ end get_messaging_session_endpoint() get_messaging_session_endpoint(params::Dict{String,<:Any}) -The details of the endpoint for the messaging session. +The details of the endpoint for the messaging session. This API is is no longer supported +and will not be updated. We recommend using the latest version, +GetMessagingSessionEndpoint, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. """ function get_messaging_session_endpoint(; aws_config::AbstractAWSConfig=global_aws_config()) @@ -3843,6 +4074,10 @@ end get_proxy_session(proxy_session_id, voice_connector_id, params::Dict{String,<:Any}) Gets the specified proxy session details for the specified Amazon Chime Voice Connector. +This API is is no longer supported and will not be updated. We recommend using the latest +version, GetProxySession, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `proxy_session_id`: The proxy session ID. @@ -3950,7 +4185,10 @@ end get_sip_media_application(sip_media_application_id, params::Dict{String,<:Any}) Retrieves the information for a SIP media application, including name, AWS Region, and -endpoints. +endpoints. This API is is no longer supported and will not be updated. We recommend using +the latest version, GetSipMediaApplication, in the Amazon Chime SDK. Using the latest +version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `sip_media_application_id`: The SIP media application ID. @@ -3984,7 +4222,11 @@ end get_sip_media_application_logging_configuration(sip_media_application_id) get_sip_media_application_logging_configuration(sip_media_application_id, params::Dict{String,<:Any}) -Returns the logging configuration for the specified SIP media application. +Returns the logging configuration for the specified SIP media application. This API is is +no longer supported and will not be updated. We recommend using the latest version, +GetSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK. Using the latest +version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `sip_media_application_id`: The SIP media application ID. @@ -4019,7 +4261,10 @@ end get_sip_rule(sip_rule_id, params::Dict{String,<:Any}) Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target -endpoints. +endpoints. This API is is no longer supported and will not be updated. We recommend using +the latest version, GetSipRule, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `sip_rule_id`: The SIP rule ID. @@ -4124,7 +4369,11 @@ end get_voice_connector(voice_connector_id, params::Dict{String,<:Any}) Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, -outbound host, and encryption requirements. +outbound host, and encryption requirements. This API is is no longer supported and will +not be updated. We recommend using the latest version, GetVoiceConnector, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime Voice Connector ID. @@ -4159,7 +4408,11 @@ end get_voice_connector_emergency_calling_configuration(voice_connector_id, params::Dict{String,<:Any}) Gets the emergency calling configuration details for the specified Amazon Chime Voice -Connector. +Connector. This API is is no longer supported and will not be updated. We recommend using +the latest version, GetVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime +SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime Voice Connector ID. @@ -4194,7 +4447,11 @@ end get_voice_connector_group(voice_connector_group_id, params::Dict{String,<:Any}) Retrieves details for the specified Amazon Chime Voice Connector group, such as -timestamps,name, and associated VoiceConnectorItems. +timestamps,name, and associated VoiceConnectorItems. This API is is no longer supported +and will not be updated. We recommend using the latest version, GetVoiceConnectorGroup, in +the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. +For more information, refer to Migrating from the Amazon Chime namespace in the Amazon +Chime SDK Developer Guide. # Arguments - `voice_connector_group_id`: The Amazon Chime Voice Connector group ID. @@ -4229,7 +4486,11 @@ end get_voice_connector_logging_configuration(voice_connector_id, params::Dict{String,<:Any}) Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. -Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs. +Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs. This +API is is no longer supported and will not be updated. We recommend using the latest +version, GetVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK. Using the latest +version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime Voice Connector ID. @@ -4264,6 +4525,10 @@ end get_voice_connector_origination(voice_connector_id, params::Dict{String,<:Any}) Retrieves origination setting details for the specified Amazon Chime Voice Connector. +This API is is no longer supported and will not be updated. We recommend using the latest +version, GetVoiceConnectorOrigination, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime Voice Connector ID. @@ -4297,7 +4562,11 @@ end get_voice_connector_proxy(voice_connector_id) get_voice_connector_proxy(voice_connector_id, params::Dict{String,<:Any}) -Gets the proxy configuration details for the specified Amazon Chime Voice Connector. +Gets the proxy configuration details for the specified Amazon Chime Voice Connector. This +API is is no longer supported and will not be updated. We recommend using the latest +version, GetVoiceConnectorProxy, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime voice connector ID. @@ -4333,7 +4602,11 @@ end Retrieves the streaming configuration details for the specified Amazon Chime 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. +shows the retention period, in hours, for the Amazon Kinesis data. This API is is no +longer supported and will not be updated. We recommend using the latest version, +GetVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime Voice Connector ID. @@ -4368,6 +4641,10 @@ end get_voice_connector_termination(voice_connector_id, params::Dict{String,<:Any}) Retrieves termination setting details for the specified Amazon Chime Voice Connector. +This API is is no longer supported and will not be updated. We recommend using the latest +version, GetVoiceConnectorTermination, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime Voice Connector ID. @@ -4401,6 +4678,10 @@ end get_voice_connector_termination_health(voice_connector_id) get_voice_connector_termination_health(voice_connector_id, params::Dict{String,<:Any}) + This API is is no longer supported and will not be updated. We recommend using the latest +version, GetVoiceConnectorTerminationHealth, in the Amazon Chime SDK. Using the latest +version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector. @@ -4506,7 +4787,11 @@ end list_app_instance_admins(app_instance_arn) list_app_instance_admins(app_instance_arn, params::Dict{String,<:Any}) -Returns a list of the administrators in the AppInstance. +Returns a list of the administrators in the AppInstance. This API is is no longer +supported and will not be updated. We recommend using the latest version, +ListAppInstanceAdmins, in the Amazon Chime SDK. Using the latest version requires migrating +to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Arguments - `app_instance_arn`: The ARN of the AppInstance. @@ -4545,7 +4830,11 @@ end list_app_instance_users(app-instance-arn) list_app_instance_users(app-instance-arn, params::Dict{String,<:Any}) -List all AppInstanceUsers created under a single AppInstance. +List all AppInstanceUsers created under a single AppInstance. This API is is no longer +supported and will not be updated. We recommend using the latest version, +ListAppInstanceUsers, in the Amazon Chime SDK. Using the latest version requires migrating +to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Arguments - `app-instance-arn`: The ARN of the AppInstance. @@ -4589,7 +4878,11 @@ end list_app_instances() list_app_instances(params::Dict{String,<:Any}) -Lists all Amazon Chime AppInstances created under a single AWS account. +Lists all Amazon Chime AppInstances created under a single AWS account. This API is is no +longer supported and will not be updated. We recommend using the latest version, +ListAppInstances, in the Amazon Chime SDK. Using the latest version requires migrating to a +dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -4618,7 +4911,9 @@ end list_attendee_tags(attendee_id, meeting_id) list_attendee_tags(attendee_id, meeting_id, params::Dict{String,<:Any}) -Lists the tags applied to an Amazon Chime SDK attendee resource. +Lists the tags applied to an Amazon Chime SDK attendee resource. ListAttendeeTags is not +supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove +calls to this API. # Arguments - `attendee_id`: The Amazon Chime SDK attendee ID. @@ -4656,7 +4951,10 @@ end Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer -Guide. +Guide. This API is is no longer supported and will not be updated. We recommend using +the latest version, ListAttendees, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `meeting_id`: The Amazon Chime SDK meeting ID. @@ -4731,7 +5029,10 @@ end Lists all the users banned from a particular channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the -value in the header. +value in the header. This API is is no longer supported and will not be updated. We +recommend using the latest version, ListChannelBans, in the Amazon Chime SDK. Using the +latest version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `channel_arn`: The ARN of the channel. @@ -4771,7 +5072,10 @@ end Lists all channel memberships in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in -the header. +the header. This API is is no longer supported and will not be updated. We recommend +using the latest version, ListChannelMemberships, in the Amazon Chime SDK. Using the latest +version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `channel_arn`: The maximum number of channel memberships that you want returned. @@ -4817,7 +5121,11 @@ end Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that -makes the API call as the value in the header. +makes the API call as the value in the header. This API is is no longer supported and +will not be updated. We recommend using the latest version, +ListChannelMembershipsForAppInstanceUser, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -4858,7 +5166,11 @@ default, sorted by creation timestamp in descending order. Redacted messages ap results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message. Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user -that makes the API call as the value in the header. +that makes the API call as the value in the header. This API is is no longer supported +and will not be updated. We recommend using the latest version, ListChannelMessages, in the +Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For +more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime +SDK Developer Guide. # Arguments - `channel_arn`: The ARN of the channel. @@ -4904,7 +5216,10 @@ end Lists all the moderators for a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in -the header. +the header. This API is is no longer supported and will not be updated. We recommend +using the latest version, ListChannelModerators, in the Amazon Chime SDK. Using the latest +version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `channel_arn`: The ARN of the channel. @@ -4949,7 +5264,10 @@ filters to narrow results. Functionality & restrictions Use privacy = PU retrieve all public channels in the account. Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the -value in the header. +value in the header. This API is is no longer supported and will not be updated. We +recommend using the latest version, ListChannels, in the Amazon Chime SDK. Using the latest +version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `app-instance-arn`: The ARN of the AppInstance. @@ -4996,7 +5314,11 @@ end A list of the channels moderated by an AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the -value in the header. +value in the header. This API is is no longer supported and will not be updated. We +recommend using the latest version, ListChannelsModeratedByAppInstanceUser, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -5032,7 +5354,11 @@ end list_media_capture_pipelines() list_media_capture_pipelines(params::Dict{String,<:Any}) -Returns a list of media capture pipelines. +Returns a list of media capture pipelines. This API is is no longer supported and will +not be updated. We recommend using the latest version, ListMediaCapturePipelines, in the +Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For +more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime +SDK Developer Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -5064,7 +5390,11 @@ end list_meeting_tags(meeting_id) list_meeting_tags(meeting_id, params::Dict{String,<:Any}) -Lists the tags applied to an Amazon Chime SDK meeting resource. +Lists the tags applied to an Amazon Chime SDK meeting resource. This API is is no longer +supported and will not be updated. We recommend using the latest version, +ListTagsForResource, in the Amazon Chime SDK. Using the latest version requires migrating +to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Arguments - `meeting_id`: The Amazon Chime SDK meeting ID. @@ -5096,8 +5426,10 @@ end list_meetings() list_meetings(params::Dict{String,<:Any}) - Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon -Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide. +Lists up to 100 active Amazon Chime SDK meetings. ListMeetings is not supported in the +Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API. +For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the +Amazon Chime SDK Developer Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -5183,7 +5515,11 @@ end list_proxy_sessions(voice_connector_id) list_proxy_sessions(voice_connector_id, params::Dict{String,<:Any}) -Lists the proxy sessions for the specified Amazon Chime Voice Connector. +Lists the proxy sessions for the specified Amazon Chime Voice Connector. This API is is +no longer supported and will not be updated. We recommend using the latest version, +ListProxySessions, in the Amazon Chime SDK. Using the latest version requires migrating to +a dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime voice connector ID. @@ -5302,7 +5638,11 @@ end list_sip_media_applications() list_sip_media_applications(params::Dict{String,<:Any}) -Lists the SIP media applications under the administrator's AWS account. +Lists the SIP media applications under the administrator's AWS account. This API is is no +longer supported and will not be updated. We recommend using the latest version, +ListSipMediaApplications, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -5334,7 +5674,11 @@ end list_sip_rules() list_sip_rules(params::Dict{String,<:Any}) -Lists the SIP rules under the administrator's AWS account. +Lists the SIP rules under the administrator's AWS account. This API is is no longer +supported and will not be updated. We recommend using the latest version, ListSipRules, in +the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. +For more information, refer to Migrating from the Amazon Chime namespace in the Amazon +Chime SDK Developer Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -5397,7 +5741,12 @@ end list_tags_for_resource(arn) list_tags_for_resource(arn, params::Dict{String,<:Any}) -Lists the tags applied to an Amazon Chime SDK meeting resource. +Lists the tags applied to an Amazon Chime SDK meeting and messaging resources. This API +is is no longer supported and will not be updated. We recommend using the applicable latest +version in the Amazon Chime SDK. For meetings: ListTagsForResource. For messaging: +ListTagsForResource. Using the latest version requires migrating to a dedicated +namespace. For more information, refer to Migrating from the Amazon Chime namespace in the +Amazon Chime SDK Developer Guide. # Arguments - `arn`: The resource ARN. @@ -5468,7 +5817,11 @@ end list_voice_connector_groups() list_voice_connector_groups(params::Dict{String,<:Any}) -Lists the Amazon Chime Voice Connector groups for the administrator's AWS account. +Lists the Amazon Chime Voice Connector groups for the administrator's AWS account. This +API is is no longer supported and will not be updated. We recommend using the latest +version, ListVoiceConnectorGroups, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -5499,7 +5852,11 @@ end list_voice_connector_termination_credentials(voice_connector_id) list_voice_connector_termination_credentials(voice_connector_id, params::Dict{String,<:Any}) -Lists the SIP credentials for the specified Amazon Chime Voice Connector. +Lists the SIP credentials for the specified Amazon Chime Voice Connector. This API is is +no longer supported and will not be updated. We recommend using the latest version, +ListVoiceConnectorTerminationCredentials, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime Voice Connector ID. @@ -5533,7 +5890,11 @@ end list_voice_connectors() list_voice_connectors(params::Dict{String,<:Any}) -Lists the Amazon Chime Voice Connectors for the administrator's AWS account. +Lists the Amazon Chime Voice Connectors for the administrator's AWS account. This API is +is no longer supported and will not be updated. We recommend using the latest version, +ListVoiceConnectors, in the Amazon Chime SDK. Using the latest version requires migrating +to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -5595,7 +5956,11 @@ end put_app_instance_retention_settings(app_instance_retention_settings, app_instance_arn) put_app_instance_retention_settings(app_instance_retention_settings, app_instance_arn, params::Dict{String,<:Any}) -Sets the amount of time in days that a given AppInstance retains data. +Sets the amount of time in days that a given AppInstance retains data. This API is is no +longer supported and will not be updated. We recommend using the latest version, +PutAppInstanceRetentionSettings, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `app_instance_retention_settings`: The time in days to retain data. Data type: number. @@ -5642,7 +6007,11 @@ end put_app_instance_streaming_configurations(app_instance_streaming_configurations, app_instance_arn) put_app_instance_streaming_configurations(app_instance_streaming_configurations, app_instance_arn, params::Dict{String,<:Any}) -The data streaming configurations of an AppInstance. +The data streaming configurations of an AppInstance. This API is is no longer supported +and will not be updated. We recommend using the latest version, +PutMessagingStreamingConfigurations, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `app_instance_streaming_configurations`: The streaming configurations set for an @@ -5783,7 +6152,11 @@ end put_sip_media_application_logging_configuration(sip_media_application_id) put_sip_media_application_logging_configuration(sip_media_application_id, params::Dict{String,<:Any}) -Updates the logging configuration for the specified SIP media application. +Updates the logging configuration for the specified SIP media application. This API is is +no longer supported and will not be updated. We recommend using the latest version, +PutSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK. Using the latest +version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `sip_media_application_id`: The SIP media application ID. @@ -5823,7 +6196,11 @@ end Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be -configured. +configured. This API is is no longer supported and will not be updated. We recommend +using the latest version, PutVoiceConnectorEmergencyCallingConfiguration, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `emergency_calling_configuration`: The emergency calling configuration details. @@ -5872,7 +6249,10 @@ end Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon -CloudWatch Logs. +CloudWatch Logs. This API is is no longer supported and will not be updated. We recommend +using the latest version, PutVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK. +Using the latest version requires migrating to a dedicated namespace. For more information, +refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `logging_configuration`: The logging configuration details to add. @@ -5919,7 +6299,11 @@ end Adds origination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to -turning off origination settings. +turning off origination settings. This API is is no longer supported and will not be +updated. We recommend using the latest version, PutVoiceConnectorOrigination, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `origination`: The origination setting details to add. @@ -5959,6 +6343,10 @@ end put_voice_connector_proxy(default_session_expiry_minutes, phone_number_pool_countries, voice_connector_id, params::Dict{String,<:Any}) Puts the specified proxy configuration to the specified Amazon Chime Voice Connector. +This API is is no longer supported and will not be updated. We recommend using the latest +version, PutVoiceConnectorProxy, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `default_session_expiry_minutes`: The default number of minutes allowed for proxy @@ -6020,7 +6408,11 @@ end Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to -Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data. +Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data. This +API is is no longer supported and will not be updated. We recommend using the latest +version, PutVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK. Using the latest +version requires migrating to a dedicated namespace. For more information, refer to +Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `streaming_configuration`: The streaming configuration details to add. @@ -6067,7 +6459,11 @@ end Adds termination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to -turning off termination settings. +turning off termination settings. This API is is no longer supported and will not be +updated. We recommend using the latest version, PutVoiceConnectorTermination, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `termination`: The termination setting details to add. @@ -6106,7 +6502,11 @@ end put_voice_connector_termination_credentials(voice_connector_id) put_voice_connector_termination_credentials(voice_connector_id, params::Dict{String,<:Any}) -Adds termination SIP credentials for the specified Amazon Chime Voice Connector. +Adds termination SIP credentials for the specified Amazon Chime Voice Connector. This API +is is no longer supported and will not be updated. We recommend using the latest version, +PutVoiceConnectorTerminationCredentials, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `voice_connector_id`: The Amazon Chime Voice Connector ID. @@ -6146,7 +6546,10 @@ end Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call -as the value in the header. +as the value in the header. This API is is no longer supported and will not be updated. +We recommend using the latest version, RedactChannelMessage, in the Amazon Chime SDK. Using +the latest version requires migrating to a dedicated namespace. For more information, refer +to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `channel_arn`: The ARN of the channel containing the messages that you want to redact. @@ -6416,7 +6819,10 @@ Sends a message to a particular channel that the member is a part of. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no -metadata. +metadata. This API is is no longer supported and will not be updated. We recommend using +the latest version, SendChannelMessage, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `client_request_token`: The Idempotency token for each client request. @@ -6493,6 +6899,10 @@ parameter and which combinations are valid, refer to the StartStreamTranscriptio the Amazon Transcribe Developer Guide. Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services. +This API is is no longer supported and will not be updated. We recommend using the latest +version, StartMeetingTranscription, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `transcription_configuration`: The configuration for the current transcription operation. @@ -6538,7 +6948,11 @@ end stop_meeting_transcription(meeting_id) stop_meeting_transcription(meeting_id, params::Dict{String,<:Any}) -Stops transcription for the specified meetingId. +Stops transcription for the specified meetingId. This API is is no longer supported and +will not be updated. We recommend using the latest version, StopMeetingTranscription, in +the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. +For more information, refer to Migrating from the Amazon Chime namespace in the Amazon +Chime SDK Developer Guide. # Arguments - `meeting_id`: The unique ID of the meeting for which you stop transcription. @@ -6572,7 +6986,9 @@ end tag_attendee(tags, attendee_id, meeting_id) tag_attendee(tags, attendee_id, meeting_id, params::Dict{String,<:Any}) -Applies the specified tags to the specified Amazon Chime SDK attendee. +Applies the specified tags to the specified Amazon Chime attendee. TagAttendee is not +supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove +calls to this API. # Arguments - `tags`: The tag key-value pairs. @@ -6611,7 +7027,11 @@ end tag_meeting(tags, meeting_id) tag_meeting(tags, meeting_id, params::Dict{String,<:Any}) -Applies the specified tags to the specified Amazon Chime SDK meeting. +Applies the specified tags to the specified Amazon Chime SDK meeting. This API is is no +longer supported and will not be updated. We recommend using the latest version, +TagResource, in the Amazon Chime SDK. Using the latest version requires migrating to a +dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Arguments - `tags`: The tag key-value pairs. @@ -6646,7 +7066,11 @@ end tag_resource(resource_arn, tags) tag_resource(resource_arn, tags, params::Dict{String,<:Any}) -Applies the specified tags to the specified Amazon Chime SDK meeting resource. +Applies the specified tags to the specified Amazon Chime SDK meeting resource. This API +is is no longer supported and will not be updated. We recommend using the latest version, +TagResource, in the Amazon Chime SDK. Using the latest version requires migrating to a +dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Arguments - `resource_arn`: The resource ARN. @@ -6687,7 +7111,9 @@ end untag_attendee(tag_keys, attendee_id, meeting_id) untag_attendee(tag_keys, attendee_id, meeting_id, params::Dict{String,<:Any}) -Untags the specified tags from the specified Amazon Chime SDK attendee. +Untags the specified tags from the specified Amazon Chime SDK attendee. UntagAttendee is +not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove +calls to this API. # Arguments - `tag_keys`: The tag keys. @@ -6726,7 +7152,11 @@ end untag_meeting(tag_keys, meeting_id) untag_meeting(tag_keys, meeting_id, params::Dict{String,<:Any}) -Untags the specified tags from the specified Amazon Chime SDK meeting. +Untags the specified tags from the specified Amazon Chime SDK meeting. This API is is no +longer supported and will not be updated. We recommend using the latest version, +UntagResource, in the Amazon Chime SDK. Using the latest version requires migrating to a +dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Arguments - `tag_keys`: The tag keys. @@ -6763,7 +7193,12 @@ end untag_resource(resource_arn, tag_keys) untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any}) -Untags the specified tags from the specified Amazon Chime SDK meeting resource. +Untags the specified tags from the specified Amazon Chime SDK meeting resource. Applies the +specified tags to the specified Amazon Chime SDK meeting resource. This API is is no +longer supported and will not be updated. We recommend using the latest version, +UntagResource, in the Amazon Chime SDK. Using the latest version requires migrating to a +dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Arguments - `resource_arn`: The resource ARN. @@ -6887,7 +7322,10 @@ end update_app_instance(name, app_instance_arn) update_app_instance(name, app_instance_arn, params::Dict{String,<:Any}) -Updates AppInstance metadata. +Updates AppInstance metadata. This API is is no longer supported and will not be updated. +We recommend using the latest version, UpdateAppInstance, in the Amazon Chime SDK. Using +the latest version requires migrating to a dedicated namespace. For more information, refer +to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `name`: The name that you want to change. @@ -6927,7 +7365,11 @@ end update_app_instance_user(name, app_instance_user_arn) update_app_instance_user(name, app_instance_user_arn, params::Dict{String,<:Any}) -Updates the details of an AppInstanceUser. You can update names and metadata. +Updates the details of an AppInstanceUser. You can update names and metadata. This API is +is no longer supported and will not be updated. We recommend using the latest version, +UpdateAppInstanceUser, in the Amazon Chime SDK. Using the latest version requires migrating +to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Arguments - `name`: The name of the AppInstanceUser. @@ -7007,7 +7449,11 @@ end Update a channel's attributes. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that -makes the API call as the value in the header. +makes the API call as the value in the header. This API is is no longer supported and +will not be updated. We recommend using the latest version, UpdateChannel, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `mode`: The mode of the update request. @@ -7054,6 +7500,10 @@ end Updates the content of a message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. +This API is is no longer supported and will not be updated. We recommend using the latest +version, UpdateChannelMessage, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `channel_arn`: The ARN of the channel. @@ -7096,7 +7546,11 @@ end The details of the time when a user last read messages in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that -makes the API call as the value in the header. +makes the API call as the value in the header. This API is is no longer supported and +will not be updated. We recommend using the latest version, UpdateChannelReadMarker, in the +Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For +more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime +SDK Developer Guide. # Arguments - `channel_arn`: The ARN of the channel. @@ -7239,7 +7693,11 @@ end update_proxy_session(capabilities, proxy_session_id, voice_connector_id) update_proxy_session(capabilities, proxy_session_id, voice_connector_id, params::Dict{String,<:Any}) -Updates the specified proxy session details, such as voice or SMS capabilities. +Updates the specified proxy session details, such as voice or SMS capabilities. This API +is is no longer supported and will not be updated. We recommend using the latest version, +UpdateProxySession, in the Amazon Chime SDK. Using the latest version requires migrating to +a dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Arguments - `capabilities`: The proxy session capabilities. @@ -7368,7 +7826,11 @@ end update_sip_media_application(sip_media_application_id) update_sip_media_application(sip_media_application_id, params::Dict{String,<:Any}) -Updates the details of the specified SIP media application. +Updates the details of the specified SIP media application. This API is is no longer +supported and will not be updated. We recommend using the latest version, +UpdateSipMediaApplication, in the Amazon Chime SDK. Using the latest version requires +migrating to a dedicated namespace. For more information, refer to Migrating from the +Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `sip_media_application_id`: The SIP media application ID. @@ -7407,7 +7869,11 @@ end update_sip_media_application_call(arguments, sip_media_application_id, transaction_id, params::Dict{String,<:Any}) 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. +ID in an update request. The Lambda function can then return a new set of actions. This +API is is no longer supported and will not be updated. We recommend using the latest +version, UpdateSipMediaApplicationCall, in the Amazon Chime SDK. Using the latest version +requires migrating to a dedicated namespace. For more information, refer to Migrating from +the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. # Arguments - `arguments`: Arguments made available to the Lambda function as part of the @@ -7452,7 +7918,11 @@ end update_sip_rule(name, sip_rule_id) update_sip_rule(name, sip_rule_id, params::Dict{String,<:Any}) -Updates the details of the specified SIP rule. +Updates the details of the specified SIP rule. This API is is no longer supported and +will not be updated. We recommend using the latest version, UpdateSipRule, in the Amazon +Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `name`: The new name for the specified SIP rule. @@ -7573,7 +8043,11 @@ end update_voice_connector(name, require_encryption, voice_connector_id) update_voice_connector(name, require_encryption, voice_connector_id, params::Dict{String,<:Any}) -Updates details for the specified Amazon Chime Voice Connector. +Updates details for the specified Amazon Chime Voice Connector. This API is is no longer +supported and will not be updated. We recommend using the latest version, +UpdateVoiceConnector, in the Amazon Chime SDK. Using the latest version requires migrating +to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime +namespace in the Amazon Chime SDK Developer Guide. # Arguments - `name`: The name of the Amazon Chime Voice Connector. @@ -7623,7 +8097,11 @@ end update_voice_connector_group(name, voice_connector_items, voice_connector_group_id, params::Dict{String,<:Any}) Updates details of the specified Amazon Chime Voice Connector group, such as the name and -Amazon Chime Voice Connector priority ranking. +Amazon Chime Voice Connector priority ranking. This API is is no longer supported and +will not be updated. We recommend using the latest version, UpdateVoiceConnectorGroup, in +the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. +For more information, refer to Migrating from the Amazon Chime namespace in the Amazon +Chime SDK Developer Guide. # Arguments - `name`: The name of the Amazon Chime Voice Connector group. @@ -7676,7 +8154,11 @@ end Validates an address to be used for 911 calls made with Amazon Chime 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. +Public Safety Answering Point. This API is is no longer supported and will not be +updated. We recommend using the latest version, ValidateE911Address, in the Amazon Chime +SDK. Using the latest version requires migrating to a dedicated namespace. For more +information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK +Developer Guide. # Arguments - `aws_account_id`: The AWS account ID. diff --git a/src/services/chime_sdk_identity.jl b/src/services/chime_sdk_identity.jl index 50e09d6fa8..4bf90ed009 100644 --- a/src/services/chime_sdk_identity.jl +++ b/src/services/chime_sdk_identity.jl @@ -1145,6 +1145,9 @@ Updates the name and metadata of an AppInstanceBot. - `name`: The name of the AppInstanceBot. - `app_instance_bot_arn`: The ARN of the AppInstanceBot. +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"Configuration"`: The configuration for the bot update. """ function update_app_instance_bot( Metadata, Name, appInstanceBotArn; aws_config::AbstractAWSConfig=global_aws_config() diff --git a/src/services/chime_sdk_messaging.jl b/src/services/chime_sdk_messaging.jl index d8daa84d7f..296c8e4820 100644 --- a/src/services/chime_sdk_messaging.jl +++ b/src/services/chime_sdk_messaging.jl @@ -132,10 +132,10 @@ end channel_flow_callback(callback_id, channel_message, channel_arn) channel_flow_callback(callback_id, channel_message, channel_arn, params::Dict{String,<:Any}) -Calls back Chime SDK Messaging with a processing response message. This should be invoked -from the processor Lambda. This is a developer API. You can return one of the following -processing responses: Update message content or metadata Deny a message Make no -changes to the message +Calls back Amazon Chime SDK messaging with a processing response message. This should be +invoked from the processor Lambda. This is a developer API. You can return one of the +following processing responses: Update message content or metadata Deny a message +Make no changes to the message # Arguments - `callback_id`: The identifier passed to the processor by the service when invoked. Use @@ -341,7 +341,7 @@ channel flows with channels, and the processors in the channel flow then take ac messages sent to that channel. This is a developer API. Channel flows process the following items: New and updated messages Persistent and non-persistent messages The Standard message type Channel flows don't process Control or System messages. For more -information about the message types provided by Chime SDK Messaging, refer to Message types +information about the message types provided by Chime SDK messaging, refer to Message types in the Amazon Chime developer guide. # Arguments @@ -1329,8 +1329,8 @@ end get_channel_membership_preferences(channel_arn, member_arn, x-amz-chime-bearer, params::Dict{String,<:Any}) Gets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified -channel. A user or a bot must be a member of the channel and own the membership to be able -to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel +channel. A user or a bot must be a member of the channel and own the membership in order to +retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the channel from which they are banned. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or @@ -1453,11 +1453,10 @@ status of messages going through channel flow processing. The API provides an al to retrieving message status if the event was not received because a client wasn't connected to a websocket. Messages can have any one of these statuses. SENT Message processed successfully PENDING Ongoing processing FAILED Processing failed DENIED -Messasge denied by the processor This API does not return statuses for denied -messages, because we don't store them once the processor denies them. Only the message -sender can invoke this API. The x-amz-chime-bearer request header is mandatory. Use the -ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the -header. +Message denied by the processor This API does not return statuses for denied messages, +because we don't store them once the processor denies them. Only the message sender can +invoke this API. The x-amz-chime-bearer request header is mandatory. Use the ARN of the +AppInstanceUser or AppInstanceBot that makes the API call as the value in the header. # Arguments - `channel_arn`: The ARN of the channel @@ -1739,7 +1738,7 @@ end list_channel_memberships_for_app_instance_user(x-amz-chime-bearer) list_channel_memberships_for_app_instance_user(x-amz-chime-bearer, params::Dict{String,<:Any}) - Lists all channels that anr AppInstanceUser or AppInstanceBot is a part of. Only an + Lists all channels that an AppInstanceUser or AppInstanceBot is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header. @@ -2210,13 +2209,13 @@ end put_channel_membership_preferences(preferences, channel_arn, member_arn, x-amz-chime-bearer) put_channel_membership_preferences(preferences, channel_arn, member_arn, x-amz-chime-bearer, params::Dict{String,<:Any}) -Sets the membership preferences of an AppInstanceUser or AppIntanceBot for the specified +Sets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator -roles can't set preferences for other users or users. Banned users or bots can't set -membership preferences for the channel from which they are banned. The x-amz-chime-bearer -request header is mandatory. Use the ARN of an AppInstanceUser or AppInstanceBot that makes -the API call as the value in the header. +roles can't set preferences for other users. Banned users or bots can't set membership +preferences for the channel from which they are banned. The x-amz-chime-bearer request +header is mandatory. Use the ARN of an AppInstanceUser or AppInstanceBot that makes the API +call as the value in the header. # Arguments - `preferences`: The channel membership preferences of an AppInstanceUser . @@ -2424,15 +2423,19 @@ end Sends a message to a particular channel that the member is a part of. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header. Also, STANDARD messages -can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of -data and no metadata. +can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in +a variety of ways, such as containing a link to an attachment. CONTROL messages are +limited to 30 bytes and do not contain metadata. # Arguments - `client_request_token`: The Idempotency token for each client request. -- `content`: The content of the message. +- `content`: The content of the channel message. - `persistence`: Boolean that controls whether the message is persisted on the back end. Required. -- `type`: The type of message, STANDARD or CONTROL. +- `type`: The type of message, STANDARD or CONTROL. STANDARD messages can be up to 4KB in + size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, + such as containing a link to an attachment. CONTROL messages are limited to 30 bytes and + do not contain metadata. - `channel_arn`: The ARN of the channel. - `x-amz-chime-bearer`: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call. @@ -2445,6 +2448,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"Metadata"`: The optional metadata for each message. - `"PushNotification"`: The push notification configuration of the message. - `"SubChannelId"`: The ID of the SubChannel in the request. +- `"Target"`: The target of a message. Must be a member of the channel, such as another + user, a bot, or the sender. Only the target and the sender can view targeted messages. Only + users who can see targeted messages can take actions on them. However, administrators can + delete targeted messages that they can’t see. """ function send_channel_message( ClientRequestToken, @@ -2693,7 +2700,7 @@ the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the the header. # Arguments -- `content`: The content of the message being updated. +- `content`: The content of the channel message. - `channel_arn`: The ARN of the channel. - `message_id`: The ID string of the message being updated. - `x-amz-chime-bearer`: The ARN of the AppInstanceUser or AppInstanceBot that makes the API diff --git a/src/services/cleanrooms.jl b/src/services/cleanrooms.jl index e1544eef42..30d5d62b68 100644 --- a/src/services/cleanrooms.jl +++ b/src/services/cleanrooms.jl @@ -134,7 +134,7 @@ Creates a new configured table resource. - `analysis_method`: The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`. - `name`: The name of the configured table. -- `table_reference`: A reference to the AWS Glue table being configured. +- `table_reference`: A reference to the Glue table being configured. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -1189,7 +1189,7 @@ end start_protected_query(membership_identifier, result_configuration, sql_parameters, type) start_protected_query(membership_identifier, result_configuration, sql_parameters, type, params::Dict{String,<:Any}) -Creates a protected query that is started by AWS Clean Rooms. +Creates a protected query that is started by Clean Rooms . # Arguments - `membership_identifier`: A unique identifier for the membership to run this query diff --git a/src/services/cloudformation.jl b/src/services/cloudformation.jl index 169183f478..d6b59bdc13 100644 --- a/src/services/cloudformation.jl +++ b/src/services/cloudformation.jl @@ -342,6 +342,18 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"NotificationARNs"`: The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list. +- `"OnStackFailure"`: Determines what action will be taken if stack creation fails. If this + parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation + must not be specified. This must be one of these values: DELETE - Deletes the change set + if the stack creation fails. This is only valid when the ChangeSetType parameter is set to + CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED. + DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true + for the DisableRollback parameter to the ExecuteChangeSet API operation. ROLLBACK - if + the stack creation fails, roll back the stack. This is equivalent to specifying false for + the DisableRollback parameter to the ExecuteChangeSet API operation. For nested stacks, + when the OnStackFailure parameter is set to DELETE for the change set for the parent stack, + any failure in a child stack will cause the parent stack creation to fail and all stacks to + be deleted. - `"Parameters"`: A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type. - `"ResourceTypes"`: The template resource types that you have permissions to work with if @@ -2044,7 +2056,12 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully received them. - `"DisableRollback"`: Preserves the state of previously provisioned resources when an - operation fails. Default: True + operation fails. This parameter can't be specified when the OnStackFailure parameter to the + CreateChangeSet API operation was specified. True - if the stack creation fails, do + nothing. This is equivalent to specifying DO_NOTHING for the OnStackFailure parameter to + the CreateChangeSet API operation. False - if the stack creation fails, roll back the + stack. This is equivalent to specifying ROLLBACK for the OnStackFailure parameter to the + CreateChangeSet API operation. Default: True - `"StackName"`: If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute. """ diff --git a/src/services/connect.jl b/src/services/connect.jl index 1af51b9c73..b42873fdee 100644 --- a/src/services/connect.jl +++ b/src/services/connect.jl @@ -511,7 +511,18 @@ Connect instance or traffic distribution group was created. For more information to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide. You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the -DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation. +DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation. If +you plan to claim and release numbers frequently during a 30 day period, contact us for a +service quota exception. Otherwise, it is possible you will be blocked from claiming and +releasing any more numbers until 30 days past the oldest number released has expired. By +default you can claim and release up to 200% of your maximum number of active phone numbers +during any 30 day period. If you claim and release phone numbers using the UI or API during +a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will +be blocked from claiming any more numbers until 30 days past the oldest number released has +expired. For example, if you already have 99 claimed numbers and a service level quota of +99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, +you will have exceeded the 200% limit. At that point you are blocked from claiming any more +numbers until you open an Amazon Web Services support ticket. # Arguments - `phone_number`: The phone number you want to claim. Phone numbers are formatted [+] @@ -5937,7 +5948,18 @@ number was claimed. To release phone numbers from a traffic distribution group, ReleasePhoneNumber API, not the Amazon Connect console. After releasing a phone number, the phone number enters into a cooldown period of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact -Amazon Web Services Support. +Amazon Web Services Support. If you plan to claim and release numbers frequently during a +30 day period, contact us for a service quota exception. Otherwise, it is possible you will +be blocked from claiming and releasing any more numbers until 30 days past the oldest +number released has expired. By default you can claim and release up to 200% of your +maximum number of active phone numbers during any 30 day period. If you claim and release +phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your +phone number service level quota, you will be blocked from claiming any more numbers until +30 days past the oldest number released has expired. For example, if you already have 99 +claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you +release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that +point you are blocked from claiming any more numbers until you open an Amazon Web Services +support ticket. # Arguments - `phone_number_id`: A unique identifier for the phone number. @@ -6046,8 +6068,8 @@ end resume_contact_recording(contact_id, initial_contact_id, instance_id, params::Dict{String,<:Any}) When a contact is being recorded, and the recording has been suspended using -SuspendContactRecording, this API resumes recording the call. Only voice recordings are -supported at this time. +SuspendContactRecording, this API resumes recording the call or screen. Voice and screen +recordings are supported. # Arguments - `contact_id`: The identifier of the contact. @@ -6348,6 +6370,51 @@ function search_quick_connects( ) end +""" + search_resource_tags(instance_id) + search_resource_tags(instance_id, params::Dict{String,<:Any}) + +Searches tags used in an Amazon Connect instance using optional search criteria. + +# Arguments +- `instance_id`: The identifier of the Amazon Connect instance. You can find the instanceId + in the Amazon Resource Name (ARN) of the instance. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"MaxResults"`: The maximum number of results to return per page. +- `"NextToken"`: 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. +- `"ResourceTypes"`: The list of resource types to be used to search tags from. If not + provided or if any empty list is provided, this API will search from all supported resource + types. +- `"SearchCriteria"`: The search criteria to be used to return tags. +""" +function search_resource_tags(InstanceId; aws_config::AbstractAWSConfig=global_aws_config()) + return connect( + "POST", + "/search-resource-tags", + Dict{String,Any}("InstanceId" => InstanceId); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function search_resource_tags( + InstanceId, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return connect( + "POST", + "/search-resource-tags", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ search_routing_profiles(instance_id) search_routing_profiles(instance_id, params::Dict{String,<:Any}) @@ -7222,11 +7289,11 @@ end suspend_contact_recording(contact_id, initial_contact_id, instance_id) suspend_contact_recording(contact_id, initial_contact_id, instance_id, params::Dict{String,<:Any}) -When a contact is being recorded, this API suspends recording the call. For example, you -might suspend the call recording while collecting sensitive information, such as a credit -card number. Then use ResumeContactRecording to restart recording. The period of time that -the recording is suspended is filled with silence in the final recording. Only voice -recordings are supported at this time. +When a contact is being recorded, this API suspends recording the call or screen. For +example, you might suspend the call or screen recording while collecting sensitive +information, such as a credit card number. Then use ResumeContactRecording to restart +recording. The period of time that the recording is suspended is filled with silence in the +final recording. Voice and screen recordings are supported. # Arguments - `contact_id`: The identifier of the contact. diff --git a/src/services/devops_guru.jl b/src/services/devops_guru.jl index 99dd0e64f4..3138592fa4 100644 --- a/src/services/devops_guru.jl +++ b/src/services/devops_guru.jl @@ -11,16 +11,12 @@ using AWS.UUIDs Adds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated. If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru -permission to it notifications. DevOps Guru adds the required policy on your behalf to send -notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS -topics. For more information, see Permissions for cross account Amazon SNS topics. If you -use an Amazon SNS topic in another account, you must attach a policy to it that grants -DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your -behalf to send notifications using Amazon SNS in your account. For more information, see -Permissions for cross account Amazon SNS topics. If you use an Amazon SNS topic that is -encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then -you must add permissions to the CMK. For more information, see Permissions for Amazon Web -Services KMS–encrypted Amazon SNS topics. +permission to send it notifications. DevOps Guru adds the required policy on your behalf to +send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS +topics. For more information, see Permissions for Amazon SNS topics. If you use an Amazon +SNS topic that is encrypted by an Amazon Web Services Key Management Service +customer-managed key (CMK), then you must add permissions to the CMK. For more information, +see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics. # Arguments - `config`: A NotificationChannelConfig object that specifies what type of notification diff --git a/src/services/dynamodb.jl b/src/services/dynamodb.jl index dc524e7e66..53a030214a 100644 --- a/src/services/dynamodb.jl +++ b/src/services/dynamodb.jl @@ -618,6 +618,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys from the small network and processing overhead of receiving a larger response. No read capacity units are consumed. The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD. +- `"ReturnValuesOnConditionCheckFailure"`: An optional parameter that returns the item + attributes for a DeleteItem operation that failed a condition check. There is no additional + cost associated with requesting a return value aside from the small network and processing + overhead of receiving a larger response. No read capacity units are consumed. """ function delete_item(Key, TableName; aws_config::AbstractAWSConfig=global_aws_config()) return dynamodb( @@ -808,9 +812,8 @@ end describe_endpoints() describe_endpoints(params::Dict{String,<:Any}) -Returns the regional endpoint information. This action must be included in your VPC -endpoint policies, or access to the DescribeEndpoints API will be denied. For more -information on policy permissions, please see Internetwork traffic privacy. +Returns the regional endpoint information. For more information on policy permissions, +please see Internetwork traffic privacy. """ function describe_endpoints(; aws_config::AbstractAWSConfig=global_aws_config()) @@ -1288,6 +1291,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys statement response. - `"Parameters"`: The parameters for the PartiQL statement, if any. - `"ReturnConsumedCapacity"`: +- `"ReturnValuesOnConditionCheckFailure"`: An optional parameter that returns the item + attributes for an ExecuteStatement operation that failed a condition check. There is no + additional cost associated with requesting a return value aside from the small network and + processing overhead of receiving a larger response. No read capacity units are consumed. """ function execute_statement(Statement; aws_config::AbstractAWSConfig=global_aws_config()) return dynamodb( @@ -1895,6 +1902,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys response. No read capacity units are consumed. The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD. +- `"ReturnValuesOnConditionCheckFailure"`: An optional parameter that returns the item + attributes for a PutItem operation that failed a condition check. There is no additional + cost associated with requesting a return value aside from the small network and processing + overhead of receiving a larger response. No read capacity units are consumed. """ function put_item(Item, TableName; aws_config::AbstractAWSConfig=global_aws_config()) return dynamodb( @@ -2956,6 +2967,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys operation. There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed. The values returned are strongly consistent. +- `"ReturnValuesOnConditionCheckFailure"`: An optional parameter that returns the item + attributes for an UpdateItem operation that failed a condition check. There is no + additional cost associated with requesting a return value aside from the small network and + processing overhead of receiving a larger response. No read capacity units are consumed. - `"UpdateExpression"`: An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them. The following action values are available for UpdateExpression. SET - Adds one or more attributes and values to an diff --git a/src/services/ec2.jl b/src/services/ec2.jl index 2cd4b2809a..b32411a972 100644 --- a/src/services/ec2.jl +++ b/src/services/ec2.jl @@ -415,8 +415,8 @@ function allocate_address( end """ - allocate_hosts(availability_zone, quantity) - allocate_hosts(availability_zone, quantity, params::Dict{String,<:Any}) + allocate_hosts(availability_zone) + allocate_hosts(availability_zone, params::Dict{String,<:Any}) Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the @@ -424,11 +424,16 @@ number of hosts to allocate. # Arguments - `availability_zone`: The Availability Zone in which to allocate the Dedicated Host. -- `quantity`: The number of Dedicated Hosts to allocate to your account with these - parameters. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"AssetId"`: The IDs of the Outpost hardware assets on which to allocate the Dedicated + Hosts. Targeting specific hardware assets on an Outpost can help to minimize latency + between your workloads. This parameter is supported only if you specify OutpostArn. If you + are allocating the Dedicated Hosts in a Region, omit this parameter. If you specify this + parameter, you can omit Quantity. In this case, Amazon EC2 allocates a Dedicated Host on + each specified hardware asset. If you specify both AssetIds and Quantity, then the value + for Quantity must be equal to the number of asset IDs specified. - `"HostMaintenance"`: Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide. - `"HostRecovery"`: Indicates whether to enable or disable host recovery for the Dedicated @@ -440,7 +445,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request. - `"OutpostArn"`: The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on - which to allocate the Dedicated Host. + which to allocate the Dedicated Host. If you specify OutpostArn, you can optionally specify + AssetIds. If you are allocating the Dedicated Host in a Region, omit this parameter. - `"TagSpecification"`: The tags to apply to the Dedicated Host during creation. - `"autoPlacement"`: Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance @@ -453,20 +459,22 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys instance type only. If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request. +- `"quantity"`: The number of Dedicated Hosts to allocate to your account with these + parameters. If you are allocating the Dedicated Hosts on an Outpost, and you specify + AssetIds, you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host + on each specified hardware asset. If you specify both AssetIds and Quantity, then the value + that you specify for Quantity must be equal to the number of asset IDs specified. """ -function allocate_hosts( - availabilityZone, quantity; aws_config::AbstractAWSConfig=global_aws_config() -) +function allocate_hosts(availabilityZone; aws_config::AbstractAWSConfig=global_aws_config()) return ec2( "AllocateHosts", - Dict{String,Any}("availabilityZone" => availabilityZone, "quantity" => quantity); + Dict{String,Any}("availabilityZone" => availabilityZone); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) end function allocate_hosts( availabilityZone, - quantity, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config(), ) @@ -474,11 +482,7 @@ function allocate_hosts( "AllocateHosts", Dict{String,Any}( mergewith( - _merge, - Dict{String,Any}( - "availabilityZone" => availabilityZone, "quantity" => quantity - ), - params, + _merge, Dict{String,Any}("availabilityZone" => availabilityZone), params ), ); aws_config=aws_config, @@ -3726,9 +3730,11 @@ end create_fleet(target_capacity_specification, item) create_fleet(target_capacity_specification, item, params::Dict{String,<:Any}) -Launches an EC2 Fleet. You can create a single EC2 Fleet that includes multiple launch -specifications that vary by instance type, AMI, Availability Zone, or subnet. For more -information, see EC2 Fleet in the Amazon EC2 User Guide. +Creates an EC2 Fleet that contains the configuration information for On-Demand Instances +and Spot Instances. Instances are launched immediately if there is available capacity. A +single EC2 Fleet can include multiple launch specifications that vary by instance type, +AMI, Availability Zone, or subnet. For more information, see EC2 Fleet in the Amazon EC2 +User Guide. # Arguments - `target_capacity_specification`: The number of units to request. @@ -11581,18 +11587,14 @@ end describe_account_attributes(params::Dict{String,<:Any}) Describes attributes of your Amazon Web Services account. The following are the supported -account attributes: supported-platforms: Indicates whether your account can launch -instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. default-vpc: The ID of the -default VPC for your account, or none. max-instances: This attribute is no longer -supported. The returned value does not reflect your actual vCPU limit for running On-Demand -Instances. For more information, see On-Demand Instance Limits in the Amazon Elastic -Compute Cloud User Guide. vpc-max-security-groups-per-interface: The maximum number of -security groups that you can assign to a network interface. max-elastic-ips: The maximum -number of Elastic IP addresses that you can allocate for use with EC2-Classic. -vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for -use with EC2-VPC. We are retiring EC2-Classic on August 15, 2022. We recommend that you -migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a -VPC in the Amazon EC2 User Guide. +account attributes: default-vpc: The ID of the default VPC for your account, or none. +max-instances: This attribute is no longer supported. The returned value does not reflect +your actual vCPU limit for running On-Demand Instances. For more information, see On-Demand +Instance Limits in the Amazon Elastic Compute Cloud User Guide. max-elastic-ips: The +maximum number of Elastic IP addresses that you can allocate. supported-platforms: This +attribute is deprecated. vpc-max-elastic-ips: The maximum number of Elastic IP addresses +that you can allocate. vpc-max-security-groups-per-interface: The maximum number of +security groups that you can assign to a network interface. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -13931,6 +13933,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys instance. network-info.network-performance - The network performance (for example, \"25 Gigabit\"). processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64). processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz. + processor-info.supported-features - The supported CPU features (amd-sev-snp). supported-boot-mode - The boot mode (legacy-bios | uefi). supported-root-device-type - The root device type (ebs | instance-store). supported-usage-class - The usage class (on-demand | spot). supported-virtualization-type - The virtualization type (hvm | @@ -24470,14 +24473,15 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys placement groups, the instance must have a tenancy of default or dedicated. To remove an instance from a placement group, specify an empty string (\"\"). - `"HostResourceGroupArn"`: The ARN of the host resource group in which to place the - instance. + instance. The instance must have a tenancy of host to specify this parameter. - `"PartitionNumber"`: The number of the partition in which to place the instance. Valid only if the placement group strategy is set to partition. - `"affinity"`: The affinity setting for the instance. - `"hostId"`: The ID of the Dedicated Host with which to associate the instance. -- `"tenancy"`: The tenancy for the instance. For T3 instances, you can't change the - tenancy from dedicated to host, or from host to dedicated. Attempting to make one of these - unsupported tenancy changes results in the InvalidTenancy error code. +- `"tenancy"`: The tenancy for the instance. For T3 instances, you must launch the + instance on a Dedicated Host to use a tenancy of host. You can't change the tenancy from + host to dedicated or default. Attempting to make one of these unsupported tenancy changes + results in an InvalidRequest error code. """ function modify_instance_placement( instanceId; aws_config::AbstractAWSConfig=global_aws_config() @@ -29488,7 +29492,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop. - `"InstanceType"`: The instance type. For more information, see Instance types in the - Amazon EC2 User Guide. Default: m1.small + Amazon EC2 User Guide. When you change your EBS-backed instance type, instance restart or + replacement behavior depends on the instance type compatibility between the old and new + types. An instance that's backed by an instance store volume is always replaced. For more + information, see Change the instance type in the Amazon EC2 User Guide. Default: m1.small - `"Ipv6Address"`: The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a diff --git a/src/services/ecs.jl b/src/services/ecs.jl index 63128dacb9..73f329f106 100644 --- a/src/services/ecs.jl +++ b/src/services/ecs.jl @@ -244,7 +244,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys isn't specified. If schedulingStrategy is DAEMON then this isn't required. - `"enableECSManagedTags"`: Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see Tagging your Amazon ECS resources in - the Amazon Elastic Container Service Developer Guide. + the Amazon Elastic Container Service Developer Guide. When you use Amazon ECS managed tags, + you need to set the propagateTags request parameter. - `"enableExecuteCommand"`: Determines whether the execute command functionality is turned on for the service. If true, this enables execute command functionality on all containers in the service tasks. @@ -318,7 +319,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"propagateTags"`: Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't 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. + TagResource API action. The default is NONE. - `"role"`: The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the @@ -729,6 +730,11 @@ count. You can't use a DELETE_IN_PROGRESS task definition revision to run new ta create new services. You also can't update an existing service to reference a DELETE_IN_PROGRESS task definition revision. A task definition revision will stay in DELETE_IN_PROGRESS status until all the associated tasks and services have been terminated. +When you delete all INACTIVE task definition revisions, the task definition name is not +displayed in the console and not returned in the API. If a task definition revisions are in +the DELETE_IN_PROGRESS state, the task definition name is displayed in the console and +returned in the API. The task definition name is retained by Amazon ECS and the revision is +incremented the next time you create a task definition with that name. # Arguments - `task_definitions`: The family and revision (family:revision) or full Amazon Resource diff --git a/src/services/efs.jl b/src/services/efs.jl index 53fd04f413..c11aa06434 100644 --- a/src/services/efs.jl +++ b/src/services/efs.jl @@ -16,10 +16,14 @@ exposed as the access point's root directory. Applications using the access poin access data in the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access points. If multiple requests to create access points on the same file system are sent in quick succession, and the file system is near -the limit of 1000 access points, you may experience a throttling response for these +the limit of 1,000 access points, you may experience a throttling response for these requests. This is to ensure that the file system does not exceed the stated access point limit. This operation requires permissions for the elasticfilesystem:CreateAccessPoint -action. +action. Access points can be tagged on creation. If tags are specified in the creation +action, IAM performs additional authorization on the elasticfilesystem:TagResource action +to verify if users have permissions to create tags. Therefore, you must grant explicit +permissions to use the elasticfilesystem:TagResource action. For more information, see +Granting permissions to tag resources during creation. # Arguments - `client_token`: A string of up to 64 ASCII characters that Amazon EFS uses to ensure @@ -110,8 +114,13 @@ the file system using the ThroughputMode parameter. After the file system is ful Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount -target. For more information, see Amazon EFS: How it Works. This operation requires -permissions for the elasticfilesystem:CreateFileSystem action. +target. For more information, see Amazon EFS: How it Works. This operation requires +permissions for the elasticfilesystem:CreateFileSystem action. File systems can be tagged +on creation. If tags are specified in the creation action, IAM performs additional +authorization on the elasticfilesystem:TagResource action to verify if users have +permissions to create tags. Therefore, you must grant explicit permissions to use the +elasticfilesystem:TagResource action. For more information, see Granting permissions to tag +resources during creation. # Arguments - `creation_token`: A string of up to 64 ASCII characters. Amazon EFS uses this to ensure diff --git a/src/services/emr.jl b/src/services/emr.jl index a77031a607..37613cf557 100644 --- a/src/services/emr.jl +++ b/src/services/emr.jl @@ -1414,6 +1414,49 @@ function list_studios( ) end +""" + list_supported_instance_types(release_label) + list_supported_instance_types(release_label, params::Dict{String,<:Any}) + +A list of the instance types that Amazon EMR supports. You can filter the list by Amazon +Web Services Region and Amazon EMR release. + +# Arguments +- `release_label`: The Amazon EMR release label determines the versions of open-source + application packages that Amazon EMR has installed on the cluster. Release labels are in + the format emr-x.x.x, where x.x.x is an Amazon EMR release number such as emr-6.10.0. For + more information about Amazon EMR releases and their included application versions and + features, see the Amazon EMR Release Guide . + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"Marker"`: The pagination token that marks the next set of results to retrieve. +""" +function list_supported_instance_types( + ReleaseLabel; aws_config::AbstractAWSConfig=global_aws_config() +) + return emr( + "ListSupportedInstanceTypes", + Dict{String,Any}("ReleaseLabel" => ReleaseLabel); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function list_supported_instance_types( + ReleaseLabel, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return emr( + "ListSupportedInstanceTypes", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("ReleaseLabel" => ReleaseLabel), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ modify_cluster(cluster_id) modify_cluster(cluster_id, params::Dict{String,<:Any}) diff --git a/src/services/emr_serverless.jl b/src/services/emr_serverless.jl index 43b98f6cb6..843161a20d 100644 --- a/src/services/emr_serverless.jl +++ b/src/services/emr_serverless.jl @@ -49,7 +49,7 @@ Creates an application. # Arguments - `client_token`: The client idempotency token of the application to create. Its value must be unique for each request. -- `release_label`: The EMR release associated with the application. +- `release_label`: The Amazon EMR release associated with the application. - `type`: The type of application you want to start, such as Spark or Hive. # Optional Parameters @@ -594,6 +594,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys 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. - `"networkConfiguration"`: +- `"releaseLabel"`: The Amazon EMR release label for the application. You can change the + release label to use a different release of Amazon EMR. - `"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 diff --git a/src/services/gamelift.jl b/src/services/gamelift.jl index eeefa6cfb6..d18e155878 100644 --- a/src/services/gamelift.jl +++ b/src/services/gamelift.jl @@ -86,9 +86,9 @@ connection information that players can use to connect to the game server. To c server, identify a game server group. You can also specify a game server ID, although this approach bypasses Amazon GameLift FleetIQ placement optimization. Optionally, include game data to pass to the game server at the start of a game session, such as a game map or -player information. Filter options may be included to further restrict how a game server is -chosen, such as only allowing game servers on ACTIVE instances to be claimed. When a game -server is successfully claimed, connection information is returned. A claimed game server's +player information. Add filter options to further restrict how a game server is chosen, +such as only allowing game servers on ACTIVE instances to be claimed. When a game server is +successfully claimed, connection information is returned. A claimed game server's utilization status remains AVAILABLE while the claim status is set to CLAIMED for up to 60 seconds. This time period gives the game server time to update its status to UTILIZED after players join. If the game server's status is not updated within 60 seconds, the game server @@ -96,8 +96,8 @@ reverts to unclaimed status and is available to be claimed by another request. T time period is a fixed value and is not configurable. If you try to claim a specific game server, this request will fail in the following cases: If the game server utilization status is UTILIZED. If the game server claim status is CLAIMED. If the game server is -running on an instance in DRAINING status and provided filter option does not allow placing -on DRAINING instances. Learn more Amazon GameLift FleetIQ Guide +running on an instance in DRAINING status and the provided filter option does not allow +placing on DRAINING instances. Learn more Amazon GameLift FleetIQ Guide # Arguments - `game_server_group_name`: A unique identifier for the game server group where the game @@ -878,8 +878,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys accept a proposed match, if acceptance is required. - `"AdditionalPlayerCount"`: The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single - 12-person team, and the additional player count is set to 2, only 10 players are selected - for the match. This parameter is not used if FlexMatchMode is set to STANDALONE. + 10-person team, and the additional player count is set to 2, 10 players will be selected + for the match and 2 more player slots will be open for future players. This parameter is + not used if FlexMatchMode is set to STANDALONE. - `"BackfillMode"`: The method used to backfill game sessions that are created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have Amazon GameLift @@ -5413,8 +5414,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys accept a proposed match, if acceptance is required. - `"AdditionalPlayerCount"`: The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single - 12-person team, and the additional player count is set to 2, only 10 players are selected - for the match. This parameter is not used if FlexMatchMode is set to STANDALONE. + 10-person team, and the additional player count is set to 2, 10 players will be selected + for the match and 2 more player slots will be open for future players. This parameter is + not used if FlexMatchMode is set to STANDALONE. - `"BackfillMode"`: The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a diff --git a/src/services/guardduty.jl b/src/services/guardduty.jl index a555bbb3cf..72baa6e1c6 100644 --- a/src/services/guardduty.jl +++ b/src/services/guardduty.jl @@ -392,12 +392,17 @@ end Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account IDs. This step is a prerequisite for managing the associated -member accounts either by invitation or through an organization. When using Create Members -as an organizations delegated administrator this action will enable GuardDuty in the added -member accounts, with the exception of the organization delegated administrator account, -which must enable GuardDuty prior to being added as a member. If you are adding accounts by -invitation, use this action after GuardDuty has bee enabled in potential member accounts -and before using InviteMembers. +member accounts either by invitation or through an organization. As a delegated +administrator, using CreateMembers will enable GuardDuty in the added member accounts, with +the exception of the organization delegated administrator account. A delegated +administrator must enable GuardDuty prior to being added as a member. If you are adding +accounts by invitation, before using InviteMembers, use CreateMembers after GuardDuty has +been enabled in potential member accounts. If you disassociate a member from a GuardDuty +delegated administrator, the member account details obtained from this API, including the +associated email addresses, will be retained. This is done so that the delegated +administrator can invoke the InviteMembers API without the need to invoke the CreateMembers +API again. To remove the details associated with a member account, the delegated +administrator must invoke the DeleteMembers API. # Arguments - `account_details`: A list of account ID and email address pairs of the accounts that you @@ -1084,7 +1089,12 @@ end disassociate_from_administrator_account(detector_id) disassociate_from_administrator_account(detector_id, params::Dict{String,<:Any}) -Disassociates the current GuardDuty member account from its administrator account. With +Disassociates the current GuardDuty member account from its administrator account. When you +disassociate an invited member from a GuardDuty delegated administrator, the member account +details obtained from the CreateMembers API, including the associated email addresses, are +retained. This is done so that the delegated administrator can invoke the InviteMembers API +without the need to invoke the CreateMembers API again. To remove the details associated +with a member account, the delegated administrator must invoke the DeleteMembers API. With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to disable GuardDuty in a member account. @@ -1120,7 +1130,12 @@ end disassociate_from_master_account(detector_id) disassociate_from_master_account(detector_id, params::Dict{String,<:Any}) -Disassociates the current GuardDuty member account from its administrator account. +Disassociates the current GuardDuty member account from its administrator account. When you +disassociate an invited member from a GuardDuty delegated administrator, the member account +details obtained from the CreateMembers API, including the associated email addresses, are +retained. This is done so that the delegated administrator can invoke the InviteMembers API +without the need to invoke the CreateMembers API again. To remove the details associated +with a member account, the delegated administrator must invoke the DeleteMembers API. # Arguments - `detector_id`: The unique ID of the detector of the GuardDuty member account. @@ -1154,10 +1169,16 @@ end disassociate_members(account_ids, detector_id) disassociate_members(account_ids, detector_id, params::Dict{String,<:Any}) -Disassociates GuardDuty member accounts (to the current administrator account) specified by -the account IDs. With autoEnableOrganizationMembers configuration for your organization set -to ALL, you'll receive an error if you attempt to disassociate a member account before -removing them from your Amazon Web Services organization. +Disassociates GuardDuty member accounts (from the current administrator account) specified +by the account IDs. When you disassociate an invited member from a GuardDuty delegated +administrator, the member account details obtained from the CreateMembers API, including +the associated email addresses, are retained. This is done so that the delegated +administrator can invoke the InviteMembers API without the need to invoke the CreateMembers +API again. To remove the details associated with a member account, the delegated +administrator must invoke the DeleteMembers API. With autoEnableOrganizationMembers +configuration for your organization set to ALL, you'll receive an error if you attempt to +disassociate a member account before removing them from your Amazon Web Services +organization. # Arguments - `account_ids`: A list of account IDs of the GuardDuty member accounts that you want to @@ -1831,10 +1852,21 @@ end invite_members(account_ids, detector_id) invite_members(account_ids, detector_id, params::Dict{String,<:Any}) -Invites other Amazon Web Services accounts (created as members of the current Amazon Web -Services account by CreateMembers) to enable GuardDuty, and allow the current Amazon Web -Services account to view and manage these accounts' findings on their behalf as the -GuardDuty administrator account. +Invites Amazon Web Services accounts to become members of an organization administered by +the Amazon Web Services account that invokes this API. If you are using Amazon Web Services +Organizations to manager your GuardDuty environment, this step is not needed. For more +information, see Managing accounts with Amazon Web Services Organizations. To invite Amazon +Web Services accounts, the first step is to ensure that GuardDuty has been enabled in the +potential member accounts. You can now invoke this API to add accounts by invitation. The +invited accounts can either accept or decline the invitation from their GuardDuty accounts. +Each invited Amazon Web Services account can choose to accept the invitation from only one +Amazon Web Services account. For more information, see Managing GuardDuty accounts by +invitation. After the invite has been accepted and you choose to disassociate a member +account (by using DisassociateMembers) from your account, the details of the member account +obtained by invoking CreateMembers, including the associated email addresses, will be +retained. This is done so that you can invoke InviteMembers without the need to invoke +CreateMembers again. To remove the details associated with a member account, you must also +invoke DeleteMembers. # Arguments - `account_ids`: A list of account IDs of the accounts that you want to invite to GuardDuty @@ -2257,8 +2289,8 @@ end list_tags_for_resource(resource_arn, params::Dict{String,<:Any}) Lists tags for a resource. Tagging is currently supported for detectors, finding filters, -IP sets, and threat intel sets, with a limit of 50 tags per resource. When invoked, this -operation returns all assigned tags for a given resource. +IP sets, threat intel sets, publishing destination, with a limit of 50 tags per resource. +When invoked, this operation returns all assigned tags for a given resource. # Arguments - `resource_arn`: The Amazon Resource Name (ARN) for the given GuardDuty resource. diff --git a/src/services/iam.jl b/src/services/iam.jl index 0118ff1d9e..07d0a74729 100644 --- a/src/services/iam.jl +++ b/src/services/iam.jl @@ -165,7 +165,7 @@ end Attaches the specified managed policy to the specified IAM group. You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use -PutGroupPolicy. As a best practice, you can validate your IAM policies. To learn more, see +PutGroupPolicy . As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide. For more information about policies, see Managed policies and inline policies in the IAM User Guide. @@ -216,9 +216,9 @@ end Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is -created at the same time as the role, using CreateRole. You can update a role's trust -policy using UpdateAssumeRolePolicy. Use this operation to attach a managed policy to a -role. To embed an inline policy in a role, use PutRolePolicy. For more information about +created at the same time as the role, using CreateRole . You can update a role's trust +policy using UpdateAssumerolePolicy . Use this operation to attach a managed policy to a +role. To embed an inline policy in a role, use PutRolePolicy . For more information about policies, see Managed policies and inline policies in the IAM User Guide. As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide. @@ -268,8 +268,8 @@ end attach_user_policy(policy_arn, user_name, params::Dict{String,<:Any}) Attaches the specified managed policy to the specified user. You use this operation to -attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy. -As a best practice, you can validate your IAM policies. To learn more, see Validating IAM +attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy +. As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide. For more information about policies, see Managed policies and inline policies in the IAM User Guide. @@ -3219,6 +3219,43 @@ function get_login_profile( ) end +""" + get_mfadevice(serial_number) + get_mfadevice(serial_number, params::Dict{String,<:Any}) + +Retrieves information about an MFA device for a specified user. + +# Arguments +- `serial_number`: Serial number that uniquely identifies the MFA device. For this API, we + only accept FIDO security key ARNs. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"UserName"`: The friendly name identifying the user. +""" +function get_mfadevice(SerialNumber; aws_config::AbstractAWSConfig=global_aws_config()) + return iam( + "GetMFADevice", + Dict{String,Any}("SerialNumber" => SerialNumber); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_mfadevice( + SerialNumber, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return iam( + "GetMFADevice", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("SerialNumber" => SerialNumber), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ get_open_idconnect_provider(open_idconnect_provider_arn) get_open_idconnect_provider(open_idconnect_provider_arn, params::Dict{String,<:Any}) @@ -5066,9 +5103,10 @@ end Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see Working with roles. IAM resource-listing operations return a subset of the available attributes for the resource. -For example, this operation does not return tags, even though they are an attribute of the -returned object. To view all of the information for a role, see GetRole. You can paginate -the results using the MaxItems and Marker parameters. +This operation does not return the following attributes, even though they are an attribute +of the returned object: PermissionsBoundary RoleLastUsed Tags To view all of the +information for a role, see GetRole. You can paginate the results using the MaxItems and +Marker parameters. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -5525,10 +5563,10 @@ end Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list. IAM resource-listing operations return a subset of the -available attributes for the resource. For example, this operation does not return tags, -even though they are an attribute of the returned object. To view all of the information -for a user, see GetUser. You can paginate the results using the MaxItems and Marker -parameters. +available attributes for the resource. This operation does not return the following +attributes, even though they are an attribute of the returned object: PermissionsBoundary + Tags To view all of the information for a user, see GetUser. You can paginate the +results using the MaxItems and Marker parameters. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -5610,10 +5648,10 @@ end Adds or updates an inline policy document that is embedded in the specified IAM group. A user can also have managed policies attached to it. To attach a managed policy to a group, -use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information -about policies, see Managed policies and inline policies in the IAM User Guide. For -information about the maximum number of inline policies that you can embed in a group, see -IAM and STS quotas in the IAM User Guide. Because policy documents can be large, you +use AttachGroupPolicy . To create a new managed policy, use CreatePolicy . For +information about policies, see Managed policies and inline policies in the IAM User Guide. +For information about the maximum number of inline policies that you can embed in a group, +see IAM and STS quotas in the IAM User Guide. Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide. @@ -5739,16 +5777,16 @@ end Adds or updates an inline policy document that is embedded in the specified IAM role. When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the -role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. -For more information about IAM roles, see Using roles to delegate permissions and federate -identities. A role can also have a managed policy attached to it. To attach a managed -policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. -For information about policies, see Managed policies and inline policies in the IAM User -Guide. For information about the maximum number of inline policies that you can embed with -a role, see IAM and STS quotas in the IAM User Guide. Because policy documents can be -large, you should use POST rather than GET when calling PutRolePolicy. For general -information about using the Query API with IAM, see Making query requests in the IAM User -Guide. +role, using CreateRole . You can update a role's trust policy using +UpdateAssumerolePolicy . For more information about IAM roles, see Using roles to delegate +permissions and federate identities. A role can also have a managed policy attached to it. +To attach a managed policy to a role, use AttachRolePolicy . To create a new managed +policy, use CreatePolicy . For information about policies, see Managed policies and inline +policies in the IAM User Guide. For information about the maximum number of inline policies +that you can embed with a role, see IAM and STS quotas in the IAM User Guide. Because +policy documents can be large, you should use POST rather than GET when calling +PutRolePolicy. For general information about using the Query API with IAM, see Making query +requests in the IAM User Guide. # Arguments - `policy_document`: The policy document. You must provide policies in JSON format in IAM. @@ -5871,7 +5909,7 @@ end Adds or updates an inline policy document that is embedded in the specified IAM user. An IAM user can also have a managed policy attached to it. To attach a managed policy to a -user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For +user, use AttachUserPolicy . To create a new managed policy, use CreatePolicy . For information about policies, see Managed policies and inline policies in the IAM User Guide. For information about the maximum number of inline policies that you can embed in a user, see IAM and STS quotas in the IAM User Guide. Because policy documents can be large, you diff --git a/src/services/inspector2.jl b/src/services/inspector2.jl index 2db5d98077..239582bf6f 100644 --- a/src/services/inspector2.jl +++ b/src/services/inspector2.jl @@ -71,6 +71,45 @@ function batch_get_account_status( ) end +""" + batch_get_code_snippet(finding_arns) + batch_get_code_snippet(finding_arns, params::Dict{String,<:Any}) + +Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities +in. + +# Arguments +- `finding_arns`: An array of finding ARNs for the findings you want to retrieve code + snippets from. + +""" +function batch_get_code_snippet( + findingArns; aws_config::AbstractAWSConfig=global_aws_config() +) + return inspector2( + "POST", + "/codesnippet/batchget", + Dict{String,Any}("findingArns" => findingArns); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function batch_get_code_snippet( + findingArns, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return inspector2( + "POST", + "/codesnippet/batchget", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("findingArns" => findingArns), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ batch_get_free_trial_info(account_ids) batch_get_free_trial_info(account_ids, params::Dict{String,<:Any}) @@ -218,6 +257,41 @@ function cancel_findings_report( ) end +""" + cancel_sbom_export(report_id) + cancel_sbom_export(report_id, params::Dict{String,<:Any}) + +Cancels a software bill of materials (SBOM) report. + +# Arguments +- `report_id`: The report ID of the SBOM export to cancel. + +""" +function cancel_sbom_export(reportId; aws_config::AbstractAWSConfig=global_aws_config()) + return inspector2( + "POST", + "/sbomexport/cancel", + Dict{String,Any}("reportId" => reportId); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function cancel_sbom_export( + reportId, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return inspector2( + "POST", + "/sbomexport/cancel", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("reportId" => reportId), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ create_filter(action, filter_criteria, name) create_filter(action, filter_criteria, name, params::Dict{String,<:Any}) @@ -324,6 +398,55 @@ function create_findings_report( ) end +""" + create_sbom_export(report_format, s3_destination) + create_sbom_export(report_format, s3_destination, params::Dict{String,<:Any}) + +Creates a software bill of materials (SBOM) report. + +# Arguments +- `report_format`: The output format for the software bill of materials (SBOM) report. +- `s3_destination`: + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"resourceFilterCriteria"`: The resource filter criteria for the software bill of + materials (SBOM) report. +""" +function create_sbom_export( + reportFormat, s3Destination; aws_config::AbstractAWSConfig=global_aws_config() +) + return inspector2( + "POST", + "/sbomexport/create", + Dict{String,Any}("reportFormat" => reportFormat, "s3Destination" => s3Destination); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function create_sbom_export( + reportFormat, + s3Destination, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return inspector2( + "POST", + "/sbomexport/create", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "reportFormat" => reportFormat, "s3Destination" => s3Destination + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ delete_filter(arn) delete_filter(arn, params::Dict{String,<:Any}) @@ -666,6 +789,49 @@ function get_ec2_deep_inspection_configuration( ) end +""" + get_encryption_key(resource_type, scan_type) + get_encryption_key(resource_type, scan_type, params::Dict{String,<:Any}) + +Gets an encryption key. + +# Arguments +- `resource_type`: The resource type the key encrypts. +- `scan_type`: The scan type the key encrypts. + +""" +function get_encryption_key( + resourceType, scanType; aws_config::AbstractAWSConfig=global_aws_config() +) + return inspector2( + "GET", + "/encryptionkey/get", + Dict{String,Any}("resourceType" => resourceType, "scanType" => scanType); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_encryption_key( + resourceType, + scanType, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return inspector2( + "GET", + "/encryptionkey/get", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}("resourceType" => resourceType, "scanType" => scanType), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ get_findings_report_status() get_findings_report_status(params::Dict{String,<:Any}) @@ -732,6 +898,41 @@ function get_member( ) end +""" + get_sbom_export(report_id) + get_sbom_export(report_id, params::Dict{String,<:Any}) + +Gets details of a software bill of materials (SBOM) report. + +# Arguments +- `report_id`: The report ID of the SBOM export to get details for. + +""" +function get_sbom_export(reportId; aws_config::AbstractAWSConfig=global_aws_config()) + return inspector2( + "POST", + "/sbomexport/get", + Dict{String,Any}("reportId" => reportId); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_sbom_export( + reportId, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return inspector2( + "POST", + "/sbomexport/get", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("reportId" => reportId), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ list_account_permissions() list_account_permissions(params::Dict{String,<:Any}) @@ -1086,6 +1287,50 @@ function list_usage_totals( ) end +""" + reset_encryption_key(resource_type, scan_type) + reset_encryption_key(resource_type, scan_type, params::Dict{String,<:Any}) + +Resets an encryption key. After the key is reset your resources will be encrypted by an +Amazon Web Services owned key. + +# Arguments +- `resource_type`: The resource type the key encrypts. +- `scan_type`: The scan type the key encrypts. + +""" +function reset_encryption_key( + resourceType, scanType; aws_config::AbstractAWSConfig=global_aws_config() +) + return inspector2( + "PUT", + "/encryptionkey/reset", + Dict{String,Any}("resourceType" => resourceType, "scanType" => scanType); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function reset_encryption_key( + resourceType, + scanType, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return inspector2( + "PUT", + "/encryptionkey/reset", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}("resourceType" => resourceType, "scanType" => scanType), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ search_vulnerabilities(filter_criteria) search_vulnerabilities(filter_criteria, params::Dict{String,<:Any}) @@ -1281,6 +1526,58 @@ function update_ec2_deep_inspection_configuration( ) end +""" + update_encryption_key(kms_key_id, resource_type, scan_type) + update_encryption_key(kms_key_id, resource_type, scan_type, params::Dict{String,<:Any}) + +Updates an encryption key. A ResourceNotFoundException means that an AWS owned key is being +used for encryption. + +# Arguments +- `kms_key_id`: A KMS key ID for the encryption key. +- `resource_type`: The resource type for the encryption key. +- `scan_type`: The scan type for the encryption key. + +""" +function update_encryption_key( + kmsKeyId, resourceType, scanType; aws_config::AbstractAWSConfig=global_aws_config() +) + return inspector2( + "PUT", + "/encryptionkey/update", + Dict{String,Any}( + "kmsKeyId" => kmsKeyId, "resourceType" => resourceType, "scanType" => scanType + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function update_encryption_key( + kmsKeyId, + resourceType, + scanType, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return inspector2( + "PUT", + "/encryptionkey/update", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "kmsKeyId" => kmsKeyId, + "resourceType" => resourceType, + "scanType" => scanType, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ update_filter(filter_arn) update_filter(filter_arn, params::Dict{String,<:Any}) diff --git a/src/services/internetmonitor.jl b/src/services/internetmonitor.jl index a8371f117f..1268a5301f 100644 --- a/src/services/internetmonitor.jl +++ b/src/services/internetmonitor.jl @@ -29,6 +29,11 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"ClientToken"`: 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. +- `"HealthEventsConfig"`: Defines the health event threshold percentages, for performance + score and availability score. Internet Monitor creates a health event when there's an + internet issue that affects your application end users where a health score percentage is + at or below a set threshold. If you don't set a health event threshold, the default calue + is 95%. - `"InternetMeasurementsLogDelivery"`: Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs. - `"MaxCityNetworksToMonitor"`: The maximum number of city-networks to monitor for your @@ -397,6 +402,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"ClientToken"`: 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. +- `"HealthEventsConfig"`: The list of health event thresholds. A health event threshold + percentage, for performance and availability, determines when Internet Monitor creates a + health event when there's an internet issue that affects your application end users. - `"InternetMeasurementsLogDelivery"`: Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs. diff --git a/src/services/ivs.jl b/src/services/ivs.jl index eefc45caa5..fbad785f75 100644 --- a/src/services/ivs.jl +++ b/src/services/ivs.jl @@ -66,6 +66,44 @@ function batch_get_stream_key( ) end +""" + batch_start_viewer_session_revocation(viewer_sessions) + batch_start_viewer_session_revocation(viewer_sessions, params::Dict{String,<:Any}) + +Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs +simultaneously. + +# Arguments +- `viewer_sessions`: Array of viewer sessions, one per channel-ARN and viewer-ID pair. + +""" +function batch_start_viewer_session_revocation( + viewerSessions; aws_config::AbstractAWSConfig=global_aws_config() +) + return ivs( + "POST", + "/BatchStartViewerSessionRevocation", + Dict{String,Any}("viewerSessions" => viewerSessions); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function batch_start_viewer_session_revocation( + viewerSessions, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return ivs( + "POST", + "/BatchStartViewerSessionRevocation", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("viewerSessions" => viewerSessions), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ create_channel() create_channel(params::Dict{String,<:Any}) @@ -932,6 +970,58 @@ function put_metadata( ) end +""" + start_viewer_session_revocation(channel_arn, viewer_id) + start_viewer_session_revocation(channel_arn, viewer_id, params::Dict{String,<:Any}) + +Starts the process of revoking the viewer session associated with a specified channel ARN +and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than +and including that version. For instructions on associating a viewer ID with a viewer +session, see Setting Up Private Channels. + +# Arguments +- `channel_arn`: The ARN of the channel associated with the viewer session to revoke. +- `viewer_id`: The ID of the viewer associated with the viewer session to revoke. Do not + use this field for personally identifying, confidential, or sensitive information. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"viewerSessionVersionsLessThanOrEqualTo"`: An optional filter on which versions of the + viewer session to revoke. All versions less than or equal to the specified version will be + revoked. Default: 0. +""" +function start_viewer_session_revocation( + channelArn, viewerId; aws_config::AbstractAWSConfig=global_aws_config() +) + return ivs( + "POST", + "/StartViewerSessionRevocation", + Dict{String,Any}("channelArn" => channelArn, "viewerId" => viewerId); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function start_viewer_session_revocation( + channelArn, + viewerId, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return ivs( + "POST", + "/StartViewerSessionRevocation", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}("channelArn" => channelArn, "viewerId" => viewerId), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ stop_stream(channel_arn) stop_stream(channel_arn, params::Dict{String,<:Any}) diff --git a/src/services/kendra.jl b/src/services/kendra.jl index 4f8173e822..ef2b7b0171 100644 --- a/src/services/kendra.jl +++ b/src/services/kendra.jl @@ -591,9 +591,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"Description"`: A description for the FAQ. - `"FileFormat"`: The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that - includes custom attributes. The format must match the format of the file stored in the S3 - bucket identified in the S3Path parameter. For more information, see Adding questions and - answers. + includes custom attributes. The default format is CSV. The format must match the format of + the file stored in the S3 bucket identified in the S3Path parameter. For more information, + see Adding questions and answers. - `"LanguageCode"`: The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English. @@ -2473,50 +2473,51 @@ end query(index_id) query(index_id, params::Dict{String,<:Any}) -Searches an active index. Use this API to search your documents using query. The Query API -enables to do faceted search and to filter results based on document attributes. It also -enables you to provide user context that Amazon Kendra uses to enforce document access -control in the search results. Amazon Kendra searches your index for text content and -question and answer (FAQ) content. By default the response contains three types of results. - Relevant passages Matching FAQs Relevant documents You can specify that the query -return only one type of result using the QueryResultTypeFilter parameter. Each query -returns the 100 most relevant results. +Searches an index given an input query. You can configure boosting or relevance tuning at +the query level to override boosting at the index level, filter based on document +fields/attributes and faceted search, and filter based on the user or their group access to +documents. You can also include certain fields in the response that might provide useful +additional information. A query response contains three types of results. Relevant +suggested answers. The answers can be either a text excerpt or table excerpt. The answer +can be highlighted in the excerpt. Matching FAQs or questions-answer from your FAQ file. + Relevant documents. This result type includes an excerpt of the document with the document +title. The searched terms can be highlighted in the excerpt. You can specify that the +query return only one type of result using the QueryResultTypeFilter parameter. Each query +returns the 100 most relevant results. If you filter result type to only question-answers, +a maximum of four results are returned. If you filter result type to only answers, a +maximum of three results are returned. # Arguments -- `index_id`: The identifier of the index to search. The identifier is returned in the - response from the CreateIndex API. +- `index_id`: The identifier of the index for the search. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"AttributeFilter"`: Enables filtered searches based on document attributes. You can only +- `"AttributeFilter"`: Filters search results by document fields/attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters - parameters contain a list of other filters. The AttributeFilter parameter enables you to + parameters contain a list of other filters. The AttributeFilter parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results. - `"DocumentRelevanceOverrideConfigurations"`: Overrides relevance tuning configurations of - fields or attributes set at the index level. If you use this API to override the relevance + fields/attributes set at the index level. If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning. If there is relevance - tuning configured at the index level, but you do not use this API to override any relevance - tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the - index level. If there is relevance tuning configured for fields at the index level, but you - use this API to override only some of these fields, then for the fields you did not - override, the importance is set to 1. -- `"Facets"`: An array of documents attributes. Amazon Kendra returns a count for each - attribute key specified. This helps your users narrow their search. + tuning configured for fields at the index level, and you use this API to override only some + of these fields, then for the fields you did not override, the importance is set to 1. +- `"Facets"`: An array of documents fields/attributes for faceted search. Amazon Kendra + returns a count for each field key specified. This helps your users narrow their search. - `"PageNumber"`: Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one. - `"PageSize"`: Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned. -- `"QueryResultTypeFilter"`: Sets the type of query. Only results for the specified query - type are returned. +- `"QueryResultTypeFilter"`: Sets the type of query result or response. Only results for + the specified type are returned. - `"QueryText"`: The input query text for the search. Amazon Kendra truncates queries at 30 token words, which excludes punctuation and stop words. Truncation still applies if you use Boolean or more advanced, complex queries. -- `"RequestedDocumentAttributes"`: An array of document attributes to include in the - response. You can limit the response to include certain document attributes. By default all +- `"RequestedDocumentAttributes"`: An array of document fields/attributes to include in the + response. You can limit the response to include certain document fields. By default, all document attributes are included in the response. - `"SortingConfiguration"`: Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and @@ -2549,6 +2550,80 @@ function query( ) end +""" + retrieve(index_id, query_text) + retrieve(index_id, query_text, params::Dict{String,<:Any}) + +Retrieves relevant passages or text excerpts given an input query. This API is similar to +the Query API. However, by default, the Query API only returns excerpt passages of up to +100 token words. With the Retrieve API, you can retrieve longer passages of up to 200 token +words and up to 100 semantically relevant passages. This doesn't include question-answer or +FAQ type responses from your index. The passages are text excerpts that can be semantically +extracted from multiple documents and multiple parts of the same document. If in extreme +cases your documents produce no relevant passages using the Retrieve API, you can +alternatively use the Query API. You can also do the following: Override boosting at the +index level Filter based on document fields or attributes Filter based on the user or +their group access to documents You can also include certain fields in the response that +might provide useful additional information. + +# Arguments +- `index_id`: The identifier of the index to retrieve relevant passages for the search. +- `query_text`: The input query text to retrieve relevant passages for the search. Amazon + Kendra truncates queries at 30 token words, which excludes punctuation and stop words. + Truncation still applies if you use Boolean or more advanced, complex queries. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"AttributeFilter"`: Filters search results by document fields/attributes. You can only + provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters + parameters contain a list of other filters. The AttributeFilter parameter means you can + create a set of filtering rules that a document must satisfy to be included in the query + results. +- `"DocumentRelevanceOverrideConfigurations"`: Overrides relevance tuning configurations of + fields/attributes set at the index level. If you use this API to override the relevance + tuning configured at the index level, but there is no relevance tuning configured at the + index level, then Amazon Kendra does not apply any relevance tuning. If there is relevance + tuning configured for fields at the index level, and you use this API to override only some + of these fields, then for the fields you did not override, the importance is set to 1. +- `"PageNumber"`: Retrieved relevant passages are returned in pages the size of the + PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this + parameter to get result pages after the first one. +- `"PageSize"`: Sets the number of retrieved relevant passages that are returned in each + page of results. The default page size is 10. The maximum number of results returned is + 100. If you ask for more than 100 results, only 100 are returned. +- `"RequestedDocumentAttributes"`: A list of document fields/attributes to include in the + response. You can limit the response to include certain document fields. By default, all + document fields are included in the response. +- `"UserContext"`: The user context token or user and group information. +""" +function retrieve(IndexId, QueryText; aws_config::AbstractAWSConfig=global_aws_config()) + return kendra( + "Retrieve", + Dict{String,Any}("IndexId" => IndexId, "QueryText" => QueryText); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function retrieve( + IndexId, + QueryText, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return kendra( + "Retrieve", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}("IndexId" => IndexId, "QueryText" => QueryText), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ start_data_source_sync_job(id, index_id) start_data_source_sync_job(id, index_id, params::Dict{String,<:Any}) diff --git a/src/services/kinesis_video.jl b/src/services/kinesis_video.jl index 90cbc49462..b10303df43 100644 --- a/src/services/kinesis_video.jl +++ b/src/services/kinesis_video.jl @@ -75,7 +75,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys implementation, Kinesis Video Streams does not use this name. - `"KmsKeyId"`: The ID of the Key Management Service (KMS) key that you want Kinesis Video Streams to use to encrypt stream data. If no key ID is specified, the default, Kinesis - Video-managed key (aws/kinesisvideo) is used. For more information, see DescribeKey. + Video-managed key (Amazon Web Services/kinesisvideo) is used. For more information, see + DescribeKey. - `"MediaType"`: The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines. @@ -109,6 +110,45 @@ function create_stream( ) end +""" + delete_edge_configuration() + delete_edge_configuration(params::Dict{String,<:Any}) + +An asynchronous API that deletes a stream’s existing edge configuration, as well as the +corresponding media from the Edge Agent. When you invoke this API, the sync status is set +to DELETING. A deletion process starts, in which active edge jobs are stopped and all media +is deleted from the edge device. The time to delete varies, depending on the total amount +of stored media. If the deletion process fails, the sync status changes to DELETE_FAILED. +You will need to re-try the deletion. When the deletion process has completed successfully, +the edge configuration is no longer accessible. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"StreamARN"`: The Amazon Resource Name (ARN) of the stream. Specify either the + StreamName or the StreamARN. +- `"StreamName"`: The name of the stream from which to delete the edge configuration. + Specify either the StreamName or the StreamARN. +""" +function delete_edge_configuration(; aws_config::AbstractAWSConfig=global_aws_config()) + return kinesis_video( + "POST", + "/deleteEdgeConfiguration"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function delete_edge_configuration( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return kinesis_video( + "POST", + "/deleteEdgeConfiguration", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ delete_signaling_channel(channel_arn) delete_signaling_channel(channel_arn, params::Dict{String,<:Any}) @@ -205,8 +245,10 @@ end describe_edge_configuration(params::Dict{String,<:Any}) Describes a stream’s edge configuration that was set using the -StartEdgeConfigurationUpdate API. Use this API to get the status of the configuration if -the configuration is in sync with the Edge Agent. +StartEdgeConfigurationUpdate API and the latest status of the edge agent's recorder and +uploader jobs. Use this API to get the status of the configuration to determine if the +configuration is in sync with the Edge Agent. Use this API to evaluate the health of the +Edge Agent. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -275,9 +317,8 @@ end describe_mapped_resource_configuration() describe_mapped_resource_configuration(params::Dict{String,<:Any}) -Returns the most current information about the stream. Either streamName or streamARN -should be provided in the input. Returns the most current information about the stream. The -streamName or streamARN should be provided in the input. +Returns the most current information about the stream. The streamName or streamARN should +be provided in the input. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -531,6 +572,52 @@ function get_signaling_channel_endpoint( ) end +""" + list_edge_agent_configurations(hub_device_arn) + list_edge_agent_configurations(hub_device_arn, params::Dict{String,<:Any}) + +Returns an array of edge configurations associated with the specified Edge Agent. In the +request, you must specify the Edge Agent HubDeviceArn. + +# Arguments +- `hub_device_arn`: The \"Internet of Things (IoT) Thing\" Arn of the edge agent. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"MaxResults"`: The maximum number of edge configurations to return in the response. The + default is 5. +- `"NextToken"`: If you specify this parameter, when the result of a + ListEdgeAgentConfigurations operation is truncated, the call returns the NextToken in the + response. To get another batch of edge configurations, provide this token in your next + request. +""" +function list_edge_agent_configurations( + HubDeviceArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return kinesis_video( + "POST", + "/listEdgeAgentConfigurations", + Dict{String,Any}("HubDeviceArn" => HubDeviceArn); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function list_edge_agent_configurations( + HubDeviceArn, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return kinesis_video( + "POST", + "/listEdgeAgentConfigurations", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("HubDeviceArn" => HubDeviceArn), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ list_signaling_channels() list_signaling_channels(params::Dict{String,<:Any}) diff --git a/src/services/lambda.jl b/src/services/lambda.jl index 5182bc5162..c497b643d3 100644 --- a/src/services/lambda.jl +++ b/src/services/lambda.jl @@ -367,10 +367,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"SourceAccessConfigurations"`: An array of authentication protocols or VPC components required to secure your event source. - `"StartingPosition"`: The position in a stream from which to start reading. Required for - Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is supported - only for Amazon Kinesis streams and Amazon DocumentDB. + Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for + Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka. - `"StartingPositionTimestamp"`: With StartingPosition set to AT_TIMESTAMP, the time from - which to start reading. + which to start reading. StartingPositionTimestamp cannot be in the future. - `"Topics"`: The name of the Kafka topic. - `"TumblingWindowInSeconds"`: (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds @@ -711,10 +711,11 @@ end delete_function(function_name, params::Dict{String,<:Any}) Deletes a Lambda function. To delete a specific function version, use the Qualifier -parameter. Otherwise, all versions and aliases are deleted. To delete Lambda event source -mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services and -resources that invoke your function directly, delete the trigger in the service where you -originally configured it. +parameter. Otherwise, all versions and aliases are deleted. This doesn't require the user +to have explicit permissions for DeleteAlias. To delete Lambda event source mappings that +invoke a function, use DeleteEventSourceMapping. For Amazon Web Services and resources that +invoke your function directly, delete the trigger in the service where you originally +configured it. # Arguments - `function_name`: The name of the Lambda function or version. Name formats Function diff --git a/src/services/location.jl b/src/services/location.jl index fb4a0ae3bc..d72b9307b9 100644 --- a/src/services/location.jl +++ b/src/services/location.jl @@ -269,26 +269,26 @@ end batch_update_device_position(tracker_name, updates) batch_update_device_position(tracker_name, updates, params::Dict{String,<:Any}) -Uploads position update data for one or more devices to a tracker resource. Amazon Location -uses the data when it reports the last known device position and position history. Amazon -Location retains location data for 30 days. Position updates are handled based on the -PositionFiltering property of the tracker. When PositionFiltering is set to TimeBased, -updates are evaluated against linked geofence collections, and location data is stored at a -maximum of one position per 30 second interval. If your update frequency is more often than -every 30 seconds, only one update per 30 seconds is stored for each unique device ID. When -PositionFiltering is set to DistanceBased filtering, location data is stored and evaluated -against linked geofence collections only if the device has moved more than 30 m (98.4 ft). -When PositionFiltering is set to AccuracyBased filtering, location data is stored and -evaluated against linked geofence collections only if the device has moved more than the -measured accuracy. For example, if two consecutive updates from a device have a horizontal -accuracy of 5 m and 10 m, the second update is neither stored or evaluated if the device -has moved less than 15 m. If PositionFiltering is set to AccuracyBased filtering, Amazon -Location uses the default value { \"Horizontal\": 0} when accuracy is not provided on a -DevicePositionUpdate. +Uploads position update data for one or more devices to a tracker resource (up to 10 +devices per batch). Amazon Location uses the data when it reports the last known device +position and position history. Amazon Location retains location data for 30 days. Position +updates are handled based on the PositionFiltering property of the tracker. When +PositionFiltering is set to TimeBased, updates are evaluated against linked geofence +collections, and location data is stored at a maximum of one position per 30 second +interval. If your update frequency is more often than every 30 seconds, only one update per +30 seconds is stored for each unique device ID. When PositionFiltering is set to +DistanceBased filtering, location data is stored and evaluated against linked geofence +collections only if the device has moved more than 30 m (98.4 ft). When PositionFiltering +is set to AccuracyBased filtering, location data is stored and evaluated against linked +geofence collections only if the device has moved more than the measured accuracy. For +example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 +m, the second update is neither stored or evaluated if the device has moved less than 15 m. +If PositionFiltering is set to AccuracyBased filtering, Amazon Location uses the default +value { \"Horizontal\": 0} when accuracy is not provided on a DevicePositionUpdate. # Arguments - `tracker_name`: The name of the tracker resource to update. -- `updates`: Contains the position update details for each device. +- `updates`: Contains the position update details for each device, up to 10 devices. """ function batch_update_device_position( @@ -2101,6 +2101,10 @@ existing geofence if a geofence ID is included in the request. polygon or a circle. Including both will return a validation error. Each geofence polygon can have a maximum of 1,000 vertices. +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"GeofenceProperties"`: Specifies additional user-defined properties to store with the + Geofence. An array of key-value pairs. """ function put_geofence( CollectionName, GeofenceId, Geometry; aws_config::AbstractAWSConfig=global_aws_config() @@ -2222,6 +2226,11 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542. FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error. +- `"FilterCategories"`: A list of one or more Amazon Location categories to filter the + returned places. If you include more than one category, the results will include results + that match any of the categories listed. For more information about using categories, + including a list of Amazon Location categories, see Categories and filtering, in the Amazon + Location Service Developer Guide. - `"FilterCountries"`: An optional parameter that limits the search results by returning only suggestions within the provided list of countries. Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS. @@ -2297,6 +2306,11 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542. FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error. +- `"FilterCategories"`: A list of one or more Amazon Location categories to filter the + returned places. If you include more than one category, the results will include results + that match any of the categories listed. For more information about using categories, + including a list of Amazon Location categories, see Categories and filtering, in the Amazon + Location Service Developer Guide. - `"FilterCountries"`: An optional parameter that limits the search results by returning only places that are in a specified list of countries. Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS. diff --git a/src/services/macie2.jl b/src/services/macie2.jl index 2873752c14..575fbe384e 100644 --- a/src/services/macie2.jl +++ b/src/services/macie2.jl @@ -177,17 +177,24 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys specify for the job (managedDataIdentifierSelector). To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation. - `"managedDataIdentifierSelector"`: The selection type to apply when determining which - managed data identifiers the job uses to analyze data. Valid values are: ALL - Use all the - managed data identifiers that Amazon Macie provides. If you specify this value, don't - specify any values for the managedDataIdentifierIds property. EXCLUDE - Use all the managed - data identifiers that Macie provides except the managed data identifiers specified by the - managedDataIdentifierIds property. INCLUDE - Use only the managed data identifiers - specified by the managedDataIdentifierIds property. NONE - Don't use any managed data - identifiers. If you specify this value, specify at least one custom data identifier for the - job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds - property. If you don't specify a value for this property, the job uses all managed data - identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE - for a recurring job, the job also uses new managed data identifiers as they are released. + managed data identifiers the job uses to analyze data. Valid values are: ALL (default) - + Use all managed data identifiers. If you specify this value, don't specify any values for + the managedDataIdentifierIds property. EXCLUDE - Use all managed data identifiers except + the ones specified by the managedDataIdentifierIds property. INCLUDE - Use only the managed + data identifiers specified by the managedDataIdentifierIds property. NONE - Don't use any + managed data identifiers. If you specify this value, specify at least one custom data + identifier for the job (customDataIdentifierIds) and don't specify any values for the + managedDataIdentifierIds property. RECOMMENDED - Use only the set of managed data + identifiers that Amazon Web Services recommends for jobs. If you specify this value, don't + specify any values for the managedDataIdentifierIds property. If you don't specify a value + for this property, the job uses all managed data identifiers. If the job is a recurring job + and you don't specify a value for this property or you specify ALL or EXCLUDE, each job run + automatically uses new managed data identifiers that are released. If you specify + RECOMMENDED for a recurring job, each job run automatically uses all the managed data + identifiers that are in the recommended set when the job starts to run. For information + about individual managed data identifiers or to determine which ones are in the recommended + set, see Using managed data identifiers and Recommended managed data identifiers in the + Amazon Macie User Guide. - `"samplingPercentage"`: The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at @@ -285,7 +292,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50. - `"severityLevels"`: The severity to assign to findings that the custom data identifier - produces, based on the number of occurrences of text that matches the custom data + produces, based on the number of occurrences of text that match the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For @@ -1253,7 +1260,7 @@ end get_finding_statistics(group_by) get_finding_statistics(group_by, params::Dict{String,<:Any}) - Retrieves (queries) aggregated statistical data about findings. +Retrieves (queries) aggregated statistical data about findings. # Arguments - `group_by`: The finding property to use to group the query results. Valid values are: diff --git a/src/services/mq.jl b/src/services/mq.jl index 810818bae8..69f6b4e24a 100644 --- a/src/services/mq.jl +++ b/src/services/mq.jl @@ -17,17 +17,21 @@ broker instance. ec2:DeleteNetworkInterface ec2:DeleteNetworkInterfacePermission ec2:DetachNetworkInterface ec2:DescribeInternetGateways ec2:DescribeNetworkInterfaces ec2:DescribeNetworkInterfacePermissions ec2:DescribeRouteTables ec2:DescribeSecurityGroups ec2:DescribeSubnets ec2:DescribeVpcs For more information, see Create an IAM User and Get -Your AWS Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in -the Amazon MQ Developer Guide. +Your Amazon Web Services Credentials and Never Modify or Delete the Amazon MQ Elastic +Network Interface in the Amazon MQ Developer Guide. # Arguments - `auto_minor_version_upgrade`: Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot. Set to true by default, if no value is specified. -- `broker_name`: Required. The broker's name. This value must be unique in your AWS - account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, - and must not contain white spaces, brackets, wildcard characters, or special characters. +- `broker_name`: Required. The broker's name. This value must be unique in your Amazon Web + Services account, 1-50 characters long, must contain only letters, numbers, dashes, and + underscores, and must not contain white spaces, brackets, wildcard characters, or special + characters. Do not add personally identifiable information (PII) or other confidential or + sensitive information in broker names. Broker names are accessible to other Amazon Web + Services services, including CloudWatch Logs. Broker names are not intended to be used for + private or sensitive data. - `deployment_mode`: Required. The broker's deployment mode. - `engine_type`: Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ. @@ -36,13 +40,10 @@ the Amazon MQ Developer Guide. - `host_instance_type`: Required. The broker's instance type. - `publicly_accessible`: Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided. -- `users`: Required. The list of broker users (persons or applications) who can access - queues and topics. This value can contain only alphanumeric characters, dashes, periods, - underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Amazon MQ for - RabbitMQ When you create an Amazon MQ for RabbitMQ broker, one and only one administrative - user is accepted and created when a broker is first provisioned. All subsequent broker - users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web - console. +- `users`: The list of broker users (persons or applications) who can access queues and + topics. For Amazon MQ for RabbitMQ brokers, one and only one administrative user is + accepted and created when a broker is first provisioned. All subsequent broker users are + created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -50,11 +51,14 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys broker. The default is SIMPLE. - `"configuration"`: A list of information about the configuration. - `"creatorRequestId"`: The unique ID that the requester receives for the created broker. - Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique + Amazon MQ passes your ID with the API action. We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency. -- `"encryptionOptions"`: Encryption options for the broker. Does not apply to RabbitMQ - brokers. +- `"dataReplicationMode"`: Defines whether this broker is a part of a data replication pair. +- `"dataReplicationPrimaryBrokerArn"`: The Amazon Resource Name (ARN) of the primary broker + that is used to replicate data from in a data replication pair, and is applied to the + replica broker. Must be set when dataReplicationMode is set to CRDR. +- `"encryptionOptions"`: Encryption options for the broker. - `"ldapServerMetadata"`: Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers. - `"logs"`: Enables Amazon CloudWatch logging for brokers. @@ -71,8 +75,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet. If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to - which the specified subnets belong must be owned by your AWS account. Amazon MQ will not be - able to create VPC endpoints in VPCs that are not owned by your AWS account. + which the specified subnets belong must be owned by your Amazon Web Services account. + Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your + Amazon Web Services account. - `"tags"`: Create tags when creating the broker. """ function create_broker( @@ -241,7 +246,10 @@ end create_user(broker-id, password, username) create_user(broker-id, password, username, params::Dict{String,<:Any}) -Creates an ActiveMQ user. +Creates an ActiveMQ user. Do not add personally identifiable information (PII) or other +confidential or sensitive information in broker usernames. Broker usernames are accessible +to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not +intended to be used for private or sensitive data. # Arguments - `broker-id`: The unique ID that Amazon MQ generates for the broker. @@ -258,6 +266,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"groups"`: The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. +- `"replicationUser"`: Defines if this user is intended for CRDR replication purposes. """ function create_user( broker_id, password, username; aws_config::AbstractAWSConfig=global_aws_config() @@ -771,6 +780,42 @@ function list_users( ) end +""" + promote(broker-id, mode) + promote(broker-id, mode, params::Dict{String,<:Any}) + +Promotes a data replication replica broker to the primary broker role. + +# Arguments +- `broker-id`: The unique ID that Amazon MQ generates for the broker. +- `mode`: The Promote mode requested. Note: Valid values for the parameter are SWITCHOVER, + FAILOVER. + +""" +function promote(broker_id, mode; aws_config::AbstractAWSConfig=global_aws_config()) + return mq( + "POST", + "/v1/brokers/$(broker-id)/promote", + Dict{String,Any}("mode" => mode); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function promote( + broker_id, + mode, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return mq( + "POST", + "/v1/brokers/$(broker-id)/promote", + Dict{String,Any}(mergewith(_merge, Dict{String,Any}("mode" => mode), params)); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ reboot_broker(broker-id) reboot_broker(broker-id, params::Dict{String,<:Any}) @@ -820,6 +865,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot. - `"configuration"`: A list of information about the configuration. +- `"dataReplicationMode"`: Defines whether this broker is a part of a data replication pair. - `"engineVersion"`: The broker engine version. For a list of supported engine versions, see Supported engines. - `"hostInstanceType"`: The broker's host instance type to upgrade to. For a list of @@ -861,7 +907,8 @@ Updates the specified configuration. # Arguments - `configuration-id`: The unique ID that Amazon MQ generates for the configuration. -- `data`: Required. The base64-encoded XML configuration. +- `data`: Amazon MQ for Active MQ: The base64-encoded XML configuration. Amazon MQ for + RabbitMQ: the base64-encoded Cuttlefish configuration. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -914,6 +961,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"password"`: The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=). +- `"replicationUser"`: Defines whether the user is intended for data replication. """ function update_user(broker_id, username; aws_config::AbstractAWSConfig=global_aws_config()) return mq( diff --git a/src/services/privatenetworks.jl b/src/services/privatenetworks.jl index 6120179103..0179387eef 100644 --- a/src/services/privatenetworks.jl +++ b/src/services/privatenetworks.jl @@ -100,6 +100,14 @@ Activates the specified network site. Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"clientToken"`: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency. +- `"commitmentConfiguration"`: Determines the duration and renewal status of the commitment + period for all pending radio units. If you include commitmentConfiguration in the + ActivateNetworkSiteRequest action, you must specify the following: The commitment period + for the radio unit. You can choose a 60-day, 1-year, or 3-year period. Whether you want + your commitment period to automatically renew for one more year after your current + commitment period expires. For pricing, see Amazon Web Services Private 5G Pricing. If + you do not include commitmentConfiguration in the ActivateNetworkSiteRequest action, the + commitment period is set to 60-days. """ function activate_network_site( networkSiteArn, shippingAddress; aws_config::AbstractAWSConfig=global_aws_config() @@ -855,21 +863,38 @@ end start_network_resource_update(network_resource_arn, update_type) start_network_resource_update(network_resource_arn, update_type, params::Dict{String,<:Any}) -Starts an update of the specified network resource. After you submit a request to replace -or return a network resource, the status of the network resource is -CREATING_SHIPPING_LABEL. The shipping label is available when the status of the network -resource is PENDING_RETURN. After the network resource is successfully returned, its status -is DELETED. For more information, see Return a radio unit. +Use this action to do the following tasks: Update the duration and renewal status of the +commitment period for a radio unit. The update goes into effect immediately. Request a +replacement for a network resource. Request that you return a network resource. After +you submit a request to replace or return a network resource, the status of the network +resource changes to CREATING_SHIPPING_LABEL. The shipping label is available when the +status of the network resource is PENDING_RETURN. After the network resource is +successfully returned, its status changes to DELETED. For more information, see Return a +radio unit. # Arguments - `network_resource_arn`: The Amazon Resource Name (ARN) of the network resource. - `update_type`: The update type. REPLACE - Submits a request to replace a defective radio unit. We provide a shipping label that you can use for the return process and we ship - a replacement radio unit to you. RETURN - Submits a request to replace a radio unit that + a replacement radio unit to you. RETURN - Submits a request to return a radio unit that you no longer need. We provide a shipping label that you can use for the return process. + COMMITMENT - Submits a request to change or renew the commitment period. If you choose this + value, then you must set commitmentConfiguration . # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"commitmentConfiguration"`: Use this action to extend and automatically renew the + commitment period for the radio unit. You can do the following: Change a 60-day + commitment to a 1-year or 3-year commitment. The change is immediate and the hourly rate + decreases to the rate for the new commitment period. Change a 1-year commitment to a + 3-year commitment. The change is immediate and the hourly rate decreases to the rate for + the 3-year commitment period. Set a 1-year commitment to automatically renew for an + additional 1 year. The hourly rate for the additional year will continue to be the same as + your existing 1-year rate. Set a 3-year commitment to automatically renew for an + additional 1 year. The hourly rate for the additional year will continue to be the same as + your existing 3-year rate. Turn off a previously-enabled automatic renewal on a 1-year or + 3-year commitment. You cannot use the automatic-renewal option for a 60-day commitment. + For pricing, see Amazon Web Services Private 5G Pricing. - `"returnReason"`: The reason for the return. Providing a reason for a return is optional. - `"shippingAddress"`: The shipping address. If you don't provide a shipping address when replacing or returning a network resource, we use the address from the original order for diff --git a/src/services/rds.jl b/src/services/rds.jl index 475dcbfaf1..b2c5a516f7 100644 --- a/src/services/rds.jl +++ b/src/services/rds.jl @@ -1073,103 +1073,104 @@ RDS for MySQL or PostgreSQL DB instance as the source. For more information abou DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. # Arguments -- `dbcluster_identifier`: The DB cluster identifier. This parameter is stored as a - lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. - First character must be a letter. Can't end with a hyphen or contain two consecutive - hyphens. Example: my-cluster1 Valid for: Aurora DB clusters and Multi-AZ DB clusters -- `engine`: The name of the database engine to be used for this DB cluster. Valid Values: - aurora-mysql aurora-postgresql mysql postgres Valid for: Aurora DB clusters - and Multi-AZ DB clusters +- `dbcluster_identifier`: The identifier for this DB cluster. This parameter is stored as a + lowercase string. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character + must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: + my-cluster1 +- `engine`: The database engine to use for this DB cluster. Valid for Cluster Type: Aurora + DB clusters and Multi-AZ DB clusters Valid Values: aurora-mysql | aurora-postgresql | mysql + | postgres # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"AllocatedStorage"`: The amount of storage in gibibytes (GiB) to allocate to each DB - instance in the Multi-AZ DB cluster. This setting is required to create a Multi-AZ DB - cluster. Valid for: Multi-AZ DB clusters only -- `"AutoMinorVersionUpgrade"`: A value that indicates whether minor engine upgrades are - applied automatically to the DB cluster during the maintenance window. By default, minor - engine upgrades are applied automatically. Valid for: Multi-AZ DB clusters only + instance in the Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only This + setting is required to create a Multi-AZ DB cluster. +- `"AutoMinorVersionUpgrade"`: Specifies whether minor engine upgrades are applied + automatically to the DB cluster during the maintenance window. By default, minor engine + upgrades are applied automatically. Valid for Cluster Type: Multi-AZ DB clusters only - `"AvailabilityZones"`: A list of Availability Zones (AZs) where DB instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. - Valid for: Aurora DB clusters only + Valid for Cluster Type: Aurora DB clusters only - `"BacktrackWindow"`: The target backtrack window, in seconds. To disable backtracking, - set this value to 0. Default: 0 Constraints: If specified, this value must be set to a - number from 0 to 259,200 (72 hours). Valid for: Aurora MySQL DB clusters only + set this value to 0. Valid for Cluster Type: Aurora MySQL DB clusters only Default: 0 + Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 + hours). - `"BackupRetentionPeriod"`: The number of days for which automated backups are retained. - Default: 1 Constraints: Must be a value from 1 to 35 Valid for: Aurora DB clusters and - Multi-AZ DB clusters -- `"CharacterSetName"`: A value that indicates that the DB cluster should be associated - with the specified CharacterSet. Valid for: Aurora DB clusters only -- `"CopyTagsToSnapshot"`: A value that indicates whether to copy all tags from the DB - cluster to snapshots of the DB cluster. The default is not to copy them. Valid for: Aurora - DB clusters and Multi-AZ DB clusters + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Default: 1 + Constraints: Must be a value from 1 to 35. +- `"CharacterSetName"`: The name of the character set (CharacterSet) to associate the DB + cluster with. Valid for Cluster Type: Aurora DB clusters only +- `"CopyTagsToSnapshot"`: Specifies whether to copy all tags from the DB cluster to + snapshots of the DB cluster. The default is not to copy them. Valid for Cluster Type: + Aurora DB clusters and Multi-AZ DB clusters - `"DBClusterInstanceClass"`: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS - User Guide. This setting is required to create a Multi-AZ DB cluster. Valid for: Multi-AZ - DB clusters only + User Guide. This setting is required to create a Multi-AZ DB cluster. Valid for Cluster + Type: Multi-AZ DB clusters only - `"DBClusterParameterGroupName"`: The name of the DB cluster parameter group to associate - with this DB cluster. If you do not specify a value, then the default DB cluster parameter - group for the specified DB engine and version is used. Constraints: If supplied, must - match the name of an existing DB cluster parameter group. Valid for: Aurora DB clusters - and Multi-AZ DB clusters + with this DB cluster. If you don't specify a value, then the default DB cluster parameter + group for the specified DB engine and version is used. Valid for Cluster Type: Aurora DB + clusters and Multi-AZ DB clusters Constraints: If supplied, must match the name of an + existing DB cluster parameter group. - `"DBSubnetGroupName"`: A DB subnet group to associate with this DB cluster. This setting - is required to create a Multi-AZ DB cluster. Constraints: Must match the name of an - existing DBSubnetGroup. Must not be default. Example: mydbsubnetgroup Valid for: Aurora DB - clusters and Multi-AZ DB clusters + is required to create a Multi-AZ DB cluster. Valid for Cluster Type: Aurora DB clusters and + Multi-AZ DB clusters Constraints: Must match the name of an existing DB subnet group. + Must not be default. Example: mydbsubnetgroup - `"DBSystemId"`: Reserved for future use. - `"DatabaseName"`: The name for your database of up to 64 alphanumeric characters. If you - do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are - creating. Valid for: Aurora DB clusters and Multi-AZ DB clusters -- `"DeletionProtection"`: A value that indicates whether the DB cluster has deletion - protection enabled. The database can't be deleted when deletion protection is enabled. By - default, deletion protection isn't enabled. Valid for: Aurora DB clusters and Multi-AZ DB + don't provide a name, Amazon RDS doesn't create a database in the DB cluster you are + creating. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters +- `"DeletionProtection"`: Specifies whether the DB cluster has deletion protection enabled. + The database can't be deleted when deletion protection is enabled. By default, deletion + protection isn't enabled. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters - `"Domain"`: The Active Directory directory ID to create the DB cluster in. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos authentication in the Amazon - Aurora User Guide. Valid for: Aurora DB clusters only -- `"DomainIAMRoleName"`: Specify the name of the IAM role to be used when making API calls - to the Directory Service. Valid for: Aurora DB clusters only + Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only +- `"DomainIAMRoleName"`: The name of the IAM role to use when making API calls to the + Directory Service. Valid for Cluster Type: Aurora DB clusters only - `"EnableCloudwatchLogsExports"`: The list of log types that need to be enabled for - exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. - RDS for MySQL Possible values are error, general, and slowquery. RDS for PostgreSQL - Possible values are postgresql and upgrade. Aurora MySQL Possible values are audit, - error, general, and slowquery. Aurora PostgreSQL Possible value is postgresql. For more - information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to - Amazon CloudWatch Logs in the Amazon RDS User Guide. For more information about exporting - CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs - in the Amazon Aurora User Guide. Valid for: Aurora DB clusters and Multi-AZ DB clusters -- `"EnableGlobalWriteForwarding"`: A value that indicates whether to enable this DB cluster - to forward write operations to the primary cluster of an Aurora global database - (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that - are secondary clusters in an Aurora global database. You can set this value only on Aurora - DB clusters that are members of an Aurora global database. With this parameter enabled, a - secondary cluster can forward writes to the current primary cluster and the resulting - changes are replicated back to this cluster. For the primary DB cluster of an Aurora global - database, this value is used immediately if the primary is demoted by the - FailoverGlobalCluster API operation, but it does nothing until then. Valid for: Aurora DB - clusters only -- `"EnableHttpEndpoint"`: A value that indicates whether to enable the HTTP endpoint for an - Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled. When enabled, - the HTTP endpoint provides a connectionless web service API for running SQL queries on the - Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS - console with the query editor. For more information, see Using the Data API for Aurora - Serverless v1 in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only -- `"EnableIAMDatabaseAuthentication"`: A value that indicates whether to enable mapping of - Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By - default, mapping isn't enabled. For more information, see IAM Database Authentication in - the Amazon Aurora User Guide. Valid for: Aurora DB clusters only -- `"EnablePerformanceInsights"`: A value that indicates whether to turn on Performance - Insights for the DB cluster. For more information, see Using Amazon Performance Insights - in the Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only + exporting to CloudWatch Logs. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB + clusters The following values are valid for each DB engine: Aurora MySQL - audit | error + | general | slowquery Aurora PostgreSQL - postgresql RDS for MySQL - error | general + | slowquery RDS for PostgreSQL - postgresql | upgrade For more information about + exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch + Logs in the Amazon RDS User Guide. For more information about exporting CloudWatch Logs for + Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora + User Guide. +- `"EnableGlobalWriteForwarding"`: Specifies whether to enable this DB cluster to forward + write operations to the primary cluster of a global cluster (Aurora global database). By + default, write operations are not allowed on Aurora DB clusters that are secondary clusters + in an Aurora global database. You can set this value only on Aurora DB clusters that are + members of an Aurora global database. With this parameter enabled, a secondary cluster can + forward writes to the current primary cluster, and the resulting changes are replicated + back to this cluster. For the primary DB cluster of an Aurora global database, this value + is used immediately if the primary is demoted by a global cluster API operation, but it + does nothing until then. Valid for Cluster Type: Aurora DB clusters only +- `"EnableHttpEndpoint"`: Specifies whether to enable the HTTP endpoint for an Aurora + Serverless v1 DB cluster. By default, the HTTP endpoint is disabled. When enabled, the HTTP + endpoint provides a connectionless web service API for running SQL queries on the Aurora + Serverless v1 DB cluster. You can also query your database from inside the RDS console with + the query editor. For more information, see Using the Data API for Aurora Serverless v1 in + the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only +- `"EnableIAMDatabaseAuthentication"`: Specifies whether to enable mapping of Amazon Web + Services Identity and Access Management (IAM) accounts to database accounts. By default, + mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon + Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only +- `"EnablePerformanceInsights"`: Specifies whether to turn on Performance Insights for the + DB cluster. For more information, see Using Amazon Performance Insights in the Amazon RDS + User Guide. Valid for Cluster Type: Multi-AZ DB clusters only - `"EngineMode"`: The DB engine mode of the DB cluster, either provisioned or serverless. The serverless engine mode only applies for Aurora Serverless v1 DB clusters. For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide: Limitations of Aurora Serverless v1 - Requirements for Aurora Serverless v2 Valid for: Aurora DB clusters only + Requirements for Aurora Serverless v2 Valid for Cluster Type: Aurora DB clusters only - `"EngineVersion"`: The version number of the database engine to use. To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command: aws rds describe-db-engine-versions --engine @@ -1181,45 +1182,47 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys for MySQL, use the following command: aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\" To list all of the available engine versions for RDS for PostgreSQL, use the following command: aws rds describe-db-engine-versions - --engine postgres --query \"DBEngineVersions[].EngineVersion\" Aurora MySQL For - information, see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User - Guide. Aurora PostgreSQL For information, see Amazon Aurora PostgreSQL releases and - engine versions in the Amazon Aurora User Guide. MySQL For information, see Amazon RDS - for MySQL in the Amazon RDS User Guide. PostgreSQL For information, see Amazon RDS for - PostgreSQL in the Amazon RDS User Guide. Valid for: Aurora DB clusters and Multi-AZ DB - clusters + --engine postgres --query \"DBEngineVersions[].EngineVersion\" For information about a + specific engine, see the following topics: Aurora MySQL - see Database engine updates for + Amazon Aurora MySQL in the Amazon Aurora User Guide. Aurora PostgreSQL - see Amazon + Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide. RDS for + MySQL - see Amazon RDS for MySQL in the Amazon RDS User Guide. RDS for PostgreSQL - see + Amazon RDS for PostgreSQL in the Amazon RDS User Guide. Valid for Cluster Type: Aurora DB + clusters and Multi-AZ DB clusters - `"GlobalClusterIdentifier"`: The global cluster ID of an Aurora cluster that becomes the - primary cluster in the new global database cluster. Valid for: Aurora DB clusters only + primary cluster in the new global database cluster. Valid for Cluster Type: Aurora DB + clusters only - `"Iops"`: The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide. This setting - is required to create a Multi-AZ DB cluster. Constraints: Must be a multiple between .5 and - 50 of the storage amount for the DB cluster. Valid for: Multi-AZ DB clusters only + is required to create a Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters + only Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB + cluster. - `"KmsKeyId"`: The Amazon Web Services KMS key identifier for an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. When a KMS key isn't specified in KmsKeyId: If - ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the - KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key. - If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't - specified, then Amazon RDS will use your default KMS key. There is a default KMS key for - your Amazon Web Services account. Your Amazon Web Services account has a different default - KMS key for each Amazon Web Services Region. If you create a read replica of an encrypted - DB cluster in another Amazon Web Services Region, you must set KmsKeyId to a KMS key - identifier that is valid in the destination Amazon Web Services Region. This KMS key is - used to encrypt the read replica in that Amazon Web Services Region. Valid for: Aurora DB - clusters and Multi-AZ DB clusters -- `"ManageMasterUserPassword"`: A value that indicates whether to manage the master user - password with Amazon Web Services Secrets Manager. For more information, see Password - management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and - Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User - Guide. Constraints: Can't manage the master user password with Amazon Web Services - Secrets Manager if MasterUserPassword is specified. Valid for: Aurora DB clusters and - Multi-AZ DB clusters -- `"MasterUserPassword"`: The password for the master database user. This password can - contain any printable ASCII character except \"/\", \"\"\", or \"@\". Constraints: Must - contain from 8 to 41 characters. Can't be specified if ManageMasterUserPassword is turned - on. Valid for: Aurora DB clusters and Multi-AZ DB clusters + ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS uses the KMS + key used to encrypt the source. Otherwise, Amazon RDS uses your default KMS key. If the + StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then + Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web + Services account. Your Amazon Web Services account has a different default KMS key for each + Amazon Web Services Region. If you create a read replica of an encrypted DB cluster in + another Amazon Web Services Region, make sure to set KmsKeyId to a KMS key identifier that + is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the + read replica in that Amazon Web Services Region. Valid for Cluster Type: Aurora DB clusters + and Multi-AZ DB clusters +- `"ManageMasterUserPassword"`: Specifies whether to manage the master user password with + Amazon Web Services Secrets Manager. For more information, see Password management with + Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management + with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide. Valid for + Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: Can't manage the + master user password with Amazon Web Services Secrets Manager if MasterUserPassword is + specified. +- `"MasterUserPassword"`: The password for the master database user. Valid for Cluster + Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: Must contain from 8 to 41 + characters. Can contain any printable ASCII character except \"/\", \"\"\", or \"@\". + Can't be specified if ManageMasterUserPassword is turned on. - `"MasterUserSecretKmsKeyId"`: The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by RDS in Amazon Web @@ -1231,47 +1234,45 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Valid - for: Aurora DB clusters and Multi-AZ DB clusters -- `"MasterUsername"`: The name of the master user for the DB cluster. Constraints: Must - be 1 to 16 letters or numbers. First character must be a letter. Can't be a reserved - word for the chosen database engine. Valid for: Aurora DB clusters and Multi-AZ DB - clusters + for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters +- `"MasterUsername"`: The name of the master user for the DB cluster. Valid for Cluster + Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: Must be 1 to 16 letters or + numbers. First character must be a letter. Can't be a reserved word for the chosen + database engine. - `"MonitoringInterval"`: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring - metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, also set - MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60 Valid - for: Multi-AZ DB clusters only + metrics, specify 0. If MonitoringRoleArn is specified, also set MonitoringInterval to a + value other than 0. Valid for Cluster Type: Multi-AZ DB clusters only Valid Values: 0 | 1 | + 5 | 10 | 15 | 30 | 60 Default: 0 - `"MonitoringRoleArn"`: The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value. Valid - for: Multi-AZ DB clusters only -- `"NetworkType"`: The network type of the DB cluster. Valid values: IPV4 DUAL - The network type is determined by the DBSubnetGroup specified for the DB cluster. A - DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). - For more information, see Working with a DB instance in a VPC in the Amazon Aurora User - Guide. Valid for: Aurora DB clusters only -- `"OptionGroupName"`: A value that indicates that the DB cluster should be associated with - the specified option group. DB clusters are associated with a default option group that - can't be modified. + for Cluster Type: Multi-AZ DB clusters only +- `"NetworkType"`: The network type of the DB cluster. The network type is determined by + the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 + protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with + a DB instance in a VPC in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB + clusters only Valid Values: IPV4 | DUAL +- `"OptionGroupName"`: The option group to associate the DB cluster with. DB clusters are + associated with a default option group that can't be modified. - `"PerformanceInsightsKMSKeyId"`: The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a - different default KMS key for each Amazon Web Services Region. Valid for: Multi-AZ DB - clusters only -- `"PerformanceInsightsRetentionPeriod"`: The number of days to retain Performance Insights - data. The default is 7 days. The following values are valid: 7 month * 31, where month - is a number of months from 1-23 731 For example, the following values are valid: 93 - (3 months * 31) 341 (11 months * 31) 589 (19 months * 31) 731 If you specify a - retention period such as 94, which isn't a valid value, RDS issues an error. Valid for: + different default KMS key for each Amazon Web Services Region. Valid for Cluster Type: Multi-AZ DB clusters only +- `"PerformanceInsightsRetentionPeriod"`: The number of days to retain Performance Insights + data. Valid for Cluster Type: Multi-AZ DB clusters only Valid Values: 7 month * 31, + where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * + 31), 589 (19 months * 31) 731 Default: 7 days If you specify a retention period that + isn't valid, such as 94, Amazon RDS issues an error. - `"Port"`: The port number on which the instances in the DB cluster accept connections. - RDS for MySQL and Aurora MySQL Default: 3306 Valid values: 1150-65535 RDS for - PostgreSQL and Aurora PostgreSQL Default: 5432 Valid values: 1150-65535 Valid for: - Aurora DB clusters and Multi-AZ DB clusters + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: + 1150-65535 Default: RDS for MySQL and Aurora MySQL - 3306 RDS for PostgreSQL and + Aurora PostgreSQL - 5432 - `"PreSignedUrl"`: When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region @@ -1295,62 +1296,63 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that - can run in the source Amazon Web Services Region. Valid for: Aurora DB clusters onlyIf you - supply a value for this operation's SourceRegion parameter, a pre-signed URL will be - calculated on your behalf. + can run in the source Amazon Web Services Region. Valid for Cluster Type: Aurora DB + clusters onlyIf you supply a value for this operation's SourceRegion parameter, a + pre-signed URL will be calculated on your behalf. - `"PreferredBackupWindow"`: The daily time range during which automated backups are - created if automated backups are enabled using the BackupRetentionPeriod parameter. The - default is a 30-minute window selected at random from an 8-hour block of time for each - Amazon Web Services Region. To view the time blocks available, see Backup window in the - Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be - in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance - window. Must be at least 30 minutes. Valid for: Aurora DB clusters and Multi-AZ DB - clusters + created if automated backups are enabled using the BackupRetentionPeriod parameter. Valid + for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters The default is a 30-minute + window selected at random from an 8-hour block of time for each Amazon Web Services Region. + To view the time blocks available, see Backup window in the Amazon Aurora User Guide. + Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated + Time (UTC). Must not conflict with the preferred maintenance window. Must be at least + 30 minutes. - `"PreferredMaintenanceWindow"`: The weekly time range during which system maintenance can - occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is - a 30-minute window selected at random from an 8-hour block of time for each Amazon Web + occur. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters The default is 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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. - Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. Valid - for: Aurora DB clusters and Multi-AZ DB clusters -- `"PubliclyAccessible"`: A value that indicates whether the DB cluster is publicly - accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) - endpoint resolves to the private IP address from within the DB cluster's virtual private - cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. - Access to the DB cluster is ultimately controlled by the security group it uses. That - public access isn't permitted if the security group assigned to the DB cluster doesn't - permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with - a DNS name that resolves to a private IP address. Default: The default behavior varies - depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, - and PubliclyAccessible isn't specified, the following applies: If the default VPC in the - target Region doesn’t have an internet gateway attached to it, the DB cluster is private. - If the default VPC in the target Region has an internet gateway attached to it, the DB - cluster is public. If DBSubnetGroupName is specified, and PubliclyAccessible isn't - specified, the following applies: If the subnets are part of a VPC that doesn’t have an - internet gateway attached to it, the DB cluster is private. If the subnets are part of a - VPC that has an internet gateway attached to it, the DB cluster is public. Valid for: - Multi-AZ DB clusters only + Constraints: Must be in the format ddd:hh24:mi-ddd:hh24:mi. Days must be one of Mon | + Tue | Wed | Thu | Fri | Sat | Sun. Must be in Universal Coordinated Time (UTC). Must be + at least 30 minutes. +- `"PubliclyAccessible"`: Specifies whether the DB cluster is publicly accessible. When the + DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the + private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to + the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is + ultimately controlled by the security group it uses. That public access isn't permitted if + the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't + publicly accessible, it is an internal DB cluster with a DNS name that resolves to a + private IP address. Valid for Cluster Type: Multi-AZ DB clusters only Default: The default + behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName + isn't specified, and PubliclyAccessible isn't specified, the following applies: If the + default VPC in the target Region doesn’t have an internet gateway attached to it, the DB + cluster is private. If the default VPC in the target Region has an internet gateway + attached to it, the DB cluster is public. If DBSubnetGroupName is specified, and + PubliclyAccessible isn't specified, the following applies: If the subnets are part of a + VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. If + the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster + is public. - `"ReplicationSourceIdentifier"`: The Amazon Resource Name (ARN) of the source DB instance - or DB cluster if this DB cluster is created as a read replica. Valid for: Aurora DB - clusters and Multi-AZ DB clusters + or DB cluster if this DB cluster is created as a read replica. Valid for Cluster Type: + Aurora DB clusters and Multi-AZ DB clusters - `"ScalingConfiguration"`: For DB clusters in serverless DB engine mode, the scaling - properties of the DB cluster. Valid for: Aurora DB clusters only + properties of the DB cluster. Valid for Cluster Type: Aurora DB clusters only - `"ServerlessV2ScalingConfiguration"`: - `"SourceRegion"`: The ID of the region that contains the source for the read replica. -- `"StorageEncrypted"`: A value that indicates whether the DB cluster is encrypted. Valid - for: Aurora DB clusters and Multi-AZ DB clusters -- `"StorageType"`: Specifies the storage type to be associated with the DB cluster. This - setting is required to create a Multi-AZ DB cluster. When specified for a Multi-AZ DB - cluster, a value for the Iops parameter is required. Valid values: aurora, aurora-iopt1 - (Aurora DB clusters); io1 (Multi-AZ DB clusters) Default: aurora (Aurora DB clusters); io1 - (Multi-AZ DB clusters) Valid for: Aurora DB clusters and Multi-AZ DB clusters For more - information on storage types for Aurora DB clusters, see Storage configurations for Amazon - Aurora DB clusters. For more information on storage types for Multi-AZ DB clusters, see - Settings for creating Multi-AZ DB clusters. -- `"Tags"`: Tags to assign to the DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB - clusters +- `"StorageEncrypted"`: Specifies whether the DB cluster is encrypted. Valid for Cluster + Type: Aurora DB clusters and Multi-AZ DB clusters +- `"StorageType"`: The storage type to associate with the DB cluster. For information on + storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB + clusters. For information on storage types for Multi-AZ DB clusters, see Settings for + creating Multi-AZ DB clusters. This setting is required to create a Multi-AZ DB cluster. + When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required. Valid + for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: Aurora DB + clusters - aurora | aurora-iopt1 Multi-AZ DB clusters - io1 Default: Aurora DB + clusters - aurora Multi-AZ DB clusters - io1 +- `"Tags"`: Tags to assign to the DB cluster. Valid for Cluster Type: Aurora DB clusters + and Multi-AZ DB clusters - `"VpcSecurityGroupIds"`: A list of EC2 VPC security groups to associate with this DB - cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters + cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters """ function create_dbcluster( DBClusterIdentifier, Engine; aws_config::AbstractAWSConfig=global_aws_config() @@ -1617,230 +1619,242 @@ Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide. or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. -- `dbinstance_identifier`: The DB instance identifier. This parameter is stored as a - lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. - First character must be a letter. Can't end with a hyphen or contain two consecutive +- `dbinstance_identifier`: The identifier for this DB instance. This parameter is stored as + a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. + First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: mydbinstance -- `engine`: The name of the database engine to be used for this instance. Not every - database engine is available for every Amazon Web Services Region. Valid Values: - aurora-mysql (for Aurora MySQL DB instances) aurora-postgresql (for Aurora PostgreSQL DB - instances) custom-oracle-ee (for RDS Custom for Oracle DB instances) - custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances) custom-sqlserver-ee (for - RDS Custom for SQL Server DB instances) custom-sqlserver-se (for RDS Custom for SQL - Server DB instances) custom-sqlserver-web (for RDS Custom for SQL Server DB instances) - mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb - postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web +- `engine`: The database engine to use for this DB instance. Not every database engine is + available in every Amazon Web Services Region. Valid Values: aurora-mysql (for Aurora + MySQL DB instances) aurora-postgresql (for Aurora PostgreSQL DB instances) + custom-oracle-ee (for RDS Custom for Oracle DB instances) custom-oracle-ee-cdb (for RDS + Custom for Oracle DB instances) custom-sqlserver-ee (for RDS Custom for SQL Server DB + instances) custom-sqlserver-se (for RDS Custom for SQL Server DB instances) + custom-sqlserver-web (for RDS Custom for SQL Server DB instances) mariadb mysql + oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee + sqlserver-se sqlserver-ex sqlserver-web # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"AllocatedStorage"`: The amount of storage in gibibytes (GiB) to allocate for the DB - instance. Type: Integer Amazon Aurora Not applicable. Aurora cluster volumes + instance. This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only - charged for the space that you use in an Aurora cluster volume. Amazon RDS Custom - Constraints to the amount of storage for each storage type are the following: General - Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for - Oracle, 16384 for RDS Custom for SQL Server. Provisioned IOPS storage (io1): Must be an - integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server. - MySQL Constraints to the amount of storage for each storage type are the following: - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536. - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage - (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of - storage for each storage type are the following: General Purpose (SSD) storage (gp2, - gp3): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an - integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to - 3072. PostgreSQL Constraints to the amount of storage for each storage type are the + charged for the space that you use in an Aurora cluster volume. Amazon RDS Custom RDS for + MariaDB RDS for MySQL RDS for Oracle RDS for PostgreSQL RDS for SQL Server Constraints to + the amount of storage for each storage type are the following: General Purpose (SSD) + storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 + for RDS Custom for SQL Server. Provisioned IOPS storage (io1): Must be an integer from 40 + to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server. Constraints to + the amount of storage for each storage type are the following: General Purpose (SSD) + storage (gp2, gp3): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): + Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer + from 5 to 3072. Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage - (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of - storage for each storage type are the following: General Purpose (SSD) storage (gp2, - gp3): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an - integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 10 to - 3072. SQL Server Constraints to the amount of storage for each storage type are the + (standard): Must be an integer from 5 to 3072. Constraints to the amount of storage for + each storage type are the following: General Purpose (SSD) storage (gp2, gp3): Must be an + integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to + 65536. Magnetic storage (standard): Must be an integer from 10 to 3072. Constraints + to the amount of storage for each storage type are the following: General Purpose (SSD) + storage (gp2, gp3): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): + Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer + from 5 to 3072. Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2, gp3): Enterprise and Standard editions: Must be an integer from 20 to 16384. Web and Express editions: Must be an integer from 20 to 16384. Provisioned IOPS storage (io1): Enterprise and Standard editions: Must be an integer from 100 to 16384. Web and Express editions: Must be an integer from 100 to 16384. Magnetic storage (standard): Enterprise and Standard editions: Must be an integer from 20 to 1024. Web and Express editions: Must be an integer from 20 to 1024. -- `"AutoMinorVersionUpgrade"`: A value that indicates whether minor engine upgrades are - applied automatically to the DB instance during the maintenance window. By default, minor - engine upgrades are applied automatically. If you create an RDS Custom DB instance, you - must set AutoMinorVersionUpgrade to false. + +- `"AutoMinorVersionUpgrade"`: Specifies whether minor engine upgrades are applied + automatically to the DB instance during the maintenance window. By default, minor engine + upgrades are applied automatically. If you create an RDS Custom DB instance, you must set + AutoMinorVersionUpgrade to false. - `"AvailabilityZone"`: The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and - Availability Zones. Amazon Aurora Each Aurora DB cluster hosts copies of its storage in - three separate Availability Zones. Specify one of these Availability Zones. Aurora + Availability Zones. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage + in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region. - Example: us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the - DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same - Amazon Web Services Region as the current endpoint. + Constraints: The AvailabilityZone parameter can't be specified if the DB instance is a + Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web + Services Region as the current endpoint. Example: us-east-1d - `"BackupRetentionPeriod"`: The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 - disables automated backups. Amazon Aurora Not applicable. The retention period for - automated backups is managed by the DB cluster. Default: 1 Constraints: Must be a value - from 0 to 35 Can't be set to 0 if the DB instance is a source to read replicas Can't be - set to 0 for an RDS Custom for Oracle DB instance -- `"BackupTarget"`: Specifies where automated backups and manual snapshots are stored. - Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services - Region). The default is region. For more information, see Working with Amazon RDS on Amazon - Web Services Outposts in the Amazon RDS User Guide. -- `"CACertificateIdentifier"`: Specifies the CA certificate identifier to use for the DB - instance’s server certificate. This setting doesn't apply to RDS Custom. For more + disables automated backups. This setting doesn't apply to Amazon Aurora DB instances. The + retention period for automated backups is managed by the DB cluster. Default: 1 + Constraints: Must be a value from 0 to 35. Can't be set to 0 if the DB instance is a + source to read replicas. Can't be set to 0 for an RDS Custom for Oracle DB instance. +- `"BackupTarget"`: The location for storing automated backups and manual snapshots. Valie + Values: outposts (Amazon Web Services Outposts) region (Amazon Web Services Region) + Default: region For more information, see Working with Amazon RDS on Amazon Web Services + Outposts in the Amazon RDS User Guide. +- `"CACertificateIdentifier"`: The CA certificate identifier to use for the DB instance's + server certificate. This setting doesn't apply to RDS Custom DB instances. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide. -- `"CharacterSetName"`: For supported engines, this value indicates that the DB instance - should be associated with the specified CharacterSet. This setting doesn't apply to RDS - Custom. However, if you need to change the character set, you can change it on the database - itself. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For - more information, see CreateDBCluster. -- `"CopyTagsToSnapshot"`: A value that indicates whether to copy tags from the DB instance - to snapshots of the DB instance. By default, tags are not copied. Amazon Aurora Not - applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for - an Aurora DB instance has no effect on the DB cluster setting. +- `"CharacterSetName"`: For supported engines, the character set (CharacterSet) to + associate the DB instance with. This setting doesn't apply to the following DB instances: + Amazon Aurora - The character set is managed by the DB cluster. For more information, see + CreateDBCluster. RDS Custom - However, if you need to change the character set, you can + change it on the database itself. +- `"CopyTagsToSnapshot"`: Spcifies whether to copy tags from the DB instance to snapshots + of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon + Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this + value for an Aurora DB instance has no effect on the DB cluster setting. - `"CustomIamInstanceProfile"`: The instance profile associated with the underlying Amazon - EC2 instance of an RDS Custom DB instance. The instance profile must meet the following - requirements: The profile must exist in your account. The profile must have an IAM role + EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. + Constraints: The profile must exist in your account. The profile must have an IAM role that Amazon EC2 has permissions to assume. The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide. - This setting is required for RDS Custom. -- `"DBClusterIdentifier"`: The identifier of the DB cluster that the instance will belong - to. This setting doesn't apply to RDS Custom. -- `"DBName"`: The meaning of this parameter differs according to the database engine you - use. MySQL The name of the database to create when the DB instance is created. If this - parameter isn't specified, no database is created in the DB instance. Constraints: Must - contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can - be letters, underscores, or digits (0-9). Can't be a word reserved by the specified - database engine MariaDB The name of the database to create when the DB instance is - created. If this parameter isn't specified, no database is created in the DB instance. - Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter. - Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word - reserved by the specified database engine PostgreSQL The name of the database to create - when the DB instance is created. If this parameter isn't specified, a database named - postgres is created in the DB instance. Constraints: Must contain 1 to 63 letters, - numbers, or underscores. Must begin with a letter. Subsequent characters can be letters, - underscores, or digits (0-9). Can't be a word reserved by the specified database engine - Oracle The Oracle System ID (SID) of the created DB instance. If you specify null, the - default value ORCL is used. You can't specify the string NULL, or any other reserved word, - for DBName. Default: ORCL Constraints: Can't be longer than 8 characters Amazon RDS - Custom for Oracle The Oracle System ID (SID) of the created RDS Custom DB instance. If you - don't specify a value, the default value is ORCL. Default: ORCL Constraints: It must - contain 1 to 8 alphanumeric characters. It must contain a letter. It can't be a word - reserved by the database engine. Amazon RDS Custom for SQL Server Not applicable. Must - be null. SQL Server Not applicable. Must be null. Amazon Aurora MySQL The name of the - database to create when the primary DB instance of the Aurora MySQL DB cluster is created. - If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in - the DB cluster. Constraints: It must contain 1 to 64 alphanumeric characters. It can't - be a word reserved by the database engine. Amazon Aurora PostgreSQL The name of the - database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is - created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database - named postgres is created in the DB cluster. Constraints: It must contain 1 to 63 - alphanumeric characters. It must begin with a letter. Subsequent characters can be - letters, underscores, or digits (0 to 9). It can't be a word reserved by the database - engine. +- `"DBClusterIdentifier"`: The identifier of the DB cluster that this DB instance will + belong to. This setting doesn't apply to RDS Custom DB instances. +- `"DBName"`: The meaning of this parameter differs depending on the database engine. + Amazon Aurora MySQL Amazon Aurora PostgreSQL Amazon RDS Custom for Oracle Amazon RDS Custom + for SQL Server RDS for MariaDB RDS for MySQL RDS for Oracle RDS for PostgreSQL RDS for SQL + Server The name of the database to create when the primary DB instance of the Aurora MySQL + DB cluster is created. If you don't specify a value, Amazon RDS doesn't create a database + in the DB cluster. Constraints: Must contain 1 to 64 alphanumeric characters. Can't be + a word reserved by the database engine. The name of the database to create when the + primary DB instance of the Aurora PostgreSQL DB cluster is created. Default: postgres + Constraints: Must contain 1 to 63 alphanumeric characters. Must begin with a letter. + Subsequent characters can be letters, underscores, or digits (0 to 9). Can't be a word + reserved by the database engine. The Oracle System ID (SID) of the created RDS Custom + DB instance. Default: ORCL Constraints: Must contain 1 to 8 alphanumeric characters. + Must contain a letter. Can't be a word reserved by the database engine. Not + applicable. Must be null. The name of the database to create when the DB instance is + created. If you don't specify a value, Amazon RDS doesn't create a database in the DB + instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with a + letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a + word reserved by the database engine. The name of the database to create when the DB + instance is created. If you don't specify a value, Amazon RDS doesn't create a database in + the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with + a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a + word reserved by the database engine. The Oracle System ID (SID) of the created DB + instance. Default: ORCL Constraints: Can't be longer than 8 characters. Can't be a + word reserved by the database engine, such as the string NULL. The name of the database + to create when the DB instance is created. Default: postgres Constraints: Must contain 1 + to 63 letters, numbers, or underscores. Must begin with a letter. Subsequent characters + can be letters, underscores, or digits (0-9). Can't be a word reserved by the database + engine. Not applicable. Must be null. - `"DBParameterGroupName"`: The name of the DB parameter group to associate with this DB - instance. If you do not specify a value, then the default DB parameter group for the - specified DB engine and version is used. This setting doesn't apply to RDS Custom. - Constraints: It must be 1 to 255 letters, numbers, or hyphens. The first character must - be a letter. It can't end with a hyphen or contain two consecutive hyphens. + instance. If you don't specify a value, then Amazon RDS uses the default DB parameter group + for the specified DB engine and version. This setting doesn't apply to RDS Custom DB + instances. Constraints: Must be 1 to 255 letters, numbers, or hyphens. The first + character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. - `"DBSecurityGroups"`: A list of DB security groups to associate with this DB instance. This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead. - `"DBSubnetGroupName"`: A DB subnet group to associate with this DB instance. Constraints: - Must match the name of an existing DBSubnetGroup. Must not be default. Example: + Must match the name of an existing DB subnet group. Must not be default. Example: mydbsubnetgroup -- `"DeletionProtection"`: A value that indicates whether the DB instance has deletion - protection enabled. The database can't be deleted when deletion protection is enabled. By - default, deletion protection isn't enabled. For more information, see Deleting a DB - Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for - the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can - be deleted even when deletion protection is enabled for the DB cluster. +- `"DeletionProtection"`: Specifies whether the DB instance has deletion protection + enabled. The database can't be deleted when deletion protection is enabled. By default, + deletion protection isn't enabled. For more information, see Deleting a DB Instance. This + setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion + protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a + DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - `"Domain"`: The Active Directory directory ID to create the DB instance in. Currently, - only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an + only Microsoft SQL Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon - RDS User Guide. This setting doesn't apply to RDS Custom. Amazon Aurora Not applicable. - The domain is managed by the DB cluster. -- `"DomainIAMRoleName"`: Specify the name of the IAM role to be used when making API calls - to the Directory Service. This setting doesn't apply to RDS Custom. Amazon Aurora Not - applicable. The domain is managed by the DB cluster. + RDS User Guide. This setting doesn't apply to the following DB instances: Amazon Aurora + (The domain is managed by the DB cluster.) RDS Custom +- `"DomainAuthSecretArn"`: The ARN for the Secrets Manager secret that contains the + credentials for the user performing the domain join. Example: + arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 +- `"DomainDnsIps"`: The IPv4 DNS IP addresses of your primary and secondary Active + Directory domain controllers. Constraints: Two IP addresses must be provided. If there + isn't a secondary domain controller, use the IP address of the primary domain controller + for both entries in the list. Example: 123.124.125.126,234.235.236.237 +- `"DomainFqdn"`: Specifies the fully qualified domain name of an Active Directory domain. + Constraints: Cannot be greater than 64 characters. Example: + mymanagedADtest.mymanagedAD.mydomain +- `"DomainIAMRoleName"`: The name of the IAM role to use when making API calls to the + Directory Service. This setting doesn't apply to the following DB instances: Amazon + Aurora (The domain is managed by the DB cluster.) RDS Custom +- `"DomainOu"`: The Active Directory organizational unit for your DB instance to join. + Constraints: Must be in the distinguished name format. Cannot be greater than 64 + characters. Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain - `"EnableCloudwatchLogsExports"`: The list of log types that need to be enabled for - exporting to CloudWatch Logs. The values in the list depend on the DB engine. For more - information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User - Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB - cluster. RDS Custom Not applicable. MariaDB Possible values are audit, error, general, - and slowquery. Microsoft SQL Server Possible values are agent and error. MySQL Possible - values are audit, error, general, and slowquery. Oracle Possible values are alert, audit, - listener, trace, and oemagent. PostgreSQL Possible values are postgresql and upgrade. -- `"EnableCustomerOwnedIp"`: A value that indicates whether to enable a customer-owned IP - address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external - connectivity to resources in your Outpost subnets through your on-premises network. For - some use cases, a CoIP can provide lower latency for connections to the DB instance from - outside of its virtual private cloud (VPC) on your local network. For more information - about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the - Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in - the Amazon Web Services Outposts User Guide. -- `"EnableIAMDatabaseAuthentication"`: A value that indicates whether to enable mapping of - Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By - default, mapping isn't enabled. For more information, see IAM Database Authentication for - MySQL and PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to RDS - Custom. Amazon Aurora Not applicable. Mapping Amazon Web Services IAM accounts to - database accounts is managed by the DB cluster. -- `"EnablePerformanceInsights"`: A value that indicates whether to enable Performance - Insights for the DB instance. For more information, see Using Amazon Performance Insights - in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. -- `"EngineVersion"`: The version number of the database engine to use. For a list of valid - engine versions, use the DescribeDBEngineVersions operation. The following are the database - engines and links to information about the major and minor versions that are available with - Amazon RDS. Not every database engine is available for every Amazon Web Services Region. - Amazon Aurora Not applicable. The version number of the database engine to be used by the - DB instance is managed by the DB cluster. Amazon RDS Custom for Oracle A custom engine - version (CEV) that you have previously created. This setting is required for RDS Custom for - Oracle. The CEV name has the following format: 19.customized_string. A valid CEV name is - 19.my_cev1. For more information, see Creating an RDS Custom for Oracle DB instance in the - Amazon RDS User Guide. Amazon RDS Custom for SQL Server See RDS Custom for SQL Server - general requirements in the Amazon RDS User Guide. MariaDB For information, see MariaDB - on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server For - information, see Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. - MySQL For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide. - Oracle For information, see Oracle Database Engine Release Notes in the Amazon RDS User - Guide. PostgreSQL For information, see Amazon RDS for PostgreSQL versions and extensions - in the Amazon RDS User Guide. -- `"Iops"`: The amount of Provisioned IOPS (input/output operations per second) to be - initially allocated for the DB instance. For information about valid IOPS values, see - Amazon RDS DB instance storage in the Amazon RDS User Guide. Constraints: For MariaDB, - MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the - storage amount for the DB instance. For SQL Server DB instances, must be a multiple between - 1 and 50 of the storage amount for the DB instance. Amazon Aurora Not applicable. Storage - is managed by the DB cluster. + exporting to CloudWatch Logs. For more information, see Publishing Database Logs to Amazon + CloudWatch Logs in the Amazon RDS User Guide. This setting doesn't apply to the following + DB instances: Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.) + RDS Custom The following values are valid for each DB engine: RDS for MariaDB - audit | + error | general | slowquery RDS for Microsoft SQL Server - agent | error RDS for + MySQL - audit | error | general | slowquery RDS for Oracle - alert | audit | listener | + trace | oemagent RDS for PostgreSQL - postgresql | upgrade +- `"EnableCustomerOwnedIp"`: Specifies whether to enable a customer-owned IP address (CoIP) + for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to + resources in your Outpost subnets through your on-premises network. For some use cases, a + CoIP can provide lower latency for connections to the DB instance from outside of its + virtual private cloud (VPC) on your local network. For more information about RDS on + Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS + User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon + Web Services Outposts User Guide. +- `"EnableIAMDatabaseAuthentication"`: Specifies whether to enable mapping of Amazon Web + Services Identity and Access Management (IAM) accounts to database accounts. By default, + mapping isn't enabled. For more information, see IAM Database Authentication for MySQL and + PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to the following DB + instances: Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts + is managed by the DB cluster.) RDS Custom +- `"EnablePerformanceInsights"`: Specifies whether to enable Performance Insights for the + DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS + User Guide. This setting doesn't apply to RDS Custom DB instances. +- `"EngineVersion"`: The version number of the database engine to use. This setting doesn't + apply to Amazon Aurora DB instances. The version number of the database engine the DB + instance uses is managed by the DB cluster. For a list of valid engine versions, use the + DescribeDBEngineVersions operation. The following are the database engines and links to + information about the major and minor versions that are available with Amazon RDS. Not + every database engine is available for every Amazon Web Services Region. Amazon RDS Custom + for Oracle Amazon RDS Custom for SQL Server RDS for MariaDB RDS for Microsoft SQL Server + RDS for MySQL RDS for Oracle RDS for PostgreSQL A custom engine version (CEV) that you + have previously created. This setting is required for RDS Custom for Oracle. The CEV name + has the following format: 19.customized_string. A valid CEV name is 19.my_cev1. For more + information, see Creating an RDS Custom for Oracle DB instance in the Amazon RDS User + Guide. See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide. + For information, see MariaDB on Amazon RDS versions in the Amazon RDS User Guide. For + information, see Microsoft SQL Server versions on Amazon RDS in the Amazon RDS User Guide. + For information, see MySQL on Amazon RDS versions in the Amazon RDS User Guide. For + information, see Oracle Database Engine release notes in the Amazon RDS User Guide. For + information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User + Guide. +- `"Iops"`: The amount of Provisioned IOPS (input/output operations per second) to + initially allocate for the DB instance. For information about valid IOPS values, see Amazon + RDS DB instance storage in the Amazon RDS User Guide. This setting doesn't apply to Amazon + Aurora DB instances. Storage is managed by the DB cluster. Constraints: For RDS for + MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the + storage amount for the DB instance. For RDS for SQL Server - Must be a multiple between 1 + and 50 of the storage amount for the DB instance. - `"KmsKeyId"`: The Amazon Web Services KMS key identifier for an encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the - key ARN or alias ARN. Amazon Aurora Not applicable. The Amazon Web Services KMS key - identifier is managed by the DB cluster. For more information, see CreateDBCluster. If - StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, - then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web - Services account. Your Amazon Web Services account has a different default KMS key for each - Amazon Web Services Region. Amazon RDS Custom A KMS key is required for RDS Custom - instances. For most RDS engines, if you leave this parameter empty while enabling - StorageEncrypted, the engine uses the default KMS key. However, RDS Custom doesn't use the - default key when this parameter is empty. You must explicitly specify a key. -- `"LicenseModel"`: License model information for this DB instance. Valid values: - license-included | bring-your-own-license | general-public-license This setting doesn't - apply to RDS Custom. Amazon Aurora Not applicable. -- `"ManageMasterUserPassword"`: A value that indicates whether to manage the master user - password with Amazon Web Services Secrets Manager. For more information, see Password - management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide. - Constraints: Can't manage the master user password with Amazon Web Services Secrets - Manager if MasterUserPassword is specified. -- `"MasterUserPassword"`: The password for the master user. The password can include any - printable ASCII character except \"/\", \"\"\", or \"@\". Amazon Aurora Not applicable. - The password for the master user is managed by the DB cluster. Constraints: Can't be - specified if ManageMasterUserPassword is turned on. MariaDB Constraints: Must contain - from 8 to 41 characters. Microsoft SQL Server Constraints: Must contain from 8 to 128 - characters. MySQL Constraints: Must contain from 8 to 41 characters. Oracle - Constraints: Must contain from 8 to 30 characters. PostgreSQL Constraints: Must contain + key ARN or alias ARN. This setting doesn't apply to Amazon Aurora DB instances. The Amazon + Web Services KMS key identifier is managed by the DB cluster. For more information, see + CreateDBCluster. If StorageEncrypted is enabled, and you do not specify a value for the + KmsKeyId parameter, then Amazon RDS uses your default KMS key. There is a default KMS key + for your Amazon Web Services account. Your Amazon Web Services account has a different + default KMS key for each Amazon Web Services Region. For Amazon RDS Custom, a KMS key is + required for DB instances. For most RDS engines, if you leave this parameter empty while + enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom doesn't + use the default key when this parameter is empty. You must explicitly specify a key. +- `"LicenseModel"`: The license model information for this DB instance. This setting + doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for MariaDB + - general-public-license RDS for Microsoft SQL Server - license-included RDS for + MySQL - general-public-license RDS for Oracle - bring-your-own-license | + license-included RDS for PostgreSQL - postgresql-license +- `"ManageMasterUserPassword"`: Specifies whether to manage the master user password with + Amazon Web Services Secrets Manager. For more information, see Password management with + Amazon Web Services Secrets Manager in the Amazon RDS User Guide. Constraints: Can't + manage the master user password with Amazon Web Services Secrets Manager if + MasterUserPassword is specified. +- `"MasterUserPassword"`: The password for the master user. This setting doesn't apply to + Amazon Aurora DB instances. The password for the master user is managed by the DB cluster. + Constraints: Can't be specified if ManageMasterUserPassword is turned on. Can include + any printable ASCII character except \"/\", \"\"\", or \"@\". Length Constraints: RDS + for MariaDB - Must contain from 8 to 41 characters. RDS for Microsoft SQL Server - Must + contain from 8 to 128 characters. RDS for MySQL - Must contain from 8 to 41 characters. + RDS for Oracle - Must contain from 8 to 30 characters. RDS for PostgreSQL - Must contain from 8 to 128 characters. - `"MasterUserSecretKmsKeyId"`: The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. @@ -1853,120 +1867,121 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. -- `"MasterUsername"`: The name for the master user. Amazon Aurora Not applicable. The - name for the master user is managed by the DB cluster. Amazon RDS Constraints: - Required. Must be 1 to 16 letters, numbers, or underscores. First character must be a - letter. Can't be a reserved word for the chosen database engine. +- `"MasterUsername"`: The name for the master user. This setting doesn't apply to Amazon + Aurora DB instances. The name for the master user is managed by the DB cluster. This + setting is required for RDS DB instances. Constraints: Must be 1 to 16 letters, numbers, + or underscores. First character must be a letter. Can't be a reserved word for the + chosen database engine. - `"MaxAllocatedStorage"`: The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to - RDS Custom. Amazon Aurora Not applicable. Storage is managed by the DB cluster. + the following DB instances: Amazon Aurora (Storage is managed by the DB cluster.) RDS + Custom - `"MonitoringInterval"`: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring - metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must set - MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom. Valid - Values: 0, 1, 5, 10, 15, 30, 60 + metrics, specify 0. If MonitoringRoleArn is specified, then you must set MonitoringInterval + to a value other than 0. This setting doesn't apply to RDS Custom DB instances. Valid + Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0 - `"MonitoringRoleArn"`: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn - value. This setting doesn't apply to RDS Custom. -- `"MultiAZ"`: A value that indicates whether the DB instance is a Multi-AZ deployment. You - can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. This - setting doesn't apply to RDS Custom. Amazon Aurora Not applicable. DB instance - Availability Zones (AZs) are managed by the DB cluster. + value. This setting doesn't apply to RDS Custom DB instances. +- `"MultiAZ"`: Specifies whether the DB instance is a Multi-AZ deployment. You can't set + the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. This setting + doesn't apply to the following DB instances: Amazon Aurora (DB instance Availability + Zones (AZs) are managed by the DB cluster.) RDS Custom - `"NcharCharacterSetName"`: The name of the NCHAR character set for the Oracle DB - instance. This parameter doesn't apply to RDS Custom. -- `"NetworkType"`: The network type of the DB instance. Valid values: IPV4 DUAL - The network type is determined by the DBSubnetGroup specified for the DB instance. A - DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). - For more information, see Working with a DB instance in a VPC in the Amazon RDS User - Guide. -- `"OptionGroupName"`: A value that indicates that the DB instance should be associated - with the specified option group. Permanent options, such as the TDE option for Oracle - Advanced Security TDE, can't be removed from an option group. Also, that option group can't - be removed from a DB instance after it is associated with a DB instance. This setting - doesn't apply to RDS Custom. Amazon Aurora Not applicable. + instance. This setting doesn't apply to RDS Custom DB instances. +- `"NetworkType"`: The network type of the DB instance. The network type is determined by + the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 + protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with + a DB instance in a VPC in the Amazon RDS User Guide. Valid Values: IPV4 | DUAL +- `"OptionGroupName"`: The option group to associate the DB instance with. Permanent + options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an + option group. Also, that option group can't be removed from a DB instance after it is + associated with a DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB + instances. - `"PerformanceInsightsKMSKeyId"`: The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the - key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value - for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a - default KMS key for your Amazon Web Services account. Your Amazon Web Services account has - a different default KMS key for each Amazon Web Services Region. This setting doesn't apply - to RDS Custom. + key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for + PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default + KMS key for your Amazon Web Services account. Your Amazon Web Services account has a + different default KMS key for each Amazon Web Services Region. This setting doesn't apply + to RDS Custom DB instances. - `"PerformanceInsightsRetentionPeriod"`: The number of days to retain Performance Insights - data. The default is 7 days. The following values are valid: 7 month * 31, where month - is a number of months from 1-23 731 For example, the following values are valid: 93 - (3 months * 31) 341 (11 months * 31) 589 (19 months * 31) 731 If you specify a - retention period such as 94, which isn't a valid value, RDS issues an error. This setting - doesn't apply to RDS Custom. -- `"Port"`: The port number on which the database accepts connections. MySQL Default: - 3306 Valid values: 1150-65535 Type: Integer MariaDB Default: 3306 Valid values: - 1150-65535 Type: Integer PostgreSQL Default: 5432 Valid values: 1150-65535 Type: - Integer Oracle Default: 1521 Valid values: 1150-65535 SQL Server Default: 1433 Valid - values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156. Amazon - Aurora Default: 3306 Valid values: 1150-65535 Type: Integer + data. This setting doesn't apply to RDS Custom DB instances. Valid Values: 7 month * + 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 + months * 31), 589 (19 months * 31) 731 Default: 7 days If you specify a retention + period that isn't valid, such as 94, Amazon RDS returns an error. +- `"Port"`: The port number on which the database accepts connections. This setting doesn't + apply to Aurora DB instances. The port number is managed by the cluster. Valid Values: + 1150-65535 Default: RDS for MariaDB - 3306 RDS for Microsoft SQL Server - 1433 RDS + for MySQL - 3306 RDS for Oracle - 1521 RDS for PostgreSQL - 5432 Constraints: + For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260, 3343, 3389, 47001, + or 49152-49156. - `"PreferredBackupWindow"`: The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User - Guide. Amazon Aurora Not applicable. The daily time range for creating automated backups - is managed by the DB cluster. Constraints: Must be in the format hh24:mi-hh24:mi. Must - be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance - window. Must be at least 30 minutes. + Guide. This setting doesn't apply to Amazon Aurora DB instances. The daily time range for + creating automated backups is managed by the DB cluster. Constraints: Must be in the + format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict + with the preferred maintenance window. Must be at least 30 minutes. - `"PreferredMaintenanceWindow"`: The time range each week during which system maintenance - can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS - Maintenance Window. Format: ddd:hh24:mi-ddd:hh24:mi The default is 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. + can occur. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User + Guide. The default is 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. Constraints: + Must be in the format ddd:hh24:mi-ddd:hh24:mi. The day values must be mon | tue | wed | + thu | fri | sat | sun. Must be in Universal Coordinated Time (UTC). Must not conflict + with the preferred backup window. Must be at least 30 minutes. - `"ProcessorFeatures"`: The number of CPU cores and the number of threads per core for the - DB instance class of the DB instance. This setting doesn't apply to RDS Custom. Amazon - Aurora Not applicable. -- `"PromotionTier"`: A value that specifies the order in which an Aurora Replica is - promoted to the primary instance after a failure of the existing primary instance. For more - information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. - This setting doesn't apply to RDS Custom. Default: 1 Valid Values: 0 - 15 -- `"PubliclyAccessible"`: A value that indicates whether the DB instance is publicly - accessible. When the DB instance is publicly accessible, its Domain Name System (DNS) - endpoint resolves to the private IP address from within the DB instance's virtual private - cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. - Access to the DB instance is ultimately controlled by the security group it uses. That - public access is not permitted if the security group assigned to the DB instance doesn't - permit it. When the DB instance isn't publicly accessible, it is an internal DB instance - with a DNS name that resolves to a private IP address. Default: The default behavior varies - depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, - and PubliclyAccessible isn't specified, the following applies: If the default VPC in the + DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS + Custom DB instances. +- `"PromotionTier"`: The order of priority in which an Aurora Replica is promoted to the + primary instance after a failure of the existing primary instance. For more information, + see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting + doesn't apply to RDS Custom DB instances. Default: 1 Valid Values: 0 - 15 +- `"PubliclyAccessible"`: Specifies whether the DB instance is publicly accessible. When + the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to + the private IP address from within the DB instance's virtual private cloud (VPC). It + resolves to the public IP address from outside of the DB instance's VPC. Access to the DB + instance is ultimately controlled by the security group it uses. That public access is not + permitted if the security group assigned to the DB instance doesn't permit it. When the DB + instance isn't publicly accessible, it is an internal DB instance with a DNS name that + resolves to a private IP address. Default: The default behavior varies depending on whether + DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and + PubliclyAccessible isn't specified, the following applies: If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private. If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public. If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies: If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private. If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public. -- `"StorageEncrypted"`: A value that indicates whether the DB instance is encrypted. By - default, it isn't encrypted. For RDS Custom instances, either set this parameter to true or - leave it unset. If you set this parameter to false, RDS reports an error. Amazon Aurora - Not applicable. The encryption for DB instances is managed by the DB cluster. -- `"StorageThroughput"`: Specifies the storage throughput value for the DB instance. This - setting applies only to the gp3 storage type. This setting doesn't apply to RDS Custom or - Amazon Aurora. -- `"StorageType"`: Specifies the storage type to be associated with the DB instance. Valid - values: gp2 | gp3 | io1 | standard If you specify io1 or gp3, you must also include a - value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise - gp2 Amazon Aurora Not applicable. Storage is managed by the DB cluster. +- `"StorageEncrypted"`: Specifes whether the DB instance is encrypted. By default, it isn't + encrypted. For RDS Custom DB instances, either enable this setting or leave it unset. + Otherwise, Amazon RDS reports an error. This setting doesn't apply to Amazon Aurora DB + instances. The encryption for DB instances is managed by the DB cluster. +- `"StorageThroughput"`: The storage throughput value for the DB instance. This setting + applies only to the gp3 storage type. This setting doesn't apply to Amazon Aurora or RDS + Custom DB instances. +- `"StorageType"`: The storage type to associate with the DB instance. If you specify io1 + or gp3, you must also include a value for the Iops parameter. This setting doesn't apply to + Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: gp2 | gp3 | + io1 | standard Default: io1, if the Iops parameter is specified. Otherwise, gp2. - `"Tags"`: Tags to assign to the DB instance. - `"TdeCredentialArn"`: The ARN from the key store with which to associate the instance for - TDE encryption. This setting doesn't apply to RDS Custom. Amazon Aurora Not applicable. + TDE encryption. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. - `"TdeCredentialPassword"`: The password for the given ARN from the key store in order to - access the device. This setting doesn't apply to RDS Custom. + access the device. This setting doesn't apply to RDS Custom DB instances. - `"Timezone"`: The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server. - `"VpcSecurityGroupIds"`: A list of Amazon EC2 VPC security groups to associate with this - DB instance. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups - is managed by the DB cluster. Default: The default EC2 VPC security group for the DB subnet - group's VPC. + DB instance. This setting doesn't apply to Amazon Aurora DB instances. The associated list + of EC2 VPC security groups is managed by the DB cluster. Default: The default EC2 VPC + security group for the DB subnet group's VPC. """ function create_dbinstance( DBInstanceClass, @@ -2082,8 +2097,21 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. +- `"DomainAuthSecretArn"`: The ARN for the Secrets Manager secret that contains the + credentials for the user performing the domain join. Example: + arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 +- `"DomainDnsIps"`: The IPv4 DNS IP addresses of your primary and secondary Active + Directory domain controllers. Constraints: Two IP addresses must be provided. If there + isn't a secondary domain controller, use the IP address of the primary domain controller + for both entries in the list. Example: 123.124.125.126,234.235.236.237 +- `"DomainFqdn"`: Specifies the fully qualified domain name of an Active Directory domain. + Constraints: Cannot be greater than 64 characters. Example: + mymanagedADtest.mymanagedAD.mydomain - `"DomainIAMRoleName"`: The name of the IAM role to be used when making API calls to the Directory Service. This setting doesn't apply to RDS Custom. +- `"DomainOu"`: The Active Directory organizational unit for your DB instance to join. + Constraints: Must be in the distinguished name format. Cannot be greater than 64 + characters. Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain - `"EnableCloudwatchLogsExports"`: The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User @@ -4183,20 +4211,20 @@ end describe_dbclusters() describe_dbclusters(params::Dict{String,<:Any}) -Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API -supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon -Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see +Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports +pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? +in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"DBClusterIdentifier"`: The user-supplied DB cluster identifier or the Amazon Resource - Name (ARN) of the DB cluster. If this parameter is specified, information from only the + Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: If - supplied, must match an existing DBClusterIdentifier. + supplied, must match an existing DB cluster identifier. - `"Filters"`: A filter that specifies one or more DB clusters to describe. Supported - filters: clone-group-id - Accepts clone group identifiers. The results list only + Filters: clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups. db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs. @@ -4206,8 +4234,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys includes information about the DB clusters associated with these domains. engine - Accepts engine names. The results list only includes information about the DB clusters for these engines. -- `"IncludeShared"`: Optional Boolean parameter that specifies whether the output includes - information about clusters shared from other Amazon Web Services accounts. +- `"IncludeShared"`: Specifies whether the output includes information about clusters + shared from other Amazon Web Services accounts. - `"Marker"`: An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. @@ -4356,27 +4384,26 @@ end describe_dbinstances() describe_dbinstances(params::Dict{String,<:Any}) -Returns information about provisioned RDS instances. This API supports pagination. This -operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB -instances. +Describes provisioned RDS instances. This API supports pagination. This operation can also +return information for Amazon Neptune DB instances and Amazon DocumentDB instances. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"DBInstanceIdentifier"`: The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive. Constraints: If - supplied, must match the identifier of an existing DBInstance. + supplied, must match the identifier of an existing DB instance. - `"Filters"`: A filter that specifies one or more DB instances to describe. Supported - filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource + Filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs. db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs. dbi-resource-id - Accepts - DB instance resource identifiers. The results list will only include information about the - DB instances identified by these DB instance resource identifiers. domain - Accepts - Active Directory directory IDs. The results list only includes information about the DB - instances associated with these domains. engine - Accepts engine names. The results list - only includes information about the DB instances for these engines. + DB instance resource identifiers. The results list only includes information about the DB + instances identified by these DB instance resource identifiers. domain - Accepts Active + Directory directory IDs. The results list only includes information about the DB instances + associated with these domains. engine - Accepts engine names. The results list only + includes information about the DB instances for these engines. - `"Marker"`: An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. @@ -6049,7 +6076,7 @@ end modify_dbcluster(dbcluster_identifier) modify_dbcluster(dbcluster_identifier, params::Dict{String,<:Any}) -Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can +Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ @@ -6057,102 +6084,102 @@ DB cluster deployments in the Amazon RDS User Guide. # Arguments - `dbcluster_identifier`: The DB cluster identifier for the cluster being modified. This - parameter isn't case-sensitive. Constraints: This identifier must match the identifier of - an existing DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters + parameter isn't case-sensitive. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB + clusters Constraints: Must match the identifier of an existing DB cluster. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"AllocatedStorage"`: The amount of storage in gibibytes (GiB) to allocate to each DB - instance in the Multi-AZ DB cluster. Valid for: Multi-AZ DB clusters only -- `"AllowEngineModeChange"`: A value that indicates whether engine mode changes from - serverless to provisioned are allowed. Constraints: You must allow engine mode changes when - specifying a different value for the EngineMode parameter from the DB cluster's current - engine mode. Valid for: Aurora Serverless v1 DB clusters only -- `"AllowMajorVersionUpgrade"`: A value that indicates whether major version upgrades are - allowed. Constraints: You must allow major version upgrades when specifying a value for the - EngineVersion parameter that is a different major version than the DB cluster's current - version. Valid for: Aurora DB clusters only -- `"ApplyImmediately"`: A value that indicates whether the modifications in this request - and any pending modifications are asynchronously applied as soon as possible, regardless of - the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, + instance in the Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only +- `"AllowEngineModeChange"`: Specifies whether engine mode changes from serverless to + provisioned are allowed. Valid for Cluster Type: Aurora Serverless v1 DB clusters only + Constraints: You must allow engine mode changes when specifying a different value for the + EngineMode parameter from the DB cluster's current engine mode. +- `"AllowMajorVersionUpgrade"`: Specifies whether major version upgrades are allowed. Valid + for Cluster Type: Aurora DB clusters only Constraints: You must allow major version + upgrades when specifying a value for the EngineVersion parameter that is a different major + version than the DB cluster's current version. +- `"ApplyImmediately"`: Specifies whether the modifications in this request and any pending + modifications are asynchronously applied as soon as possible, regardless of the + PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window. Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them. By - default, this parameter is disabled. Valid for: Aurora DB clusters and Multi-AZ DB clusters -- `"AutoMinorVersionUpgrade"`: A value that indicates whether minor engine upgrades are - applied automatically to the DB cluster during the maintenance window. By default, minor - engine upgrades are applied automatically. Valid for: Multi-AZ DB clusters only + default, this parameter is disabled. Valid for Cluster Type: Aurora DB clusters and + Multi-AZ DB clusters +- `"AutoMinorVersionUpgrade"`: Specifies whether minor engine upgrades are applied + automatically to the DB cluster during the maintenance window. By default, minor engine + upgrades are applied automatically. Valid for Cluster Type: Multi-AZ DB clusters only - `"BacktrackWindow"`: The target backtrack window, in seconds. To disable backtracking, - set this value to 0. Default: 0 Constraints: If specified, this value must be set to a - number from 0 to 259,200 (72 hours). Valid for: Aurora MySQL DB clusters only + set this value to 0. Valid for Cluster Type: Aurora MySQL DB clusters only Default: 0 + Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 + hours). - `"BackupRetentionPeriod"`: The number of days for which automated backups are retained. - Specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to 35 - Valid for: Aurora DB clusters and Multi-AZ DB clusters + Specify a minimum value of 1. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB + clusters Default: 1 Constraints: Must be a value from 1 to 35. - `"CloudwatchLogsExportConfiguration"`: The configuration setting for the log types to be - enabled for export to CloudWatch Logs for a specific DB cluster. The values in the list - depend on the DB engine being used. RDS for MySQL Possible values are error, general, and - slowquery. RDS for PostgreSQL Possible values are postgresql and upgrade. Aurora MySQL - Possible values are audit, error, general, and slowquery. Aurora PostgreSQL Possible - value is postgresql. For more information about exporting CloudWatch Logs for Amazon RDS, - see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. For - more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database - Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. Valid for: Aurora DB - clusters and Multi-AZ DB clusters -- `"CopyTagsToSnapshot"`: A value that indicates whether to copy all tags from the DB - cluster to snapshots of the DB cluster. The default is not to copy them. Valid for: Aurora - DB clusters and Multi-AZ DB clusters + enabled for export to CloudWatch Logs for a specific DB cluster. Valid for Cluster Type: + Aurora DB clusters and Multi-AZ DB clusters The following values are valid for each DB + engine: Aurora MySQL - audit | error | general | slowquery Aurora PostgreSQL - + postgresql RDS for MySQL - error | general | slowquery RDS for PostgreSQL - + postgresql | upgrade For more information about exporting CloudWatch Logs for Amazon + RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. + For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing + Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. +- `"CopyTagsToSnapshot"`: Specifies whether to copy all tags from the DB cluster to + snapshots of the DB cluster. The default is not to copy them. Valid for Cluster Type: + Aurora DB clusters and Multi-AZ DB clusters - `"DBClusterInstanceClass"`: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS - User Guide. Valid for: Multi-AZ DB clusters only + User Guide. Valid for Cluster Type: Multi-AZ DB clusters only - `"DBClusterParameterGroupName"`: The name of the DB cluster parameter group to use for - the DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters + the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters - `"DBInstanceParameterGroupName"`: The name of the DB parameter group to apply to all instances of the DB cluster. When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window. - Default: The existing name setting Constraints: The DB parameter group must be in the - same DB parameter group family as this DB cluster. The DBInstanceParameterGroupName - parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major - version upgrade only. Valid for: Aurora DB clusters only -- `"DeletionProtection"`: A value that indicates whether the DB cluster has deletion - protection enabled. The database can't be deleted when deletion protection is enabled. By - default, deletion protection isn't enabled. Valid for: Aurora DB clusters and Multi-AZ DB + Valid for Cluster Type: Aurora DB clusters only Default: The existing name setting + Constraints: The DB parameter group must be in the same DB parameter group family as this + DB cluster. The DBInstanceParameterGroupName parameter is valid in combination with the + AllowMajorVersionUpgrade parameter for a major version upgrade only. +- `"DeletionProtection"`: Specifies whether the DB cluster has deletion protection enabled. + The database can't be deleted when deletion protection is enabled. By default, deletion + protection isn't enabled. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters - `"Domain"`: The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation. For more information, see Kerberos Authentication in the Amazon Aurora User - Guide. Valid for: Aurora DB clusters only -- `"DomainIAMRoleName"`: Specify the name of the IAM role to be used when making API calls - to the Directory Service. Valid for: Aurora DB clusters only -- `"EnableGlobalWriteForwarding"`: A value that indicates whether to enable this DB cluster - to forward write operations to the primary cluster of an Aurora global database - (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that - are secondary clusters in an Aurora global database. You can set this value only on Aurora - DB clusters that are members of an Aurora global database. With this parameter enabled, a - secondary cluster can forward writes to the current primary cluster and the resulting - changes are replicated back to this cluster. For the primary DB cluster of an Aurora global - database, this value is used immediately if the primary is demoted by the - FailoverGlobalCluster API operation, but it does nothing until then. Valid for: Aurora DB - clusters only -- `"EnableHttpEndpoint"`: A value that indicates whether to enable the HTTP endpoint for an - Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled. When enabled, - the HTTP endpoint provides a connectionless web service API for running SQL queries on the - Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS - console with the query editor. For more information, see Using the Data API for Aurora - Serverless v1 in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only -- `"EnableIAMDatabaseAuthentication"`: A value that indicates whether to enable mapping of - Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By - default, mapping isn't enabled. For more information, see IAM Database Authentication in - the Amazon Aurora User Guide. Valid for: Aurora DB clusters only -- `"EnablePerformanceInsights"`: A value that indicates whether to turn on Performance - Insights for the DB cluster. For more information, see Using Amazon Performance Insights - in the Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only + Guide. Valid for Cluster Type: Aurora DB clusters only +- `"DomainIAMRoleName"`: The name of the IAM role to use when making API calls to the + Directory Service. Valid for Cluster Type: Aurora DB clusters only +- `"EnableGlobalWriteForwarding"`: Specifies whether to enable this DB cluster to forward + write operations to the primary cluster of a global cluster (Aurora global database). By + default, write operations are not allowed on Aurora DB clusters that are secondary clusters + in an Aurora global database. You can set this value only on Aurora DB clusters that are + members of an Aurora global database. With this parameter enabled, a secondary cluster can + forward writes to the current primary cluster, and the resulting changes are replicated + back to this cluster. For the primary DB cluster of an Aurora global database, this value + is used immediately if the primary is demoted by a global cluster API operation, but it + does nothing until then. Valid for Cluster Type: Aurora DB clusters only +- `"EnableHttpEndpoint"`: Specifies whether to enable the HTTP endpoint for an Aurora + Serverless v1 DB cluster. By default, the HTTP endpoint is disabled. When enabled, the HTTP + endpoint provides a connectionless web service API for running SQL queries on the Aurora + Serverless v1 DB cluster. You can also query your database from inside the RDS console with + the query editor. For more information, see Using the Data API for Aurora Serverless v1 in + the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only +- `"EnableIAMDatabaseAuthentication"`: Specifies whether to enable mapping of Amazon Web + Services Identity and Access Management (IAM) accounts to database accounts. By default, + mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon + Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only +- `"EnablePerformanceInsights"`: Specifies whether to turn on Performance Insights for the + DB cluster. For more information, see Using Amazon Performance Insights in the Amazon RDS + User Guide. Valid for Cluster Type: Multi-AZ DB clusters only - `"EngineMode"`: The DB engine mode of the DB cluster, either provisioned or serverless. The DB engine mode can be modified only from serverless to provisioned. For more - information, see CreateDBCluster. Valid for: Aurora DB clusters only + information, see CreateDBCluster. Valid for Cluster Type: Aurora DB clusters only - `"EngineVersion"`: The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled. If the cluster that you're @@ -6166,28 +6193,28 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys for MySQL, use the following command: aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\" To list all of the available engine versions for RDS for PostgreSQL, use the following command: aws rds describe-db-engine-versions - --engine postgres --query \"DBEngineVersions[].EngineVersion\" Valid for: Aurora DB - clusters and Multi-AZ DB clusters + --engine postgres --query \"DBEngineVersions[].EngineVersion\" Valid for Cluster Type: + Aurora DB clusters and Multi-AZ DB clusters - `"Iops"`: The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide. - Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster. - Valid for: Multi-AZ DB clusters only -- `"ManageMasterUserPassword"`: A value that indicates whether to manage the master user - password with Amazon Web Services Secrets Manager. If the DB cluster doesn't manage the - master user password with Amazon Web Services Secrets Manager, you can turn on this - management. In this case, you can't specify MasterUserPassword. If the DB cluster already - manages the master user password with Amazon Web Services Secrets Manager, and you specify - that the master user password is not managed with Amazon Web Services Secrets Manager, then - you must specify MasterUserPassword. In this case, RDS deletes the secret and uses the new - password for the master user specified by MasterUserPassword. For more information, see - Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide - and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User - Guide. Valid for: Aurora DB clusters and Multi-AZ DB clusters -- `"MasterUserPassword"`: The new password for the master database user. This password can - contain any printable ASCII character except \"/\", \"\"\", or \"@\". Constraints: Must - contain from 8 to 41 characters. Can't be specified if ManageMasterUserPassword is turned - on. Valid for: Aurora DB clusters and Multi-AZ DB clusters + Valid for Cluster Type: Multi-AZ DB clusters only Constraints: Must be a multiple between + .5 and 50 of the storage amount for the DB cluster. +- `"ManageMasterUserPassword"`: Specifies whether to manage the master user password with + Amazon Web Services Secrets Manager. If the DB cluster doesn't manage the master user + password with Amazon Web Services Secrets Manager, you can turn on this management. In this + case, you can't specify MasterUserPassword. If the DB cluster already manages the master + user password with Amazon Web Services Secrets Manager, and you specify that the master + user password is not managed with Amazon Web Services Secrets Manager, then you must + specify MasterUserPassword. In this case, RDS deletes the secret and uses the new password + for the master user specified by MasterUserPassword. For more information, see Password + management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and + Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User + Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters +- `"MasterUserPassword"`: The new password for the master database user. Valid for Cluster + Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: Must contain from 8 to 41 + characters. Can contain any printable ASCII character except \"/\", \"\"\", or \"@\". + Can't be specified if ManageMasterUserPassword is turned on. - `"MasterUserSecretKmsKeyId"`: The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if both of the following conditions are met: The DB cluster @@ -6203,81 +6230,82 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon - Web Services Region. Valid for: Aurora DB clusters and Multi-AZ DB clusters + Web Services Region. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters - `"MonitoringInterval"`: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring - metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, also set - MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60 Valid - for: Multi-AZ DB clusters only + metrics, specify 0. If MonitoringRoleArn is specified, also set MonitoringInterval to a + value other than 0. Valid for Cluster Type: Multi-AZ DB clusters only Valid Values: 0 | 1 | + 5 | 10 | 15 | 30 | 60 Default: 0 - `"MonitoringRoleArn"`: The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value. Valid - for: Multi-AZ DB clusters only -- `"NetworkType"`: The network type of the DB cluster. Valid values: IPV4 DUAL - The network type is determined by the DBSubnetGroup specified for the DB cluster. A - DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). - For more information, see Working with a DB instance in a VPC in the Amazon Aurora User - Guide. Valid for: Aurora DB clusters only + for Cluster Type: Multi-AZ DB clusters only +- `"NetworkType"`: The network type of the DB cluster. The network type is determined by + the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 + protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with + a DB instance in a VPC in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB + clusters only Valid Values: IPV4 | DUAL - `"NewDBClusterIdentifier"`: The new DB cluster identifier for the DB cluster when - renaming a DB cluster. This value is stored as a lowercase string. Constraints: Must - contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter - Can't end with a hyphen or contain two consecutive hyphens Example: my-cluster2 Valid - for: Aurora DB clusters and Multi-AZ DB clusters -- `"OptionGroupName"`: A value that indicates that the DB cluster should be associated with - the specified option group. DB clusters are associated with a default option group that - can't be modified. + renaming a DB cluster. This value is stored as a lowercase string. Valid for Cluster Type: + Aurora DB clusters and Multi-AZ DB clusters Constraints: Must contain from 1 to 63 + letters, numbers, or hyphens. The first character must be a letter. Can't end with a + hyphen or contain two consecutive hyphens. Example: my-cluster2 +- `"OptionGroupName"`: The option group to associate the DB cluster with. DB clusters are + associated with a default option group that can't be modified. - `"PerformanceInsightsKMSKeyId"`: The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a - different default KMS key for each Amazon Web Services Region. Valid for: Multi-AZ DB - clusters only -- `"PerformanceInsightsRetentionPeriod"`: The number of days to retain Performance Insights - data. The default is 7 days. The following values are valid: 7 month * 31, where month - is a number of months from 1-23 731 For example, the following values are valid: 93 - (3 months * 31) 341 (11 months * 31) 589 (19 months * 31) 731 If you specify a - retention period such as 94, which isn't a valid value, RDS issues an error. Valid for: + different default KMS key for each Amazon Web Services Region. Valid for Cluster Type: Multi-AZ DB clusters only -- `"Port"`: The port number on which the DB cluster accepts connections. Constraints: Value - must be 1150-65535 Default: The same port as the original DB cluster. Valid for: Aurora DB - clusters only +- `"PerformanceInsightsRetentionPeriod"`: The number of days to retain Performance Insights + data. Valid for Cluster Type: Multi-AZ DB clusters only Valid Values: 7 month * 31, + where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * + 31), 589 (19 months * 31) 731 Default: 7 days If you specify a retention period that + isn't valid, such as 94, Amazon RDS issues an error. +- `"Port"`: The port number on which the DB cluster accepts connections. Valid for Cluster + Type: Aurora DB clusters only Valid Values: 1150-65535 Default: The same port as the + original DB cluster. - `"PreferredBackupWindow"`: The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the - Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be - in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance - window. Must be at least 30 minutes. Valid for: Aurora DB clusters and Multi-AZ DB - clusters + Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB + clusters Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal + Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must + be at least 30 minutes. - `"PreferredMaintenanceWindow"`: The weekly time range during which system maintenance can - occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is - 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. To see the time blocks available, - see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. - Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. Valid - for: Aurora DB clusters and Multi-AZ DB clusters -- `"RotateMasterUserPassword"`: A value that indicates whether to rotate the secret managed - by Amazon Web Services Secrets Manager for the master user password. This setting is valid - only if the master user password is managed by RDS in Amazon Web Services Secrets Manager - for the DB cluster. The secret value contains the updated password. For more information, - see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User - Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora - User Guide. Constraints: You must apply the change immediately when rotating the master - user password. Valid for: Aurora DB clusters and Multi-AZ DB clusters + occur, in Universal Coordinated Time (UTC). Valid for Cluster Type: Aurora DB clusters and + Multi-AZ DB clusters The default is 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. + To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance + Window in the Amazon Aurora User Guide. Constraints: Must be in the format + ddd:hh24:mi-ddd:hh24:mi. Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun. + Must be in Universal Coordinated Time (UTC). Must be at least 30 minutes. +- `"RotateMasterUserPassword"`: Specifies whether to rotate the secret managed by Amazon + Web Services Secrets Manager for the master user password. This setting is valid only if + the master user password is managed by RDS in Amazon Web Services Secrets Manager for the + DB cluster. The secret value contains the updated password. For more information, see + Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide + and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User + Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: + You must apply the change immediately when rotating the master user password. - `"ScalingConfiguration"`: The scaling properties of the DB cluster. You can only modify - scaling properties for DB clusters in serverless DB engine mode. Valid for: Aurora DB - clusters only + scaling properties for DB clusters in serverless DB engine mode. Valid for Cluster Type: + Aurora DB clusters only - `"ServerlessV2ScalingConfiguration"`: -- `"StorageType"`: Specifies the storage type to be associated with the DB cluster. When - specified for a Multi-AZ DB cluster, a value for the Iops parameter is required. Valid - values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters) Default: - aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters) Valid for: Aurora DB clusters and - Multi-AZ DB clusters -- `"VpcSecurityGroupIds"`: A list of VPC security groups that the DB cluster will belong - to. Valid for: Aurora DB clusters and Multi-AZ DB clusters +- `"StorageType"`: The storage type to associate with the DB cluster. For information on + storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB + clusters. For information on storage types for Multi-AZ DB clusters, see Settings for + creating Multi-AZ DB clusters. When specified for a Multi-AZ DB cluster, a value for the + Iops parameter is required. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB + clusters Valid Values: Aurora DB clusters - aurora | aurora-iopt1 Multi-AZ DB clusters + - io1 Default: Aurora DB clusters - aurora Multi-AZ DB clusters - io1 +- `"VpcSecurityGroupIds"`: A list of EC2 VPC security groups to associate with this DB + cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters """ function modify_dbcluster( DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config() @@ -6533,43 +6561,44 @@ modifications you can make to your DB instance, call DescribeValidDBInstanceModi before you call ModifyDBInstance. # Arguments -- `dbinstance_identifier`: The DB instance identifier. This value is stored as a lowercase - string. Constraints: Must match the identifier of an existing DBInstance. +- `dbinstance_identifier`: The identifier of DB instance to modify. This value is stored as + a lowercase string. Constraints: Must match the identifier of an existing DB instance. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"AllocatedStorage"`: The new amount of storage in gibibytes (GiB) to allocate for the DB - instance. For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least - 10% greater than the current value. Values that are not at least 10% greater than the - existing value are rounded up so that they are 10% greater than the current value. For the - valid values for allocated storage for each engine, see CreateDBInstance. -- `"AllowMajorVersionUpgrade"`: A value that indicates whether major version upgrades are - allowed. Changing this parameter doesn't result in an outage and the change is - asynchronously applied as soon as possible. This setting doesn't apply to RDS Custom. - Constraints: Major version upgrades must be allowed when specifying a value for the - EngineVersion parameter that is a different major version than the DB instance's current + instance. For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, the + value supplied must be at least 10% greater than the current value. Values that are not at + least 10% greater than the existing value are rounded up so that they are 10% greater than + the current value. For the valid values for allocated storage for each engine, see + CreateDBInstance. +- `"AllowMajorVersionUpgrade"`: Specifies whether major version upgrades are allowed. + Changing this parameter doesn't result in an outage and the change is asynchronously + applied as soon as possible. This setting doesn't apply to RDS Custom DB instances. + Constraints: Major version upgrades must be allowed when specifying a value for the + EngineVersion parameter that's a different major version than the DB instance's current version. -- `"ApplyImmediately"`: A value that indicates whether the modifications in this request - and any pending modifications are asynchronously applied as soon as possible, regardless of - the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is +- `"ApplyImmediately"`: Specifies whether the modifications in this request and any pending + modifications are asynchronously applied as soon as possible, regardless of the + PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled. If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied. -- `"AutoMinorVersionUpgrade"`: A value that indicates whether minor version upgrades are - applied automatically to the DB instance during the maintenance window. An outage occurs - when all the following conditions are met: The automatic upgrade is enabled for the - maintenance window. A newer minor version is available. RDS has enabled automatic - patching for the engine version. If any of the preceding conditions isn't met, RDS - applies the change as soon as possible and doesn't cause an outage. For an RDS Custom DB - instance, set AutoMinorVersionUpgrade to false. Otherwise, the operation returns an error. -- `"AutomationMode"`: The automation mode of the RDS Custom DB instance: full or all - paused. If full, the DB instance automates monitoring and instance recovery. If all paused, - the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes. +- `"AutoMinorVersionUpgrade"`: Specifies whether minor version upgrades are applied + automatically to the DB instance during the maintenance window. An outage occurs when all + the following conditions are met: The automatic upgrade is enabled for the maintenance + window. A newer minor version is available. RDS has enabled automatic patching for the + engine version. If any of the preceding conditions isn't met, Amazon RDS applies the + change as soon as possible and doesn't cause an outage. For an RDS Custom DB instance, + don't enable this setting. Otherwise, the operation returns an error. +- `"AutomationMode"`: The automation mode of the RDS Custom DB instance. If full, the DB + instance automates monitoring and instance recovery. If all paused, the instance pauses + automation for the duration set by ResumeFullAutomationModeMinutes. - `"AwsBackupRecoveryPointArn"`: The Amazon Resource Name (ARN) of the recovery point in - Amazon Web Services Backup. This setting doesn't apply to RDS Custom. + Amazon Web Services Backup. This setting doesn't apply to RDS Custom DB instances. - `"BackupRetentionPeriod"`: The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Enabling and disabling backups can result in a brief I/O suspension @@ -6577,38 +6606,36 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys instance. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon - as possible. Amazon Aurora Not applicable. The retention period for automated backups is - managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses - existing setting Constraints: It must be a value from 0 to 35. It can't be set to 0 if - the DB instance is a source to read replicas. It can't be set to 0 for an RDS Custom for - Oracle DB instance. It can be specified for a MySQL read replica only if the source is - running MySQL 5.6 or later. It can be specified for a PostgreSQL read replica only if the - source is running PostgreSQL 9.3.5. -- `"CACertificateIdentifier"`: Specifies the CA certificate identifier to use for the DB - instance’s server certificate. This setting doesn't apply to RDS Custom. For more + as possible. This setting doesn't apply to Amazon Aurora DB instances. The retention period + for automated backups is managed by the DB cluster. For more information, see + ModifyDBCluster. Default: Uses existing setting Constraints: Must be a value from 0 to + 35. Can't be set to 0 if the DB instance is a source to read replicas. Can't be set to + 0 for an RDS Custom for Oracle DB instance. +- `"CACertificateIdentifier"`: The CA certificate identifier to use for the DB instance6's + server certificate. This setting doesn't apply to RDS Custom DB instances. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide. -- `"CertificateRotationRestart"`: A value that indicates whether the DB instance is - restarted when you rotate your SSL/TLS certificate. By default, the DB instance is - restarted when you rotate your SSL/TLS certificate. The certificate is not updated until - the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to - connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow - the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: For - more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating - Your SSL/TLS Certificate. in the Amazon RDS User Guide. For more information about - rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS - Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom. -- `"CloudwatchLogsExportConfiguration"`: The configuration setting for the log types to be - enabled for export to CloudWatch Logs for a specific DB instance. A change to the +- `"CertificateRotationRestart"`: Specifies whether the DB instance is restarted when you + rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate + your SSL/TLS certificate. The certificate is not updated until the DB instance is + restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB + instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate + instructions for your DB engine to rotate your SSL/TLS certificate: For more information + about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS + Certificate. in the Amazon RDS User Guide. For more information about rotating your + SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the + Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances. +- `"CloudwatchLogsExportConfiguration"`: The log types to be enabled for export to + CloudWatch Logs for a specific DB instance. A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect. This setting doesn't - apply to RDS Custom. -- `"CopyTagsToSnapshot"`: A value that indicates whether to copy all tags from the DB - instance to snapshots of the DB instance. By default, tags are not copied. Amazon Aurora - Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value - for an Aurora DB instance has no effect on the DB cluster setting. For more information, - see ModifyDBCluster. + apply to RDS Custom DB instances. +- `"CopyTagsToSnapshot"`: Specifies whether to copy all tags from the DB instance to + snapshots of the DB instance. By default, tags aren't copied. This setting doesn't apply to + Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting + this value for an Aurora DB instance has no effect on the DB cluster setting. For more + information, see ModifyDBCluster. - `"DBInstanceClass"`: The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for @@ -6624,58 +6651,73 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys instance without failover. In this case, the DB instance isn't rebooted automatically, and the parameter changes aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are - applied immediately without a reboot. This setting doesn't apply to RDS Custom. Default: - Uses existing setting Constraints: The DB parameter group must be in the same DB parameter + applied immediately without a reboot. This setting doesn't apply to RDS Custom DB + instances. Default: Uses existing setting Constraints: Must be in the same DB parameter group family as the DB instance. - `"DBPortNumber"`: The port number on which the database accepts connections. The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance. If you change the DBPortNumber value, your database restarts regardless of the value of the ApplyImmediately parameter. This setting doesn't - apply to RDS Custom. MySQL Default: 3306 Valid values: 1150-65535 MariaDB Default: - 3306 Valid values: 1150-65535 PostgreSQL Default: 5432 Valid values: 1150-65535 Type: - Integer Oracle Default: 1521 Valid values: 1150-65535 SQL Server Default: 1433 Valid - values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156. Amazon - Aurora Default: 3306 Valid values: 1150-65535 + apply to RDS Custom DB instances. Valid Values: 1150-65535 Default: Amazon Aurora - 3306 + RDS for MariaDB - 3306 RDS for Microsoft SQL Server - 1433 RDS for MySQL - 3306 + RDS for Oracle - 1521 RDS for PostgreSQL - 5432 Constraints: For RDS for Microsoft + SQL Server, the value can't be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156. - `"DBSecurityGroups"`: A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied - as soon as possible. This setting doesn't apply to RDS Custom. Constraints: If supplied, - must match existing DBSecurityGroups. + as soon as possible. This setting doesn't apply to RDS Custom DB instances. Constraints: + If supplied, must match existing DB security groups. - `"DBSubnetGroupName"`: The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. Changing the subnet group causes an outage during the change. The change is applied during the next maintenance - window, unless you enable ApplyImmediately. This parameter doesn't apply to RDS Custom. - Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: + window, unless you enable ApplyImmediately. This parameter doesn't apply to RDS Custom DB + instances. Constraints: If supplied, must match existing DB subnet group. Example: mydbsubnetgroup -- `"DeletionProtection"`: A value that indicates whether the DB instance has deletion - protection enabled. The database can't be deleted when deletion protection is enabled. By - default, deletion protection isn't enabled. For more information, see Deleting a DB - Instance. +- `"DeletionProtection"`: Specifies whether the DB instance has deletion protection + enabled. The database can't be deleted when deletion protection is enabled. By default, + deletion protection isn't enabled. For more information, see Deleting a DB Instance. +- `"DisableDomain"`: Boolean. If present, removes the instance from the Active Directory + domain. - `"Domain"`: The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain. For more information, see Kerberos - Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. + Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB + instances. +- `"DomainAuthSecretArn"`: The ARN for the Secrets Manager secret that contains the + credentials for the user performing the domain join. Example: + arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 +- `"DomainDnsIps"`: The IPv4 DNS IP addresses of your primary and secondary Active + Directory domain controllers. Constraints: Two IP addresses must be provided. If there + isn't a secondary domain controller, use the IP address of the primary domain controller + for both entries in the list. Example: 123.124.125.126,234.235.236.237 +- `"DomainFqdn"`: Specifies the fully qualified domain name of an Active Directory domain. + Constraints: Cannot be greater than 64 characters. Example: + mymanagedADtest.mymanagedAD.mydomain - `"DomainIAMRoleName"`: The name of the IAM role to use when making API calls to the - Directory Service. This setting doesn't apply to RDS Custom. -- `"EnableCustomerOwnedIp"`: A value that indicates whether to enable a customer-owned IP - address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external - connectivity to resources in your Outpost subnets through your on-premises network. For - some use cases, a CoIP can provide lower latency for connections to the DB instance from - outside of its virtual private cloud (VPC) on your local network. For more information - about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the - Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in - the Amazon Web Services Outposts User Guide. -- `"EnableIAMDatabaseAuthentication"`: A value that indicates whether to enable mapping of - Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By - default, mapping isn't enabled. This setting doesn't apply to Amazon Aurora. Mapping Amazon - Web Services IAM accounts to database accounts is managed by the DB cluster. For more + Directory Service. This setting doesn't apply to RDS Custom DB instances. +- `"DomainOu"`: The Active Directory organizational unit for your DB instance to join. + Constraints: Must be in the distinguished name format. Cannot be greater than 64 + characters. Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain +- `"EnableCustomerOwnedIp"`: Specifies whether to enable a customer-owned IP address (CoIP) + for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to + resources in your Outpost subnets through your on-premises network. For some use cases, a + CoIP can provide lower latency for connections to the DB instance from outside of its + virtual private cloud (VPC) on your local network. For more information about RDS on + Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS + User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon + Web Services Outposts User Guide. +- `"EnableIAMDatabaseAuthentication"`: Specifies whether to enable mapping of Amazon Web + Services Identity and Access Management (IAM) accounts to database accounts. By default, + mapping isn't enabled. This setting doesn't apply to Amazon Aurora. Mapping Amazon Web + Services IAM accounts to database accounts is managed by the DB cluster. For more information about IAM database authentication, see IAM Database Authentication for MySQL - and PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. -- `"EnablePerformanceInsights"`: A value that indicates whether to enable Performance - Insights for the DB instance. For more information, see Using Amazon Performance Insights - in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. + and PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB + instances. +- `"EnablePerformanceInsights"`: Specifies whether to enable Performance Insights for the + DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS + User Guide. This setting doesn't apply to RDS Custom DB instances. - `"Engine"`: The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB. Note the following requirements: Make sure that you specify @@ -6693,10 +6735,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family. If you specify only - a major version, Amazon RDS will update the DB instance to the default minor version if the + a major version, Amazon RDS updates the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions. If the instance that you're modifying - is acting as a read replica, the engine version that you specify must be the same or later + is acting as a read replica, the engine version that you specify must be the same or higher than the version that the source DB instance or cluster is running. In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the PATCH_DB_FAILURE lifecycle. @@ -6715,39 +6757,41 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating - a DB snapshot of the instance. Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the - value supplied must be at least 10% greater than the current value. Values that are not at - least 10% greater than the existing value are rounded up so that they are 10% greater than - the current value. Default: Uses existing setting + a DB snapshot of the instance. Constraints: For RDS for MariaDB, RDS for MySQL, RDS for + Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the + current value. Values that are not at least 10% greater than the existing value are rounded + up so that they are 10% greater than the current value. Default: Uses existing setting - `"LicenseModel"`: The license model for the DB instance. This setting doesn't apply to - RDS Custom. Valid values: license-included | bring-your-own-license | - general-public-license -- `"ManageMasterUserPassword"`: A value that indicates whether to manage the master user - password with Amazon Web Services Secrets Manager. If the DB instance doesn't manage the - master user password with Amazon Web Services Secrets Manager, you can turn on this - management. In this case, you can't specify MasterUserPassword. If the DB instance already - manages the master user password with Amazon Web Services Secrets Manager, and you specify - that the master user password is not managed with Amazon Web Services Secrets Manager, then - you must specify MasterUserPassword. In this case, RDS deletes the secret and uses the new + Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for MariaDB - + general-public-license RDS for Microsoft SQL Server - license-included RDS for MySQL + - general-public-license RDS for Oracle - bring-your-own-license | license-included + RDS for PostgreSQL - postgresql-license +- `"ManageMasterUserPassword"`: Specifies whether to manage the master user password with + Amazon Web Services Secrets Manager. If the DB instance doesn't manage the master user + password with Amazon Web Services Secrets Manager, you can turn on this management. In this + case, you can't specify MasterUserPassword. If the DB instance already manages the master + user password with Amazon Web Services Secrets Manager, and you specify that the master + user password is not managed with Amazon Web Services Secrets Manager, then you must + specify MasterUserPassword. In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide. Constraints: Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified. -- `"MasterUserPassword"`: The new password for the master user. The password can include - any printable ASCII character except \"/\", \"\"\", or \"@\". Changing this parameter +- `"MasterUserPassword"`: The new password for the master user. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword - element exists in the PendingModifiedValues element of the operation response. This setting - doesn't apply to RDS Custom. Amazon Aurora Not applicable. The password for the master - user is managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses - existing setting Constraints: Can't be specified if ManageMasterUserPassword is turned on. - MariaDB Constraints: Must contain from 8 to 41 characters. Microsoft SQL Server - Constraints: Must contain from 8 to 128 characters. MySQL Constraints: Must contain from - 8 to 41 characters. Oracle Constraints: Must contain from 8 to 30 characters. PostgreSQL - Constraints: Must contain from 8 to 128 characters. Amazon RDS API operations never - return the password, so this action provides a way to regain access to a primary instance - user if the password is lost. This includes restoring privileges that might have been - accidentally revoked. + element exists in the PendingModifiedValues element of the operation response. Amazon RDS + API operations never return the password, so this action provides a way to regain access to + a primary instance user if the password is lost. This includes restoring privileges that + might have been accidentally revoked. This setting doesn't apply to the following DB + instances: Amazon Aurora (The password for the master user is managed by the DB cluster. + For more information, see ModifyDBCluster.) RDS Custom Default: Uses existing setting + Constraints: Can't be specified if ManageMasterUserPassword is turned on. Can include + any printable ASCII character except \"/\", \"\"\", or \"@\". Length Constraints: RDS + for MariaDB - Must contain from 8 to 41 characters. RDS for Microsoft SQL Server - Must + contain from 8 to 128 characters. RDS for MySQL - Must contain from 8 to 41 characters. + RDS for Oracle - Must contain from 8 to 30 characters. RDS for PostgreSQL - Must contain + from 8 to 128 characters. - `"MasterUserSecretKmsKeyId"`: The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if both of the following conditions are met: The DB instance @@ -6768,94 +6812,93 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to - RDS Custom. + RDS Custom DB instances. - `"MonitoringInterval"`: The interval, in seconds, between points when Enhanced Monitoring - metrics are collected for the DB instance. To disable collecting Enhanced Monitoring - metrics, specify 0, which is the default. If MonitoringRoleArn is specified, set - MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom. Valid - Values: 0, 1, 5, 10, 15, 30, 60 + metrics are collected for the DB instance. To disable collection of Enhanced Monitoring + metrics, specify 0. If MonitoringRoleArn is specified, set MonitoringInterval to a value + other than 0. This setting doesn't apply to RDS Custom DB instances. Valid Values: 0 | 1 | + 5 | 10 | 15 | 30 | 60 Default: 0 - `"MonitoringRoleArn"`: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value. This - setting doesn't apply to RDS Custom. -- `"MultiAZ"`: A value that indicates whether the DB instance is a Multi-AZ deployment. - Changing this parameter doesn't result in an outage. The change is applied during the next - maintenance window unless the ApplyImmediately parameter is enabled for this request. This - setting doesn't apply to RDS Custom. -- `"NetworkType"`: The network type of the DB instance. Valid values: IPV4 DUAL - The network type is determined by the DBSubnetGroup specified for the DB instance. A - DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). - For more information, see Working with a DB instance in a VPC in the Amazon RDS User - Guide. -- `"NewDBInstanceIdentifier"`: The new DB instance identifier for the DB instance when - renaming a DB instance. When you change the DB instance identifier, an instance reboot - occurs immediately if you enable ApplyImmediately, or will occur during the next - maintenance window if you disable Apply Immediately. This value is stored as a lowercase - string. This setting doesn't apply to RDS Custom. Constraints: Must contain from 1 to 63 - letters, numbers, or hyphens. The first character must be a letter. Can't end with a - hyphen or contain two consecutive hyphens. Example: mydbinstance -- `"OptionGroupName"`: A value that indicates the DB instance should be associated with the - specified option group. Changing this parameter doesn't result in an outage, with one - exception. If the parameter change results in an option group that enables OEM, it can - cause a brief period, lasting less than a second, during which new connections are rejected - but existing connections aren't interrupted. The change is applied during the next - maintenance window unless the ApplyImmediately parameter is enabled for this request. - Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be - removed from an option group, and that option group can't be removed from a DB instance - after it is associated with a DB instance. This setting doesn't apply to RDS Custom. + setting doesn't apply to RDS Custom DB instances. +- `"MultiAZ"`: Specifies whether the DB instance is a Multi-AZ deployment. Changing this + parameter doesn't result in an outage. The change is applied during the next maintenance + window unless the ApplyImmediately parameter is enabled for this request. This setting + doesn't apply to RDS Custom DB instances. +- `"NetworkType"`: The network type of the DB instance. The network type is determined by + the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 + protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with + a DB instance in a VPC in the Amazon RDS User Guide. Valid Values: IPV4 | DUAL +- `"NewDBInstanceIdentifier"`: The new identifier for the DB instance when renaming a DB + instance. When you change the DB instance identifier, an instance reboot occurs immediately + if you enable ApplyImmediately, or will occur during the next maintenance window if you + disable ApplyImmediately. This value is stored as a lowercase string. This setting doesn't + apply to RDS Custom DB instances. Constraints: Must contain from 1 to 63 letters, + numbers, or hyphens. The first character must be a letter. Can't end with a hyphen or + contain two consecutive hyphens. Example: mydbinstance +- `"OptionGroupName"`: The option group to associate the DB instance with. Changing this + parameter doesn't result in an outage, with one exception. If the parameter change results + in an option group that enables OEM, it can cause a brief period, lasting less than a + second, during which new connections are rejected but existing connections aren't + interrupted. The change is applied during the next maintenance window unless the + ApplyImmediately parameter is enabled for this request. Permanent options, such as the TDE + option for Oracle Advanced Security TDE, can't be removed from an option group, and that + option group can't be removed from a DB instance after it is associated with a DB instance. + This setting doesn't apply to RDS Custom DB instances. - `"PerformanceInsightsKMSKeyId"`: The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the - key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value - for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a - default KMS key for your Amazon Web Services account. Your Amazon Web Services account has - a different default KMS key for each Amazon Web Services Region. This setting doesn't apply - to RDS Custom. + key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for + PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default + KMS key for your Amazon Web Services account. Your Amazon Web Services account has a + different default KMS key for each Amazon Web Services Region. This setting doesn't apply + to RDS Custom DB instances. - `"PerformanceInsightsRetentionPeriod"`: The number of days to retain Performance Insights - data. The default is 7 days. The following values are valid: 7 month * 31, where month - is a number of months from 1-23 731 For example, the following values are valid: 93 - (3 months * 31) 341 (11 months * 31) 589 (19 months * 31) 731 If you specify a - retention period such as 94, which isn't a valid value, RDS issues an error. This setting - doesn't apply to RDS Custom. + data. This setting doesn't apply to RDS Custom DB instances. Valid Values: 7 month * + 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 + months * 31), 589 (19 months * 31) 731 Default: 7 days If you specify a retention + period that isn't valid, such as 94, Amazon RDS returns an error. - `"PreferredBackupWindow"`: The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more - information, see Backup window in the Amazon RDS User Guide. Amazon Aurora Not - applicable. The daily time range for creating automated backups is managed by the DB - cluster. For more information, see ModifyDBCluster. Constraints: Must be in the format - hh24:mi-hh24:mi Must be in Universal Time Coordinated (UTC) Must not conflict with the - preferred maintenance window Must be at least 30 minutes -- `"PreferredMaintenanceWindow"`: The weekly time range (in UTC) during which system - maintenance can occur, which might result in an outage. Changing this parameter doesn't - result in an outage, except in the following situation, and the change is asynchronously - applied as soon as possible. If there are pending actions that cause a reboot, and the - maintenance window is changed to include the current time, then changing this parameter - will cause a reboot of the DB instance. If moving this window to the current time, there - must be at least 30 minutes between the current time and end of the window to ensure - pending changes are applied. For more information, see Amazon RDS Maintenance Window in the - Amazon RDS User Guide. Default: Uses existing setting Format: ddd:hh24:mi-ddd:hh24:mi - Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes + information, see Backup window in the Amazon RDS User Guide. This setting doesn't apply to + Amazon Aurora DB instances. The daily time range for creating automated backups is managed + by the DB cluster. For more information, see ModifyDBCluster. Constraints: Must be in the + format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict + with the preferred maintenance window. Must be at least 30 minutes. +- `"PreferredMaintenanceWindow"`: The weekly time range during which system maintenance can + occur, which might result in an outage. Changing this parameter doesn't result in an + outage, except in the following situation, and the change is asynchronously applied as soon + as possible. If there are pending actions that cause a reboot, and the maintenance window + is changed to include the current time, then changing this parameter causes a reboot of the + DB instance. If you change this window to the current time, there must be at least 30 + minutes between the current time and end of the window to ensure pending changes are + applied. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User + Guide. Default: Uses existing setting Constraints: Must be in the format + ddd:hh24:mi-ddd:hh24:mi. The day values must be mon | tue | wed | thu | fri | sat | sun. + Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred + backup window. Must be at least 30 minutes. - `"ProcessorFeatures"`: The number of CPU cores and the number of threads per core for the - DB instance class of the DB instance. This setting doesn't apply to RDS Custom. -- `"PromotionTier"`: A value that specifies the order in which an Aurora Replica is - promoted to the primary instance after a failure of the existing primary instance. For more - information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. - This setting doesn't apply to RDS Custom. Default: 1 Valid Values: 0 - 15 -- `"PubliclyAccessible"`: A value that indicates whether the DB instance is publicly - accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) - endpoint resolves to the private IP address from within the DB cluster's virtual private - cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. - Access to the DB cluster is ultimately controlled by the security group it uses. That - public access isn't permitted if the security group assigned to the DB cluster doesn't - permit it. When the DB instance isn't publicly accessible, it is an internal DB instance - with a DNS name that resolves to a private IP address. PubliclyAccessible only applies to - DB instances in a VPC. The DB instance must be part of a public subnet and - PubliclyAccessible must be enabled for it to be publicly accessible. Changes to the - PubliclyAccessible parameter are applied immediately regardless of the value of the - ApplyImmediately parameter. + DB instance class of the DB instance. This setting doesn't apply to RDS Custom DB instances. +- `"PromotionTier"`: The order of priority in which an Aurora Replica is promoted to the + primary instance after a failure of the existing primary instance. For more information, + see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting + doesn't apply to RDS Custom DB instances. Default: 1 Valid Values: 0 - 15 +- `"PubliclyAccessible"`: Specifies whether the DB instance is publicly accessible. When + the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to + the private IP address from within the DB cluster's virtual private cloud (VPC). It + resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB + cluster is ultimately controlled by the security group it uses. That public access isn't + permitted if the security group assigned to the DB cluster doesn't permit it. When the DB + instance isn't publicly accessible, it is an internal DB instance with a DNS name that + resolves to a private IP address. PubliclyAccessible only applies to DB instances in a + VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled + for it to be publicly accessible. Changes to the PubliclyAccessible parameter are applied + immediately regardless of the value of the ApplyImmediately parameter. - `"ReplicaMode"`: A value that sets the open mode of a replica database to either mounted or read-only. Currently, this parameter is only supported for Oracle DB instances. Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for @@ -6863,46 +6906,47 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting - doesn't apply to RDS Custom. + doesn't apply to RDS Custom DB instances. - `"ResumeFullAutomationModeMinutes"`: The number of minutes to pause the automation. When - the time period ends, RDS Custom resumes full automation. The minimum value is 60 - (default). The maximum value is 1,440. -- `"RotateMasterUserPassword"`: A value that indicates whether to rotate the secret managed - by Amazon Web Services Secrets Manager for the master user password. This setting is valid - only if the master user password is managed by RDS in Amazon Web Services Secrets Manager - for the DB cluster. The secret value contains the updated password. For more information, - see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User - Guide. Constraints: You must apply the change immediately when rotating the master user + the time period ends, RDS Custom resumes full automation. Default: 60 Constraints: Must + be at least 60. Must be no more than 1,440. +- `"RotateMasterUserPassword"`: Specifies whether to rotate the secret managed by Amazon + Web Services Secrets Manager for the master user password. This setting is valid only if + the master user password is managed by RDS in Amazon Web Services Secrets Manager for the + DB cluster. The secret value contains the updated password. For more information, see + Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide. + Constraints: You must apply the change immediately when rotating the master user password. -- `"StorageThroughput"`: Specifies the storage throughput value for the DB instance. This - setting applies only to the gp3 storage type. This setting doesn't apply to RDS Custom or - Amazon Aurora. -- `"StorageType"`: Specifies the storage type to be associated with the DB instance. If you - specify Provisioned IOPS (io1), you must also include a value for the Iops parameter. If - you choose to migrate your DB instance from using standard storage to using Provisioned - IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. - The duration of the migration depends on several factors such as database load, storage - size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and - the number of prior scale storage operations. Typical migration times are under 24 hours, - but the process can take up to several days in some cases. During the migration, the DB - instance is available for use, but might experience performance degradation. While the - migration takes place, nightly backups for the instance are suspended. No other Amazon RDS - operations can take place for the instance, including modifying the instance, rebooting the - instance, deleting the instance, creating a read replica for the instance, and creating a - DB snapshot of the instance. Valid values: gp2 | gp3 | io1 | standard Default: io1 if the - Iops parameter is specified, otherwise gp2 +- `"StorageThroughput"`: The storage throughput value for the DB instance. This setting + applies only to the gp3 storage type. This setting doesn't apply to Amazon Aurora or RDS + Custom DB instances. +- `"StorageType"`: The storage type to associate with the DB instance. If you specify + Provisioned IOPS (io1), you must also include a value for the Iops parameter. If you choose + to migrate your DB instance from using standard storage to using Provisioned IOPS, or from + using Provisioned IOPS to using standard storage, the process can take time. The duration + of the migration depends on several factors such as database load, storage size, storage + type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of + prior scale storage operations. Typical migration times are under 24 hours, but the process + can take up to several days in some cases. During the migration, the DB instance is + available for use, but might experience performance degradation. While the migration takes + place, nightly backups for the instance are suspended. No other Amazon RDS operations can + take place for the instance, including modifying the instance, rebooting the instance, + deleting the instance, creating a read replica for the instance, and creating a DB snapshot + of the instance. Valid Values: gp2 | gp3 | io1 | standard Default: io1, if the Iops + parameter is specified. Otherwise, gp2. - `"TdeCredentialArn"`: The ARN from the key store with which to associate the instance for - TDE encryption. This setting doesn't apply to RDS Custom. + TDE encryption. This setting doesn't apply to RDS Custom DB instances. - `"TdeCredentialPassword"`: The password for the given ARN from the key store in order to - access the device. This setting doesn't apply to RDS Custom. -- `"UseDefaultProcessorFeatures"`: A value that indicates whether the DB instance class of - the DB instance uses its default processor features. This setting doesn't apply to RDS - Custom. -- `"VpcSecurityGroupIds"`: A list of Amazon EC2 VPC security groups to authorize on this DB - instance. This change is asynchronously applied as soon as possible. This setting doesn't - apply to RDS Custom. Amazon Aurora Not applicable. The associated list of EC2 VPC - security groups is managed by the DB cluster. For more information, see ModifyDBCluster. - Constraints: If supplied, must match existing VpcSecurityGroupIds. + access the device. This setting doesn't apply to RDS Custom DB instances. +- `"UseDefaultProcessorFeatures"`: Specifies whether the DB instance class of the DB + instance uses its default processor features. This setting doesn't apply to RDS Custom DB + instances. +- `"VpcSecurityGroupIds"`: A list of Amazon EC2 VPC security groups to associate with this + DB instance. This change is asynchronously applied as soon as possible. This setting + doesn't apply to the following DB instances: Amazon Aurora (The associated list of EC2 + VPC security groups is managed by the DB cluster. For more information, see + ModifyDBCluster.) RDS Custom Constraints: If supplied, must match existing VPC + security group IDs. """ function modify_dbinstance( DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config() @@ -7183,9 +7227,11 @@ MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom. Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"EngineVersion"`: The engine version to upgrade the DB snapshot to. The following are the database engines and engine versions that are available when you upgrade a DB snapshot. - MySQL 5.5.46 (supported for 5.1 DB snapshots) Oracle 12.1.0.2.v8 (supported for - 12.1.0.1 DB snapshots) 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots) - 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots) PostgreSQL For the list of engine + MySQL 5.5.46 (supported for 5.1 DB snapshots) Oracle + 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB snapshots) + 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB snapshots) 12.1.0.2.v8 + (supported for 12.1.0.1 DB snapshots) 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots) + 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots) PostgreSQL For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS. - `"OptionGroupName"`: The option group to identify with the upgraded DB snapshot. You can @@ -8828,8 +8874,21 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. +- `"DomainAuthSecretArn"`: The ARN for the Secrets Manager secret that contains the + credentials for the user performing the domain join. Constraints: Example: + arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 +- `"DomainDnsIps"`: The IPv4 DNS IP addresses of your primary and secondary Active + Directory domain controllers. Constraints: Two IP addresses must be provided. If there + isn't a secondary domain controller, use the IP address of the primary domain controller + for both entries in the list. Example: 123.124.125.126,234.235.236.237 +- `"DomainFqdn"`: Specifies the fully qualified domain name of an Active Directory domain. + Constraints: Cannot be greater than 64 characters. Example: + mymanagedADtest.mymanagedAD.mydomain - `"DomainIAMRoleName"`: Specify the name of the IAM role to be used when making API calls to the Directory Service. This setting doesn't apply to RDS Custom. +- `"DomainOu"`: The Active Directory organizational unit for your DB instance to join. + Constraints: Must be in the distinguished name format. Cannot be greater than 64 + characters. Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain - `"EnableCloudwatchLogsExports"`: The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS @@ -9251,8 +9310,22 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain. This setting doesn't apply to RDS Custom. For more information, see Kerberos Authentication in the Amazon RDS User Guide. +- `"DomainAuthSecretArn"`: The ARN for the Secrets Manager secret that contains the + credentials for the user performing the domain join. Constraints: Cannot be greater than + 64 characters. Example: + arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 +- `"DomainDnsIps"`: The IPv4 DNS IP addresses of your primary and secondary Active + Directory domain controllers. Constraints: Two IP addresses must be provided. If there + isn't a secondary domain controller, use the IP address of the primary domain controller + for both entries in the list. Example: 123.124.125.126,234.235.236.237 +- `"DomainFqdn"`: Specifies the fully qualified domain name of an Active Directory domain. + Constraints: Cannot be greater than 64 characters. Example: + mymanagedADtest.mymanagedAD.mydomain - `"DomainIAMRoleName"`: Specify the name of the IAM role to be used when making API calls to the Directory Service. This setting doesn't apply to RDS Custom. +- `"DomainOu"`: The Active Directory organizational unit for your DB instance to join. + Constraints: Must be in the distinguished name format. Cannot be greater than 64 + characters. Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain - `"EnableCloudwatchLogsExports"`: The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS diff --git a/src/services/redshift.jl b/src/services/redshift.jl index c873961ab7..fd8e607d2c 100644 --- a/src/services/redshift.jl +++ b/src/services/redshift.jl @@ -328,8 +328,8 @@ Amazon Redshift Cluster Management Guide. Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"SnapshotArn"`: The Amazon Resource Name (ARN) of the snapshot to authorize access to. - `"SnapshotClusterIdentifier"`: The identifier of the cluster the snapshot was created - from. This parameter is required if your IAM user or role has a policy containing a - snapshot resource element that specifies anything other than * for the cluster name. + from. This parameter is required if your IAM user has a policy containing a snapshot + resource element that specifies anything other than * for the cluster name. - `"SnapshotIdentifier"`: The identifier of the snapshot the account is authorized to restore. """ @@ -513,9 +513,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1. - `"SourceSnapshotClusterIdentifier"`: The identifier of the cluster the source snapshot - was created from. This parameter is required if your IAM user or role has a policy - containing a snapshot resource element that specifies anything other than * for the cluster - name. Constraints: Must be the identifier for a valid cluster. + was created from. This parameter is required if your IAM user has a policy containing a + snapshot resource element that specifies anything other than * for the cluster name. + Constraints: Must be the identifier for a valid cluster. """ function copy_cluster_snapshot( SourceSnapshotIdentifier, @@ -623,16 +623,16 @@ Redshift Cluster Management Guide. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an Amazon Web Services account. Example: myexamplecluster -- `master_user_password`: The password associated with the admin user for the cluster that - is being created. Constraints: Must be between 8 and 64 characters in length. Must - contain at least one uppercase letter. Must contain at least one lowercase letter. Must - contain one number. Can be any printable ASCII character (ASCII code 33-126) except ' - (single quote), \" (double quote), , /, or @. -- `master_username`: The user name associated with the admin user for the cluster that is - being created. Constraints: Must be 1 - 128 alphanumeric characters or hyphens. The user - name can't be PUBLIC. Must contain only lowercase letters, numbers, underscore, plus - sign, period (dot), at symbol (@), or hyphen. The first character must be a letter. - Must not contain a colon (:) or a slash (/). Cannot be a reserved word. A list of +- `master_user_password`: The password associated with the admin user account for the + cluster that is being created. Constraints: Must be between 8 and 64 characters in + length. Must contain at least one uppercase letter. Must contain at least one lowercase + letter. Must contain one number. Can be any printable ASCII character (ASCII code + 33-126) except ' (single quote), \" (double quote), , /, or @. +- `master_username`: The user name associated with the admin user account for the cluster + that is being created. Constraints: Must be 1 - 128 alphanumeric characters or hyphens. + The user name can't be PUBLIC. Must contain only lowercase letters, numbers, underscore, + plus sign, period (dot), at symbol (@), or hyphen. The first character must be a letter. + Must not contain a colon (:) or a slash (/). Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. - `node_type`: The node type to be provisioned for the cluster. For information about node @@ -1044,6 +1044,63 @@ function create_cluster_subnet_group( ) end +""" + create_custom_domain_association(cluster_identifier, custom_domain_certificate_arn, custom_domain_name) + create_custom_domain_association(cluster_identifier, custom_domain_certificate_arn, custom_domain_name, params::Dict{String,<:Any}) + +Used to create a custom domain name for a cluster. Properties include the custom domain +name, the cluster the custom domain is associated with, and the certificate Amazon Resource +Name (ARN). + +# Arguments +- `cluster_identifier`: The cluster identifier that the custom domain is associated with. +- `custom_domain_certificate_arn`: The certificate Amazon Resource Name (ARN) for the + custom domain name association. +- `custom_domain_name`: The custom domain name for a custom domain association. + +""" +function create_custom_domain_association( + ClusterIdentifier, + CustomDomainCertificateArn, + CustomDomainName; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return redshift( + "CreateCustomDomainAssociation", + Dict{String,Any}( + "ClusterIdentifier" => ClusterIdentifier, + "CustomDomainCertificateArn" => CustomDomainCertificateArn, + "CustomDomainName" => CustomDomainName, + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function create_custom_domain_association( + ClusterIdentifier, + CustomDomainCertificateArn, + CustomDomainName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return redshift( + "CreateCustomDomainAssociation", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "ClusterIdentifier" => ClusterIdentifier, + "CustomDomainCertificateArn" => CustomDomainCertificateArn, + "CustomDomainName" => CustomDomainName, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ create_endpoint_access(endpoint_name, subnet_group_name) create_endpoint_access(endpoint_name, subnet_group_name, params::Dict{String,<:Any}) @@ -1862,7 +1919,7 @@ authorizations before you can delete the snapshot. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"SnapshotClusterIdentifier"`: The unique identifier of the cluster the snapshot was - created from. This parameter is required if your IAM user or role has a policy containing a + created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. Constraints: Must be the name of valid cluster. """ @@ -1932,6 +1989,44 @@ function delete_cluster_subnet_group( ) end +""" + delete_custom_domain_association(cluster_identifier) + delete_custom_domain_association(cluster_identifier, params::Dict{String,<:Any}) + +Contains information about deleting a custom domain association for a cluster. + +# Arguments +- `cluster_identifier`: The identifier of the cluster to delete a custom domain association + for. + +""" +function delete_custom_domain_association( + ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config() +) + return redshift( + "DeleteCustomDomainAssociation", + Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function delete_custom_domain_association( + ClusterIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return redshift( + "DeleteCustomDomainAssociation", + Dict{String,Any}( + mergewith( + _merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ delete_endpoint_access(endpoint_name) delete_endpoint_access(endpoint_name, params::Dict{String,<:Any}) @@ -2669,7 +2764,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum - 20, maximum 500. + 20, maximum 100. - `"OwnerAccount"`: The Amazon Web Services account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your Amazon Web Services account, or do not @@ -2897,6 +2992,40 @@ function describe_clusters( ) end +""" + describe_custom_domain_associations() + describe_custom_domain_associations(params::Dict{String,<:Any}) + +Contains information for custom domain associations for a cluster. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"CustomDomainCertificateArn"`: The certificate Amazon Resource Name (ARN) for the custom + domain association. +- `"CustomDomainName"`: The custom domain name for the custom domain association. +- `"Marker"`: The marker for the custom domain association. +- `"MaxRecords"`: The maximum records setting for the associated custom domain. +""" +function describe_custom_domain_associations(; + aws_config::AbstractAWSConfig=global_aws_config() +) + return redshift( + "DescribeCustomDomainAssociations"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function describe_custom_domain_associations( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return redshift( + "DescribeCustomDomainAssociations", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ describe_data_shares() describe_data_shares(params::Dict{String,<:Any}) @@ -4323,8 +4452,8 @@ function enable_snapshot_copy( end """ - get_cluster_credentials(cluster_identifier, db_user) - get_cluster_credentials(cluster_identifier, db_user, params::Dict{String,<:Any}) + get_cluster_credentials(db_user) + get_cluster_credentials(db_user, params::Dict{String,<:Any}) Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with @@ -4344,8 +4473,6 @@ specified, the IAM policy must allow access to the resource dbname for the speci database name. # Arguments -- `cluster_identifier`: The unique identifier of the cluster that contains the database for - which you are requesting credentials. This parameter is case sensitive. - `db_user`: The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesn't exist in the database and Autocreate is True, a new user is created using @@ -4363,6 +4490,9 @@ database name. Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"AutoCreate"`: Create a database user with the name specified for the user named in DbUser if one does not exist. +- `"ClusterIdentifier"`: The unique identifier of the cluster that contains the database + for which you are requesting credentials. This parameter is case sensitive. +- `"CustomDomainName"`: The custom domain name for the cluster credentials. - `"DbGroups"`: A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC. Database group name @@ -4381,41 +4511,28 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"DurationSeconds"`: The number of seconds until the returned temporary password expires. Constraint: minimum 900, maximum 3600. Default: 900 """ -function get_cluster_credentials( - ClusterIdentifier, DbUser; aws_config::AbstractAWSConfig=global_aws_config() -) +function get_cluster_credentials(DbUser; aws_config::AbstractAWSConfig=global_aws_config()) return redshift( "GetClusterCredentials", - Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier, "DbUser" => DbUser); + Dict{String,Any}("DbUser" => DbUser); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) end function get_cluster_credentials( - ClusterIdentifier, - DbUser, - params::AbstractDict{String}; - aws_config::AbstractAWSConfig=global_aws_config(), + DbUser, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() ) return redshift( "GetClusterCredentials", - Dict{String,Any}( - mergewith( - _merge, - Dict{String,Any}( - "ClusterIdentifier" => ClusterIdentifier, "DbUser" => DbUser - ), - params, - ), - ); + Dict{String,Any}(mergewith(_merge, Dict{String,Any}("DbUser" => DbUser), params)); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) end """ - get_cluster_credentials_with_iam(cluster_identifier) - get_cluster_credentials_with_iam(cluster_identifier, params::Dict{String,<:Any}) + get_cluster_credentials_with_iam() + get_cluster_credentials_with_iam(params::Dict{String,<:Any}) Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database. The database user is mapped 1:1 to the source Identity and @@ -4426,12 +4543,11 @@ operation must have an IAM policy attached that allows access to all necessary a resources. For more information about permissions, see Using identity-based policies (IAM policies) in the Amazon Redshift Cluster Management Guide. -# Arguments -- `cluster_identifier`: The unique identifier of the cluster that contains the database for - which you are requesting credentials. - # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"ClusterIdentifier"`: The unique identifier of the cluster that contains the database + for which you are requesting credentials. +- `"CustomDomainName"`: The custom domain name for the IAM message cluster credentials. - `"DbName"`: The name of the database for which you are requesting credentials. If the database name is specified, the IAM policy must allow access to the resource dbname for the specified database name. If the database name is not specified, access to all databases is @@ -4439,28 +4555,21 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"DurationSeconds"`: The number of seconds until the returned temporary password expires. Range: 900-3600. Default: 900. """ -function get_cluster_credentials_with_iam( - ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config() +function get_cluster_credentials_with_iam(; + aws_config::AbstractAWSConfig=global_aws_config() ) return redshift( - "GetClusterCredentialsWithIAM", - Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier); + "GetClusterCredentialsWithIAM"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) end function get_cluster_credentials_with_iam( - ClusterIdentifier, - params::AbstractDict{String}; - aws_config::AbstractAWSConfig=global_aws_config(), + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() ) return redshift( "GetClusterCredentialsWithIAM", - Dict{String,Any}( - mergewith( - _merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params - ), - ); + params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) @@ -4741,11 +4850,11 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response. Operations never return the - password, so this operation provides a way to regain access to the admin user for a cluster - if the password is lost. Default: Uses existing setting. Constraints: Must be between 8 - and 64 characters in length. Must contain at least one uppercase letter. Must contain - at least one lowercase letter. Must contain one number. Can be any printable ASCII - character (ASCII code 33-126) except ' (single quote), \" (double quote), , /, or @. + password, so this operation provides a way to regain access to the admin user account for a + cluster if the password is lost. Default: Uses existing setting. Constraints: Must be + between 8 and 64 characters in length. Must contain at least one uppercase letter. Must + contain at least one lowercase letter. Must contain one number. Can be any printable + ASCII character (ASCII code 33-126) except ' (single quote), \" (double quote), , /, or @. - `"NewClusterIdentifier"`: The new identifier for the cluster. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive @@ -5152,6 +5261,49 @@ function modify_cluster_subnet_group( ) end +""" + modify_custom_domain_association(cluster_identifier) + modify_custom_domain_association(cluster_identifier, params::Dict{String,<:Any}) + +Contains information for changing a custom domain association. + +# Arguments +- `cluster_identifier`: The identifier of the cluster to change a custom domain association + for. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"CustomDomainCertificateArn"`: The certificate Amazon Resource Name (ARN) for the + changed custom domain association. +- `"CustomDomainName"`: The custom domain name for a changed custom domain association. +""" +function modify_custom_domain_association( + ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config() +) + return redshift( + "ModifyCustomDomainAssociation", + Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function modify_custom_domain_association( + ClusterIdentifier, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return redshift( + "ModifyCustomDomainAssociation", + Dict{String,Any}( + mergewith( + _merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ modify_endpoint_access(endpoint_name) modify_endpoint_access(endpoint_name, params::Dict{String,<:Any}) @@ -5845,8 +5997,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys message to restore from a cluster. You must specify this parameter or snapshotIdentifier, but not both. - `"SnapshotClusterIdentifier"`: The name of the cluster the source snapshot was created - from. This parameter is required if your IAM user or role has a policy containing a - snapshot resource element that specifies anything other than * for the cluster name. + from. This parameter is required if your IAM user has a policy containing a snapshot + resource element that specifies anything other than * for the cluster name. - `"SnapshotIdentifier"`: The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You must specify this parameter or snapshotArn, but not both. Example: my-snapshot-id @@ -6111,8 +6263,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"SnapshotArn"`: The Amazon Resource Name (ARN) of the snapshot associated with the message to revoke access. - `"SnapshotClusterIdentifier"`: The identifier of the cluster the snapshot was created - from. This parameter is required if your IAM user or role has a policy containing a - snapshot resource element that specifies anything other than * for the cluster name. + from. This parameter is required if your IAM user has a policy containing a snapshot + resource element that specifies anything other than * for the cluster name. - `"SnapshotIdentifier"`: The identifier of the snapshot that the account can no longer access. """ diff --git a/src/services/route_53_domains.jl b/src/services/route_53_domains.jl index 722d025da1..7db27313ed 100644 --- a/src/services/route_53_domains.jl +++ b/src/services/route_53_domains.jl @@ -878,24 +878,22 @@ end register_domain(admin_contact, domain_name, duration_in_years, registrant_contact, tech_contact) register_domain(admin_contact, domain_name, duration_in_years, registrant_contact, tech_contact, params::Dict{String,<:Any}) -This operation registers a domain. Domains are registered either by Amazon Registrar (for -.com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). -For some top-level domains (TLDs), this operation requires extra parameters. When you -register a domain, Amazon Route 53 does the following: Creates a Route 53 hosted zone -that has the same name as the domain. Route 53 assigns four name servers to your hosted -zone and automatically updates your domain registration with the names of these name -servers. Enables auto renew, so your domain registration will renew automatically each -year. We'll notify you in advance of the renewal date so you can choose whether to renew -the registration. Optionally enables privacy protection, so WHOIS queries return contact -information either for Amazon Registrar (for .com, .net, and .org domains) or for our -registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, -WHOIS queries return the information that you entered for the administrative, registrant, -and technical contacts. You must specify the same privacy setting for the administrative, -registrant, and technical contacts. If registration is successful, returns an operation -ID that you can use to track the progress and completion of the action. If the request is -not completed successfully, the domain registrant is notified by email. Charges your -Amazon Web Services account an amount based on the top-level domain. For more information, -see Amazon Route 53 Pricing. +This operation registers a domain. For some top-level domains (TLDs), this operation +requires extra parameters. When you register a domain, Amazon Route 53 does the following: + Creates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four +name servers to your hosted zone and automatically updates your domain registration with +the names of these name servers. Enables auto renew, so your domain registration will +renew automatically each year. We'll notify you in advance of the renewal date so you can +choose whether to renew the registration. Optionally enables privacy protection, so WHOIS +queries return contact for the registrar or the phrase \"REDACTED FOR PRIVACY\", or \"On +behalf of <domain name> owner.\" If you don't enable privacy protection, WHOIS +queries return the information that you entered for the administrative, registrant, and +technical contacts. While some domains may allow different privacy settings per contact, +we recommend specifying the same privacy setting for all contacts. If registration is +successful, returns an operation ID that you can use to track the progress and completion +of the action. If the request is not completed successfully, the domain registrant is +notified by email. Charges your Amazon Web Services account an amount based on the +top-level domain. For more information, see Amazon Route 53 Pricing. # Arguments - `admin_contact`: Provides detailed contact information. For information about the values @@ -1199,17 +1197,15 @@ end transfer_domain(admin_contact, domain_name, duration_in_years, registrant_contact, tech_contact) transfer_domain(admin_contact, domain_name, duration_in_years, registrant_contact, tech_contact, params::Dict{String,<:Any}) -Transfers a domain from another registrar to Amazon Route 53. When the transfer is -complete, the domain is registered either with Amazon Registrar (for .com, .net, and .org -domains) or with our registrar associate, Gandi (for all other TLDs). For more information -about transferring domains, see the following topics: For transfer requirements, a -detailed procedure, and information about viewing the status of a domain that you're -transferring to Route 53, see Transferring Registration for a Domain to Amazon Route 53 in -the Amazon Route 53 Developer Guide. For information about how to transfer a domain from -one Amazon Web Services account to another, see TransferDomainToAnotherAwsAccount. For -information about how to transfer a domain to another domain registrar, see Transferring a -Domain from Amazon Route 53 to Another Registrar in the Amazon Route 53 Developer Guide. -If the registrar for your domain is also the DNS service provider for the domain, we highly +Transfers a domain from another registrar to Amazon Route 53. For more information about +transferring domains, see the following topics: For transfer requirements, a detailed +procedure, and information about viewing the status of a domain that you're transferring to +Route 53, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route +53 Developer Guide. For information about how to transfer a domain from one Amazon Web +Services account to another, see TransferDomainToAnotherAwsAccount. For information +about how to transfer a domain to another domain registrar, see Transferring a Domain from +Amazon Route 53 to Another Registrar in the Amazon Route 53 Developer Guide. If the +registrar for your domain is also the DNS service provider for the domain, we highly recommend that you transfer your DNS service to Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar @@ -1246,10 +1242,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"Nameservers"`: Contains details for the host and glue IP addresses. - `"PrivacyProtectAdminContact"`: Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information - either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar - associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the - information that you entered for the admin contact. You must specify the same privacy - setting for the administrative, registrant, and technical contacts. Default: true + for the registrar, the phrase \"REDACTED FOR PRIVACY\", or \"On behalf of <domain + name> owner.\". While some domains may allow different privacy settings per contact, we + recommend specifying the same privacy setting for all contacts. Default: true - `"PrivacyProtectRegistrantContact"`: Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar @@ -1387,7 +1382,8 @@ domain registrant will be notified by email. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"AdminContact"`: Provides detailed contact information. -- `"Consent"`: Customer's consent for the owner change request. +- `"Consent"`: Customer's consent for the owner change request. Required if the domain is + not free (consent price is more than 0.00). - `"RegistrantContact"`: Provides detailed contact information. - `"TechContact"`: Provides detailed contact information. """ @@ -1421,11 +1417,11 @@ end update_domain_contact_privacy(domain_name, params::Dict{String,<:Any}) This operation updates the specified domain contact's privacy setting. When privacy -protection is enabled, contact information such as email address is replaced either with -contact information for Amazon Registrar (for .com, .net, and .org domains) or with contact -information for our registrar associate, Gandi. You must specify the same privacy setting -for the administrative, registrant, and technical contacts. This operation affects only -the contact information for the specified contact type (administrative, registrant, or +protection is enabled, your contact information is replaced with contact information for +the registrar or with the phrase \"REDACTED FOR PRIVACY\", or \"On behalf of <domain +name> owner.\" While some domains may allow different privacy settings per contact, we +recommend specifying the same privacy setting for all contacts. This operation affects +only the contact information for the specified contact type (administrative, registrant, or technical). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email. By diff --git a/src/services/s3.jl b/src/services/s3.jl index 7336ea8c8d..ca58cec82e 100644 --- a/src/services/s3.jl +++ b/src/services/s3.jl @@ -32,7 +32,7 @@ ListMultipartUploads the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: Key of the object for which the multipart upload was initiated. - `upload_id`: Upload ID that identifies the multipart upload. @@ -127,7 +127,7 @@ ListMultipartUploads the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: Object key for which the multipart upload was initiated. - `upload_id`: ID for the initiated multipart upload. @@ -226,17 +226,17 @@ Region that you specify for the destination object. For pricing information, see pricing. Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration. Metadata When copying an -object, you can preserve all metadata (default) or specify new metadata. However, the ACL -is not preserved and is set to private for the user making the request. To override the -default ACL setting, specify a new ACL when generating a copy request. For more -information, see Using ACLs. To specify whether you want the object metadata copied from -the source object or replaced with metadata provided in the request, you can optionally add -the x-amz-metadata-directive header. When you grant permissions, you can use the -s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects -are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 -User Guide. For a complete list of Amazon S3-specific condition keys, see Actions, -Resources, and Condition Keys for Amazon S3. x-amz-website-redirect-location is unique to -each object and must be specified in the request headers to copy the value. +object, you can preserve all metadata (the default) or specify new metadata. However, the +access control list (ACL) is not preserved and is set to private for the user making the +request. To override the default ACL setting, specify a new ACL when generating a copy +request. For more information, see Using ACLs. To specify whether you want the object +metadata copied from the source object or replaced with metadata provided in the request, +you can optionally add the x-amz-metadata-directive header. When you grant permissions, you +can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior +when objects are uploaded. For more information, see Specifying Conditions in a Policy in +the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition keys, see +Actions, Resources, and Condition Keys for Amazon S3. x-amz-website-redirect-location is +unique to each object and must be specified in the request headers to copy the value. x-amz-copy-source-if Headers To only copy an object under certain conditions, such as whether the Etag matches or whether the object was modified before or after a specified date, use the following request parameters: x-amz-copy-source-if-match @@ -256,51 +256,53 @@ request, the encryption setting of the target object is set to the default encry configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration that uses -server-side encryption with an Key Management Service (KMS) key (SSE-KMS), or a -customer-provided encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a -customer-provided key to encrypt the target object copy. When you perform a CopyObject -operation, if you want to use a different type of encryption setting for the target object, -you can use other appropriate encryption-related headers to encrypt the target object with -a KMS key, an Amazon S3 managed key, or a customer-provided key. With server-side -encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and -decrypts the data when you access it. If the encryption setting in your request is -different from the default encryption configuration of the destination bucket, the -encryption setting in your request takes precedence. If the source object for the copy is -stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in -your request so that Amazon S3 can decrypt the object for copying. For more information +server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer +server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side +encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding +KMS key, or a customer-provided key to encrypt the target object copy. When you perform a +CopyObject operation, if you want to use a different type of encryption setting for the +target object, you can use other appropriate encryption-related headers to encrypt the +target object with a KMS key, an Amazon S3 managed key, or a customer-provided key. With +server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its +data centers and decrypts the data when you access it. If the encryption setting in your +request is different from the default encryption configuration of the destination bucket, +the encryption setting in your request takes precedence. If the source object for the copy +is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information +in your request so that Amazon S3 can decrypt the object for copying. For more information about server-side encryption, see Using Server-Side Encryption. If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide. Access Control List (ACL)-Specific Request Headers When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services -accounts or to predefined groups defined by Amazon S3. These permissions are then added to -the ACL on the object. For more information, see Access Control List (ACL) Overview and -Managing ACLs Using the REST API. If the bucket that you're copying objects to uses the -bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer -affect permissions. Buckets that use this setting only accept PUT requests that don't -specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the -bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML -format. For more information, see Controlling ownership of objects and disabling ACLs in -the Amazon S3 User Guide. If your bucket uses the bucket owner enforced setting for Object -Ownership, all objects written to the bucket by any account will be owned by the bucket -owner. Checksums When copying an object, if it has a checksum, that checksum will be -copied to the new object by default. When you copy the object over, you may optionally +accounts or to predefined groups that are defined by Amazon S3. These permissions are then +added to the ACL on the object. For more information, see Access Control List (ACL) +Overview and Managing ACLs Using the REST API. If the bucket that you're copying objects +to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no +longer affect permissions. Buckets that use this setting only accept PUT requests that +don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as +the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the +XML format. For more information, see Controlling ownership of objects and disabling ACLs +in the Amazon S3 User Guide. If your bucket uses the bucket owner enforced setting for +Object Ownership, all objects written to the bucket by any account will be owned by the +bucket owner. Checksums When copying an object, if it has a checksum, that checksum will +be copied to the new object by default. When you copy the object over, you can optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm header. Storage Class Options You can use the CopyObject action to change the storage class of an -object that is already stored in Amazon S3 using the StorageClass parameter. For more +object that is already stored in Amazon S3 by using the StorageClass parameter. For more information, see Storage Classes in the Amazon S3 User Guide. If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject. For more -information, see Copying Objects. Versioning By default, x-amz-copy-source identifies the -current version of an object to copy. If the current version is a delete marker, Amazon S3 -behaves as if the object was deleted. To copy a different version, use the versionId -subresource. If you enable versioning on the target bucket, Amazon S3 generates a unique -version ID for the object being copied. This version ID is different from the version ID of -the source object. Amazon S3 returns the version ID of the copied object in the -x-amz-version-id response header in the response. If you do not enable versioning or -suspend it on the target bucket, the version ID that Amazon S3 generates is always null. -The following operations are related to CopyObject: PutObject GetObject +information, see Copying Objects. Versioning By default, x-amz-copy-source header +identifies the current version of an object to copy. If the current version is a delete +marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use +the versionId subresource. If you enable versioning on the target bucket, Amazon S3 +generates a unique version ID for the object being copied. This version ID is different +from the version ID of the source object. Amazon S3 returns the version ID of the copied +object in the x-amz-version-id response header in the response. If you do not enable +versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is +always null. The following operations are related to CopyObject: PutObject +GetObject # Arguments - `bucket`: The name of the destination bucket. When using this action with an access @@ -314,7 +316,7 @@ The following operations are related to CopyObject: PutObject GetObject AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts - ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: The key of the destination object. - `x-amz-copy-source`: Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object @@ -395,18 +397,17 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys object's Object Lock to expire. - `"x-amz-request-payer"`: - `"x-amz-server-side-encryption"`: The server-side encryption algorithm used when storing - this object in Amazon S3 (for example, AES256, aws:kms). -- `"x-amz-server-side-encryption-aws-kms-key-id"`: Specifies the Amazon Web Services KMS - key ID to use for object encryption. All GET and PUT requests for an object protected by - Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about - configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web - Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon - S3 User Guide. + this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse). +- `"x-amz-server-side-encryption-aws-kms-key-id"`: Specifies the KMS key ID to use for + object encryption. All GET and PUT requests for an object protected by KMS will fail if + they're not made via SSL or using SigV4. For information about configuring any of the + officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying + the Signature Version in Request Authentication in the Amazon S3 User Guide. - `"x-amz-server-side-encryption-bucket-key-enabled"`: Specifies whether Amazon S3 should - use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS - (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object - encryption with SSE-KMS. Specifying this header with a COPY action doesn’t affect - bucket-level settings for S3 Bucket Key. + use an S3 Bucket Key for object encryption with server-side encryption using Key Management + Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 + Bucket Key for object encryption with SSE-KMS. Specifying this header with a COPY action + doesn’t affect bucket-level settings for S3 Bucket Key. - `"x-amz-server-side-encryption-context"`: Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. @@ -495,44 +496,36 @@ Region. Accordingly, the signature calculations in Signature Version 4 must use as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, -see Virtual hosting of buckets. Access control lists (ACLs) When creating a bucket using -this operation, you can optionally configure the bucket ACL to specify the accounts or -groups that should be granted specific permissions on the bucket. If your CreateBucket -request sets bucket owner enforced for S3 Object Ownership and specifies a bucket ACL that +see Virtual hosting of buckets. Permissions In addition to s3:CreateBucket, the +following permissions are required when your CreateBucket request includes specific +headers: Access control lists (ACLs) - If your CreateBucket request specifies access +control list (ACL) permissions and the ACL is public-read, public-read-write, +authenticated-read, or if you specify access permissions explicitly through any other ACL, +both s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL for the +CreateBucket request is private or if the request doesn't specify any ACLs, only +s3:CreateBucket permission is needed. Object Lock - If ObjectLockEnabledForBucket is +set to true in your CreateBucket request, s3:PutBucketObjectLockConfiguration and +s3:PutBucketVersioning permissions are required. S3 Object Ownership - If your +CreateBucket request includes the x-amz-object-ownership header, then the +s3:PutBucketOwnershipControls permission is required. By default, ObjectOwnership is set to +BucketOWnerEnforced and ACLs are disabled. We recommend keeping ACLs disabled, except in +uncommon use cases where you must control access for each object individually. If you want +to change the ObjectOwnership setting, you can use the x-amz-object-ownership header in +your CreateBucket request to set the ObjectOwnership setting of your choice. For more +information about S3 Object Ownership, see Controlling object ownership in the Amazon S3 +User Guide. S3 Block Public Access - If your specific use case requires granting public +access to your S3 resources, you can disable Block Public Access. You can create a new +bucket with Block Public Access enabled, then separately call the DeletePublicAccessBlock +API. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. By +default, all Block Public Access settings are enabled for new buckets. To avoid inadvertent +exposure of your resources, we recommend keeping the S3 Block Public Access settings +enabled. For more information about S3 Block Public Access, see Blocking public access to +your Amazon S3 storage in the Amazon S3 User Guide. If your CreateBucket request +sets BucketOwnerEnforced for Amazon S3 Object Ownership and specifies a bucket ACL that provides access to an external Amazon Web Services account, your request fails with a 400 -error and returns the InvalidBucketAclWithObjectOwnership error code. For more information, -see Controlling object ownership in the Amazon S3 User Guide. There are two ways to grant -the appropriate permissions using the request headers. Specify a canned ACL using the -x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned -ACLs. Each canned ACL has a predefined set of grantees and permissions. For more -information, see Canned ACL. Specify access permissions explicitly using the -x-amz-grant-read, x-amz-grant-write, x-amz-grant-read-acp, x-amz-grant-write-acp, and -x-amz-grant-full-control headers. These headers map to the set of permissions Amazon S3 -supports in an ACL. For more information, see Access control list (ACL) overview. You -specify each grantee as a type=value pair, where the type is one of the following: id -– if the value specified is the canonical user ID of an Amazon Web Services account -uri – if you are granting permissions to a predefined group emailAddress – if the -value specified is the email address of an Amazon Web Services account Using email -addresses to specify a grantee is only supported in the following Amazon Web Services -Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia -Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland) -South America (São Paulo) For a list of all the Amazon S3 supported Regions and -endpoints, see Regions and Endpoints in the Amazon Web Services General Reference. For -example, the following x-amz-grant-read header grants the Amazon Web Services accounts -identified by account IDs permissions to read object data and its metadata: -x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" You can use either a canned -ACL or specify access permissions explicitly. You cannot do both. Permissions In -addition to s3:CreateBucket, the following permissions are required when your CreateBucket -includes specific headers: ACLs - If your CreateBucket request specifies ACL permissions -and the ACL is public-read, public-read-write, authenticated-read, or if you specify access -permissions explicitly through any other ACL, both s3:CreateBucket and s3:PutBucketAcl -permissions are needed. If the ACL the CreateBucket request is private or doesn't specify -any ACLs, only s3:CreateBucket permission is needed. Object Lock - If -ObjectLockEnabledForBucket is set to true in your CreateBucket request, -s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required. -S3 Object Ownership - If your CreateBucket request includes the x-amz-object-ownership -header, s3:PutBucketOwnershipControls permission is required. The following operations -are related to CreateBucket: PutObject DeleteBucket +error and returns the InvalidBucketAcLWithObjectOwnership error code. For more information, +see Setting Object Ownership on an existing bucket in the Amazon S3 User Guide. The +following operations are related to CreateBucket: PutObject DeleteBucket # Arguments - `bucket`: The name of the bucket to create. @@ -691,7 +684,7 @@ AbortMultipartUpload ListParts ListMultipartUploads the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: Object key for which the multipart upload is to be initiated. # Optional Parameters @@ -732,15 +725,15 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys this object in Amazon S3 (for example, AES256, aws:kms). - `"x-amz-server-side-encryption-aws-kms-key-id"`: Specifies the ID of the symmetric encryption customer managed key to use for object encryption. All GET and PUT requests for - an object protected by Amazon Web Services KMS will fail if not made via SSL or using - SigV4. For information about configuring using any of the officially supported Amazon Web - Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request - Authentication in the Amazon S3 User Guide. + an object protected by KMS will fail if they're not made via SSL or using SigV4. For + information about configuring any of the officially supported Amazon Web Services SDKs and + Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in + the Amazon S3 User Guide. - `"x-amz-server-side-encryption-bucket-key-enabled"`: Specifies whether Amazon S3 should - use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS - (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object - encryption with SSE-KMS. Specifying this header with an object action doesn’t affect - bucket-level settings for S3 Bucket Key. + use an S3 Bucket Key for object encryption with server-side encryption using Key Management + Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 + Bucket Key for object encryption with SSE-KMS. Specifying this header with an object action + doesn’t affect bucket-level settings for S3 Bucket Key. - `"x-amz-server-side-encryption-context"`: Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. @@ -881,8 +874,8 @@ end Deletes the cors configuration information set for the bucket. To use this operation, you must have permission to perform the s3:PutBucketCORS action. The bucket owner has this permission by default and can grant this permission to others. For information about cors, -see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide. The following -operations are related to DeleteBucketCors: PutBucketCors RESTOPTIONSobject +see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide. Related Resources + PutBucketCors RESTOPTIONSobject # Arguments - `bucket`: Specifies the bucket whose cors configuration is being deleted. @@ -1402,7 +1395,7 @@ related to DeleteObject: PutObject the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: Key name of the object to delete. # Optional Parameters @@ -1465,7 +1458,7 @@ DeleteObjectTagging: PutObjectTagging GetObjectTagging the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: The key that identifies the object in the bucket from which to remove all tags. # Optional Parameters @@ -1539,7 +1532,7 @@ ListParts AbortMultipartUpload AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts - ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `delete`: Container for the request. # Optional Parameters @@ -1657,6 +1650,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied). +- `"x-amz-request-payer"`: """ function get_bucket_accelerate_configuration( Bucket; aws_config::AbstractAWSConfig=global_aws_config() @@ -2662,58 +2656,60 @@ the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification. For more information about returning the ACL of an object, see GetObjectAcl. If the object you are retrieving is stored in the S3 Glacier -or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 -Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first -restore a copy using RestoreObject. Otherwise, this action returns an InvalidObjectState -error. For information about restoring archived objects, see Restoring Archived Objects. -Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET -requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side -encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these -types of keys, you’ll get an HTTP 400 BadRequest error. If you encrypt an object by using -server-side encryption with customer-provided encryption keys (SSE-C) when you store the -object in Amazon S3, then when you GET the object, you must use the following headers: -x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key - x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see -Server-Side Encryption (Using Customer-Provided Encryption Keys). Assuming you have the -relevant permission to read object tags, the response also returns the x-amz-tagging-count -header that provides the count of number of tags associated with the object. You can use -GetObjectTagging to retrieve the tag set associated with an object. Permissions You need -the relevant read object (or version) permission for this operation. For more information, -see Specifying Permissions in a Policy. If the object you request does not exist, the error -Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you -have the s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status code -404 (\"no such key\") error. If you don’t have the s3:ListBucket permission, Amazon S3 -will return an HTTP status code 403 (\"access denied\") error. Versioning By default, -the GET action returns the current version of an object. To return a different version, use -the versionId subresource. If you supply a versionId, you need the s3:GetObjectVersion -permission to access a specific version of an object. If you request a specific version, -you do not need to have the s3:GetObject permission. If you request the current version -without a specific version ID, only s3:GetObject permission is required. -s3:GetObjectVersion permission won't be required. If the current version of the object is -a delete marker, Amazon S3 behaves as if the object was deleted and includes -x-amz-delete-marker: true in the response. For more information about versioning, see -PutBucketVersioning. Overriding Response Header Values There are times when you want to -override certain response header values in a GET response. For example, you might override -the Content-Disposition response header value in your GET request. You can override values -for a set of response headers using the following query parameters. These response header -values are sent only on a successful request, that is, when status code 200 OK is returned. -The set of headers you can override using these parameters is a subset of the headers that -Amazon S3 accepts when you create an object. The response headers that you can override for -the GET response are Content-Type, Content-Language, Expires, Cache-Control, -Content-Disposition, and Content-Encoding. To override these header values in the GET -response, you use the following request parameters. You must sign the request, either -using an Authorization header or a presigned URL, when using these parameters. They cannot -be used with an unsigned (anonymous) request. response-content-type -response-content-language response-expires response-cache-control -response-content-disposition response-content-encoding Overriding Response Header -Values If both of the If-Match and If-Unmodified-Since headers are present in the request -as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition -evaluates to false; then, S3 returns 200 OK and the data requested. If both of the -If-None-Match and If-Modified-Since headers are present in the request as follows: -If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to -true; then, S3 returns 304 Not Modified response code. For more information about -conditional requests, see RFC 7232. The following operations are related to GetObject: -ListBuckets GetObjectAcl +Flexible Retrieval or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering +Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object +you must first restore a copy using RestoreObject. Otherwise, this action returns an +InvalidObjectState error. For information about restoring archived objects, see Restoring +Archived Objects. Encryption request headers, like x-amz-server-side-encryption, should not +be sent for GET requests if your object uses server-side encryption with Key Management +Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services +KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys +(SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 Bad Request +error. If you encrypt an object by using server-side encryption with customer-provided +encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the +object, you must use the following headers: +x-amz-server-side-encryption-customer-algorithm +x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 + For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided +Encryption Keys). Assuming you have the relevant permission to read object tags, the +response also returns the x-amz-tagging-count header that provides the count of number of +tags associated with the object. You can use GetObjectTagging to retrieve the tag set +associated with an object. Permissions You need the relevant read object (or version) +permission for this operation. For more information, see Specifying Permissions in a +Policy. If the object that you request doesn’t exist, the error that Amazon S3 returns +depends on whether you also have the s3:ListBucket permission. If you have the +s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 (Not +Found) error. If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP +status code 403 (\"access denied\") error. Versioning By default, the GET action returns +the current version of an object. To return a different version, use the versionId +subresource. If you supply a versionId, you need the s3:GetObjectVersion permission to +access a specific version of an object. If you request a specific version, you do not need +to have the s3:GetObject permission. If you request the current version without a specific +version ID, only s3:GetObject permission is required. s3:GetObjectVersion permission won't +be required. If the current version of the object is a delete marker, Amazon S3 behaves +as if the object was deleted and includes x-amz-delete-marker: true in the response. For +more information about versioning, see PutBucketVersioning. Overriding Response Header +Values There are times when you want to override certain response header values in a GET +response. For example, you might override the Content-Disposition response header value in +your GET request. You can override values for a set of response headers using the following +query parameters. These response header values are sent only on a successful request, that +is, when status code 200 OK is returned. The set of headers you can override using these +parameters is a subset of the headers that Amazon S3 accepts when you create an object. The +response headers that you can override for the GET response are Content-Type, +Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To +override these header values in the GET response, you use the following request parameters. + You must sign the request, either using an Authorization header or a presigned URL, when +using these parameters. They cannot be used with an unsigned (anonymous) request. +response-content-type response-content-language response-expires +response-cache-control response-content-disposition response-content-encoding +Overriding Response Header Values If both of the If-Match and If-Unmodified-Since headers +are present in the request as follows: If-Match condition evaluates to true, and; +If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data +requested. If both of the If-None-Match and If-Modified-Since headers are present in the +request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since +condition evaluates to true; then, S3 returns 304 Not Modified response code. For more +information about conditional requests, see RFC 7232. The following operations are +related to GetObject: ListBuckets GetObjectAcl # Arguments - `bucket`: The bucket name containing the object. When using this action with an access @@ -2729,7 +2725,7 @@ ListBuckets GetObjectAcl AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts - ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: Key of the object to get. # Optional Parameters @@ -2901,10 +2897,10 @@ GetObjectTagging HeadObject ListParts AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts - ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: The object key. -- `x-amz-object-attributes`: An XML header that specifies the fields at the root level that - you want returned in the response. Fields that you do not specify are not returned. +- `x-amz-object-attributes`: Specifies the fields at the root level that you want returned + in the response. Fields that you do not specify are not returned. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -3142,7 +3138,7 @@ to GetObjectTagging: DeleteObjectTagging GetObjectAttributes PutObjec the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: Object key for which to get the tagging information. # Optional Parameters @@ -3307,7 +3303,7 @@ InvalidAccessPointAliasError, see List of Error Codes. AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts - ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -3339,30 +3335,31 @@ Request, 403 Forbidden or 404 Not Found code. It is not possible to retrieve the exception beyond these error codes. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following -headers: x-amz-server-side-encryption-customer-algorithm -x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 -For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided +headers: x-amz-server-side-encryption-customer-algorithm +x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 + For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Encryption request headers, like x-amz-server-side-encryption, should -not be sent for GET requests if your object uses server-side encryption with KMS keys -(SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If -your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. The -last modified property in this case is the creation date of the object. Request headers -are limited to 8 KB in size. For more information, see Common Request Headers. Consider the -following when using request headers: Consideration 1 – If both of the If-Match and -If-Unmodified-Since headers are present in the request as follows: If-Match condition -evaluates to true, and; If-Unmodified-Since condition evaluates to false; Then Amazon -S3 returns 200 OK and the data requested. Consideration 2 – If both of the -If-None-Match and If-Modified-Since headers are present in the request as follows: -If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates -to true; Then Amazon S3 returns the 304 Not Modified response code. For more +not be sent for GET requests if your object uses server-side encryption with Key Management +Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services +KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys +(SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 Bad Request +error. The last modified property in this case is the creation date of the object. +Request headers are limited to 8 KB in size. For more information, see Common Request +Headers. Consider the following when using request headers: Consideration 1 – If both +of the If-Match and If-Unmodified-Since headers are present in the request as follows: +If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to +false; Then Amazon S3 returns 200 OK and the data requested. Consideration 2 – If +both of the If-None-Match and If-Modified-Since headers are present in the request as +follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition +evaluates to true; Then Amazon S3 returns the 304 Not Modified response code. For more information about conditional requests, see RFC 7232. Permissions You need the relevant read object (or version) permission for this operation. For more information, see Actions, -resources, and condition keys for Amazon S3. If the object you request does not exist, the -error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If -you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code -404 (\"no such key\") error. If you don’t have the s3:ListBucket permission, Amazon S3 -returns an HTTP status code 403 (\"access denied\") error. The following actions are -related to HeadObject: GetObject GetObjectAttributes +resources, and condition keys for Amazon S3. If the object you request doesn't exist, the +error that Amazon S3 returns depends on whether you also have the s3:ListBucket permission. + If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status +code 404 error. If you don’t have the s3:ListBucket permission, Amazon S3 returns an +HTTP status code 403 error. The following actions are related to HeadObject: +GetObject GetObjectAttributes # Arguments - `bucket`: The name of the bucket containing the object. When using this action with an @@ -3376,7 +3373,7 @@ related to HeadObject: GetObject GetObjectAttributes AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts - ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: The object key. # Optional Parameters @@ -3698,7 +3695,7 @@ UploadPart CompleteMultipartUpload ListParts AbortMultipartUpload the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -3719,7 +3716,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys response. - `"prefix"`: Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can - think of using prefix to make groups in the same way you'd use a folder in a file system.) + think of using prefix to make groups in the same way that you'd use a folder in a file + system.) - `"upload-id-marker"`: Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be @@ -3728,6 +3726,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied). +- `"x-amz-request-payer"`: """ function list_multipart_uploads(Bucket; aws_config::AbstractAWSConfig=global_aws_config()) return s3( @@ -3752,7 +3751,7 @@ end Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object -versions. To use this operation, you must have permissions to perform the +versions. To use this operation, you must have permission to perform the s3:ListBucketVersions action. Be aware of the name difference. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. To use this operation, you must have READ access @@ -3772,20 +3771,23 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys response. - `"encoding-type"`: - `"key-marker"`: Specifies the key to start with when listing objects in a bucket. -- `"max-keys"`: Sets the maximum number of keys returned in the response. By default the +- `"max-keys"`: Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker. - `"prefix"`: Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You - can think of using prefix to make groups in the same way you'd use a folder in a file + can think of using prefix to make groups in the same way that you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. - `"version-id-marker"`: Specifies the object version you want to start listing from. - `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied). +- `"x-amz-optional-object-attributes"`: Specifies the optional fields that you want + returned in the response. Fields that you do not specify are not returned. +- `"x-amz-request-payer"`: """ function list_object_versions(Bucket; aws_config::AbstractAWSConfig=global_aws_config()) return s3( @@ -3829,21 +3831,23 @@ CreateBucket ListBuckets AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts - ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"delimiter"`: A delimiter is a character you use to group keys. +- `"delimiter"`: A delimiter is a character that you use to group keys. - `"encoding-type"`: - `"marker"`: Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket. -- `"max-keys"`: Sets the maximum number of keys returned in the response. By default the +- `"max-keys"`: Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. - `"prefix"`: Limits the response to keys that begin with the specified prefix. - `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied). +- `"x-amz-optional-object-attributes"`: Specifies the optional fields that you want + returned in the response. Fields that you do not specify are not returned. - `"x-amz-request-payer"`: Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests. @@ -3868,16 +3872,17 @@ the request parameters as selection criteria to return a subset of the objects i A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. Objects are returned sorted in an ascending order of the respective key names in the list. For more information about -listing objects, see Listing object keys programmatically To use this operation, you must -have READ access to the bucket. To use this action in an Identity and Access Management -(IAM) policy, you must have permissions to perform the s3:ListBucket action. The bucket -owner has this permission by default and can grant this permission to others. For more -information about permissions, see Permissions Related to Bucket Subresource Operations and -Managing Access Permissions to Your Amazon S3 Resources. This section describes the latest -revision of this action. We recommend that you use this revised API for application -development. For backward compatibility, Amazon S3 continues to support the prior version -of this API, ListObjects. To get a list of your buckets, see ListBuckets. The following -operations are related to ListObjectsV2: GetObject PutObject CreateBucket +listing objects, see Listing object keys programmatically in the Amazon S3 User Guide. To +use this operation, you must have READ access to the bucket. To use this action in an +Identity and Access Management (IAM) policy, you must have permission to perform the +s3:ListBucket action. The bucket owner has this permission by default and can grant this +permission to others. For more information about permissions, see Permissions Related to +Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources +in the Amazon S3 User Guide. This section describes the latest revision of this action. We +recommend that you use this revised API operation for application development. For backward +compatibility, Amazon S3 continues to support the prior version of this API operation, +ListObjects. To get a list of your buckets, see ListBuckets. The following operations are +related to ListObjectsV2: GetObject PutObject CreateBucket # Arguments - `bucket`: Bucket name to list. When using this action with an access point, you must @@ -3890,18 +3895,19 @@ operations are related to ListObjectsV2: GetObject PutObject CreateBu the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"continuation-token"`: ContinuationToken indicates Amazon S3 that the list is being +- `"continuation-token"`: ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. -- `"delimiter"`: A delimiter is a character you use to group keys. +- `"delimiter"`: A delimiter is a character that you use to group keys. - `"encoding-type"`: Encoding type used by Amazon S3 to encode object keys in the response. -- `"fetch-owner"`: The owner field is not present in listV2 by default, if you want to - return owner field with each key in the result then set the fetch owner field to true. -- `"max-keys"`: Sets the maximum number of keys returned in the response. By default the +- `"fetch-owner"`: The owner field is not present in ListObjectsV2 by default. If you want + to return the owner field with each key in the result, then set the FetchOwner field to + true. +- `"max-keys"`: Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. - `"prefix"`: Limits the response to keys that begin with the specified prefix. @@ -3910,6 +3916,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied). +- `"x-amz-optional-object-attributes"`: Specifies the optional fields that you want + returned in the response. Fields that you do not specify are not returned. - `"x-amz-request-payer"`: Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests. @@ -3966,7 +3974,7 @@ AbortMultipartUpload GetObjectAttributes ListMultipartUploads the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: Object key for which the multipart upload was initiated. - `upload_id`: Upload ID identifying the multipart upload whose parts are being listed. @@ -4108,12 +4116,12 @@ longer affect permissions. You must use policies to grant access to your bucket objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide. -Permissions You can set access permissions using one of the following methods: Specify a -canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, -known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. -Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot -use other access control-specific headers in your request. For more information, see Canned -ACL. Specify access permissions explicitly with the x-amz-grant-read, +Permissions You can set access permissions by using one of the following methods: +Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of +predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and +permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, +you cannot use other access control-specific headers in your request. For more information, +see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these @@ -4367,18 +4375,20 @@ This action uses the encryption subresource to configure default encryption and Bucket Keys for an existing bucket. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default encryption for a bucket by using server-side encryption -with an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). If you -specify default encryption by using SSE-KMS, you can also configure Amazon S3 Bucket Keys. -For information about bucket default encryption, see Amazon S3 bucket default encryption in -the Amazon S3 User Guide. For more information about S3 Bucket Keys, see Amazon S3 Bucket -Keys in the Amazon S3 User Guide. This action requires Amazon Web Services Signature -Version 4. For more information, see Authenticating Requests (Amazon Web Services -Signature Version 4). To use this operation, you must have permissions to perform the -s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The -bucket owner can grant this permission to others. For more information about permissions, -see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to -Your Amazon S3 Resources in the Amazon S3 User Guide. The following operations are related -to PutBucketEncryption: GetBucketEncryption DeleteBucketEncryption +with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with +Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with customer-provided +keys (SSE-C). If you specify default encryption by using SSE-KMS, you can also configure +Amazon S3 Bucket Keys. For information about bucket default encryption, see Amazon S3 +bucket default encryption in the Amazon S3 User Guide. For more information about S3 Bucket +Keys, see Amazon S3 Bucket Keys in the Amazon S3 User Guide. This action requires Amazon +Web Services Signature Version 4. For more information, see Authenticating Requests +(Amazon Web Services Signature Version 4). To use this operation, you must have +permission to perform the s3:PutEncryptionConfiguration action. The bucket owner has this +permission by default. The bucket owner can grant this permission to others. For more +information about permissions, see Permissions Related to Bucket Subresource Operations and +Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. The +following operations are related to PutBucketEncryption: GetBucketEncryption +DeleteBucketEncryption # Arguments - `bucket`: Specifies default encryption for a bucket using server-side encryption with @@ -4690,23 +4700,23 @@ backward compatibility. For the related API description, see PutBucketLifecycle. You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the -following: Filter identifying a subset of objects to which the rule applies. The filter -can be based on a key name prefix, object tags, or a combination of both. Status whether -the rule is in effect. One or more lifecycle transition and expiration actions that you -want Amazon S3 to perform on the objects identified by the filter. If the state of your -bucket is versioning-enabled or versioning-suspended, you can have many versions of the -same object (one current version and zero or more noncurrent versions). Amazon S3 provides -predefined actions that you can specify for current and noncurrent object versions. For -more information, see Object Lifecycle Management and Lifecycle Configuration Elements. -Permissions By default, all Amazon S3 resources are private, including buckets, objects, -and related subresources (for example, lifecycle configuration and website configuration). -Only the resource owner (that is, the Amazon Web Services account that created it) can -access the resource. The resource owner can optionally grant access permissions to others -by writing an access policy. For this operation, a user must get the -s3:PutLifecycleConfiguration permission. You can also explicitly deny permissions. Explicit -deny also supersedes any other permissions. If you want to block users or accounts from -removing or deleting objects from your bucket, you must deny them permissions for the -following actions: s3:DeleteObject s3:DeleteObjectVersion +following: A filter identifying a subset of objects to which the rule applies. The filter +can be based on a key name prefix, object tags, or a combination of both. A status +indicating whether the rule is in effect. One or more lifecycle transition and expiration +actions that you want Amazon S3 to perform on the objects identified by the filter. If the +state of your bucket is versioning-enabled or versioning-suspended, you can have many +versions of the same object (one current version and zero or more noncurrent versions). +Amazon S3 provides predefined actions that you can specify for current and noncurrent +object versions. For more information, see Object Lifecycle Management and Lifecycle +Configuration Elements. Permissions By default, all Amazon S3 resources are private, +including buckets, objects, and related subresources (for example, lifecycle configuration +and website configuration). Only the resource owner (that is, the Amazon Web Services +account that created it) can access the resource. The resource owner can optionally grant +access permissions to others by writing an access policy. For this operation, a user must +get the s3:PutLifecycleConfiguration permission. You can also explicitly deny permissions. +An explicit deny also supersedes any other permissions. If you want to block users or +accounts from removing or deleting objects from your bucket, you must deny them permissions +for the following actions: s3:DeleteObject s3:DeleteObjectVersion s3:PutLifecycleConfiguration For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources. The following operations are related to PutBucketLifecycleConfiguration: Examples of Lifecycle Configuration @@ -4766,15 +4776,15 @@ log delivery uses the bucket owner enforced setting for S3 Object Ownership, you the Grantee request element to grant access to others. Permissions can only be granted using policies. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide. Grantee Values You can specify the person (grantee) to whom you're -assigning access rights (using request elements) in the following ways: By the person's -ID: <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" +assigning access rights (by using request elements) in the following ways: By the +person's ID: <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName>< -;>GranteesEmail<></DisplayName> </Grantee> DisplayName is optional +;>GranteesEmail<></DisplayName> </Grantee> DisplayName is optional and ignored in the request. By Email address: <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<> ;</EmailAddress></Grantee> The grantee is resolved to the CanonicalUser and, -in a response to a GET Object acl request, appears as the CanonicalUser. By URI: +in a response to a GETObjectAcl request, appears as the CanonicalUser. By URI: <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/Authenticate dUsers<></URI></Grantee> To enable logging, you use LoggingEnabled @@ -4853,10 +4863,10 @@ Subresource Operations and Managing Access Permissions to Your Amazon S3 Resourc information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch. The following operations are related to PutBucketMetricsConfiguration: DeleteBucketMetricsConfiguration GetBucketMetricsConfiguration -ListBucketMetricsConfigurations GetBucketLifecycle has the following special error: -Error code: TooManyConfigurations Description: You are attempting to create a new -configuration but have already reached the 1,000-configuration limit. HTTP Status Code: -HTTP 400 Bad Request +ListBucketMetricsConfigurations PutBucketMetricsConfiguration has the following special +error: Error code: TooManyConfigurations Description: You are attempting to create a +new configuration but have already reached the 1,000-configuration limit. HTTP Status +Code: HTTP 400 Bad Request # Arguments - `bucket`: The name of the bucket for which the metrics configuration is set. @@ -4986,11 +4996,11 @@ disable notifications by adding the empty NotificationConfiguration element. For information about the number of event notification configurations that you can create per bucket, see Amazon S3 service quotas in Amazon Web Services General Reference. By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can -use a bucket policy to grant permission to other users to set this configuration with -s3:PutBucketNotification permission. The PUT notification is an atomic operation. For -example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda -function configurations. When you send a PUT request with this configuration, Amazon S3 -sends test messages to your SNS topic. If the message fails, the entire PUT action will +use a bucket policy to grant permission to other users to set this configuration with the +required s3:PutBucketNotification permission. The PUT notification is an atomic operation. +For example, suppose your notification configuration includes SNS topic, SQS queue, and +Lambda function configurations. When you send a PUT request with this configuration, Amazon +S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket. If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the @@ -5577,24 +5587,24 @@ successfully set the tag-set with your PutObject request, you must have the s3:PutObjectTagging in your IAM permissions. The Content-MD5 header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the -Amazon S3 User Guide. You have three mutually exclusive options to protect data using +Amazon S3 User Guide. You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon -Web Services KMS keys (SSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts -data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You -can optionally tell Amazon S3 to encrypt data at by rest using server-side encryption with -other key options. For more information, see Using Server-Side Encryption. When adding a -new object, you can use headers to grant ACL-based permissions to individual Amazon Web -Services accounts or to predefined groups defined by Amazon S3. These permissions are then -added to the ACL on the object. By default, all objects are private. Only the owner has -full access control. For more information, see Access Control List (ACL) Overview and -Managing ACLs Using the REST API. If the bucket that you're uploading objects to uses the -bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer -affect permissions. Buckets that use this setting only accept PUT requests that don't -specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the -bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML -format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon -Web Services accounts) fail and return a 400 error with the error code +Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 +encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by +default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side +encryption with other key options. For more information, see Using Server-Side Encryption. +When adding a new object, you can use headers to grant ACL-based permissions to individual +Amazon Web Services accounts or to predefined groups defined by Amazon S3. These +permissions are then added to the ACL on the object. By default, all objects are private. +Only the owner has full access control. For more information, see Access Control List (ACL) +Overview and Managing ACLs Using the REST API. If the bucket that you're uploading objects +to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no +longer affect permissions. Buckets that use this setting only accept PUT requests that +don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as +the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the +XML format. PUT requests that contain other ACLs (for example, custom grants to certain +Amazon Web Services accounts) fail and return a 400 error with the error code AccessControlListNotSupported. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide. If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account @@ -5623,7 +5633,7 @@ GetBucketVersioning. For more information about related Amazon S3 APIs, see the the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: Object key for which the PUT action was initiated. # Optional Parameters @@ -5695,19 +5705,20 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys User Guide. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter. - `"x-amz-server-side-encryption"`: The server-side encryption algorithm used when storing - this object in Amazon S3 (for example, AES256, aws:kms). + this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse). - `"x-amz-server-side-encryption-aws-kms-key-id"`: If x-amz-server-side-encryption has a - valid value of aws:kms, this header specifies the ID of the Amazon Web Services Key - Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that - was used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not - provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services - managed key to protect the data. If the KMS key does not exist in the same account issuing - the command, you must use the full ARN and not just the ID. + valid value of aws:kms or aws:kms:dsse, this header specifies the ID of the Key Management + Service (KMS) symmetric encryption customer managed key that was used for the object. If + you specify x-amz-server-side-encryption:aws:kms or + x-amz-server-side-encryption:aws:kms:dsse, but do not provide + x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed + key (aws/s3) to protect the data. If the KMS key does not exist in the same account that's + issuing the command, you must use the full ARN and not just the ID. - `"x-amz-server-side-encryption-bucket-key-enabled"`: Specifies whether Amazon S3 should - use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS - (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object - encryption with SSE-KMS. Specifying this header with a PUT action doesn’t affect - bucket-level settings for S3 Bucket Key. + use an S3 Bucket Key for object encryption with server-side encryption using Key Management + Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 + Bucket Key for object encryption with SSE-KMS. Specifying this header with a PUT action + doesn’t affect bucket-level settings for S3 Bucket Key. - `"x-amz-server-side-encryption-context"`: Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This @@ -5843,7 +5854,7 @@ CopyObject GetObject AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts - ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -6126,7 +6137,7 @@ PutObjectTagging: GetObjectTagging DeleteObjectTagging AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts - ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: Name of the object key. - `tagging`: Container for the TagSet and Tag elements @@ -6286,67 +6297,67 @@ operation, you must have permissions to perform the s3:RestoreObject action. The owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. -Restoring objects Objects that you archive to the S3 Glacier Flexible Retrieval or S3 -Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 -Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the -S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes, you must first -initiate a restore request, and then wait until a temporary copy of the object is -available. If you want a permanent copy of the object, create a copy of it in the Amazon S3 -Standard storage class in your S3 bucket. To access an archived object, you must restore -the object for the duration (number of days) that you specify. For objects in the Archive -Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first initiate a -restore request, and then wait until the object is moved into the Frequent Access tier. To -restore a specific object version, you can provide a version ID. If you don't provide a -version ID, Amazon S3 restores the current version. When restoring an archived object, you -can specify one of the following data access tier options in the Tier element of the -request body: Expedited - Expedited retrievals allow you to quickly access your data -stored in the S3 Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive -tier when occasional urgent requests for restoring archives are required. For all but the -largest archived objects (250 MB+), data accessed using Expedited retrievals is typically -made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity -for Expedited retrievals is available when you need it. Expedited retrievals and -provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive -storage class or S3 Intelligent-Tiering Deep Archive tier. Standard - Standard -retrievals allow you to access any of your archived objects within several hours. This is -the default option for retrieval requests that do not specify the retrieval option. -Standard retrievals typically finish within 3–5 hours for objects stored in the S3 -Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. They -typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage -class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects -stored in S3 Intelligent-Tiering. Bulk - Bulk retrievals free for objects stored in the -S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to -retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically -finish within 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval storage -class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost -retrieval option when restoring objects from S3 Glacier Deep Archive. They typically finish -within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 -Intelligent-Tiering Deep Archive tier. For more information about archive retrieval -options and provisioned capacity for Expedited data access, see Restoring Archived Objects -in the Amazon S3 User Guide. You can use Amazon S3 restore speed upgrade to change the -restore speed to a faster speed while it is in progress. For more information, see -Upgrading the speed of an in-progress restore in the Amazon S3 User Guide. To get the -status of object restoration, you can send a HEAD request. Operations return the -x-amz-restore header, which provides information about the restoration status, in the -response. You can use Amazon S3 event notifications to notify you when a restore is -initiated or completed. For more information, see Configuring Amazon S3 Event Notifications -in the Amazon S3 User Guide. After restoring an archived object, you can update the -restoration period by reissuing the request with a new period. Amazon S3 updates the -restoration period relative to the current time and charges only for the request-there are -no data transfer charges. You cannot update the restoration period when Amazon S3 is -actively processing your current restore request for the object. If your bucket has a -lifecycle configuration with a rule that includes an expiration action, the object -expiration overrides the life span that you specify in a restore request. For example, if -you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, -Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, -see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon S3 User -Guide. Responses A successful action returns either the 200 OK or 202 Accepted status -code. If the object is not previously restored, then Amazon S3 returns 202 Accepted in -the response. If the object is previously restored, Amazon S3 returns 200 OK in the -response. Special errors: Code: RestoreAlreadyInProgress Cause: Object restore -is already in progress. (This error does not apply to SELECT type requests.) HTTP -Status Code: 409 Conflict SOAP Fault Code Prefix: Client Code: -GlacierExpeditedRetrievalNotAvailable Cause: expedited retrievals are currently not -available. Try again later. (Returned if there is insufficient capacity to process the +Restoring objects Objects that you archive to the S3 Glacier Flexible Retrieval Flexible +Retrieval or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or +S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in +the S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage +classes, you must first initiate a restore request, and then wait until a temporary copy of +the object is available. If you want a permanent copy of the object, create a copy of it in +the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you +must restore the object for the duration (number of days) that you specify. For objects in +the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first +initiate a restore request, and then wait until the object is moved into the Frequent +Access tier. To restore a specific object version, you can provide a version ID. If you +don't provide a version ID, Amazon S3 restores the current version. When restoring an +archived object, you can specify one of the following data access tier options in the Tier +element of the request body: Expedited - Expedited retrievals allow you to quickly +access your data stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage +class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for restoring +archives are required. For all but the largest archived objects (250 MB+), data accessed +using Expedited retrievals is typically made available within 1–5 minutes. Provisioned +capacity ensures that retrieval capacity for Expedited retrievals is available when you +need it. Expedited retrievals and provisioned capacity are not available for objects stored +in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. + Standard - Standard retrievals allow you to access any of your archived objects within +several hours. This is the default option for retrieval requests that do not specify the +retrieval option. Standard retrievals typically finish within 3–5 hours for objects +stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 +Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored +in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. +Standard retrievals are free for objects stored in S3 Intelligent-Tiering. Bulk - Bulk +retrievals free for objects stored in the S3 Glacier Flexible Retrieval and S3 +Intelligent-Tiering storage classes, enabling you to retrieve large amounts, even +petabytes, of data at no cost. Bulk retrievals typically finish within 5–12 hours for +objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 +Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost retrieval option +when restoring objects from S3 Glacier Deep Archive. They typically finish within 48 hours +for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering +Deep Archive tier. For more information about archive retrieval options and provisioned +capacity for Expedited data access, see Restoring Archived Objects in the Amazon S3 User +Guide. You can use Amazon S3 restore speed upgrade to change the restore speed to a faster +speed while it is in progress. For more information, see Upgrading the speed of an +in-progress restore in the Amazon S3 User Guide. To get the status of object restoration, +you can send a HEAD request. Operations return the x-amz-restore header, which provides +information about the restoration status, in the response. You can use Amazon S3 event +notifications to notify you when a restore is initiated or completed. For more information, +see Configuring Amazon S3 Event Notifications in the Amazon S3 User Guide. After restoring +an archived object, you can update the restoration period by reissuing the request with a +new period. Amazon S3 updates the restoration period relative to the current time and +charges only for the request-there are no data transfer charges. You cannot update the +restoration period when Amazon S3 is actively processing your current restore request for +the object. If your bucket has a lifecycle configuration with a rule that includes an +expiration action, the object expiration overrides the life span that you specify in a +restore request. For example, if you restore an object copy for 10 days, but the object is +scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information +about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle +Management in Amazon S3 User Guide. Responses A successful action returns either the 200 +OK or 202 Accepted status code. If the object is not previously restored, then Amazon S3 +returns 202 Accepted in the response. If the object is previously restored, Amazon S3 +returns 200 OK in the response. Special errors: Code: RestoreAlreadyInProgress +Cause: Object restore is already in progress. (This error does not apply to SELECT type +requests.) HTTP Status Code: 409 Conflict SOAP Fault Code Prefix: Client +Code: GlacierExpeditedRetrievalNotAvailable Cause: expedited retrievals are currently +not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.) HTTP Status Code: 503 SOAP Fault Code Prefix: N/A The following operations are related to RestoreObject: PutBucketLifecycleConfiguration @@ -6364,7 +6375,7 @@ GetBucketNotificationConfiguration AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts - ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: Object key for which the action was initiated. # Optional Parameters @@ -6442,12 +6453,15 @@ information, see Appendix: SelectObjectContent Response. GetObject Support The SelectObjectContent action does not support the following GetObject functionality. For more information, see GetObject. Range: Although you can specify a scan range for an Amazon S3 Select request (see SelectObjectContentRequest - ScanRange in the request parameters), -you cannot specify the range of bytes of an object to return. GLACIER, DEEP_ARCHIVE and -REDUCED_REDUNDANCY storage classes: You cannot specify the GLACIER, DEEP_ARCHIVE, or -REDUCED_REDUNDANCY storage classes. For more information, about storage classes see Storage -Classes in the Amazon S3 User Guide. Special Errors For a list of special errors for -this operation, see List of SELECT Object Content Error Codes The following operations -are related to SelectObjectContent: GetObject GetBucketLifecycleConfiguration +you cannot specify the range of bytes of an object to return. The GLACIER, DEEP_ARCHIVE, +and REDUCED_REDUNDANCY storage classes, or the ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS +access tiers of the INTELLIGENT_TIERING storage class: You cannot query objects in the +GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes, nor objects in the +ARCHIVE_ACCESS or DEEP_ARCHIVE_ACCESS access tiers of the INTELLIGENT_TIERING storage +class. For more information about storage classes, see Using Amazon S3 storage classes in +the Amazon S3 User Guide. Special Errors For a list of special errors for this +operation, see List of SELECT Object Content Error Codes The following operations are +related to SelectObjectContent: GetObject GetBucketLifecycleConfiguration PutBucketLifecycleConfiguration # Arguments @@ -6608,7 +6622,7 @@ CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipart the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: Object key for which the multipart upload was initiated. - `part_number`: Part number of part being uploaded. This is a positive integer between 1 and 10,000. @@ -6754,7 +6768,7 @@ CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipart the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on - Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. + Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - `key`: Object key for which the multipart upload was initiated. - `part_number`: Part number of part being copied. This is a positive integer between 1 and 10,000. diff --git a/src/services/sagemaker.jl b/src/services/sagemaker.jl index 80526ac426..9b2b91232e 100644 --- a/src/services/sagemaker.jl +++ b/src/services/sagemaker.jl @@ -500,9 +500,14 @@ end create_auto_mljob(auto_mljob_name, input_data_config, output_data_config, role_arn) create_auto_mljob(auto_mljob_name, input_data_config, output_data_config, role_arn, params::Dict{String,<:Any}) -Creates an Autopilot job. Find the best-performing model after you run an Autopilot job by -calling DescribeAutoMLJob. For information about how to use Autopilot, see Automate Model -Development with Amazon SageMaker Autopilot. +Creates an Autopilot job also referred to as Autopilot experiment or AutoML job. We +recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer +backward compatibility. CreateAutoMLJobV2 can manage tabular problem types identical to +those of its previous version CreateAutoMLJob, as well as non-tabular problem types such as +image or text classification. Find guidelines about how to migrate a CreateAutoMLJob to +CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2. You can find the +best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 +(recommended) or DescribeAutoMLJob. # Arguments - `auto_mljob_name`: Identifies an Autopilot job. The name must be unique to your account @@ -519,9 +524,9 @@ Development with Amazon SageMaker Autopilot. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"AutoMLJobConfig"`: A collection of settings used to configure an AutoML job. -- `"AutoMLJobObjective"`: Defines the objective metric used to measure the predictive - quality of an AutoML job. You provide an AutoMLJobObjectiveMetricName and Autopilot infers - whether to minimize or maximize it. For CreateAutoMLJobV2, only Accuracy is supported. +- `"AutoMLJobObjective"`: Specifies a metric to minimize or maximize as the objective of a + job. If not specified, the default objective metric depends on the problem type. See + AutoMLJobObjective for the default values. - `"GenerateCandidateDefinitionsOnly"`: Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings. @@ -584,18 +589,23 @@ end create_auto_mljob_v2(auto_mljob_input_data_config, auto_mljob_name, auto_mlproblem_type_config, output_data_config, role_arn) create_auto_mljob_v2(auto_mljob_input_data_config, auto_mljob_name, auto_mlproblem_type_config, output_data_config, role_arn, params::Dict{String,<:Any}) -Creates an Amazon SageMaker AutoML job that uses non-tabular data such as images or text -for Computer Vision or Natural Language Processing problems. Find the resulting model after -you run an AutoML job V2 by calling DescribeAutoMLJobV2. To create an AutoMLJob using -tabular data, see CreateAutoMLJob. This API action is callable through SageMaker Canvas -only. Calling it directly from the CLI or an SDK results in an error. +Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2. +CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob and +DescribeAutoMLJob which offer backward compatibility. CreateAutoMLJobV2 can manage tabular +problem types identical to those of its previous version CreateAutoMLJob, as well as +non-tabular problem types such as image or text classification. Find guidelines about how +to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to +CreateAutoMLJobV2. For the list of available problem types supported by CreateAutoMLJobV2, +see AutoMLProblemTypeConfig. You can find the best-performing model after you run an AutoML +job V2 by calling DescribeAutoMLJobV2. # Arguments - `auto_mljob_input_data_config`: An array of channel objects describing the input data and - their location. Each channel is a named input source. Similar to InputDataConfig supported - by CreateAutoMLJob. The supported formats depend on the problem type: - ImageClassification: S3Prefix, ManifestFile, AugmentedManifestFile TextClassification: - S3Prefix + their location. Each channel is a named input source. Similar to the InputDataConfig + attribute in the CreateAutoMLJob input parameters. The supported formats depend on the + problem type: For tabular problem types: S3Prefix, ManifestFile. For image + classification: S3Prefix, ManifestFile, AugmentedManifestFile. For text classification: + S3Prefix. For time-series forecasting: S3Prefix. - `auto_mljob_name`: Identifies an Autopilot job. The name must be unique to your account and is case insensitive. - `auto_mlproblem_type_config`: Defines the configuration settings of one of the supported @@ -607,13 +617,16 @@ only. Calling it directly from the CLI or an SDK results in an error. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"AutoMLJobObjective"`: Specifies a metric to minimize or maximize as the objective of a - job. For CreateAutoMLJobV2, only Accuracy is supported. + job. If not specified, the default objective metric depends on the problem type. For the + list of default values per problem type, see AutoMLJobObjective. For tabular problem + types, you must either provide both the AutoMLJobObjective and indicate the type of + supervised learning problem in AutoMLProblemTypeConfig (TabularJobConfig.ProblemType), or + none at all. - `"DataSplitConfig"`: This structure specifies how to split the data into train and - validation datasets. If you are using the V1 API (for example CreateAutoMLJob) or the V2 - API for Natural Language Processing problems (for example CreateAutoMLJobV2 with a - TextClassificationJobConfig problem type), the validation and training datasets must - contain the same headers. Also, for V1 API jobs, the validation dataset must be less than 2 - GB in size. + validation datasets. The validation and training datasets must contain the same headers. + For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB + in size. This attribute must not be set for the time-series forecasting problem type, as + Autopilot automatically splits the input dataset into training and validation sets. - `"ModelDeployConfig"`: Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment. - `"SecurityConfig"`: The security configuration for traffic encryption or Amazon VPC @@ -6257,7 +6270,8 @@ end describe_auto_mljob(auto_mljob_name) describe_auto_mljob(auto_mljob_name, params::Dict{String,<:Any}) -Returns information about an Amazon SageMaker AutoML job. +Returns information about an AutoML job created by calling CreateAutoMLJob. AutoML jobs +created by calling CreateAutoMLJobV2 cannot be described by DescribeAutoMLJob. # Arguments - `auto_mljob_name`: Requests information about an AutoML job using its unique name. @@ -6292,12 +6306,11 @@ end describe_auto_mljob_v2(auto_mljob_name) describe_auto_mljob_v2(auto_mljob_name, params::Dict{String,<:Any}) -Returns information about an Amazon SageMaker AutoML V2 job. This API action is callable -through SageMaker Canvas only. Calling it directly from the CLI or an SDK results in an -error. +Returns information about an AutoML job created by calling CreateAutoMLJobV2 or +CreateAutoMLJob. # Arguments -- `auto_mljob_name`: Requests information about an AutoML V2 job using its unique name. +- `auto_mljob_name`: Requests information about an AutoML job V2 using its unique name. """ function describe_auto_mljob_v2( @@ -13204,6 +13217,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys asynchronous operation. When you get an HTTP 200 response, you've made a valid request. It takes some time after you've made a valid request for Feature Store to update the feature group. +- `"OnlineStoreConfig"`: Updates the feature group online store configuration. """ function update_feature_group( FeatureGroupName; aws_config::AbstractAWSConfig=global_aws_config() diff --git a/src/services/sagemaker_featurestore_runtime.jl b/src/services/sagemaker_featurestore_runtime.jl index a37491edb9..e83bed83c1 100644 --- a/src/services/sagemaker_featurestore_runtime.jl +++ b/src/services/sagemaker_featurestore_runtime.jl @@ -14,6 +14,11 @@ Retrieves a batch of Records from a FeatureGroup. - `identifiers`: A list of FeatureGroup names, with their corresponding RecordIdentifier value, and Feature name that have been requested to be retrieved in batch. +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"ExpirationTimeResponse"`: Parameter to request ExpiresAt in response. If Enabled, + BatchGetRecord will return the value of ExpiresAt, if it is not null. If Disabled and null, + BatchGetRecord will return null. """ function batch_get_record(Identifiers; aws_config::AbstractAWSConfig=global_aws_config()) return sagemaker_featurestore_runtime( @@ -45,15 +50,15 @@ end delete_record(event_time, feature_group_name, record_identifier_value_as_string, params::Dict{String,<:Any}) Deletes a Record from a FeatureGroup in the OnlineStore. Feature Store supports both -SOFT_DELETE and HARD_DELETE. For SOFT_DELETE (default), feature columns are set to null and -the record is no longer retrievable by GetRecord or BatchGetRecord. For HARD_DELETE, the +SoftDelete and HardDelete. For SoftDelete (default), feature columns are set to null and +the record is no longer retrievable by GetRecord or BatchGetRecord. For HardDelete, the complete Record is removed from the OnlineStore. In both cases, Feature Store appends the deleted record marker to the OfflineStore with feature values set to null, is_deleted value set to True, and EventTime set to the delete input EventTime. Note that the EventTime specified in DeleteRecord should be set later than the EventTime of the existing record in the OnlineStore for that RecordIdentifer. If it is not, the deletion does not occur: For -SOFT_DELETE, the existing (undeleted) record remains in the OnlineStore, though the delete -record marker is still written to the OfflineStore. HARD_DELETE returns EventTime: 400 +SoftDelete, the existing (undeleted) record remains in the OnlineStore, though the delete +record marker is still written to the OfflineStore. HardDelete returns EventTime: 400 ValidationException to indicate that the delete operation failed. No delete record marker is written to the OfflineStore. @@ -130,6 +135,9 @@ empty result is returned. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"ExpirationTimeResponse"`: Parameter to request ExpiresAt in response. If Enabled, + BatchGetRecord will return the value of ExpiresAt, if it is not null. If Disabled and null, + BatchGetRecord will return null. - `"FeatureName"`: List of names of Features to be retrieved. If not specified, the latest value for all the Features are returned. """ @@ -190,6 +198,9 @@ record, it is written only to the OfflineStore. Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"TargetStores"`: A list of stores to which you're adding the record. By default, Feature Store adds the record to all of the stores that you're using for the FeatureGroup. +- `"TtlDuration"`: Time to live duration, where the record is hard deleted after the + expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on + HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide. """ function put_record( FeatureGroupName, Record; aws_config::AbstractAWSConfig=global_aws_config() diff --git a/src/services/sfn.jl b/src/services/sfn.jl index 9a5f6e5287..1c915acb96 100644 --- a/src/services/sfn.jl +++ b/src/services/sfn.jl @@ -62,14 +62,16 @@ Creates a state machine. A state machine consists of a collection of states that work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the -Step Functions User Guide. This operation is eventually consistent. The results are best -effort and may not reflect very recent updates and changes. CreateStateMachine is an -idempotent API. Subsequent requests won’t create a duplicate resource if it was already -created. CreateStateMachine's idempotency check is based on the state machine name, -definition, type, LoggingConfiguration and TracingConfiguration. If a following request has -a different roleArn or tags, Step Functions will ignore these differences and treat it as -an idempotent request of the previous. In this case, roleArn and tags will not be updated, -even if they are different. +Step Functions User Guide. If you set the publish parameter of this API action to true, it +publishes version 1 as the first revision of the state machine. This operation is +eventually consistent. The results are best effort and may not reflect very recent updates +and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create +a duplicate resource if it was already created. CreateStateMachine's idempotency check is +based on the state machine name, definition, type, LoggingConfiguration, and +TracingConfiguration. The check is also based on the publish and versionDescription +parameters. If a following request has a different roleArn or tags, Step Functions will +ignore these differences and treat it as an idempotent request of the previous. In this +case, roleArn and tags will not be updated, even if they are different. # Arguments - `definition`: The Amazon States Language definition of the state machine. See Amazon @@ -85,6 +87,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"loggingConfiguration"`: Defines what execution history events are logged and where they are logged. By default, the level is set to OFF. For more information see Log Levels in the Step Functions User Guide. +- `"publish"`: Set to true to publish the first version of the state machine during + creation. The default is false. - `"tags"`: Tags to be added when creating a state machine. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain @@ -92,6 +96,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"tracingConfiguration"`: Selects whether X-Ray tracing is enabled. - `"type"`: Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created. +- `"versionDescription"`: Sets description about the state machine version. You can only + set the description if the publish parameter is set to true. Otherwise, if you set + versionDescription, but publish to false, this API action throws ValidationException. """ function create_state_machine( definition, name, roleArn; aws_config::AbstractAWSConfig=global_aws_config() @@ -126,6 +133,72 @@ function create_state_machine( ) end +""" + create_state_machine_alias(name, routing_configuration) + create_state_machine_alias(name, routing_configuration, params::Dict{String,<:Any}) + +Creates an alias for a state machine that points to one or two versions of the same state +machine. You can set your application to call StartExecution with an alias and update the +version the alias uses without changing the client's code. You can also map an alias to +split StartExecution requests between two versions of a state machine. To do this, add a +second RoutingConfig object in the routingConfiguration parameter. You must also specify +the percentage of execution run requests each version should receive in both RoutingConfig +objects. Step Functions randomly chooses which version runs a given execution based on the +percentage you specify. To create an alias that points to a single version, specify a +single RoutingConfig object with a weight set to 100. You can create up to 100 aliases for +each state machine. You must delete unused aliases using the DeleteStateMachineAlias API +action. CreateStateMachineAlias is an idempotent API. Step Functions bases the idempotency +check on the stateMachineArn, description, name, and routingConfiguration parameters. +Requests that contain the same values for these parameters return a successful idempotent +response without creating a duplicate resource. Related operations: +DescribeStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias +DeleteStateMachineAlias + +# Arguments +- `name`: The name of the state machine alias. To avoid conflict with version ARNs, don't + use an integer in the name of the alias. +- `routing_configuration`: The routing configuration of a state machine alias. The routing + configuration shifts execution traffic between two state machine versions. + routingConfiguration contains an array of RoutingConfig objects that specify up to two + state machine versions. Step Functions then randomly choses which version to run an + execution with based on the weight assigned to each RoutingConfig. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"description"`: A description for the state machine alias. +""" +function create_state_machine_alias( + name, routingConfiguration; aws_config::AbstractAWSConfig=global_aws_config() +) + return sfn( + "CreateStateMachineAlias", + Dict{String,Any}("name" => name, "routingConfiguration" => routingConfiguration); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function create_state_machine_alias( + name, + routingConfiguration, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return sfn( + "CreateStateMachineAlias", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "name" => name, "routingConfiguration" => routingConfiguration + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ delete_activity(activity_arn) delete_activity(activity_arn, params::Dict{String,<:Any}) @@ -164,15 +237,19 @@ end delete_state_machine(state_machine_arn, params::Dict{String,<:Any}) Deletes a state machine. This is an asynchronous operation: It sets the state machine's -status to DELETING and begins the deletion process. If the given state machine Amazon -Resource Name (ARN) is a qualified state machine ARN, it will fail with -ValidationException. A qualified state machine ARN refers to a Distributed Map state -defined within a state machine. For example, the qualified state machine ARN -arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers -to a Distributed Map state with a label mapStateLabel in the state machine named -stateMachineName. For EXPRESS state machines, the deletion will happen eventually (usually -less than a minute). Running executions may emit logs after DeleteStateMachine API is -called. +status to DELETING and begins the deletion process. A qualified state machine ARN can +either refer to a Distributed Map state defined within a state machine, a version ARN, or +an alias ARN. The following are some examples of qualified and unqualified state machine +ARNs: The following qualified state machine ARN refers to a Distributed Map state with a +label mapStateLabel in a state machine named myStateMachine. +arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you +provide a qualified state machine ARN that refers to a Distributed Map state, the request +fails with ValidationException. The following unqualified state machine ARN refers to a +state machine named myStateMachine. +arn:partition:states:region:account-id:stateMachine:myStateMachine This API action also +deletes all versions and aliases associated with a state machine. For EXPRESS state +machines, the deletion happens eventually (usually in less than a minute). Running +executions may emit logs after DeleteStateMachine API is called. # Arguments - `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine to delete. @@ -205,6 +282,96 @@ function delete_state_machine( ) end +""" + delete_state_machine_alias(state_machine_alias_arn) + delete_state_machine_alias(state_machine_alias_arn, params::Dict{String,<:Any}) + +Deletes a state machine alias. After you delete a state machine alias, you can't use it to +start executions. When you delete a state machine alias, Step Functions doesn't delete the +state machine versions that alias references. Related operations: +CreateStateMachineAlias DescribeStateMachineAlias ListStateMachineAliases +UpdateStateMachineAlias + +# Arguments +- `state_machine_alias_arn`: The Amazon Resource Name (ARN) of the state machine alias to + delete. + +""" +function delete_state_machine_alias( + stateMachineAliasArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return sfn( + "DeleteStateMachineAlias", + Dict{String,Any}("stateMachineAliasArn" => stateMachineAliasArn); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function delete_state_machine_alias( + stateMachineAliasArn, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return sfn( + "DeleteStateMachineAlias", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}("stateMachineAliasArn" => stateMachineAliasArn), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + delete_state_machine_version(state_machine_version_arn) + delete_state_machine_version(state_machine_version_arn, params::Dict{String,<:Any}) + +Deletes a state machine version. After you delete a version, you can't call StartExecution +using that version's ARN or use the version with a state machine alias. Deleting a state +machine version won't terminate its in-progress executions. You can't delete a state +machine version currently referenced by one or more aliases. Before you delete a version, +you must either delete the aliases or update them to point to another state machine +version. Related operations: PublishStateMachineVersion ListStateMachineVersions + + +# Arguments +- `state_machine_version_arn`: The Amazon Resource Name (ARN) of the state machine version + to delete. + +""" +function delete_state_machine_version( + stateMachineVersionArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return sfn( + "DeleteStateMachineVersion", + Dict{String,Any}("stateMachineVersionArn" => stateMachineVersionArn); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function delete_state_machine_version( + stateMachineVersionArn, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return sfn( + "DeleteStateMachineVersion", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}("stateMachineVersionArn" => stateMachineVersionArn), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ describe_activity(activity_arn) describe_activity(activity_arn, params::Dict{String,<:Any}) @@ -243,12 +410,14 @@ end describe_execution(execution_arn) describe_execution(execution_arn, params::Dict{String,<:Any}) -Provides all information about a state machine execution, such as the state machine -associated with the execution, the execution input and output, and relevant execution -metadata. Use this API action to return the Map Run ARN if the execution was dispatched by -a Map Run. This operation is eventually consistent. The results are best effort and may -not reflect very recent updates and changes. This API action is not supported by EXPRESS -state machine executions unless they were dispatched by a Map Run. +Provides information about a state machine execution, such as the state machine associated +with the execution, the execution input and output, and relevant execution metadata. Use +this API action to return the Map Run Amazon Resource Name (ARN) if the execution was +dispatched by a Map Run. If you specify a version or alias ARN when you call the +StartExecution API action, DescribeExecution returns that ARN. This operation is +eventually consistent. The results are best effort and may not reflect very recent updates +and changes. Executions of an EXPRESS state machinearen't supported by DescribeExecution +unless a Map Run dispatched them. # Arguments - `execution_arn`: The Amazon Resource Name (ARN) of the execution to describe. @@ -316,17 +485,30 @@ end describe_state_machine(state_machine_arn, params::Dict{String,<:Any}) Provides information about a state machine's definition, its IAM role Amazon Resource Name -(ARN), and configuration. If the state machine ARN is a qualified state machine ARN, the -response returned includes the Map state's label. A qualified state machine ARN refers to a -Distributed Map state defined within a state machine. For example, the qualified state -machine ARN -arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers -to a Distributed Map state with a label mapStateLabel in the state machine named -stateMachineName. This operation is eventually consistent. The results are best effort and -may not reflect very recent updates and changes. +(ARN), and configuration. A qualified state machine ARN can either refer to a Distributed +Map state defined within a state machine, a version ARN, or an alias ARN. The following are +some examples of qualified and unqualified state machine ARNs: The following qualified +state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state +machine named myStateMachine. +arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you +provide a qualified state machine ARN that refers to a Distributed Map state, the request +fails with ValidationException. The following qualified state machine ARN refers to an +alias named PROD. +arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi +ne:PROD> If you provide a qualified state machine ARN that refers to a version ARN or +an alias ARN, the request starts execution for that version or alias. The following +unqualified state machine ARN refers to a state machine named myStateMachine. +arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi +ne> This API action returns the details for a state machine version if the +stateMachineArn you specify is a state machine version ARN. This operation is eventually +consistent. The results are best effort and may not reflect very recent updates and +changes. # Arguments -- `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine to describe. +- `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine for which you + want the information. If you specify a state machine version ARN, this API returns details + about that version. The version ARN is a combination of state machine ARN and the version + number separated by a colon (:). For example, stateMachineARN:1. """ function describe_state_machine( @@ -356,16 +538,57 @@ function describe_state_machine( ) end +""" + describe_state_machine_alias(state_machine_alias_arn) + describe_state_machine_alias(state_machine_alias_arn, params::Dict{String,<:Any}) + +Returns details about a state machine alias. Related operations: +CreateStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias +DeleteStateMachineAlias + +# Arguments +- `state_machine_alias_arn`: The Amazon Resource Name (ARN) of the state machine alias. + +""" +function describe_state_machine_alias( + stateMachineAliasArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return sfn( + "DescribeStateMachineAlias", + Dict{String,Any}("stateMachineAliasArn" => stateMachineAliasArn); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function describe_state_machine_alias( + stateMachineAliasArn, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return sfn( + "DescribeStateMachineAlias", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}("stateMachineAliasArn" => stateMachineAliasArn), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ describe_state_machine_for_execution(execution_arn) describe_state_machine_for_execution(execution_arn, params::Dict{String,<:Any}) Provides information about a state machine's definition, its execution role ARN, and -configuration. If an execution was dispatched by a Map Run, the Map Run is returned in the -response. Additionally, the state machine returned will be the state machine associated -with the Map Run. This operation is eventually consistent. The results are best effort and -may not reflect very recent updates and changes. This API action is not supported by -EXPRESS state machines. +configuration. If a Map Run dispatched the execution, this action returns the Map Run +Amazon Resource Name (ARN) in the response. The state machine returned is the state machine +associated with the Map Run. This operation is eventually consistent. The results are best +effort and may not reflect very recent updates and changes. This API action is not +supported by EXPRESS state machines. # Arguments - `execution_arn`: The Amazon Resource Name (ARN) of the execution you want state machine @@ -540,14 +763,15 @@ end Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those -related to a Map Run by specifying a Map Run ARN. Results are sorted by time, with the most -recent execution first. 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. This operation is eventually consistent. The results are best -effort and may not reflect very recent updates and changes. This API action is not -supported by EXPRESS state machines. +related to a Map Run by specifying a Map Run ARN. You can also provide a state machine +alias ARN or version ARN to list the executions associated with a specific alias or +version. Results are sorted by time, with the most recent execution first. 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. This +operation is eventually consistent. The results are best effort and may not reflect very +recent updates and changes. This API action is not supported by EXPRESS state machines. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -566,7 +790,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. - `"stateMachineArn"`: The Amazon Resource Name (ARN) of the state machine whose executions - is listed. You can specify either a mapRunArn or a stateMachineArn, but not both. + is listed. You can specify either a mapRunArn or a stateMachineArn, but not both. You can + also return a list of executions associated with a specific alias or version, by specifying + an alias ARN or a version ARN in the stateMachineArn parameter. - `"statusFilter"`: If specified, only list the executions whose current execution status matches the given filter. """ @@ -628,6 +854,118 @@ function list_map_runs( ) end +""" + list_state_machine_aliases(state_machine_arn) + list_state_machine_aliases(state_machine_arn, params::Dict{String,<:Any}) + +Lists aliases for a specified state machine ARN. Results are sorted by time, with the most +recently created aliases listed first. To list aliases that reference a state machine +version, you can specify the version ARN in the stateMachineArn parameter. 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. Related +operations: CreateStateMachineAlias DescribeStateMachineAlias +UpdateStateMachineAlias DeleteStateMachineAlias + +# Arguments +- `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine for which you + want to list aliases. If you specify a state machine version ARN, this API returns a list + of aliases for that version. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"maxResults"`: The maximum number of results that are returned per call. You can use + nextToken to obtain further pages of results. The default is 100 and the maximum allowed + page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual + number of results returned per call might be fewer than the specified maximum. +- `"nextToken"`: 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. +""" +function list_state_machine_aliases( + stateMachineArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return sfn( + "ListStateMachineAliases", + Dict{String,Any}("stateMachineArn" => stateMachineArn); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function list_state_machine_aliases( + stateMachineArn, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return sfn( + "ListStateMachineAliases", + Dict{String,Any}( + mergewith( + _merge, Dict{String,Any}("stateMachineArn" => stateMachineArn), params + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + list_state_machine_versions(state_machine_arn) + list_state_machine_versions(state_machine_arn, params::Dict{String,<:Any}) + +Lists versions for the specified state machine Amazon Resource Name (ARN). The results are +sorted in descending order of the version creation time. 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. Related operations: +PublishStateMachineVersion DeleteStateMachineVersion + +# Arguments +- `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"maxResults"`: The maximum number of results that are returned per call. You can use + nextToken to obtain further pages of results. The default is 100 and the maximum allowed + page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual + number of results returned per call might be fewer than the specified maximum. +- `"nextToken"`: 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. +""" +function list_state_machine_versions( + stateMachineArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return sfn( + "ListStateMachineVersions", + Dict{String,Any}("stateMachineArn" => stateMachineArn); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function list_state_machine_versions( + stateMachineArn, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return sfn( + "ListStateMachineVersions", + Dict{String,Any}( + mergewith( + _merge, Dict{String,Any}("stateMachineArn" => stateMachineArn), params + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ list_state_machines() list_state_machines(params::Dict{String,<:Any}) @@ -699,6 +1037,63 @@ function list_tags_for_resource( ) end +""" + publish_state_machine_version(state_machine_arn) + publish_state_machine_version(state_machine_arn, params::Dict{String,<:Any}) + +Creates a version from the current revision of a state machine. Use versions to create +immutable snapshots of your state machine. You can start executions from versions either +directly or with an alias. To create an alias, use CreateStateMachineAlias. You can publish +up to 1000 versions for each state machine. You must manually delete unused versions using +the DeleteStateMachineVersion API action. PublishStateMachineVersion is an idempotent API. +It doesn't create a duplicate state machine version if it already exists for the current +revision. Step Functions bases PublishStateMachineVersion's idempotency check on the +stateMachineArn, name, and revisionId parameters. Requests with the same parameters return +a successful idempotent response. If you don't specify a revisionId, Step Functions checks +for a previously published version of the state machine's current revision. Related +operations: DeleteStateMachineVersion ListStateMachineVersions + +# Arguments +- `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"description"`: An optional description of the state machine version. +- `"revisionId"`: Only publish the state machine version if the current state machine's + revision ID matches the specified ID. Use this option to avoid publishing a version if the + state machine changed since you last updated it. If the specified revision ID doesn't match + the state machine's current revision ID, the API returns ConflictException. To specify an + initial revision ID for a state machine with no revision ID assigned, specify the string + INITIAL for the revisionId parameter. For example, you can specify a revisionID of INITIAL + when you create a state machine using the CreateStateMachine API action. +""" +function publish_state_machine_version( + stateMachineArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return sfn( + "PublishStateMachineVersion", + Dict{String,Any}("stateMachineArn" => stateMachineArn); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function publish_state_machine_version( + stateMachineArn, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return sfn( + "PublishStateMachineVersion", + Dict{String,Any}( + mergewith( + _merge, Dict{String,Any}("stateMachineArn" => stateMachineArn), params + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ send_task_failure(task_token) send_task_failure(task_token, params::Dict{String,<:Any}) @@ -832,21 +1227,49 @@ end start_execution(state_machine_arn) start_execution(state_machine_arn, params::Dict{String,<:Any}) -Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is -a qualified state machine ARN, it will fail with ValidationException. A qualified state -machine ARN refers to a Distributed Map state defined within a state machine. For example, -the qualified state machine ARN -arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers -to a Distributed Map state with a label mapStateLabel in the state machine named -stateMachineName. StartExecution is idempotent for STANDARD workflows. For a STANDARD -workflow, if StartExecution is called with the same name and input as a running execution, -the call will succeed and return the same response as the original request. If the -execution is closed or if the input is different, it will return a 400 -ExecutionAlreadyExists error. Names can be reused after 90 days. StartExecution is not +Starts a state machine execution. A qualified state machine ARN can either refer to a +Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The +following are some examples of qualified and unqualified state machine ARNs: The +following qualified state machine ARN refers to a Distributed Map state with a label +mapStateLabel in a state machine named myStateMachine. +arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you +provide a qualified state machine ARN that refers to a Distributed Map state, the request +fails with ValidationException. The following qualified state machine ARN refers to an +alias named PROD. +arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi +ne:PROD> If you provide a qualified state machine ARN that refers to a version ARN or +an alias ARN, the request starts execution for that version or alias. The following +unqualified state machine ARN refers to a state machine named myStateMachine. +arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi +ne> If you start an execution with an unqualified state machine ARN, Step Functions +uses the latest revision of the state machine for the execution. To start executions of a +state machine version, call StartExecution and provide the version ARN or the ARN of an +alias that points to the version. StartExecution is idempotent for STANDARD workflows. +For a STANDARD workflow, if you call StartExecution with the same name and input as a +running execution, the call succeeds and return the same response as the original request. +If the execution is closed or if the input is different, it returns a 400 +ExecutionAlreadyExists error. You can reuse names after 90 days. StartExecution isn't idempotent for EXPRESS workflows. # Arguments -- `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine to execute. +- `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine to execute. The + stateMachineArn parameter accepts one of the following inputs: An unqualified state + machine ARN – Refers to a state machine ARN that isn't qualified with a version or alias + ARN. The following is an example of an unqualified state machine ARN. + arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi + ne> Step Functions doesn't associate state machine executions that you start with an + unqualified ARN with a version. This is true even if that version uses the same revision + that the execution used. A state machine version ARN – Refers to a version ARN, which + is a combination of state machine ARN and the version number separated by a colon (:). The + following is an example of the ARN for version 10. + arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi + ne>:10 Step Functions doesn't associate executions that you start with a version ARN + with any aliases that point to that version. A state machine alias ARN – Refers to an + alias ARN, which is a combination of state machine ARN and the alias name separated by a + colon (:). The following is an example of the ARN for an alias named PROD. + arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi + ne:PROD> Step Functions associates executions that you start with an alias ARN with + that alias and the state machine version used for that execution. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -854,8 +1277,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys \"input\": \"{\"first_name\" : \"test\"}\" If you don't include any JSON input data, you still must include the two braces, for example: \"input\": \"{}\" Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. -- `"name"`: The name of the execution. This name must be unique for your Amazon Web - Services account, region, and state machine for 90 days. For more information, see Limits +- `"name"`: Optional name of the execution. This name must be unique for your Amazon Web + Services account, Region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters \" # % ^ | ~ ` & , ; : / control characters (U+0000-001F, U+007F-009F) @@ -1111,15 +1534,30 @@ end Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a -MissingRequiredParameter error. If the given state machine Amazon Resource Name (ARN) is a -qualified state machine ARN, it will fail with ValidationException. A qualified state -machine ARN refers to a Distributed Map state defined within a state machine. For example, -the qualified state machine ARN +MissingRequiredParameter error. A qualified state machine ARN refers to a Distributed Map +state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named -stateMachineName. All StartExecution calls within a few seconds will use the updated -definition and roleArn. Executions started immediately after calling UpdateStateMachine may -use the previous state machine definition and roleArn. +stateMachineName. A qualified state machine ARN can either refer to a Distributed Map state +defined within a state machine, a version ARN, or an alias ARN. The following are some +examples of qualified and unqualified state machine ARNs: The following qualified state +machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine +named myStateMachine. +arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you +provide a qualified state machine ARN that refers to a Distributed Map state, the request +fails with ValidationException. The following qualified state machine ARN refers to an +alias named PROD. +arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi +ne:PROD> If you provide a qualified state machine ARN that refers to a version ARN or +an alias ARN, the request starts execution for that version or alias. The following +unqualified state machine ARN refers to a state machine named myStateMachine. +arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi +ne> After you update your state machine, you can set the publish parameter to true in +the same action to publish a new version. This way, you can opt-in to strict versioning of +your state machine. Step Functions assigns monotonically increasing integers for state +machine versions, starting at version number 1. All StartExecution calls within a few +seconds use the updated definition and roleArn. Executions started immediately after you +call UpdateStateMachine may use the previous state machine definition and roleArn. # Arguments - `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine. @@ -1128,10 +1566,14 @@ use the previous state machine definition and roleArn. Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"definition"`: The Amazon States Language definition of the state machine. See Amazon States Language. -- `"loggingConfiguration"`: The LoggingConfiguration data type is used to set CloudWatch - Logs options. +- `"loggingConfiguration"`: Use the LoggingConfiguration data type to set CloudWatch Logs + options. +- `"publish"`: Specifies whether the state machine version is published. The default is + false. To publish a version after updating the state machine, set publish to true. - `"roleArn"`: The Amazon Resource Name (ARN) of the IAM role of the state machine. - `"tracingConfiguration"`: Selects whether X-Ray tracing is enabled. +- `"versionDescription"`: An optional description of the state machine version to publish. + You can only specify the versionDescription parameter if you've set publish to true. """ function update_state_machine( stateMachineArn; aws_config::AbstractAWSConfig=global_aws_config() @@ -1159,3 +1601,57 @@ function update_state_machine( feature_set=SERVICE_FEATURE_SET, ) end + +""" + update_state_machine_alias(state_machine_alias_arn) + update_state_machine_alias(state_machine_alias_arn, params::Dict{String,<:Any}) + +Updates the configuration of an existing state machine alias by modifying its description +or routingConfiguration. You must specify at least one of the description or +routingConfiguration parameters to update a state machine alias. UpdateStateMachineAlias +is an idempotent API. Step Functions bases the idempotency check on the +stateMachineAliasArn, description, and routingConfiguration parameters. Requests with the +same parameters return an idempotent response. This operation is eventually consistent. +All StartExecution requests made within a few seconds use the latest alias configuration. +Executions started immediately after calling UpdateStateMachineAlias may use the previous +routing configuration. Related operations: CreateStateMachineAlias +DescribeStateMachineAlias ListStateMachineAliases DeleteStateMachineAlias + +# Arguments +- `state_machine_alias_arn`: The Amazon Resource Name (ARN) of the state machine alias. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"description"`: A description of the state machine alias. +- `"routingConfiguration"`: The routing configuration of the state machine alias. An array + of RoutingConfig objects that specifies up to two state machine versions that the alias + starts executions for. +""" +function update_state_machine_alias( + stateMachineAliasArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return sfn( + "UpdateStateMachineAlias", + Dict{String,Any}("stateMachineAliasArn" => stateMachineAliasArn); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function update_state_machine_alias( + stateMachineAliasArn, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return sfn( + "UpdateStateMachineAlias", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}("stateMachineAliasArn" => stateMachineAliasArn), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end diff --git a/src/services/ssm.jl b/src/services/ssm.jl index 6b98ca6297..5311e44a48 100644 --- a/src/services/ssm.jl +++ b/src/services/ssm.jl @@ -33,7 +33,8 @@ EC2) instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Gui OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager. For the Document and - Parameter values, use the name of the resource. ManagedInstance: mi-012345abcde The + Parameter values, use the name of the resource. If you're tagging a shared document, you + must use the full ARN of the document. ManagedInstance: mi-012345abcde The ManagedInstance type for this API operation is only for on-premises managed nodes. You must specify the name of the managed node in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f. @@ -651,12 +652,12 @@ end create_ops_item(description, source, title, params::Dict{String,<:Any}) Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to -create a new OpsItem. For more information, see Getting started with OpsCenter in the -Amazon Web Services Systems Manager User Guide. Operations engineers and IT professionals -use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate -operational issues impacting the performance and health of their Amazon Web Services -resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the -Amazon Web Services Systems Manager User Guide. +create a new OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services +Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web +Services Systems Manager OpsCenter to view, investigate, and remediate operational issues +impacting the performance and health of their Amazon Web Services resources. For more +information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services +Systems Manager User Guide. # Arguments - `description`: Information about the OpsItem. @@ -669,8 +670,8 @@ Amazon Web Services Systems Manager User Guide. Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"AccountId"`: The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across - accounts. For more information, see Setting up OpsCenter to work with OpsItems across - accounts in the Amazon Web Services Systems Manager User Guide. + accounts. For more information, see Set up OpsCenter in the Amazon Web Services Systems + Manager User Guide. - `"ActualEndTime"`: The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest. - `"ActualStartTime"`: The time a runbook workflow started. Currently reported only for the @@ -706,13 +707,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource. - `"Severity"`: Specify a severity to assign to an OpsItem. -- `"Tags"`: Optional metadata that you assign to a resource. You can restrict access to - OpsItems by using an inline IAM policy that specifies tags. For more information, see - Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide. Tags - use a key-value pair. For example: Key=Department,Value=Finance To add tags to a new - OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the - ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the - AddTagsToResource operation. +- `"Tags"`: Optional metadata that you assign to a resource. Tags use a key-value pair. For + example: Key=Department,Value=Finance To add tags to a new OpsItem, a user must have IAM + permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource + operation. To add tags to an existing OpsItem, use the AddTagsToResource operation. """ function create_ops_item( Description, Source, Title; aws_config::AbstractAWSConfig=global_aws_config() @@ -2028,26 +2026,29 @@ end describe_instance_information() describe_instance_information(params::Dict{String,<:Any}) -Describes one or more of your managed nodes, including information about the operating -system platform, the version of SSM Agent installed on the managed node, node status, and -so on. If you specify one or more managed node IDs, it returns information for those -managed nodes. If you don't specify node IDs, it returns information for all your managed -nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive -an error. The IamRole field for this API operation is the Identity and Access Management -(IAM) role assigned to on-premises managed nodes. This call doesn't return the IAM role for -EC2 instances. +Provides information about one or more of your managed nodes, including the operating +system platform, SSM Agent version, association status, and IP address. This operation does +not return information for nodes that are either Stopped or Terminated. If you specify one +or more node IDs, the operation returns information for those managed nodes. If you don't +specify node IDs, it returns information for all your managed nodes. If you specify a node +ID that isn't valid or a node that you don't own, you receive an error. The IamRole field +returned for this API operation is the Identity and Access Management (IAM) role assigned +to on-premises managed nodes. This operation does not return the IAM role for EC2 +instances. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"Filters"`: One or more filters. Use a filter to return a more specific list of managed - nodes. You can filter based on tags applied to your managed nodes. Use this Filters data - type instead of InstanceInformationFilterList, which is deprecated. + nodes. You can filter based on tags applied to your managed nodes. Tag filters can't be + combined with other filter types. Use this Filters data type instead of + InstanceInformationFilterList, which is deprecated. - `"InstanceInformationFilterList"`: This is a legacy method. We recommend that you don't use this method. Instead, use the Filters data type. Filters enables you to return node information by filtering based on tags applied to managed nodes. Attempting to use InstanceInformationFilterList and Filters leads to an exception error. - `"MaxResults"`: The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + The default value is 10 items. - `"NextToken"`: The token for the next set of items to return. (You received this token from a previous call.) """ @@ -2594,12 +2595,11 @@ end describe_ops_items(params::Dict{String,<:Any}) Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) -to query a list of OpsItems. For more information, see Getting started with OpsCenter in -the Amazon Web Services Systems Manager User Guide. Operations engineers and IT -professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and -remediate operational issues impacting the performance and health of their Amazon Web -Services resources. For more information, see OpsCenter in the Amazon Web Services Systems -Manager User Guide. +to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web +Services Systems Manager User Guide. Operations engineers and IT professionals use Amazon +Web Services Systems Manager OpsCenter to view, investigate, and remediate operational +issues impacting the performance and health of their Amazon Web Services resources. For +more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -2613,11 +2613,11 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys Operations: Equals,Contains Key: OperationalData** Operations: Equals Key: OperationalDataKey Operations: Equals Key: OperationalDataValue Operations: Equals, Contains Key: OpsItemId Operations: Equals Key: ResourceId Operations: Contains Key: - AutomationId Operations: Equals *The Equals operator for Title matches the first 100 - characters. If you specify more than 100 characters, they system returns an error that the - filter value exceeds the length limit. **If you filter the response by using the - OperationalData operator, specify a key-value pair by using the following JSON format: - {\"key\":\"key_name\",\"value\":\"a_value\"} + AutomationId Operations: Equals Key: AccountId Operations: Equals *The Equals operator + for Title matches the first 100 characters. If you specify more than 100 characters, they + system returns an error that the filter value exceeds the length limit. **If you filter the + response by using the OperationalData operator, specify a key-value pair by using the + following JSON format: {\"key\":\"key_name\",\"value\":\"a_value\"} """ function describe_ops_items(; aws_config::AbstractAWSConfig=global_aws_config()) return ssm("DescribeOpsItems"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET) @@ -3491,12 +3491,12 @@ end get_ops_item(ops_item_id, params::Dict{String,<:Any}) Get information about an OpsItem by using the ID. You must have permission in Identity and -Access Management (IAM) to view information about an OpsItem. For more information, see -Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide. -Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter -to view, investigate, and remediate operational issues impacting the performance and health -of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon -Web Services Systems Manager User Guide. +Access Management (IAM) to view information about an OpsItem. For more information, see Set +up OpsCenter in the Amazon Web Services Systems Manager User Guide. Operations engineers +and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, +investigate, and remediate operational issues impacting the performance and health of their +Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web +Services Systems Manager User Guide. # Arguments - `ops_item_id`: The ID of the OpsItem that you want to get. @@ -6550,12 +6550,11 @@ end update_ops_item(ops_item_id, params::Dict{String,<:Any}) Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) -to update an OpsItem. For more information, see Getting started with OpsCenter in the -Amazon Web Services Systems Manager User Guide. Operations engineers and IT professionals -use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate -operational issues impacting the performance and health of their Amazon Web Services -resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager -User Guide. +to update an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services +Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web +Services Systems Manager OpsCenter to view, investigate, and remediate operational issues +impacting the performance and health of their Amazon Web Services resources. For more +information, see OpsCenter in the Amazon Web Services Systems Manager User Guide. # Arguments - `ops_item_id`: The ID of the OpsItem. diff --git a/src/services/transfer.jl b/src/services/transfer.jl index b2d3226404..b99a6b2a42 100644 --- a/src/services/transfer.jl +++ b/src/services/transfer.jl @@ -120,7 +120,11 @@ the AS2 process is identified with the LocalProfileId. the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend - to send with StartFileTransfer. + to send with StartFileTransfer. If you are using Basic authentication for your AS2 + connector, the access role requires the secretsmanager:GetSecretValue permission for the + secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web + Services managed key in Secrets Manager, then the role also needs the kms:Decrypt + permission for that key. - `base_directory`: The landing directory (folder) for files transferred by using the AS2 protocol. A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory. - `local_profile_id`: A unique identifier for the AS2 local profile. @@ -201,7 +205,11 @@ For more details about connectors, see Create AS2 connectors. the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend - to send with StartFileTransfer. + to send with StartFileTransfer. If you are using Basic authentication for your AS2 + connector, the access role requires the secretsmanager:GetSecretValue permission for the + secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web + Services managed key in Secrets Manager, then the role also needs the kms:Decrypt + permission for that key. - `as2_config`: A structure that contains the parameters for a connector object. - `url`: The URL of the partner's AS2 endpoint. @@ -417,6 +425,14 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys EndpointType must be VPC, and domain must be Amazon S3. - `"SecurityPolicyName"`: Specifies the name of the security policy that is attached to the server. +- `"StructuredLogDestinations"`: Specifies the log groups to which your server logs are + sent. To specify a log group, you must provide the ARN for an existing log group. In this + case, the format of the log group is as follows: + arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:* For example, + arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:* If you have previously + specified a log group for a server, you can clear it, and in effect turn off structured + logging, by providing an empty value for this parameter in an update-server call. For + example: update-server --server-id s-1234567890abcdef0 --structured-log-destinations - `"Tags"`: Key-value pairs that can be used to group and search for servers. - `"WorkflowDetails"`: Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow. In addition to a workflow to execute @@ -2436,7 +2452,11 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend - to send with StartFileTransfer. + to send with StartFileTransfer. If you are using Basic authentication for your AS2 + connector, the access role requires the secretsmanager:GetSecretValue permission for the + secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web + Services managed key in Secrets Manager, then the role also needs the kms:Decrypt + permission for that key. - `"BaseDirectory"`: To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example, /DOC-EXAMPLE-BUCKET/home/mydirectory . @@ -2539,7 +2559,11 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend - to send with StartFileTransfer. + to send with StartFileTransfer. If you are using Basic authentication for your AS2 + connector, the access role requires the secretsmanager:GetSecretValue permission for the + secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web + Services managed key in Secrets Manager, then the role also needs the kms:Decrypt + permission for that key. - `"As2Config"`: A structure that contains the parameters for a connector object. - `"LoggingRole"`: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When @@ -2759,6 +2783,14 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys EndpointType must be VPC, and domain must be Amazon S3. - `"SecurityPolicyName"`: Specifies the name of the security policy that is attached to the server. +- `"StructuredLogDestinations"`: Specifies the log groups to which your server logs are + sent. To specify a log group, you must provide the ARN for an existing log group. In this + case, the format of the log group is as follows: + arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:* For example, + arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:* If you have previously + specified a log group for a server, you can clear it, and in effect turn off structured + logging, by providing an empty value for this parameter in an update-server call. For + example: update-server --server-id s-1234567890abcdef0 --structured-log-destinations - `"WorkflowDetails"`: Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow. In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and diff --git a/src/services/verifiedpermissions.jl b/src/services/verifiedpermissions.jl index af1304036f..ad9561fbc7 100644 --- a/src/services/verifiedpermissions.jl +++ b/src/services/verifiedpermissions.jl @@ -161,7 +161,9 @@ end create_policy_store(validation_settings) create_policy_store(validation_settings, params::Dict{String,<:Any}) -Creates a policy store. A policy store is a container for policy resources. +Creates a policy store. A policy store is a container for policy resources. Although Cedar +supports multiple namespaces, Verified Permissions currently supports only one namespace +per policy store. # Arguments - `validation_settings`: Specifies the validation setting for this policy store. Currently, @@ -682,8 +684,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys principal authorized to perform this action on the resource? - `"context"`: Specifies additional context that can be used to make more granular authorization decisions. -- `"entities"`: Specifies the list of entities and their associated attributes that - Verified Permissions can examine when evaluating the policies. +- `"entities"`: Specifies the list of resources and principals and their associated + attributes that Verified Permissions can examine when evaluating the policies. You can + include only principal and resource entities in this parameter; you can't include actions. + You must specify actions in the schema. - `"principal"`: Specifies the principal for which the authorization decision is to be made. - `"resource"`: Specifies the resource for which the authorization decision is to be made. """ @@ -735,8 +739,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys authorized to perform this action on the specified resource. - `"context"`: Specifies additional context that can be used to make more granular authorization decisions. -- `"entities"`: Specifies the list of entities and their associated attributes that - Verified Permissions can examine when evaluating the policies. +- `"entities"`: Specifies the list of resources and principals and their associated + attributes that Verified Permissions can examine when evaluating the policies. You can + include only principal and resource entities in this parameter; you can't include actions. + You must specify actions in the schema. - `"identityToken"`: Specifies an identity token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an AccessToken or an IdentityToken, but not both.