From 2c5c3f8e344687ab474eafbe192849d0375d43f6 Mon Sep 17 00:00:00 2001 From: mattBrzezinski Date: Thu, 6 Jan 2022 06:12:39 +0000 Subject: [PATCH] AWS API Definitions Updated --- src/services/appstream.jl | 345 ++++++ src/services/appsync.jl | 404 ++++++- src/services/chime_sdk_messaging.jl | 6 +- src/services/cloudtrail.jl | 510 +++++++- src/services/cloudwatch_logs.jl | 16 +- src/services/comprehendmedical.jl | 231 +++- src/services/customer_profiles.jl | 91 +- src/services/datasync.jl | 97 +- src/services/detective.jl | 292 ++++- src/services/ec2.jl | 52 + src/services/ecs.jl | 28 +- src/services/finspace_data.jl | 31 +- src/services/forecast.jl | 55 +- src/services/glue.jl | 197 +++ src/services/greengrassv2.jl | 189 ++- src/services/health.jl | 16 +- src/services/imagebuilder.jl | 100 +- src/services/iot.jl | 13 +- src/services/lakeformation.jl | 129 ++ src/services/lex_models_v2.jl | 61 +- src/services/location.jl | 223 ++-- src/services/lookoutmetrics.jl | 55 + src/services/lookoutvision.jl | 341 ++++-- src/services/mediaconnect.jl | 13 +- src/services/network_firewall.jl | 43 +- src/services/nimble.jl | 2 +- src/services/outposts.jl | 57 +- src/services/qldb.jl | 54 +- src/services/quicksight.jl | 22 +- src/services/rds.jl | 319 ++--- src/services/redshift.jl | 10 +- src/services/rekognition.jl | 32 +- .../route53_recovery_control_config.jl | 190 ++- src/services/route_53.jl | 35 +- src/services/route_53_domains.jl | 272 +++-- src/services/s3.jl | 75 +- src/services/sagemaker.jl | 48 +- src/services/savingsplans.jl | 2 +- src/services/secrets_manager.jl | 1070 +++++++---------- src/services/securityhub.jl | 22 +- src/services/sms.jl | 51 +- src/services/support.jl | 271 +++-- src/services/transfer.jl | 17 +- src/services/workmail.jl | 126 ++ 44 files changed, 4516 insertions(+), 1697 deletions(-) diff --git a/src/services/appstream.jl b/src/services/appstream.jl index 276ab004f9..1a009acdc2 100644 --- a/src/services/appstream.jl +++ b/src/services/appstream.jl @@ -48,6 +48,60 @@ function associate_application_fleet( ) end +""" + associate_application_to_entitlement(application_identifier, entitlement_name, stack_name) + associate_application_to_entitlement(application_identifier, entitlement_name, stack_name, params::Dict{String,<:Any}) + +Associates an application to entitle. + +# Arguments +- `application_identifier`: The identifier of the application. +- `entitlement_name`: The name of the entitlement. +- `stack_name`: The name of the stack. + +""" +function associate_application_to_entitlement( + ApplicationIdentifier, + EntitlementName, + StackName; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appstream( + "AssociateApplicationToEntitlement", + Dict{String,Any}( + "ApplicationIdentifier" => ApplicationIdentifier, + "EntitlementName" => EntitlementName, + "StackName" => StackName, + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function associate_application_to_entitlement( + ApplicationIdentifier, + EntitlementName, + StackName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appstream( + "AssociateApplicationToEntitlement", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "ApplicationIdentifier" => ApplicationIdentifier, + "EntitlementName" => EntitlementName, + "StackName" => StackName, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ associate_fleet(fleet_name, stack_name) associate_fleet(fleet_name, stack_name, params::Dict{String,<:Any}) @@ -436,6 +490,72 @@ function create_directory_config( ) end +""" + create_entitlement(app_visibility, attributes, name, stack_name) + create_entitlement(app_visibility, attributes, name, stack_name, params::Dict{String,<:Any}) + +Creates a new entitlement. Entitlements control access to specific applications within a +stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. +Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in +a stack. Entitlements don't apply to the desktop stream view application, or to +applications managed by a dynamic app provider using the Dynamic Application Framework. + +# Arguments +- `app_visibility`: Specifies whether all or selected apps are entitled. +- `attributes`: The attributes of the entitlement. +- `name`: The name of the entitlement. +- `stack_name`: The name of the stack with which the entitlement is associated. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"Description"`: The description of the entitlement. +""" +function create_entitlement( + AppVisibility, + Attributes, + Name, + StackName; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appstream( + "CreateEntitlement", + Dict{String,Any}( + "AppVisibility" => AppVisibility, + "Attributes" => Attributes, + "Name" => Name, + "StackName" => StackName, + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function create_entitlement( + AppVisibility, + Attributes, + Name, + StackName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appstream( + "CreateEntitlement", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "AppVisibility" => AppVisibility, + "Attributes" => Attributes, + "Name" => Name, + "StackName" => StackName, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ create_fleet(instance_type, name) create_fleet(instance_type, name, params::Dict{String,<:Any}) @@ -1034,6 +1154,45 @@ function delete_directory_config( ) end +""" + delete_entitlement(name, stack_name) + delete_entitlement(name, stack_name, params::Dict{String,<:Any}) + +Deletes the specified entitlement. + +# Arguments +- `name`: The name of the entitlement. +- `stack_name`: The name of the stack with which the entitlement is associated. + +""" +function delete_entitlement( + Name, StackName; aws_config::AbstractAWSConfig=global_aws_config() +) + return appstream( + "DeleteEntitlement", + Dict{String,Any}("Name" => Name, "StackName" => StackName); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function delete_entitlement( + Name, + StackName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appstream( + "DeleteEntitlement", + Dict{String,Any}( + mergewith( + _merge, Dict{String,Any}("Name" => Name, "StackName" => StackName), params + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ delete_fleet(name) delete_fleet(name, params::Dict{String,<:Any}) @@ -1393,6 +1552,45 @@ function describe_directory_configs( ) end +""" + describe_entitlements(stack_name) + describe_entitlements(stack_name, params::Dict{String,<:Any}) + +Retrieves a list that describes one of more entitlements. + +# Arguments +- `stack_name`: The name of the stack with which the entitlement is associated. + +# 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. +- `"Name"`: The name of the entitlement. +- `"NextToken"`: The pagination token used to retrieve the next page of results for this + operation. +""" +function describe_entitlements(StackName; aws_config::AbstractAWSConfig=global_aws_config()) + return appstream( + "DescribeEntitlements", + Dict{String,Any}("StackName" => StackName); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function describe_entitlements( + StackName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appstream( + "DescribeEntitlements", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("StackName" => StackName), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ describe_fleets() describe_fleets(params::Dict{String,<:Any}) @@ -1800,6 +1998,61 @@ function disassociate_application_fleet( ) end +""" + disassociate_application_from_entitlement(application_identifier, entitlement_name, stack_name) + disassociate_application_from_entitlement(application_identifier, entitlement_name, stack_name, params::Dict{String,<:Any}) + +Deletes the specified application from the specified entitlement. + +# Arguments +- `application_identifier`: The identifier of the application to remove from the + entitlement. +- `entitlement_name`: The name of the entitlement. +- `stack_name`: The name of the stack with which the entitlement is associated. + +""" +function disassociate_application_from_entitlement( + ApplicationIdentifier, + EntitlementName, + StackName; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appstream( + "DisassociateApplicationFromEntitlement", + Dict{String,Any}( + "ApplicationIdentifier" => ApplicationIdentifier, + "EntitlementName" => EntitlementName, + "StackName" => StackName, + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function disassociate_application_from_entitlement( + ApplicationIdentifier, + EntitlementName, + StackName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appstream( + "DisassociateApplicationFromEntitlement", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "ApplicationIdentifier" => ApplicationIdentifier, + "EntitlementName" => EntitlementName, + "StackName" => StackName, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ disassociate_fleet(fleet_name, stack_name) disassociate_fleet(fleet_name, stack_name, params::Dict{String,<:Any}) @@ -2001,6 +2254,54 @@ function list_associated_stacks( ) end +""" + list_entitled_applications(entitlement_name, stack_name) + list_entitled_applications(entitlement_name, stack_name, params::Dict{String,<:Any}) + +Retrieves a list of entitled applications. + +# Arguments +- `entitlement_name`: The name of the entitlement. +- `stack_name`: The name of the stack with which the entitlement is associated. + +# 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. +- `"NextToken"`: The pagination token used to retrieve the next page of results for this + operation. +""" +function list_entitled_applications( + EntitlementName, StackName; aws_config::AbstractAWSConfig=global_aws_config() +) + return appstream( + "ListEntitledApplications", + Dict{String,Any}("EntitlementName" => EntitlementName, "StackName" => StackName); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function list_entitled_applications( + EntitlementName, + StackName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appstream( + "ListEntitledApplications", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "EntitlementName" => EntitlementName, "StackName" => StackName + ), + 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}) @@ -2333,6 +2634,50 @@ function update_directory_config( ) end +""" + update_entitlement(name, stack_name) + update_entitlement(name, stack_name, params::Dict{String,<:Any}) + +Updates the specified entitlement. + +# Arguments +- `name`: The name of the entitlement. +- `stack_name`: The name of the stack with which the entitlement is associated. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"AppVisibility"`: Specifies whether all or only selected apps are entitled. +- `"Attributes"`: The attributes of the entitlement. +- `"Description"`: The description of the entitlement. +""" +function update_entitlement( + Name, StackName; aws_config::AbstractAWSConfig=global_aws_config() +) + return appstream( + "UpdateEntitlement", + Dict{String,Any}("Name" => Name, "StackName" => StackName); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function update_entitlement( + Name, + StackName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appstream( + "UpdateEntitlement", + Dict{String,Any}( + mergewith( + _merge, Dict{String,Any}("Name" => Name, "StackName" => StackName), params + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ update_fleet() update_fleet(params::Dict{String,<:Any}) diff --git a/src/services/appsync.jl b/src/services/appsync.jl index 1a61b24e23..bafbc1d197 100644 --- a/src/services/appsync.jl +++ b/src/services/appsync.jl @@ -4,6 +4,41 @@ using AWS.AWSServices: appsync using AWS.Compat using AWS.UUIDs +""" + associate_api(api_id, domain_name) + associate_api(api_id, domain_name, params::Dict{String,<:Any}) + +Maps an endpoint to your custom domain. + +# Arguments +- `api_id`: The API ID. +- `domain_name`: The domain name. + +""" +function associate_api(apiId, domainName; aws_config::AbstractAWSConfig=global_aws_config()) + return appsync( + "POST", + "/v1/domainnames/$(domainName)/apiassociation", + Dict{String,Any}("apiId" => apiId); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function associate_api( + apiId, + domainName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appsync( + "POST", + "/v1/domainnames/$(domainName)/apiassociation", + Dict{String,Any}(mergewith(_merge, Dict{String,Any}("apiId" => apiId), params)); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ create_api_cache(api_caching_behavior, api_id, ttl, type) create_api_cache(api_caching_behavior, api_id, ttl, type, params::Dict{String,<:Any}) @@ -13,8 +48,8 @@ Creates a cache for the GraphQL API. # Arguments - `api_caching_behavior`: Caching behavior. FULL_REQUEST_CACHING: All requests are fully cached. PER_RESOLVER_CACHING: Individual resolvers that you specify are cached. -- `api_id`: The GraphQL API Id. -- `ttl`: TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds. +- `api_id`: The GraphQL API ID. +- `ttl`: TTL in seconds for cache entries. Valid values are 1–3,600 seconds. - `type`: The cache instance type. Valid values are SMALL MEDIUM LARGE XLARGE LARGE_2X LARGE_4X LARGE_8X (not available in all regions) LARGE_12X Historically, instance types were identified by an EC2-style value. As of July 2020, this @@ -26,10 +61,10 @@ Creates a cache for the GraphQL API. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"atRestEncryptionEnabled"`: At rest encryption flag for cache. This setting cannot be - updated after creation. -- `"transitEncryptionEnabled"`: Transit encryption flag when connecting to cache. This - setting cannot be updated after creation. +- `"atRestEncryptionEnabled"`: At-rest encryption flag for cache. You cannot update this + setting after creation. +- `"transitEncryptionEnabled"`: Transit encryption flag when connecting to cache. You + cannot update this setting after creation. """ function create_api_cache( apiCachingBehavior, apiId, ttl, type; aws_config::AbstractAWSConfig=global_aws_config() @@ -73,7 +108,7 @@ end create_api_key(api_id) create_api_key(api_id, params::Dict{String,<:Any}) -Creates a unique key that you can distribute to clients who are executing your API. +Creates a unique key that you can distribute to clients who invoke your API. # Arguments - `api_id`: The ID for your GraphQL API. @@ -81,9 +116,9 @@ Creates a unique key that you can distribute to clients who are executing your A # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"description"`: A description of the purpose of the API key. -- `"expires"`: The time from creation time after which the API key expires. The date is - represented as seconds since the epoch, rounded down to the nearest hour. The default value - for this parameter is 7 days from creation time. For more information, see . +- `"expires"`: From the creation time, the time after which the API key expires. The date + is represented as seconds since the epoch, rounded down to the nearest hour. The default + value for this parameter is 7 days from creation time. For more information, see . """ function create_api_key(apiId; aws_config::AbstractAWSConfig=global_aws_config()) return appsync( @@ -125,11 +160,11 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys new data sources, use CreateDataSourceRequestopenSearchServiceConfig to create an OpenSearch data source. - `"httpConfig"`: HTTP endpoint settings. -- `"lambdaConfig"`: Amazon Web Services Lambda settings. +- `"lambdaConfig"`: Lambda settings. - `"openSearchServiceConfig"`: Amazon OpenSearch Service settings. - `"relationalDatabaseConfig"`: Relational database settings. -- `"serviceRoleArn"`: The Identity and Access Management service role ARN for the data - source. The system assumes this role when accessing the data source. +- `"serviceRoleArn"`: The Identity and Access Management (IAM) service role Amazon Resource + Name (ARN) for the data source. The system assumes this role when accessing the data source. """ function create_data_source( apiId, name, type; aws_config::AbstractAWSConfig=global_aws_config() @@ -160,17 +195,67 @@ function create_data_source( ) end +""" + create_domain_name(certificate_arn, domain_name) + create_domain_name(certificate_arn, domain_name, params::Dict{String,<:Any}) + +Creates a custom DomainName object. + +# Arguments +- `certificate_arn`: The Amazon Resource Name (ARN) of the certificate. This can be an + Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server + certificate. +- `domain_name`: The domain name. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"description"`: A description of the DomainName. +""" +function create_domain_name( + certificateArn, domainName; aws_config::AbstractAWSConfig=global_aws_config() +) + return appsync( + "POST", + "/v1/domainnames", + Dict{String,Any}("certificateArn" => certificateArn, "domainName" => domainName); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function create_domain_name( + certificateArn, + domainName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appsync( + "POST", + "/v1/domainnames", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "certificateArn" => certificateArn, "domainName" => domainName + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ create_function(api_id, data_source_name, function_version, name) create_function(api_id, data_source_name, function_version, name, params::Dict{String,<:Any}) -Creates a Function object. A function is a reusable entity. Multiple functions can be used +Creates a Function object. A function is a reusable entity. You can use multiple functions to compose the resolver logic. # Arguments - `api_id`: The GraphQL API ID. - `data_source_name`: The Function DataSource name. -- `function_version`: The version of the request mapping template. Currently the supported +- `function_version`: The version of the request mapping template. Currently, the supported value is 2018-05-29. - `name`: The Function name. The function name does not have to be unique. @@ -235,21 +320,20 @@ end Creates a GraphqlApi object. # Arguments -- `authentication_type`: The authentication type: API key, Identity and Access Management, - OIDC, Amazon Cognito user pools, or Amazon Web Services Lambda. +- `authentication_type`: The authentication type: API key, Identity and Access Management + (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda. - `name`: A user-supplied name for the GraphqlApi. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"additionalAuthenticationProviders"`: A list of additional authentication providers for the GraphqlApi API. -- `"lambdaAuthorizerConfig"`: Configuration for Amazon Web Services Lambda function - authorization. +- `"lambdaAuthorizerConfig"`: Configuration for Lambda function authorization. - `"logConfig"`: The Amazon CloudWatch Logs configuration. -- `"openIDConnectConfig"`: The OpenID Connect configuration. +- `"openIDConnectConfig"`: The OIDC configuration. - `"tags"`: A TagMap object. - `"userPoolConfig"`: The Amazon Cognito user pool configuration. -- `"xrayEnabled"`: A flag indicating whether to enable X-Ray tracing for the GraphqlApi. +- `"xrayEnabled"`: A flag indicating whether to use X-Ray tracing for the GraphqlApi. """ function create_graphql_api( authenticationType, name; aws_config::AbstractAWSConfig=global_aws_config() @@ -290,7 +374,7 @@ end create_resolver(api_id, field_name, type_name, params::Dict{String,<:Any}) Creates a Resolver object. A resolver converts incoming requests into a format that a data -source can understand and converts the data source's responses into GraphQL. +source can understand, and converts the data source's responses into GraphQL. # Arguments - `api_id`: The ID for the GraphQL API for which the resolver is being created. @@ -302,19 +386,19 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"cachingConfig"`: The caching configuration for the resolver. - `"dataSourceName"`: The name of the data source for which the resolver is being created. - `"kind"`: The resolver type. UNIT: A UNIT resolver type. A UNIT resolver is the - default resolver type. A UNIT resolver enables you to execute a GraphQL query against a - single data source. PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you - to execute a series of Function in a serial manner. You can use a pipeline resolver to - execute a GraphQL query against multiple data sources. + default resolver type. You can use a UNIT resolver to run a GraphQL query against a single + data source. PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to + invoke a series of Function objects in a serial manner. You can use a pipeline resolver to + run a GraphQL query against multiple data sources. - `"pipelineConfig"`: The PipelineConfig. -- `"requestMappingTemplate"`: The mapping template to be used for requests. A resolver uses - a request mapping template to convert a GraphQL expression into a format that a data source +- `"requestMappingTemplate"`: The mapping template to use for requests. A resolver uses a + request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL). - VTL request mapping templates are optional when using a Lambda data source. For all other + VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required. -- `"responseMappingTemplate"`: The mapping template to be used for responses from the data +- `"responseMappingTemplate"`: The mapping template to use for responses from the data source. -- `"syncConfig"`: The SyncConfig for a resolver attached to a versioned datasource. +- `"syncConfig"`: The SyncConfig for a resolver attached to a versioned data source. """ function create_resolver( apiId, fieldName, typeName; aws_config::AbstractAWSConfig=global_aws_config() @@ -489,6 +573,38 @@ function delete_data_source( ) end +""" + delete_domain_name(domain_name) + delete_domain_name(domain_name, params::Dict{String,<:Any}) + +Deletes a custom DomainName object. + +# Arguments +- `domain_name`: The domain name. + +""" +function delete_domain_name(domainName; aws_config::AbstractAWSConfig=global_aws_config()) + return appsync( + "DELETE", + "/v1/domainnames/$(domainName)"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function delete_domain_name( + domainName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appsync( + "DELETE", + "/v1/domainnames/$(domainName)", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ delete_function(api_id, function_id) delete_function(api_id, function_id, params::Dict{String,<:Any}) @@ -627,6 +743,38 @@ function delete_type( ) end +""" + disassociate_api(domain_name) + disassociate_api(domain_name, params::Dict{String,<:Any}) + +Removes an ApiAssociation object from a custom domain. + +# Arguments +- `domain_name`: The domain name. + +""" +function disassociate_api(domainName; aws_config::AbstractAWSConfig=global_aws_config()) + return appsync( + "DELETE", + "/v1/domainnames/$(domainName)/apiassociation"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function disassociate_api( + domainName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appsync( + "DELETE", + "/v1/domainnames/$(domainName)/apiassociation", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ flush_api_cache(api_id) flush_api_cache(api_id, params::Dict{String,<:Any}) @@ -657,6 +805,38 @@ function flush_api_cache( ) end +""" + get_api_association(domain_name) + get_api_association(domain_name, params::Dict{String,<:Any}) + +Retrieves an ApiAssociation object. + +# Arguments +- `domain_name`: The domain name. + +""" +function get_api_association(domainName; aws_config::AbstractAWSConfig=global_aws_config()) + return appsync( + "GET", + "/v1/domainnames/$(domainName)/apiassociation"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_api_association( + domainName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appsync( + "GET", + "/v1/domainnames/$(domainName)/apiassociation", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ get_api_cache(api_id) get_api_cache(api_id, params::Dict{String,<:Any}) @@ -721,6 +901,38 @@ function get_data_source( ) end +""" + get_domain_name(domain_name) + get_domain_name(domain_name, params::Dict{String,<:Any}) + +Retrieves a custom DomainName object. + +# Arguments +- `domain_name`: The domain name. + +""" +function get_domain_name(domainName; aws_config::AbstractAWSConfig=global_aws_config()) + return appsync( + "GET", + "/v1/domainnames/$(domainName)"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_domain_name( + domainName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appsync( + "GET", + "/v1/domainnames/$(domainName)", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ get_function(api_id, function_id) get_function(api_id, function_id, params::Dict{String,<:Any}) @@ -946,9 +1158,9 @@ automatically deleted. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"maxResults"`: The maximum number of results you want the request to return. +- `"maxResults"`: The maximum number of results that you want the request to return. - `"nextToken"`: An identifier that was returned from the previous call to this operation, - which can be used to return the next set of items in the list. + which you can use to return the next set of items in the list. """ function list_api_keys(apiId; aws_config::AbstractAWSConfig=global_aws_config()) return appsync( @@ -981,9 +1193,9 @@ Lists the data sources for a given API. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"maxResults"`: The maximum number of results you want the request to return. +- `"maxResults"`: The maximum number of results that you want the request to return. - `"nextToken"`: An identifier that was returned from the previous call to this operation, - which can be used to return the next set of items in the list. + which you can use to return the next set of items in the list. """ function list_data_sources(apiId; aws_config::AbstractAWSConfig=global_aws_config()) return appsync( @@ -1005,6 +1217,34 @@ function list_data_sources( ) end +""" + list_domain_names() + list_domain_names(params::Dict{String,<:Any}) + +Lists multiple custom domain names. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"maxResults"`: The maximum number of results that you want the request to return. +- `"nextToken"`: The API token. +""" +function list_domain_names(; aws_config::AbstractAWSConfig=global_aws_config()) + return appsync( + "GET", "/v1/domainnames"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET + ) +end +function list_domain_names( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return appsync( + "GET", + "/v1/domainnames", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ list_functions(api_id) list_functions(api_id, params::Dict{String,<:Any}) @@ -1016,9 +1256,9 @@ List multiple functions. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"maxResults"`: The maximum number of results you want the request to return. +- `"maxResults"`: The maximum number of results that you want the request to return. - `"nextToken"`: An identifier that was returned from the previous call to this operation, - which can be used to return the next set of items in the list. + which you can use to return the next set of items in the list. """ function list_functions(apiId; aws_config::AbstractAWSConfig=global_aws_config()) return appsync( @@ -1048,9 +1288,9 @@ Lists your GraphQL APIs. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"maxResults"`: The maximum number of results you want the request to return. +- `"maxResults"`: The maximum number of results that you want the request to return. - `"nextToken"`: An identifier that was returned from the previous call to this operation, - which can be used to return the next set of items in the list. + which you can use to return the next set of items in the list. """ function list_graphql_apis(; aws_config::AbstractAWSConfig=global_aws_config()) return appsync( @@ -1077,9 +1317,9 @@ Lists the resolvers for a given API and type. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"maxResults"`: The maximum number of results you want the request to return. +- `"maxResults"`: The maximum number of results that you want the request to return. - `"nextToken"`: An identifier that was returned from the previous call to this operation, - which can be used to return the next set of items in the list. + which you can use to return the next set of items in the list. """ function list_resolvers(apiId, typeName; aws_config::AbstractAWSConfig=global_aws_config()) return appsync( @@ -1112,11 +1352,11 @@ List the resolvers that are associated with a specific function. # Arguments - `api_id`: The API ID. -- `function_id`: The Function ID. +- `function_id`: The function ID. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"maxResults"`: The maximum number of results you want the request to return. +- `"maxResults"`: The maximum number of results that you want the request to return. - `"nextToken"`: An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list. """ @@ -1152,7 +1392,7 @@ end Lists the tags for a resource. # Arguments -- `resource_arn`: The GraphqlApi ARN. +- `resource_arn`: The GraphqlApi Amazon Resource Name (ARN). """ function list_tags_for_resource( @@ -1191,9 +1431,9 @@ Lists the types for a given API. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"maxResults"`: The maximum number of results you want the request to return. +- `"maxResults"`: The maximum number of results that you want the request to return. - `"nextToken"`: An identifier that was returned from the previous call to this operation, - which can be used to return the next set of items in the list. + which you can use to return the next set of items in the list. """ function list_types(apiId, format; aws_config::AbstractAWSConfig=global_aws_config()) return appsync( @@ -1266,7 +1506,7 @@ end Tags a resource with user-supplied tags. # Arguments -- `resource_arn`: The GraphqlApi ARN. +- `resource_arn`: The GraphqlApi Amazon Resource Name (ARN). - `tags`: A TagMap object. """ @@ -1301,7 +1541,7 @@ end Untags a resource. # Arguments -- `resource_arn`: The GraphqlApi ARN. +- `resource_arn`: The GraphqlApi Amazon Resource Name (ARN). - `tag_keys`: A list of TagKey objects. """ @@ -1340,8 +1580,8 @@ Updates the cache for the GraphQL API. # Arguments - `api_caching_behavior`: Caching behavior. FULL_REQUEST_CACHING: All requests are fully cached. PER_RESOLVER_CACHING: Individual resolvers that you specify are cached. -- `api_id`: The GraphQL API Id. -- `ttl`: TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds. +- `api_id`: The GraphQL API ID. +- `ttl`: TTL in seconds for cache entries. Valid values are 1–3,600 seconds. - `type`: The cache instance type. Valid values are SMALL MEDIUM LARGE XLARGE LARGE_2X LARGE_4X LARGE_8X (not available in all regions) LARGE_12X Historically, instance types were identified by an EC2-style value. As of July 2020, this @@ -1394,7 +1634,7 @@ end update_api_key(api_id, id) update_api_key(api_id, id, params::Dict{String,<:Any}) -Updates an API key. The key can be updated while it is not deleted. +Updates an API key. You can update the key as long as it's not deleted. # Arguments - `api_id`: The ID for the GraphQL API. @@ -1403,7 +1643,7 @@ Updates an API key. The key can be updated while it is not deleted. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"description"`: A description of the purpose of the API key. -- `"expires"`: The time from update time after which the API key expires. The date is +- `"expires"`: From the update time, the time after which the API key expires. The date is represented as seconds since the epoch. For more information, see . """ function update_api_key(apiId, id; aws_config::AbstractAWSConfig=global_aws_config()) @@ -1449,10 +1689,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys Instead, use UpdateDataSourceRequestopenSearchServiceConfig to update an OpenSearch data source. - `"httpConfig"`: The new HTTP endpoint configuration. -- `"lambdaConfig"`: The new Amazon Web Services Lambda configuration. +- `"lambdaConfig"`: The new Lambda configuration. - `"openSearchServiceConfig"`: The new OpenSearch configuration. - `"relationalDatabaseConfig"`: The new relational database configuration. -- `"serviceRoleArn"`: The new service role ARN for the data source. +- `"serviceRoleArn"`: The new service role Amazon Resource Name (ARN) for the data source. """ function update_data_source( apiId, name, type; aws_config::AbstractAWSConfig=global_aws_config() @@ -1481,6 +1721,41 @@ function update_data_source( ) end +""" + update_domain_name(domain_name) + update_domain_name(domain_name, params::Dict{String,<:Any}) + +Updates a custom DomainName object. + +# Arguments +- `domain_name`: The domain name. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"description"`: A description of the DomainName. +""" +function update_domain_name(domainName; aws_config::AbstractAWSConfig=global_aws_config()) + return appsync( + "POST", + "/v1/domainnames/$(domainName)"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function update_domain_name( + domainName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return appsync( + "POST", + "/v1/domainnames/$(domainName)", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ update_function(api_id, data_source_name, function_id, function_version, name) update_function(api_id, data_source_name, function_id, function_version, name, params::Dict{String,<:Any}) @@ -1491,7 +1766,7 @@ Updates a Function object. - `api_id`: The GraphQL API ID. - `data_source_name`: The Function DataSource name. - `function_id`: The function ID. -- `function_version`: The version of the request mapping template. Currently the supported +- `function_version`: The version of the request mapping template. Currently, the supported value is 2018-05-29. - `name`: The Function name. @@ -1566,13 +1841,12 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"additionalAuthenticationProviders"`: A list of additional authentication providers for the GraphqlApi API. - `"authenticationType"`: The new authentication type for the GraphqlApi object. -- `"lambdaAuthorizerConfig"`: Configuration for Amazon Web Services Lambda function - authorization. +- `"lambdaAuthorizerConfig"`: Configuration for Lambda function authorization. - `"logConfig"`: The Amazon CloudWatch Logs configuration for the GraphqlApi object. - `"openIDConnectConfig"`: The OpenID Connect configuration for the GraphqlApi object. -- `"userPoolConfig"`: The new Amazon Cognito user pool configuration for the GraphqlApi +- `"userPoolConfig"`: The new Amazon Cognito user pool configuration for the ~GraphqlApi object. -- `"xrayEnabled"`: A flag indicating whether to enable X-Ray tracing for the GraphqlApi. +- `"xrayEnabled"`: A flag indicating whether to use X-Ray tracing for the GraphqlApi. """ function update_graphql_api(apiId, name; aws_config::AbstractAWSConfig=global_aws_config()) return appsync( @@ -1614,18 +1888,18 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"cachingConfig"`: The caching configuration for the resolver. - `"dataSourceName"`: The new data source name. - `"kind"`: The resolver type. UNIT: A UNIT resolver type. A UNIT resolver is the - default resolver type. A UNIT resolver enables you to execute a GraphQL query against a - single data source. PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you - to execute a series of Function in a serial manner. You can use a pipeline resolver to - execute a GraphQL query against multiple data sources. + default resolver type. You can use a UNIT resolver to run a GraphQL query against a single + data source. PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to + invoke a series of Function objects in a serial manner. You can use a pipeline resolver to + run a GraphQL query against multiple data sources. - `"pipelineConfig"`: The PipelineConfig. - `"requestMappingTemplate"`: The new request mapping template. A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL). VTL - request mapping templates are optional when using a Lambda data source. For all other data + request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required. - `"responseMappingTemplate"`: The new response mapping template. -- `"syncConfig"`: The SyncConfig for a resolver attached to a versioned datasource. +- `"syncConfig"`: The SyncConfig for a resolver attached to a versioned data source. """ function update_resolver( apiId, fieldName, typeName; aws_config::AbstractAWSConfig=global_aws_config() diff --git a/src/services/chime_sdk_messaging.jl b/src/services/chime_sdk_messaging.jl index 46d9a2278c..32aed7c8b3 100644 --- a/src/services/chime_sdk_messaging.jl +++ b/src/services/chime_sdk_messaging.jl @@ -1561,9 +1561,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"max-results"`: The maximum number of channel memberships that you want returned. - `"next-token"`: The token passed by previous API calls until all requested channel memberships are returned. -- `"type"`: The membership type of a user, DEFAULT or HIDDEN. Default members are always - returned as part of ListChannelMemberships. Hidden members are only returned if the type - filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. +- `"type"`: The membership type of a user, DEFAULT or HIDDEN. Default members are returned + as part of ListChannelMemberships if no type is specified. Hidden members are only returned + if the type filter in ListChannelMemberships equals HIDDEN. """ function list_channel_memberships( channelArn, x_amz_chime_bearer; aws_config::AbstractAWSConfig=global_aws_config() diff --git a/src/services/cloudtrail.jl b/src/services/cloudtrail.jl index 899193a3a3..86da23389f 100644 --- a/src/services/cloudtrail.jl +++ b/src/services/cloudtrail.jl @@ -5,8 +5,8 @@ using AWS.Compat using AWS.UUIDs """ - add_tags(resource_id) - add_tags(resource_id, params::Dict{String,<:Any}) + add_tags(resource_id, tags_list) + add_tags(resource_id, tags_list, params::Dict{String,<:Any}) Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a @@ -18,34 +18,127 @@ which the trail was created (also known as its home region). # Arguments - `resource_id`: Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail +- `tags_list`: Contains a list of tags, up to a limit of 50 -# Optional Parameters -Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"TagsList"`: Contains a list of tags, up to a limit of 50 """ -function add_tags(ResourceId; aws_config::AbstractAWSConfig=global_aws_config()) +function add_tags(ResourceId, TagsList; aws_config::AbstractAWSConfig=global_aws_config()) return cloudtrail( "AddTags", - Dict{String,Any}("ResourceId" => ResourceId); + Dict{String,Any}("ResourceId" => ResourceId, "TagsList" => TagsList); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) end function add_tags( ResourceId, + TagsList, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config(), ) return cloudtrail( "AddTags", Dict{String,Any}( - mergewith(_merge, Dict{String,Any}("ResourceId" => ResourceId), params) + mergewith( + _merge, + Dict{String,Any}("ResourceId" => ResourceId, "TagsList" => TagsList), + params, + ), ); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) end +""" + cancel_query(event_data_store, query_id) + cancel_query(event_data_store, query_id, params::Dict{String,<:Any}) + +Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED or +FINISHED. You must specify an ARN value for EventDataStore. The ID of the query that you +want to cancel is also required. When you run CancelQuery, the query status might show as +CANCELLED even if the operation is not yet finished. + +# Arguments +- `event_data_store`: The ARN (or the ID suffix of the ARN) of an event data store on which + the specified query is running. +- `query_id`: The ID of the query that you want to cancel. The QueryId comes from the + response of a StartQuery operation. + +""" +function cancel_query( + EventDataStore, QueryId; aws_config::AbstractAWSConfig=global_aws_config() +) + return cloudtrail( + "CancelQuery", + Dict{String,Any}("EventDataStore" => EventDataStore, "QueryId" => QueryId); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function cancel_query( + EventDataStore, + QueryId, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return cloudtrail( + "CancelQuery", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}("EventDataStore" => EventDataStore, "QueryId" => QueryId), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + create_event_data_store(name) + create_event_data_store(name, params::Dict{String,<:Any}) + +Creates a new event data store. + +# Arguments +- `name`: The name of the event data store. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"AdvancedEventSelectors"`: The advanced event selectors to use to select the events for + the data store. For more information about how to use advanced event selectors, see Log + events by using advanced event selectors in the CloudTrail User Guide. +- `"MultiRegionEnabled"`: Specifies whether the event data store includes events from all + regions, or only from the region in which the event data store is created. +- `"OrganizationEnabled"`: Specifies whether an event data store collects events logged for + an organization in Organizations. +- `"RetentionPeriod"`: The retention period of the event data store, in days. You can set a + retention period of up to 2555 days, the equivalent of seven years. +- `"TagsList"`: +- `"TerminationProtectionEnabled"`: Specifies whether termination protection is enabled for + the event data store. If termination protection is enabled, you cannot delete the event + data store until termination protection is disabled. +""" +function create_event_data_store(Name; aws_config::AbstractAWSConfig=global_aws_config()) + return cloudtrail( + "CreateEventDataStore", + Dict{String,Any}("Name" => Name); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function create_event_data_store( + Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return cloudtrail( + "CreateEventDataStore", + Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params)); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ create_trail(name, s3_bucket_name) create_trail(name, s3_bucket_name, params::Dict{String,<:Any}) @@ -130,6 +223,48 @@ function create_trail( ) end +""" + delete_event_data_store(event_data_store) + delete_event_data_store(event_data_store, params::Dict{String,<:Any}) + +Disables the event data store specified by EventDataStore, which accepts an event data +store ARN. After you run DeleteEventDataStore, the event data store is automatically +deleted after a wait period of seven days. TerminationProtectionEnabled must be set to +False on the event data store; this operation cannot work if TerminationProtectionEnabled +is True. After you run DeleteEventDataStore on an event data store, you cannot run +ListQueries, DescribeQuery, or GetQueryResults on queries that are using an event data +store in a PENDING_DELETION state. + +# Arguments +- `event_data_store`: The ARN (or the ID suffix of the ARN) of the event data store to + delete. + +""" +function delete_event_data_store( + EventDataStore; aws_config::AbstractAWSConfig=global_aws_config() +) + return cloudtrail( + "DeleteEventDataStore", + Dict{String,Any}("EventDataStore" => EventDataStore); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function delete_event_data_store( + EventDataStore, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return cloudtrail( + "DeleteEventDataStore", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("EventDataStore" => EventDataStore), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ delete_trail(name) delete_trail(name, params::Dict{String,<:Any}) @@ -163,6 +298,50 @@ function delete_trail( ) end +""" + describe_query(event_data_store, query_id) + describe_query(event_data_store, query_id, params::Dict{String,<:Any}) + +Returns metadata about a query, including query run time in milliseconds, number of events +scanned and matched, and query status. You must specify an ARN for EventDataStore, and a +value for QueryID. + +# Arguments +- `event_data_store`: The ARN (or the ID suffix of the ARN) of an event data store on which + the specified query was run. +- `query_id`: The query ID. + +""" +function describe_query( + EventDataStore, QueryId; aws_config::AbstractAWSConfig=global_aws_config() +) + return cloudtrail( + "DescribeQuery", + Dict{String,Any}("EventDataStore" => EventDataStore, "QueryId" => QueryId); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function describe_query( + EventDataStore, + QueryId, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return cloudtrail( + "DescribeQuery", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}("EventDataStore" => EventDataStore, "QueryId" => QueryId), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ describe_trails() describe_trails(params::Dict{String,<:Any}) @@ -202,6 +381,43 @@ function describe_trails( ) end +""" + get_event_data_store(event_data_store) + get_event_data_store(event_data_store, params::Dict{String,<:Any}) + +Returns information about an event data store specified as either an ARN or the ID portion +of the ARN. + +# Arguments +- `event_data_store`: The ARN (or ID suffix of the ARN) of the event data store about which + you want information. + +""" +function get_event_data_store( + EventDataStore; aws_config::AbstractAWSConfig=global_aws_config() +) + return cloudtrail( + "GetEventDataStore", + Dict{String,Any}("EventDataStore" => EventDataStore); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_event_data_store( + EventDataStore, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return cloudtrail( + "GetEventDataStore", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("EventDataStore" => EventDataStore), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ get_event_selectors(trail_name) get_event_selectors(trail_name, params::Dict{String,<:Any}) @@ -291,6 +507,53 @@ function get_insight_selectors( ) end +""" + get_query_results(event_data_store, query_id) + get_query_results(event_data_store, query_id, params::Dict{String,<:Any}) + +Gets event data results of a query. You must specify the QueryID value returned by the +StartQuery operation, and an ARN for EventDataStore. + +# Arguments +- `event_data_store`: The ARN (or ID suffix of the ARN) of the event data store against + which the query was run. +- `query_id`: The ID of the query for which you want to get results. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"MaxQueryResults"`: The maximum number of query results to display on a single page. +- `"NextToken"`: A token you can use to get the next page of query results. +""" +function get_query_results( + EventDataStore, QueryId; aws_config::AbstractAWSConfig=global_aws_config() +) + return cloudtrail( + "GetQueryResults", + Dict{String,Any}("EventDataStore" => EventDataStore, "QueryId" => QueryId); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_query_results( + EventDataStore, + QueryId, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return cloudtrail( + "GetQueryResults", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}("EventDataStore" => EventDataStore, "QueryId" => QueryId), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ get_trail(name) get_trail(name, params::Dict{String,<:Any}) @@ -356,6 +619,33 @@ function get_trail_status( ) end +""" + list_event_data_stores() + list_event_data_stores(params::Dict{String,<:Any}) + +Returns information about all event data stores in the account, in the current region. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"MaxResults"`: The maximum number of event data stores to display on a single page. +- `"NextToken"`: A token you can use to get the next page of event data store results. +""" +function list_event_data_stores(; aws_config::AbstractAWSConfig=global_aws_config()) + return cloudtrail( + "ListEventDataStores"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET + ) +end +function list_event_data_stores( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return cloudtrail( + "ListEventDataStores", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ list_public_keys() list_public_keys(params::Dict{String,<:Any}) @@ -389,6 +679,54 @@ function list_public_keys( ) end +""" + list_queries(event_data_store) + list_queries(event_data_store, params::Dict{String,<:Any}) + +Returns a list of queries and query statuses for the past seven days. You must specify an +ARN value for EventDataStore. Optionally, to shorten the list of results, you can specify a +time range, formatted as timestamps, by adding StartTime and EndTime parameters, and a +QueryStatus value. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, +or CANCELLED. + +# Arguments +- `event_data_store`: The ARN (or the ID suffix of the ARN) of an event data store on which + queries were run. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"EndTime"`: Use with StartTime to bound a ListQueries request, and limit its results to + only those queries run within a specified time period. +- `"MaxResults"`: The maximum number of queries to show on a page. +- `"NextToken"`: A token you can use to get the next page of results. +- `"QueryStatus"`: The status of queries that you want to return in results. Valid values + for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, or CANCELLED. +- `"StartTime"`: Use with EndTime to bound a ListQueries request, and limit its results to + only those queries run within a specified time period. +""" +function list_queries(EventDataStore; aws_config::AbstractAWSConfig=global_aws_config()) + return cloudtrail( + "ListQueries", + Dict{String,Any}("EventDataStore" => EventDataStore); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function list_queries( + EventDataStore, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return cloudtrail( + "ListQueries", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("EventDataStore" => EventDataStore), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ list_tags(resource_id_list) list_tags(resource_id_list, params::Dict{String,<:Any}) @@ -575,12 +913,12 @@ end Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. You also use PutInsightSelectors to turn off Insights event -logging, by passing an empty list of insight types. The valid Insights event type in this -release is ApiCallRateInsight. +logging, by passing an empty list of insight types. The valid Insights event types in this +release are ApiErrorRateInsight and ApiCallRateInsight. # Arguments -- `insight_selectors`: A JSON string that contains the Insights types that you want to log - on a trail. The valid Insights type in this release is ApiCallRateInsight. +- `insight_selectors`: A JSON string that contains the insight types you want to log on a + trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types. - `trail_name`: The name of the CloudTrail trail for which you want to change or add Insights selectors. @@ -618,36 +956,80 @@ function put_insight_selectors( end """ - remove_tags(resource_id) - remove_tags(resource_id, params::Dict{String,<:Any}) + remove_tags(resource_id, tags_list) + remove_tags(resource_id, tags_list, params::Dict{String,<:Any}) Removes the specified tags from a trail. # Arguments - `resource_id`: Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail +- `tags_list`: Specifies a list of tags to be removed. -# Optional Parameters -Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"TagsList"`: Specifies a list of tags to be removed. """ -function remove_tags(ResourceId; aws_config::AbstractAWSConfig=global_aws_config()) +function remove_tags( + ResourceId, TagsList; aws_config::AbstractAWSConfig=global_aws_config() +) return cloudtrail( "RemoveTags", - Dict{String,Any}("ResourceId" => ResourceId); + Dict{String,Any}("ResourceId" => ResourceId, "TagsList" => TagsList); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) end function remove_tags( ResourceId, + TagsList, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config(), ) return cloudtrail( "RemoveTags", Dict{String,Any}( - mergewith(_merge, Dict{String,Any}("ResourceId" => ResourceId), params) + mergewith( + _merge, + Dict{String,Any}("ResourceId" => ResourceId, "TagsList" => TagsList), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + restore_event_data_store(event_data_store) + restore_event_data_store(event_data_store, params::Dict{String,<:Any}) + +Restores a deleted event data store specified by EventDataStore, which accepts an event +data store ARN. You can only restore a deleted event data store within the seven-day wait +period after deletion. Restoring an event data store can take several minutes, depending on +the size of the event data store. + +# Arguments +- `event_data_store`: The ARN (or the ID suffix of the ARN) of the event data store that + you want to restore. + +""" +function restore_event_data_store( + EventDataStore; aws_config::AbstractAWSConfig=global_aws_config() +) + return cloudtrail( + "RestoreEventDataStore", + Dict{String,Any}("EventDataStore" => EventDataStore); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function restore_event_data_store( + EventDataStore, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return cloudtrail( + "RestoreEventDataStore", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("EventDataStore" => EventDataStore), params) ); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, @@ -688,6 +1070,40 @@ function start_logging( ) end +""" + start_query(query_statement) + start_query(query_statement, params::Dict{String,<:Any}) + +Starts a CloudTrail Lake query. The required QueryStatement parameter provides your SQL +query, enclosed in single quotation marks. + +# Arguments +- `query_statement`: The SQL code of your query. + +""" +function start_query(QueryStatement; aws_config::AbstractAWSConfig=global_aws_config()) + return cloudtrail( + "StartQuery", + Dict{String,Any}("QueryStatement" => QueryStatement); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function start_query( + QueryStatement, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return cloudtrail( + "StartQuery", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("QueryStatement" => QueryStatement), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ stop_logging(name) stop_logging(name, params::Dict{String,<:Any}) @@ -725,6 +1141,60 @@ function stop_logging( ) end +""" + update_event_data_store(event_data_store) + update_event_data_store(event_data_store, params::Dict{String,<:Any}) + +Updates an event data store. The required EventDataStore value is an ARN or the ID portion +of the ARN. Other parameters are optional, but at least one optional parameter must be +specified, or CloudTrail throws an error. RetentionPeriod is in days, and valid values are +integers between 90 and 2555. By default, TerminationProtection is enabled. +AdvancedEventSelectors includes or excludes management and data events in your event data +store; for more information about AdvancedEventSelectors, see +PutEventSelectorsRequestAdvancedEventSelectors. + +# Arguments +- `event_data_store`: The ARN (or the ID suffix of the ARN) of the event data store that + you want to update. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"AdvancedEventSelectors"`: The advanced event selectors used to select events for the + event data store. +- `"MultiRegionEnabled"`: Specifies whether an event data store collects events from all + regions, or only from the region in which it was created. +- `"Name"`: The event data store name. +- `"OrganizationEnabled"`: Specifies whether an event data store collects events logged for + an organization in Organizations. +- `"RetentionPeriod"`: The retention period, in days. +- `"TerminationProtectionEnabled"`: Indicates that termination protection is enabled and + the event data store cannot be automatically deleted. +""" +function update_event_data_store( + EventDataStore; aws_config::AbstractAWSConfig=global_aws_config() +) + return cloudtrail( + "UpdateEventDataStore", + Dict{String,Any}("EventDataStore" => EventDataStore); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function update_event_data_store( + EventDataStore, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return cloudtrail( + "UpdateEventDataStore", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("EventDataStore" => EventDataStore), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ update_trail(name) update_trail(name, params::Dict{String,<:Any}) diff --git a/src/services/cloudwatch_logs.jl b/src/services/cloudwatch_logs.jl index 17912f11fe..e45f677de2 100644 --- a/src/services/cloudwatch_logs.jl +++ b/src/services/cloudwatch_logs.jl @@ -1305,6 +1305,16 @@ aws:PrincipalOrgId global key. their log events to the associated destination. This can be up to 5120 bytes. - `destination_name`: A name for an existing destination. +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"forceUpdate"`: Specify true if you are updating an existing destination policy to grant + permission to an organization ID instead of granting permission to individual AWS accounts. + Before you update a destination policy this way, you must first update the subscription + filters in the accounts that send logs to this destination. If you do not, the subscription + filters might stop working. By specifying true for forceUpdate, you are affirming that you + have already updated the subscription filters. For more information, see Updating an + existing cross-account subscription If you omit this parameter, the default of false is + used. """ function put_destination_policy( accessPolicy, destinationName; aws_config::AbstractAWSConfig=global_aws_config() @@ -1571,9 +1581,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys ARN of your CloudWatch Logs resource, such as a log group or log stream. CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys. In the example resource policy, you would replace the value of SourceArn with the resource making the call - from Route 53 to CloudWatch Logs and replace the value of SourceAccount with the Amazon Web - Services account ID making that call. { \"Version\": \"2012-10-17\", \"Statement\": [ { - \"Sid\": \"Route53LogsToCloudWatchLogs\", \"Effect\": \"Allow\", \"Principal\": { + from Route 53 to CloudWatch Logs and replace the value of SourceAccount with the Amazon + Web Services account ID making that call. { \"Version\": \"2012-10-17\", \"Statement\": [ + { \"Sid\": \"Route53LogsToCloudWatchLogs\", \"Effect\": \"Allow\", \"Principal\": { \"Service\": [ \"route53.amazonaws.com\" ] }, \"Action\": \"logs:PutLogEvents\", \"Resource\": \"logArn\", \"Condition\": { \"ArnLike\": { \"aws:SourceArn\": \"myRoute53ResourceArn\" }, \"StringEquals\": { \"aws:SourceAccount\": \"myAwsAccountId\" } diff --git a/src/services/comprehendmedical.jl b/src/services/comprehendmedical.jl index 038464bacf..e914442548 100644 --- a/src/services/comprehendmedical.jl +++ b/src/services/comprehendmedical.jl @@ -12,7 +12,7 @@ Gets the properties associated with a medical entities detection job. Use this o get the status of a detection job. # Arguments -- `job_id`: The identifier that Amazon Comprehend Medical generated for the job. The +- `job_id`: The identifier that Comprehend Medical; generated for the job. The StartEntitiesDetectionV2Job operation returns this identifier in its response. """ @@ -78,7 +78,7 @@ Gets the properties associated with a protected health information (PHI) detecti this operation to get the status of a detection job. # Arguments -- `job_id`: The identifier that Amazon Comprehend Medical generated for the job. The +- `job_id`: The identifier that Comprehend Medical; generated for the job. The StartPHIDetectionJob operation returns this identifier in its response. """ @@ -134,6 +134,39 @@ function describe_rx_norm_inference_job( ) end +""" + describe_snomedctinference_job(job_id) + describe_snomedctinference_job(job_id, params::Dict{String,<:Any}) + + Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the +status of an inference job. + +# Arguments +- `job_id`: The identifier that Amazon Comprehend Medical generated for the job. The + StartSNOMEDCTInferenceJob operation returns this identifier in its response. + +""" +function describe_snomedctinference_job( + JobId; aws_config::AbstractAWSConfig=global_aws_config() +) + return comprehendmedical( + "DescribeSNOMEDCTInferenceJob", + Dict{String,Any}("JobId" => JobId); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function describe_snomedctinference_job( + JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return comprehendmedical( + "DescribeSNOMEDCTInferenceJob", + Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params)); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ detect_entities(text) detect_entities(text, params::Dict{String,<:Any}) @@ -302,6 +335,37 @@ function infer_rx_norm( ) end +""" + infer_snomedct(text) + infer_snomedct(text, params::Dict{String,<:Any}) + + InferSNOMEDCT detects possible medical concepts as entities and links them to codes from +the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology + +# Arguments +- `text`: The input text to be analyzed using InferSNOMEDCT. The text should be a string + with 1 to 10000 characters. + +""" +function infer_snomedct(Text; aws_config::AbstractAWSConfig=global_aws_config()) + return comprehendmedical( + "InferSNOMEDCT", + Dict{String,Any}("Text" => Text); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function infer_snomedct( + Text, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return comprehendmedical( + "InferSNOMEDCT", + Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Text" => Text), params)); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ list_entities_detection_v2_jobs() list_entities_detection_v2_jobs(params::Dict{String,<:Any}) @@ -426,6 +490,35 @@ function list_rx_norm_inference_jobs( ) end +""" + list_snomedctinference_jobs() + list_snomedctinference_jobs(params::Dict{String,<:Any}) + + Gets a list of InferSNOMEDCT jobs a user has submitted. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"Filter"`: +- `"MaxResults"`: The maximum number of results to return in each page. The default is + 100. +- `"NextToken"`: Identifies the next page of InferSNOMEDCT results to return. +""" +function list_snomedctinference_jobs(; aws_config::AbstractAWSConfig=global_aws_config()) + return comprehendmedical( + "ListSNOMEDCTInferenceJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET + ) +end +function list_snomedctinference_jobs( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return comprehendmedical( + "ListSNOMEDCTInferenceJobs", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ start_entities_detection_v2_job(data_access_role_arn, input_data_config, language_code, output_data_config) start_entities_detection_v2_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any}) @@ -435,17 +528,19 @@ DescribeEntitiesDetectionV2Job operation to track the status of a job. # Arguments - `data_access_role_arn`: The Amazon Resource Name (ARN) of the AWS Identity and Access - Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. - For more information, see Role-Based Permissions Required for Asynchronous Operations. -- `input_data_config`: Specifies the format and location of the input data for the job. + Management (IAM) role that grants Comprehend Medical; read access to your input data. For + more information, see Role-Based Permissions Required for Asynchronous Operations. +- `input_data_config`: The input configuration that specifies the format and location of + the input data for the job. - `language_code`: The language of the input documents. All documents must be in the same - language. -- `output_data_config`: Specifies where to send the output files. + language. Comprehend Medical; processes files in US English (en). +- `output_data_config`: The output configuration that specifies where to send the output + files. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client - request token, Amazon Comprehend Medical generates one. + request token, Comprehend Medical; generates one for you. - `"JobName"`: The identifier of the job. - `"KMSKey"`: An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text. @@ -507,8 +602,8 @@ ontology. Use the DescribeICD10CMInferenceJob operation to track the status of a # Arguments - `data_access_role_arn`: The Amazon Resource Name (ARN) of the AWS Identity and Access - Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. - For more information, see Role-Based Permissions Required for Asynchronous Operations. + Management (IAM) role that grants Comprehend Medical; read access to your input data. For + more information, see Role-Based Permissions Required for Asynchronous Operations. - `input_data_config`: Specifies the format and location of the input data for the job. - `language_code`: The language of the input documents. All documents must be in the same language. @@ -517,7 +612,7 @@ ontology. Use the DescribeICD10CMInferenceJob operation to track the status of a # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client - request token, Amazon Comprehend Medical generates one. + request token, Comprehend Medical; generates one. - `"JobName"`: The identifier of the job. - `"KMSKey"`: An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text. @@ -579,8 +674,8 @@ DescribePHIDetectionJob operation to track the status of a job. # Arguments - `data_access_role_arn`: The Amazon Resource Name (ARN) of the AWS Identity and Access - Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. - For more information, see Role-Based Permissions Required for Asynchronous Operations. + Management (IAM) role that grants Comprehend Medical; read access to your input data. For + more information, see Role-Based Permissions Required for Asynchronous Operations. - `input_data_config`: Specifies the format and location of the input data for the job. - `language_code`: The language of the input documents. All documents must be in the same language. @@ -589,7 +684,7 @@ DescribePHIDetectionJob operation to track the status of a job. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client - request token, Amazon Comprehend Medical generates one. + request token, Comprehend Medical; generates one. - `"JobName"`: The identifier of the job. - `"KMSKey"`: An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text. @@ -651,8 +746,8 @@ ontology. Use the DescribeRxNormInferenceJob operation to track the status of a # Arguments - `data_access_role_arn`: The Amazon Resource Name (ARN) of the AWS Identity and Access - Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. - For more information, see Role-Based Permissions Required for Asynchronous Operations. + Management (IAM) role that grants Comprehend Medical; read access to your input data. For + more information, see Role-Based Permissions Required for Asynchronous Operations. - `input_data_config`: Specifies the format and location of the input data for the job. - `language_code`: The language of the input documents. All documents must be in the same language. @@ -661,7 +756,7 @@ ontology. Use the DescribeRxNormInferenceJob operation to track the status of a # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client - request token, Amazon Comprehend Medical generates one. + request token, Comprehend Medical; generates one. - `"JobName"`: The identifier of the job. - `"KMSKey"`: An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text. @@ -714,6 +809,77 @@ function start_rx_norm_inference_job( ) end +""" + start_snomedctinference_job(data_access_role_arn, input_data_config, language_code, output_data_config) + start_snomedctinference_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any}) + + Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT +ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job. + +# Arguments +- `data_access_role_arn`: The Amazon Resource Name (ARN) of the AWS Identity and Access + Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. +- `input_data_config`: +- `language_code`: The language of the input documents. All documents must be in the same + language. +- `output_data_config`: + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client + request token, Amazon Comprehend Medical generates one. +- `"JobName"`: The user generated name the asynchronous InferSNOMEDCT job. +- `"KMSKey"`: An AWS Key Management Service key used to encrypt your output files. If you + do not specify a key, the files are written in plain text. +""" +function start_snomedctinference_job( + DataAccessRoleArn, + InputDataConfig, + LanguageCode, + OutputDataConfig; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return comprehendmedical( + "StartSNOMEDCTInferenceJob", + Dict{String,Any}( + "DataAccessRoleArn" => DataAccessRoleArn, + "InputDataConfig" => InputDataConfig, + "LanguageCode" => LanguageCode, + "OutputDataConfig" => OutputDataConfig, + "ClientRequestToken" => string(uuid4()), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function start_snomedctinference_job( + DataAccessRoleArn, + InputDataConfig, + LanguageCode, + OutputDataConfig, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return comprehendmedical( + "StartSNOMEDCTInferenceJob", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "DataAccessRoleArn" => DataAccessRoleArn, + "InputDataConfig" => InputDataConfig, + "LanguageCode" => LanguageCode, + "OutputDataConfig" => OutputDataConfig, + "ClientRequestToken" => string(uuid4()), + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ stop_entities_detection_v2_job(job_id) stop_entities_detection_v2_job(job_id, params::Dict{String,<:Any}) @@ -835,3 +1001,34 @@ function stop_rx_norm_inference_job( feature_set=SERVICE_FEATURE_SET, ) end + +""" + stop_snomedctinference_job(job_id) + stop_snomedctinference_job(job_id, params::Dict{String,<:Any}) + + Stops an InferSNOMEDCT inference job in progress. + +# Arguments +- `job_id`: The job id of the asynchronous InferSNOMEDCT job to be stopped. + +""" +function stop_snomedctinference_job( + JobId; aws_config::AbstractAWSConfig=global_aws_config() +) + return comprehendmedical( + "StopSNOMEDCTInferenceJob", + Dict{String,Any}("JobId" => JobId); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function stop_snomedctinference_job( + JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return comprehendmedical( + "StopSNOMEDCTInferenceJob", + Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params)); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end diff --git a/src/services/customer_profiles.jl b/src/services/customer_profiles.jl index 34c661808e..b0368191da 100644 --- a/src/services/customer_profiles.jl +++ b/src/services/customer_profiles.jl @@ -623,23 +623,22 @@ end get_matches(domain_name) get_matches(domain_name, params::Dict{String,<:Any}) -This API is in preview release for Amazon Connect and subject to change. Before calling -this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to -true. GetMatches returns potentially matching profiles, based on the results of the latest -run of a machine learning process. The process of matching duplicate profiles. If -Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called -Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job -to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your -domains. After the Identity Resolution Job completes, use the GetMatches API to return and -review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you -can download the results from S3. Amazon Connect uses the following profile attributes to -identify matches: PhoneNumber HomePhoneNumber BusinessPhoneNumber MobilePhoneNumber - EmailAddress PersonalEmailAddress BusinessEmailAddress FullName BusinessName -For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or -different casing email addresses such as JOHN_DOE@ANYCOMPANY.COM and -johndoe@anycompany.com, or different phone number formats such as 555-010-0000 and -+1-555-010-0000—can be detected as belonging to the same customer John Doe and merged -into a unified profile. +Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: +set Matching to true. GetMatches returns potentially matching profiles, based on the +results of the latest run of a machine learning process. The process of matching +duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly +batch process called Identity Resolution Job. If you do not specify a date and time for +Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect +duplicate profiles in your domains. After the Identity Resolution Job completes, use the +GetMatches API to return and review the results. Or, if you have configured ExportingConfig +in the MatchingRequest, you can download the results from S3. Amazon Connect uses the +following profile attributes to identify matches: PhoneNumber HomePhoneNumber +BusinessPhoneNumber MobilePhoneNumber EmailAddress PersonalEmailAddress +BusinessEmailAddress FullName BusinessName For example, two or more profiles—with +spelling mistakes such as John Doe and Jhn Doe, or different casing email addresses such as +JOHN_DOE@ANYCOMPANY.COM and johndoe@anycompany.com, or different phone number formats such +as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer +John Doe and merged into a unified profile. # Arguments - `domain_name`: The unique name of the domain. @@ -958,7 +957,8 @@ Returns a list of objects associated with a profile of a given ProfileObjectType # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"ObjectFilter"`: Applies a filter to the response to include profile objects with the - specified index values. This filter is only supported for ObjectTypeName _asset and _case. + specified index values. This filter is only supported for ObjectTypeName _asset, _case and + _order. - `"max-results"`: The maximum number of objects returned per page. - `"next-token"`: The pagination token from the previous call to ListProfileObjects. """ @@ -1036,18 +1036,18 @@ end merge_profiles(domain_name, main_profile_id, profile_ids_to_be_merged) merge_profiles(domain_name, main_profile_id, profile_ids_to_be_merged, params::Dict{String,<:Any}) -This API is in preview release for Amazon Connect and subject to change. Runs an AWS Lambda -job that does the following: All the profileKeys in the ProfileToBeMerged will be moved -to the main profile. All the objects in the ProfileToBeMerged will be moved to the main -profile. All the ProfileToBeMerged will be deleted at the end. All the profileKeys in -the ProfileIdsToBeMerged will be moved to the main profile. Standard fields are merged as -follows: Fields are always \"union\"-ed if there are no conflicts in standard fields or -attributeKeys. When there are conflicting fields: If no SourceProfileIds entry is -specified, the main Profile value is always taken. If a SourceProfileIds entry is -specified, the specified profileId is always taken, even if it is a NULL value. You -can use MergeProfiles together with GetMatches, which returns potentially matching -profiles, or use it with the results of another matching system. After profiles have been -merged, they cannot be separated (unmerged). +Runs an AWS Lambda job that does the following: All the profileKeys in the +ProfileToBeMerged will be moved to the main profile. All the objects in the +ProfileToBeMerged will be moved to the main profile. All the ProfileToBeMerged will be +deleted at the end. All the profileKeys in the ProfileIdsToBeMerged will be moved to the +main profile. Standard fields are merged as follows: Fields are always \"union\"-ed if +there are no conflicts in standard fields or attributeKeys. When there are conflicting +fields: If no SourceProfileIds entry is specified, the main Profile value is always +taken. If a SourceProfileIds entry is specified, the specified profileId is always +taken, even if it is a NULL value. You can use MergeProfiles together with +GetMatches, which returns potentially matching profiles, or use it with the results of +another matching system. After profiles have been merged, they cannot be separated +(unmerged). # Arguments - `domain_name`: The unique name of the domain. @@ -1103,46 +1103,45 @@ function merge_profiles( end """ - put_integration(domain_name, object_type_name) - put_integration(domain_name, object_type_name, params::Dict{String,<:Any}) + put_integration(domain_name) + put_integration(domain_name, params::Dict{String,<:Any}) Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect. An integration can belong to only one domain. # Arguments - `domain_name`: The unique name of the domain. -- `object_type_name`: The name of the profile object type. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"FlowDefinition"`: The configuration that controls how Customer Profiles retrieves data from the source. +- `"ObjectTypeName"`: The name of the profile object type. +- `"ObjectTypeNames"`: A map in which each key is an event type from an external + application such as Segment or Shopify, and each value is an ObjectTypeName (template) used + to ingest the event. It supports the following event types: SegmentIdentify, + ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, + ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders. - `"Tags"`: The tags used to organize, track, or control access for this resource. - `"Uri"`: The URI of the S3 bucket or any other type of data source. """ -function put_integration( - DomainName, ObjectTypeName; aws_config::AbstractAWSConfig=global_aws_config() -) +function put_integration(DomainName; aws_config::AbstractAWSConfig=global_aws_config()) return customer_profiles( "PUT", - "/domains/$(DomainName)/integrations", - Dict{String,Any}("ObjectTypeName" => ObjectTypeName); + "/domains/$(DomainName)/integrations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) end function put_integration( DomainName, - ObjectTypeName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config(), ) return customer_profiles( "PUT", "/domains/$(DomainName)/integrations", - Dict{String,Any}( - mergewith(_merge, Dict{String,Any}("ObjectTypeName" => ObjectTypeName), params) - ); + params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) @@ -1270,9 +1269,11 @@ address, account number, or a custom defined index. # Arguments - `domain_name`: The unique name of the domain. - `key_name`: A searchable identifier of a customer profile. The predefined keys you can - use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, - _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, - _zendeskExternalId, _serviceNowSystemId. + use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, + _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, + _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, + _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, + _shopifyOrderId. - `values`: A list of key values. # Optional Parameters diff --git a/src/services/datasync.jl b/src/services/datasync.jl index 9ecd7cad61..eac237a82e 100644 --- a/src/services/datasync.jl +++ b/src/services/datasync.jl @@ -181,6 +181,61 @@ function create_location_efs( ) end +""" + create_location_fsx_lustre(fsx_filesystem_arn, security_group_arns) + create_location_fsx_lustre(fsx_filesystem_arn, security_group_arns, params::Dict{String,<:Any}) + +Creates an endpoint for an Amazon FSx for Lustre file system. + +# Arguments +- `fsx_filesystem_arn`: The Amazon Resource Name (ARN) for the FSx for Lustre file system. +- `security_group_arns`: The Amazon Resource Names (ARNs) of the security groups that are + used to configure the FSx for Lustre file system. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"Subdirectory"`: A subdirectory in the location's path. This subdirectory in the FSx for + Lustre file system is used to read data from the FSx for Lustre source location or write + data to the FSx for Lustre destination. +- `"Tags"`: The key-value pair that represents a tag that you want to add to the resource. + The value can be an empty string. This value helps you manage, filter, and search for your + resources. We recommend that you create a name tag for your location. +""" +function create_location_fsx_lustre( + FsxFilesystemArn, SecurityGroupArns; aws_config::AbstractAWSConfig=global_aws_config() +) + return datasync( + "CreateLocationFsxLustre", + Dict{String,Any}( + "FsxFilesystemArn" => FsxFilesystemArn, "SecurityGroupArns" => SecurityGroupArns + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function create_location_fsx_lustre( + FsxFilesystemArn, + SecurityGroupArns, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return datasync( + "CreateLocationFsxLustre", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "FsxFilesystemArn" => FsxFilesystemArn, + "SecurityGroupArns" => SecurityGroupArns, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ create_location_fsx_windows(fsx_filesystem_arn, password, security_group_arns, user) create_location_fsx_windows(fsx_filesystem_arn, password, security_group_arns, user, params::Dict{String,<:Any}) @@ -193,7 +248,7 @@ Creates an endpoint for an Amazon FSx for Windows File Server file system. - `password`: The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system. - `security_group_arns`: The Amazon Resource Names (ARNs) of the security groups that are - to use to configure the FSx for Windows File Server file system. + used to configure the FSx for Windows File Server file system. - `user`: The user who has the permissions to access files and folders in the FSx for Windows File Server file system. For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user. @@ -202,8 +257,8 @@ Creates an endpoint for an Amazon FSx for Windows File Server file system. Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"Domain"`: The name of the Windows domain that the FSx for Windows File Server belongs to. -- `"Subdirectory"`: A subdirectory in the location’s path. This subdirectory in the - Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for +- `"Subdirectory"`: A subdirectory in the location's path. This subdirectory in the Amazon + FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination. - `"Tags"`: The key-value pair that represents a tag that you want to add to the resource. @@ -906,6 +961,42 @@ function describe_location_efs( ) end +""" + describe_location_fsx_lustre(location_arn) + describe_location_fsx_lustre(location_arn, params::Dict{String,<:Any}) + +Returns metadata, such as the path information about an Amazon FSx for Lustre location. + +# Arguments +- `location_arn`: The Amazon Resource Name (ARN) of the FSx for Lustre location to + describe. + +""" +function describe_location_fsx_lustre( + LocationArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return datasync( + "DescribeLocationFsxLustre", + Dict{String,Any}("LocationArn" => LocationArn); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function describe_location_fsx_lustre( + LocationArn, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return datasync( + "DescribeLocationFsxLustre", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ describe_location_fsx_windows(location_arn) describe_location_fsx_windows(location_arn, params::Dict{String,<:Any}) diff --git a/src/services/detective.jl b/src/services/detective.jl index 87532481a8..8996d057b3 100644 --- a/src/services/detective.jl +++ b/src/services/detective.jl @@ -83,30 +83,39 @@ end create_members(accounts, graph_arn) create_members(accounts, graph_arn, params::Dict{String,<:Any}) -Sends a request to invite the specified AWS accounts to be member accounts in the behavior -graph. This operation can only be called by the administrator account for a behavior graph. - CreateMembers verifies the accounts and then invites the verified accounts. The + CreateMembers is used to send invitations to accounts. For the organization behavior +graph, the Detective administrator account uses CreateMembers to enable organization +accounts as member accounts. For invited accounts, CreateMembers sends a request to invite +the specified Amazon Web Services accounts to be member accounts in the behavior graph. +This operation can only be called by the administrator account for a behavior graph. +CreateMembers verifies the accounts and then invites the verified accounts. The administrator can optionally specify to not send invitation emails to the member accounts. -This would be used when the administrator manages their member accounts centrally. The -request provides the behavior graph ARN and the list of accounts to invite. The response +This would be used when the administrator manages their member accounts centrally. For +organization accounts in the organization behavior graph, CreateMembers attempts to enable +the accounts. The organization accounts do not receive invitations. The request provides +the behavior graph ARN and the list of accounts to invite or to enable. The response separates the requested accounts into two lists: The accounts that CreateMembers was able -to start the verification for. This list includes member accounts that are being verified, -that have passed verification and are to be invited, and that have failed verification. -The accounts that CreateMembers was unable to process. This list includes accounts that -were already invited to be member accounts in the behavior graph. +to process. For invited accounts, includes member accounts that are being verified, that +have passed verification and are to be invited, and that have failed verification. For +organization accounts in the organization behavior graph, includes accounts that can be +enabled and that cannot be enabled. The accounts that CreateMembers was unable to +process. This list includes accounts that were already invited to be member accounts in the +behavior graph. # Arguments -- `accounts`: The list of AWS accounts to invite to become member accounts in the behavior - graph. You can invite up to 50 accounts at a time. For each invited account, the account - list contains the account identifier and the AWS account root user email address. -- `graph_arn`: The ARN of the behavior graph to invite the member accounts to contribute - their data to. +- `accounts`: The list of Amazon Web Services accounts to invite or to enable. You can + invite or enable up to 50 accounts at a time. For each invited account, the account list + contains the account identifier and the Amazon Web Services account root user email + address. For organization accounts in the organization behavior graph, the email address is + not required. +- `graph_arn`: The ARN of the behavior graph. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"DisableEmailNotification"`: if set to true, then the member accounts do not receive - email notifications. By default, this is set to false, and the member accounts receive - email notifications. +- `"DisableEmailNotification"`: if set to true, then the invited accounts do not receive + email notifications. By default, this is set to false, and the invited accounts receive + email notifications. Organization accounts in the organization behavior graph do not + receive email notifications. - `"Message"`: Customized message text to include in the invitation email message to the invited member accounts. """ @@ -147,8 +156,8 @@ end delete_graph(graph_arn, params::Dict{String,<:Any}) Disables the specified behavior graph and queues it to be deleted. This operation removes -the graph from each member account's list of behavior graphs. DeleteGraph can only be -called by the administrator account for a behavior graph. +the behavior graph from each member account's list of behavior graphs. DeleteGraph can +only be called by the administrator account for a behavior graph. # Arguments - `graph_arn`: The ARN of the behavior graph to disable. @@ -183,15 +192,23 @@ end delete_members(account_ids, graph_arn) delete_members(account_ids, graph_arn, params::Dict{String,<:Any}) -Deletes one or more member accounts from the administrator account's behavior graph. This -operation can only be called by a Detective administrator account. That account cannot use -DeleteMembers to delete their own account from the behavior graph. To disable a behavior -graph, the administrator account uses the DeleteGraph API method. +Removes the specified member accounts from the behavior graph. The removed accounts no +longer contribute data to the behavior graph. This operation can only be called by the +administrator account for the behavior graph. For invited accounts, the removed accounts +are deleted from the list of accounts in the behavior graph. To restore the account, the +administrator account must send another invitation. For organization accounts in the +organization behavior graph, the Detective administrator account can always enable the +organization account again. Organization accounts that are not enabled as member accounts +are not included in the ListMembers results for the organization behavior graph. An +administrator account cannot use DeleteMembers to remove their own account from the +behavior graph. To disable a behavior graph, the administrator account uses the DeleteGraph +API method. # Arguments -- `account_ids`: The list of AWS account identifiers for the member accounts to delete from - the behavior graph. You can delete up to 50 member accounts at a time. -- `graph_arn`: The ARN of the behavior graph to delete members from. +- `account_ids`: The list of Amazon Web Services account identifiers for the member + accounts to remove from the behavior graph. You can remove up to 50 member accounts at a + time. +- `graph_arn`: The ARN of the behavior graph to remove members from. """ function delete_members( @@ -226,12 +243,86 @@ function delete_members( ) end +""" + describe_organization_configuration(graph_arn) + describe_organization_configuration(graph_arn, params::Dict{String,<:Any}) + +Returns information about the configuration for the organization behavior graph. Currently +indicates whether to automatically enable new organization accounts as member accounts. Can +only be called by the Detective administrator account for the organization. + +# Arguments +- `graph_arn`: The ARN of the organization behavior graph. + +""" +function describe_organization_configuration( + GraphArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return detective( + "POST", + "/orgs/describeOrganizationConfiguration", + Dict{String,Any}("GraphArn" => GraphArn); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function describe_organization_configuration( + GraphArn, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return detective( + "POST", + "/orgs/describeOrganizationConfiguration", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("GraphArn" => GraphArn), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + disable_organization_admin_account() + disable_organization_admin_account(params::Dict{String,<:Any}) + +Removes the Detective administrator account for the organization in the current Region. +Deletes the behavior graph for that account. Can only be called by the organization +management account. Before you can select a different Detective administrator account, you +must remove the Detective administrator account in all Regions. + +""" +function disable_organization_admin_account(; + aws_config::AbstractAWSConfig=global_aws_config() +) + return detective( + "POST", + "/orgs/disableAdminAccount"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function disable_organization_admin_account( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return detective( + "POST", + "/orgs/disableAdminAccount", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ disassociate_membership(graph_arn) disassociate_membership(graph_arn, params::Dict{String,<:Any}) Removes the member account from the specified behavior graph. This operation can only be -called by a member account that has the ENABLED status. +called by an invited member account that has the ENABLED status. DisassociateMembership +cannot be called by an organization account in the organization behavior graph. For the +organization behavior graph, the Detective administrator account determines which +organization accounts to enable or disable as member accounts. # Arguments - `graph_arn`: The ARN of the behavior graph to remove the member account from. The member @@ -265,6 +356,49 @@ function disassociate_membership( ) end +""" + enable_organization_admin_account(account_id) + enable_organization_admin_account(account_id, params::Dict{String,<:Any}) + +Designates the Detective administrator account for the organization in the current Region. +If the account does not have Detective enabled, then enables Detective for that account and +creates a new behavior graph. Can only be called by the organization management account. +The Detective administrator account for an organization must be the same in all Regions. If +you already designated a Detective administrator account in another Region, then you must +designate the same account. + +# Arguments +- `account_id`: The Amazon Web Services account identifier of the account to designate as + the Detective administrator account for the organization. + +""" +function enable_organization_admin_account( + AccountId; aws_config::AbstractAWSConfig=global_aws_config() +) + return detective( + "POST", + "/orgs/enableAdminAccount", + Dict{String,Any}("AccountId" => AccountId); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function enable_organization_admin_account( + AccountId, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return detective( + "POST", + "/orgs/enableAdminAccount", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("AccountId" => AccountId), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ get_members(account_ids, graph_arn) get_members(account_ids, graph_arn, params::Dict{String,<:Any}) @@ -272,10 +406,10 @@ end Returns the membership details for specified member accounts for a behavior graph. # Arguments -- `account_ids`: The list of AWS account identifiers for the member account for which to - return member details. You can request details for up to 50 member accounts at a time. You - cannot use GetMembers to retrieve information about member accounts that were removed from - the behavior graph. +- `account_ids`: The list of Amazon Web Services account identifiers for the member account + for which to return member details. You can request details for up to 50 member accounts at + a time. You cannot use GetMembers to retrieve information about member accounts that were + removed from the behavior graph. - `graph_arn`: The ARN of the behavior graph for which to request the member details. """ @@ -350,10 +484,10 @@ end list_invitations(params::Dict{String,<:Any}) Retrieves the list of open and accepted behavior graph invitations for the member account. -This operation can only be called by a member account. Open invitations are invitations -that the member account has not responded to. The results do not include behavior graphs -for which the member account declined the invitation. The results also do not include -behavior graphs that the member account resigned from or was removed from. +This operation can only be called by an invited member account. Open invitations are +invitations that the member account has not responded to. The results do not include +behavior graphs for which the member account declined the invitation. The results also do +not include behavior graphs that the member account resigned from or was removed from. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -385,8 +519,10 @@ end list_members(graph_arn) list_members(graph_arn, params::Dict{String,<:Any}) -Retrieves the list of member accounts for a behavior graph. Does not return member accounts -that were removed from the behavior graph. +Retrieves the list of member accounts for a behavior graph. For invited accounts, the +results do not include member accounts that were removed from the behavior graph. For the +organization behavior graph, the results do not include organization accounts that the +Detective administrator account has not enabled as member accounts. # Arguments - `graph_arn`: The ARN of the behavior graph for which to retrieve the list of member @@ -426,6 +562,42 @@ function list_members( ) end +""" + list_organization_admin_accounts() + list_organization_admin_accounts(params::Dict{String,<:Any}) + +Returns information about the Detective administrator account for an organization. Can only +be called by the organization management account. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"MaxResults"`: The maximum number of results to return. +- `"NextToken"`: For requests to get the next page of results, the pagination token that + was returned with the previous set of results. The initial request does not include a + pagination token. +""" +function list_organization_admin_accounts(; + aws_config::AbstractAWSConfig=global_aws_config() +) + return detective( + "POST", + "/orgs/adminAccountslist"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function list_organization_admin_accounts( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return detective( + "POST", + "/orgs/adminAccountslist", + 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}) @@ -465,7 +637,9 @@ end reject_invitation(graph_arn, params::Dict{String,<:Any}) Rejects an invitation to contribute the account data to a behavior graph. This operation -must be called by a member account that has the INVITED status. +must be called by an invited member account that has the INVITED status. RejectInvitation +cannot be called by an organization account in the organization behavior graph. In the +organization behavior graph, organization accounts do not receive an invitation. # Arguments - `graph_arn`: The ARN of the behavior graph to reject the invitation to. The member @@ -618,3 +792,45 @@ function untag_resource( feature_set=SERVICE_FEATURE_SET, ) end + +""" + update_organization_configuration(graph_arn) + update_organization_configuration(graph_arn, params::Dict{String,<:Any}) + +Updates the configuration for the Organizations integration in the current Region. Can only +be called by the Detective administrator account for the organization. + +# Arguments +- `graph_arn`: The ARN of the organization behavior graph. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"AutoEnable"`: Indicates whether to automatically enable new organization accounts as + member accounts in the organization behavior graph. +""" +function update_organization_configuration( + GraphArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return detective( + "POST", + "/orgs/updateOrganizationConfiguration", + Dict{String,Any}("GraphArn" => GraphArn); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function update_organization_configuration( + GraphArn, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return detective( + "POST", + "/orgs/updateOrganizationConfiguration", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("GraphArn" => GraphArn), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end diff --git a/src/services/ec2.jl b/src/services/ec2.jl index 7c29f1d2f5..da9ede3a69 100644 --- a/src/services/ec2.jl +++ b/src/services/ec2.jl @@ -22440,6 +22440,58 @@ function modify_vpc_endpoint_service_configuration( ) end +""" + modify_vpc_endpoint_service_payer_responsibility(payer_responsibility, service_id) + modify_vpc_endpoint_service_payer_responsibility(payer_responsibility, service_id, params::Dict{String,<:Any}) + +Modifies the payer responsibility for your VPC endpoint service. + +# Arguments +- `payer_responsibility`: The entity that is responsible for the endpoint costs. The + default is the endpoint owner. If you set the payer responsibility to the service owner, + you cannot set it back to the endpoint owner. +- `service_id`: The ID of the service. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"DryRun"`: Checks whether you have the required permissions for the action, without + actually making the request, and provides an error response. If you have the required + permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. +""" +function modify_vpc_endpoint_service_payer_responsibility( + PayerResponsibility, ServiceId; aws_config::AbstractAWSConfig=global_aws_config() +) + return ec2( + "ModifyVpcEndpointServicePayerResponsibility", + Dict{String,Any}( + "PayerResponsibility" => PayerResponsibility, "ServiceId" => ServiceId + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function modify_vpc_endpoint_service_payer_responsibility( + PayerResponsibility, + ServiceId, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return ec2( + "ModifyVpcEndpointServicePayerResponsibility", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "PayerResponsibility" => PayerResponsibility, "ServiceId" => ServiceId + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ modify_vpc_endpoint_service_permissions(service_id) modify_vpc_endpoint_service_permissions(service_id, params::Dict{String,<:Any}) diff --git a/src/services/ecs.jl b/src/services/ecs.jl index 0d9d171bce..c0ee2f706e 100644 --- a/src/services/ecs.jl +++ b/src/services/ecs.jl @@ -2162,19 +2162,19 @@ tasks for you, or you can customize how Amazon ECS places tasks using placement and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide. Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances. The Amazon ECS API -follows an eventual consistency model. This is because the distributed nature of the system -supporting the API. This means that the result of an API command you run that affects your -Amazon ECS resources might not be immediately visible to all subsequent commands you run. -Keep this in mind when you carry out an API command that immediately follows a previous API -command. To manage eventual consistency, you can do the following: Confirm the state of -the resource before you run a command to modify it. Run the DescribeTasks command using an -exponential backoff algorithm to ensure that you allow enough time for the previous command -to propagate through the system. To do this, run the DescribeTasks command repeatedly, -starting with a couple of seconds of wait time and increasing gradually up to five minutes -of wait time. Add wait time between subsequent commands, even if the DescribeTasks -command returns an accurate response. Apply an exponential backoff algorithm starting with -a couple of seconds of wait time, and increase gradually up to about five minutes of wait -time. +follows an eventual consistency model. This is because of the distributed nature of the +system supporting the API. This means that the result of an API command you run that +affects your Amazon ECS resources might not be immediately visible to all subsequent +commands you run. Keep this in mind when you carry out an API command that immediately +follows a previous API command. To manage eventual consistency, you can do the following: +Confirm the state of the resource before you run a command to modify it. Run the +DescribeTasks command using an exponential backoff algorithm to ensure that you allow +enough time for the previous command to propagate through the system. To do this, run the +DescribeTasks command repeatedly, starting with a couple of seconds of wait time and +increasing gradually up to five minutes of wait time. Add wait time between subsequent +commands, even if the DescribeTasks command returns an accurate response. Apply an +exponential backoff algorithm starting with a couple of seconds of wait time, and increase +gradually up to about five minutes of wait time. # Arguments - `task_definition`: The family and revision (family:revision) or full ARN of the task @@ -2848,7 +2848,7 @@ instance to ACTIVE status and once it has reached that status the Amazon ECS sch begin scheduling tasks on the instance again. # Arguments -- `container_instances`: A list of container instance IDs or full ARN entries. +- `container_instances`: A list of up to 10 container instance IDs or full ARN entries. - `status`: The container instance state to update the container instance with. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is diff --git a/src/services/finspace_data.jl b/src/services/finspace_data.jl index c71530df1a..494987a300 100644 --- a/src/services/finspace_data.jl +++ b/src/services/finspace_data.jl @@ -139,14 +139,12 @@ function create_data_view( end """ - create_dataset(alias, dataset_description, dataset_title, kind, permission_group_params) - create_dataset(alias, dataset_description, dataset_title, kind, permission_group_params, params::Dict{String,<:Any}) + create_dataset(dataset_title, kind, permission_group_params) + create_dataset(dataset_title, kind, permission_group_params, params::Dict{String,<:Any}) Creates a new FinSpace Dataset. # Arguments -- `alias`: The unique resource identifier for a Dataset. -- `dataset_description`: Description of a Dataset. - `dataset_title`: Display title for a FinSpace Dataset. - `kind`: The format in which Dataset data is structured. TABULAR - Data is structured in a tabular format. NON_TABULAR - Data is structured in a non-tabular format. @@ -154,13 +152,13 @@ Creates a new FinSpace Dataset. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"alias"`: The unique resource identifier for a Dataset. - `"clientToken"`: A token used to ensure idempotency. +- `"datasetDescription"`: Description of a Dataset. - `"ownerInfo"`: Contact information for a Dataset owner. - `"schemaDefinition"`: Definition for a schema on a tabular Dataset. """ function create_dataset( - alias, - datasetDescription, datasetTitle, kind, permissionGroupParams; @@ -170,8 +168,6 @@ function create_dataset( "POST", "/datasetsv2", Dict{String,Any}( - "alias" => alias, - "datasetDescription" => datasetDescription, "datasetTitle" => datasetTitle, "kind" => kind, "permissionGroupParams" => permissionGroupParams, @@ -182,8 +178,6 @@ function create_dataset( ) end function create_dataset( - alias, - datasetDescription, datasetTitle, kind, permissionGroupParams, @@ -197,8 +191,6 @@ function create_dataset( mergewith( _merge, Dict{String,Any}( - "alias" => alias, - "datasetDescription" => datasetDescription, "datasetTitle" => datasetTitle, "kind" => kind, "permissionGroupParams" => permissionGroupParams, @@ -588,13 +580,12 @@ function update_changeset( end """ - update_dataset(alias, dataset_id, dataset_title, kind) - update_dataset(alias, dataset_id, dataset_title, kind, params::Dict{String,<:Any}) + update_dataset(dataset_id, dataset_title, kind) + update_dataset(dataset_id, dataset_title, kind, params::Dict{String,<:Any}) Updates a FinSpace Dataset. # Arguments -- `alias`: The unique resource identifier for a Dataset. - `dataset_id`: The unique identifier for the Dataset to update. - `dataset_title`: A display title for the Dataset. - `kind`: The format in which the Dataset data is structured. TABULAR - Data is @@ -603,28 +594,25 @@ Updates a FinSpace Dataset. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"alias"`: The unique resource identifier for a Dataset. - `"clientToken"`: A token used to ensure idempotency. - `"datasetDescription"`: A description for the Dataset. - `"schemaDefinition"`: Definition for a schema on a tabular Dataset. """ function update_dataset( - alias, datasetId, datasetTitle, kind; aws_config::AbstractAWSConfig=global_aws_config() + datasetId, datasetTitle, kind; aws_config::AbstractAWSConfig=global_aws_config() ) return finspace_data( "PUT", "/datasetsv2/$(datasetId)", Dict{String,Any}( - "alias" => alias, - "datasetTitle" => datasetTitle, - "kind" => kind, - "clientToken" => string(uuid4()), + "datasetTitle" => datasetTitle, "kind" => kind, "clientToken" => string(uuid4()) ); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) end function update_dataset( - alias, datasetId, datasetTitle, kind, @@ -638,7 +626,6 @@ function update_dataset( mergewith( _merge, Dict{String,Any}( - "alias" => alias, "datasetTitle" => datasetTitle, "kind" => kind, "clientToken" => string(uuid4()), diff --git a/src/services/forecast.jl b/src/services/forecast.jl index 2832a93435..1ec5292301 100644 --- a/src/services/forecast.jl +++ b/src/services/forecast.jl @@ -29,7 +29,7 @@ specify values for the ReferencePredictorArn and PredictorName. Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"DataConfig"`: The data configuration for your dataset group and any additional datasets. - `"EncryptionConfig"`: -- `"ExplainPredictor"`: +- `"ExplainPredictor"`: Create an Explainability resource for the predictor. - `"ForecastDimensions"`: An array of dimension (field) names that specify how to group the generated forecast. For example, if you are generating forecasts for item sales across all your stores, and your dataset contains a store_id field, you would specify store_id as a @@ -404,7 +404,7 @@ valid when TimeSeriesGranularity is “SPECIFIC”. Schema - Only valid when TimeSeriesGranularity is “SPECIFIC”. StartDateTime - Only valid when TimePointGranularity is “SPECIFIC”. EndDateTime - Only valid when TimePointGranularity is “SPECIFIC”. CreateExplainability with a Forecast ARN You -can specify a maximum of 50 time series and 1500 time points. The following parameters are +can specify a maximum of 50 time series and 500 time points. The following parameters are required when providing a Predictor ARN: ExplainabilityName - A unique name for the Explainability. ResourceArn - The Arn of the forecast. TimePointGranularity - Either “ALL” or “SPECIFIC”. TimeSeriesGranularity - Either “ALL” or “SPECIFIC”. @@ -428,10 +428,12 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"EnableVisualization"`: Create an Expainability visualization that is viewable within the AWS console. - `"EndDateTime"`: If TimePointGranularity is set to SPECIFIC, define the last time point - for the Explainability. + for the Explainability. Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: + 2015-01-01T20:00:00) - `"Schema"`: - `"StartDateTime"`: If TimePointGranularity is set to SPECIFIC, define the first point for - the Explainability. + the Explainability. Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: + 2015-01-01T20:00:00) - `"Tags"`: Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive. The following restrictions apply to tags: For each resource, each tag key @@ -877,9 +879,9 @@ end create_predictor_backtest_export_job(destination, predictor_arn, predictor_backtest_export_job_name) create_predictor_backtest_export_job(destination, predictor_arn, predictor_backtest_export_job_name, params::Dict{String,<:Any}) -Exports backtest forecasts and accuracy metrics generated by the CreatePredictor operation. -Two folders containing CSV files are exported to your specified S3 bucket. The export file -names will match the following conventions: +Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or +CreatePredictor operations. Two folders containing CSV files are exported to your specified +S3 bucket. The export file names will match the following conventions: <ExportJobName>_<ExportTimestamp>_<PartNumber>.csv The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ). You must specify a DataDestination object that includes an Amazon S3 bucket and an AWS Identity @@ -1113,7 +1115,7 @@ end delete_explainability_export(explainability_export_arn) delete_explainability_export(explainability_export_arn, params::Dict{String,<:Any}) -Deletes an Explainability export job. +Deletes an Explainability export. # Arguments - `explainability_export_arn`: The Amazon Resource Name (ARN) of the Explainability export @@ -1231,9 +1233,9 @@ end delete_predictor(predictor_arn) delete_predictor(predictor_arn, params::Dict{String,<:Any}) -Deletes a predictor created using the CreatePredictor operation. You can delete only -predictor that have a status of ACTIVE or CREATE_FAILED. To get the status, use the -DescribePredictor operation. +Deletes a predictor created using the DescribePredictor or CreatePredictor operations. You +can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status, +use the DescribePredictor operation. # Arguments - `predictor_arn`: The Amazon Resource Name (ARN) of the predictor to delete. @@ -1662,9 +1664,8 @@ end describe_predictor(predictor_arn, params::Dict{String,<:Any}) This operation is only valid for legacy predictors created with CreatePredictor. If you -are not using a legacy predictor, use DescribeAutoPredictor. To upgrade a legacy predictor -to AutoPredictor, see Upgrading to AutoPredictor. Describes a predictor created using the -CreatePredictor operation. In addition to listing the properties provided in the +are not using a legacy predictor, use DescribeAutoPredictor. Describes a predictor created +using the CreatePredictor operation. In addition to listing the properties provided in the CreatePredictor request, this operation lists the following properties: DatasetImportJobArns - The dataset import jobs used to import training data. AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated. @@ -1905,7 +1906,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys exclude the resources that match the statement from the list. The match statement consists of a key and a value. Filter properties Condition - The condition to apply. Valid values are IS and IS_NOT. Key - The name of the parameter to filter on. Valid values are - PredictorArn and Status. Value - The value to match. + ResourceArn and Status. Value - The value to match. - `"MaxResults"`: The number of items returned in the response. - `"NextToken"`: If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens @@ -1943,7 +1944,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys exclude resources that match the statement from the list. The match statement consists of a key and a value. Filter properties Condition - The condition to apply. Valid values are IS and IS_NOT. Key - The name of the parameter to filter on. Valid values are - PredictorArn and Status. Value - The value to match. + ResourceArn and Status. Value - The value to match. - `"MaxResults"`: The number of items to return in the response. - `"NextToken"`: If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens @@ -2095,10 +2096,11 @@ end list_predictors() list_predictors(params::Dict{String,<:Any}) -Returns a list of predictors created using the CreatePredictor operation. For each -predictor, this operation returns a summary of its properties, including its Amazon -Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with -the DescribePredictor operation. You can filter the list using an array of Filter objects. +Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor +operations. For each predictor, this operation returns a summary of its properties, +including its Amazon Resource Name (ARN). You can retrieve the complete set of properties +by using the ARN with the DescribeAutoPredictor and DescribePredictor operations. You can +filter the list using an array of Filter objects. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -2138,8 +2140,7 @@ Lists the tags for an Amazon Forecast resource. # Arguments - `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource for which to - list the tags. Currently, the supported resources are Forecast dataset groups, datasets, - dataset import jobs, predictors, forecasts, and forecast export jobs. + list the tags. """ function list_tags_for_resource( @@ -2175,12 +2176,12 @@ Stops a resource. The resource undergoes the following states: CREATE_STOPPING a CREATE_STOPPED. You cannot resume a resource once it has been stopped. This operation can be applied to the following resources (and their corresponding child resources): Dataset Import Job Predictor Job Forecast Job Forecast Export Job Predictor Backtest Export -Job +Job Explainability Job Explainability Export Job # Arguments - `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs are DatasetImportJobArn, PredictorArn, PredictorBacktestExportJobArn, - ForecastArn, and ForecastExportJobArn. + ForecastArn, ForecastExportJobArn, ExplainabilityArn, and ExplainabilityExportArn. """ function stop_resource(ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()) @@ -2216,8 +2217,7 @@ a resource is deleted, the tags associated with that resource are also deleted. # Arguments - `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource for which to - list the tags. Currently, the supported resources are Forecast dataset groups, datasets, - dataset import jobs, predictors, forecasts, and forecast export jobs. + list the tags. - `tags`: The tags to add to the resource. A tag is an array of key-value pairs. The following basic restrictions apply to tags: Maximum number of tags per resource - 50. For each resource, each tag key must be unique, and each tag key can have only one value. @@ -2269,8 +2269,7 @@ Deletes the specified tags from a resource. # Arguments - `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource for which to - list the tags. Currently, the supported resources are Forecast dataset groups, datasets, - dataset import jobs, predictors, forecasts, and forecast exports. + list the tags. - `tag_keys`: The keys of the tags to be removed. """ diff --git a/src/services/glue.jl b/src/services/glue.jl index 88f767f1e7..a16b5f0676 100644 --- a/src/services/glue.jl +++ b/src/services/glue.jl @@ -885,6 +885,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"DatabaseName"`: The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*. - `"Description"`: A description of the new crawler. +- `"LakeFormationConfiguration"`: - `"LineageConfiguration"`: Specifies data lineage configuration settings for the crawler. - `"RecrawlPolicy"`: A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run. @@ -4489,6 +4490,201 @@ function get_triggers( ) end +""" + get_unfiltered_partition_metadata(catalog_id, database_name, partition_values, supported_permission_types, table_name) + get_unfiltered_partition_metadata(catalog_id, database_name, partition_values, supported_permission_types, table_name, params::Dict{String,<:Any}) + + + +# Arguments +- `catalog_id`: +- `database_name`: +- `partition_values`: +- `supported_permission_types`: +- `table_name`: + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"AuditContext"`: +""" +function get_unfiltered_partition_metadata( + CatalogId, + DatabaseName, + PartitionValues, + SupportedPermissionTypes, + TableName; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return glue( + "GetUnfilteredPartitionMetadata", + Dict{String,Any}( + "CatalogId" => CatalogId, + "DatabaseName" => DatabaseName, + "PartitionValues" => PartitionValues, + "SupportedPermissionTypes" => SupportedPermissionTypes, + "TableName" => TableName, + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_unfiltered_partition_metadata( + CatalogId, + DatabaseName, + PartitionValues, + SupportedPermissionTypes, + TableName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return glue( + "GetUnfilteredPartitionMetadata", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "CatalogId" => CatalogId, + "DatabaseName" => DatabaseName, + "PartitionValues" => PartitionValues, + "SupportedPermissionTypes" => SupportedPermissionTypes, + "TableName" => TableName, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + get_unfiltered_partitions_metadata(catalog_id, database_name, supported_permission_types, table_name) + get_unfiltered_partitions_metadata(catalog_id, database_name, supported_permission_types, table_name, params::Dict{String,<:Any}) + + + +# Arguments +- `catalog_id`: +- `database_name`: +- `supported_permission_types`: +- `table_name`: + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"AuditContext"`: +- `"Expression"`: +- `"MaxResults"`: +- `"NextToken"`: +- `"Segment"`: +""" +function get_unfiltered_partitions_metadata( + CatalogId, + DatabaseName, + SupportedPermissionTypes, + TableName; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return glue( + "GetUnfilteredPartitionsMetadata", + Dict{String,Any}( + "CatalogId" => CatalogId, + "DatabaseName" => DatabaseName, + "SupportedPermissionTypes" => SupportedPermissionTypes, + "TableName" => TableName, + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_unfiltered_partitions_metadata( + CatalogId, + DatabaseName, + SupportedPermissionTypes, + TableName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return glue( + "GetUnfilteredPartitionsMetadata", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "CatalogId" => CatalogId, + "DatabaseName" => DatabaseName, + "SupportedPermissionTypes" => SupportedPermissionTypes, + "TableName" => TableName, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + get_unfiltered_table_metadata(catalog_id, database_name, name, supported_permission_types) + get_unfiltered_table_metadata(catalog_id, database_name, name, supported_permission_types, params::Dict{String,<:Any}) + + + +# Arguments +- `catalog_id`: +- `database_name`: +- `name`: +- `supported_permission_types`: + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"AuditContext"`: +""" +function get_unfiltered_table_metadata( + CatalogId, + DatabaseName, + Name, + SupportedPermissionTypes; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return glue( + "GetUnfilteredTableMetadata", + Dict{String,Any}( + "CatalogId" => CatalogId, + "DatabaseName" => DatabaseName, + "Name" => Name, + "SupportedPermissionTypes" => SupportedPermissionTypes, + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_unfiltered_table_metadata( + CatalogId, + DatabaseName, + Name, + SupportedPermissionTypes, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return glue( + "GetUnfilteredTableMetadata", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "CatalogId" => CatalogId, + "DatabaseName" => DatabaseName, + "Name" => Name, + "SupportedPermissionTypes" => SupportedPermissionTypes, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ get_user_defined_function(database_name, function_name) get_user_defined_function(database_name, function_name, params::Dict{String,<:Any}) @@ -6390,6 +6586,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"DatabaseName"`: The Glue database where results are stored, such as: arn:aws:daylight:us-east-1::database/sometable/*. - `"Description"`: A description of the new crawler. +- `"LakeFormationConfiguration"`: - `"LineageConfiguration"`: Specifies data lineage configuration settings for the crawler. - `"RecrawlPolicy"`: A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run. diff --git a/src/services/greengrassv2.jl b/src/services/greengrassv2.jl index f8e30fb24a..2e60ec736b 100644 --- a/src/services/greengrassv2.jl +++ b/src/services/greengrassv2.jl @@ -4,11 +4,50 @@ using AWS.AWSServices: greengrassv2 using AWS.Compat using AWS.UUIDs +""" + associate_service_role_to_account(role_arn) + associate_service_role_to_account(role_arn, params::Dict{String,<:Any}) + +Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services +account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the +identity of client devices and manage core device connectivity information. The role must +include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that +defines equivalent permissions for the IoT Greengrass features that you use. For more +information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide. + +# Arguments +- `role_arn`: The Amazon Resource Name (ARN) of the service role to associate with IoT + Greengrass for your Amazon Web Services account in this Amazon Web Services Region. + +""" +function associate_service_role_to_account( + RoleArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return greengrassv2( + "PUT", + "/greengrass/servicerole", + Dict{String,Any}("RoleArn" => RoleArn); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function associate_service_role_to_account( + RoleArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return greengrassv2( + "PUT", + "/greengrass/servicerole", + Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RoleArn" => RoleArn), params)); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ batch_associate_client_device_with_core_device(core_device_thing_name) batch_associate_client_device_with_core_device(core_device_thing_name, params::Dict{String,<:Any}) -Associate a list of client devices with a core device. Use this API operation to specify +Associates a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud @@ -54,7 +93,7 @@ end batch_disassociate_client_device_from_core_device(core_device_thing_name) batch_disassociate_client_device_from_core_device(core_device_thing_name, params::Dict{String,<:Any}) -Disassociate a list of client devices from a core device. After you disassociate a client +Disassociates a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certificates. @@ -354,6 +393,39 @@ function describe_component( ) end +""" + disassociate_service_role_from_account() + disassociate_service_role_from_account(params::Dict{String,<:Any}) + +Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services +account in this Amazon Web Services Region. Without a service role, IoT Greengrass can't +verify the identity of client devices or manage core device connectivity information. For +more information, see Greengrass service role in the IoT Greengrass Version 2 Developer +Guide. + +""" +function disassociate_service_role_from_account(; + aws_config::AbstractAWSConfig=global_aws_config() +) + return greengrassv2( + "DELETE", + "/greengrass/servicerole"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function disassociate_service_role_from_account( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return greengrassv2( + "DELETE", + "/greengrass/servicerole", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ get_component(arn) get_component(arn, params::Dict{String,<:Any}) @@ -428,6 +500,43 @@ function get_component_version_artifact( ) end +""" + get_connectivity_info(thing_name) + get_connectivity_info(thing_name, params::Dict{String,<:Any}) + +Retrieves connectivity information for a Greengrass core device. Connectivity information +includes endpoints and ports where client devices can connect to an MQTT broker on the core +device. When a client device calls the Greengrass discovery API, IoT Greengrass returns +connectivity information for all of the core devices where the client device can connect. +For more information, see Connect client devices to core devices in the IoT Greengrass +Version 2 Developer Guide. + +# Arguments +- `thing_name`: The name of the core device. This is also the name of the IoT thing. + +""" +function get_connectivity_info(thingName; aws_config::AbstractAWSConfig=global_aws_config()) + return greengrassv2( + "GET", + "/greengrass/things/$(thingName)/connectivityInfo"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_connectivity_info( + thingName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return greengrassv2( + "GET", + "/greengrass/things/$(thingName)/connectivityInfo", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ get_core_device(core_device_thing_name) get_core_device(core_device_thing_name, params::Dict{String,<:Any}) @@ -495,6 +604,36 @@ function get_deployment( ) end +""" + get_service_role_for_account() + get_service_role_for_account(params::Dict{String,<:Any}) + +Gets the service role associated with IoT Greengrass for your Amazon Web Services account +in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of +client devices and manage core device connectivity information. For more information, see +Greengrass service role in the IoT Greengrass Version 2 Developer Guide. + +""" +function get_service_role_for_account(; aws_config::AbstractAWSConfig=global_aws_config()) + return greengrassv2( + "GET", + "/greengrass/servicerole"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_service_role_for_account( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return greengrassv2( + "GET", + "/greengrass/servicerole", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ list_client_devices_associated_with_core_device(core_device_thing_name) list_client_devices_associated_with_core_device(core_device_thing_name, params::Dict{String,<:Any}) @@ -919,3 +1058,49 @@ function untag_resource( feature_set=SERVICE_FEATURE_SET, ) end + +""" + update_connectivity_info(connectivity_info, thing_name) + update_connectivity_info(connectivity_info, thing_name, params::Dict{String,<:Any}) + +Updates connectivity information for a Greengrass core device. Connectivity information +includes endpoints and ports where client devices can connect to an MQTT broker on the core +device. When a client device calls the Greengrass discovery API, IoT Greengrass returns +connectivity information for all of the core devices where the client device can connect. +For more information, see Connect client devices to core devices in the IoT Greengrass +Version 2 Developer Guide. + +# Arguments +- `connectivity_info`: The connectivity information for the core device. +- `thing_name`: The name of the core device. This is also the name of the IoT thing. + +""" +function update_connectivity_info( + ConnectivityInfo, thingName; aws_config::AbstractAWSConfig=global_aws_config() +) + return greengrassv2( + "PUT", + "/greengrass/things/$(thingName)/connectivityInfo", + Dict{String,Any}("ConnectivityInfo" => ConnectivityInfo); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function update_connectivity_info( + ConnectivityInfo, + thingName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return greengrassv2( + "PUT", + "/greengrass/things/$(thingName)/connectivityInfo", + Dict{String,Any}( + mergewith( + _merge, Dict{String,Any}("ConnectivityInfo" => ConnectivityInfo), params + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end diff --git a/src/services/health.jl b/src/services/health.jl index abc0444dc7..fec96c30e4 100644 --- a/src/services/health.jl +++ b/src/services/health.jl @@ -564,14 +564,14 @@ Enables Health to work with Organizations. You can use the organizational view f aggregate events from all Amazon Web Services accounts in your organization in a centralized location. This operation also creates a service-linked role for the management account in the organization. To call this operation, you must meet the following -requirements: You must have a Business or Enterprise Support plan from Amazon Web -Services Support to use the Health API. If you call the Health API from an Amazon Web -Services account that doesn't have a Business or Enterprise Support plan, you receive a -SubscriptionRequiredException error. You must have permission to call this operation from -the organization's management account. For example IAM policies, see Health identity-based -policy examples. If you don't have the required support plan, you can instead use the -Health console to enable the organizational view feature. For more information, see -Aggregating Health events in the Health User Guide. +requirements: You must have a Business, Enterprise On-Ramp, or Enterprise Support plan +from Amazon Web Services Support to use the Health API. If you call the Health API from an +Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise +Support plan, you receive a SubscriptionRequiredException error. You must have permission +to call this operation from the organization's management account. For example IAM +policies, see Health identity-based policy examples. If you don't have the required +support plan, you can instead use the Health console to enable the organizational view +feature. For more information, see Aggregating Health events in the Health User Guide. """ function enable_health_service_access_for_organization(; diff --git a/src/services/imagebuilder.jl b/src/services/imagebuilder.jl index 67053aeeed..9f6754cdeb 100644 --- a/src/services/imagebuilder.jl +++ b/src/services/imagebuilder.jl @@ -12,7 +12,8 @@ CancelImageCreation cancels the creation of Image. This operation can only be us images in a non-terminal state. # Arguments -- `client_token`: The idempotency token used to make this request idempotent. +- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of + the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference. - `image_build_version_arn`: The Amazon Resource Name (ARN) of the image whose creation you want to cancel. @@ -554,7 +555,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"resourceTags"`: The tags attached to the resource created by Image Builder. - `"securityGroupIds"`: The security group IDs to associate with the instance used to customize your Amazon EC2 AMI. -- `"snsTopicArn"`: The SNS topic on which to send image build events. +- `"snsTopicArn"`: The Amazon Resource Name (ARN) for the SNS topic to which we send image + build event notifications. EC2 Image Builder is unable to send notifications to SNS topics + that are encrypted using keys from other accounts. The key that is used to encrypt the SNS + topic must reside in the account that the Image Builder service runs under. - `"subnetId"`: The subnet ID in which to place the instance used to customize your Amazon EC2 AMI. - `"tags"`: The tags of the infrastructure configuration. @@ -1434,6 +1438,93 @@ function import_component( ) end +""" + import_vm_image(client_token, name, platform, semantic_version, vm_import_task_id) + import_vm_image(client_token, name, platform, semantic_version, vm_import_task_id, params::Dict{String,<:Any}) + +When you export your virtual machine (VM) from its virtualization environment, that process +creates a set of one or more disk container files that act as snapshots of your VM’s +environment, settings, and data. The Amazon EC2 API ImportImage action uses those files to +import your VM and create an AMI. To import using the CLI command, see import-image You +can reference the task ID from the VM import to pull in the AMI that the import created as +the base image for your Image Builder recipe. + +# Arguments +- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of + the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference. +- `name`: The name of the base image that is created by the import process. +- `platform`: The operating system platform for the imported VM. +- `semantic_version`: The semantic version to attach to the base image that was created + during the import process. This version follows the semantic version syntax. The semantic + version has four nodes: <major>.<minor>.<patch>/<build>. You can + assign values for the first three, and can filter on all of them. Assignment: For the + first three nodes you can assign any positive integer value, including zero, with an upper + limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build + number to the fourth node. Patterns: You can use any numeric pattern that adheres to the + assignment requirements for the nodes that you can assign. For example, you might choose a + software version pattern, such as 1.0.0, or a date, such as 2021.01.01. +- `vm_import_task_id`: The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM + import process. Image Builder retrieves information from the import process to pull in the + AMI that is created from the VM source as the base image for your recipe. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"description"`: The description for the base image that is created by the import process. +- `"osVersion"`: The operating system version for the imported VM. +- `"tags"`: Tags that are attached to the import resources. +""" +function import_vm_image( + clientToken, + name, + platform, + semanticVersion, + vmImportTaskId; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return imagebuilder( + "PUT", + "/ImportVmImage", + Dict{String,Any}( + "clientToken" => clientToken, + "name" => name, + "platform" => platform, + "semanticVersion" => semanticVersion, + "vmImportTaskId" => vmImportTaskId, + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function import_vm_image( + clientToken, + name, + platform, + semanticVersion, + vmImportTaskId, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return imagebuilder( + "PUT", + "/ImportVmImage", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "clientToken" => clientToken, + "name" => name, + "platform" => platform, + "semanticVersion" => semanticVersion, + "vmImportTaskId" => vmImportTaskId, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ list_component_build_versions(component_version_arn) list_component_build_versions(component_version_arn, params::Dict{String,<:Any}) @@ -2402,7 +2493,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"resourceTags"`: The tags attached to the resource created by Image Builder. - `"securityGroupIds"`: The security group IDs to associate with the instance used to customize your Amazon EC2 AMI. -- `"snsTopicArn"`: The SNS topic on which to send image build events. +- `"snsTopicArn"`: The Amazon Resource Name (ARN) for the SNS topic to which we send image + build event notifications. EC2 Image Builder is unable to send notifications to SNS topics + that are encrypted using keys from other accounts. The key that is used to encrypt the SNS + topic must reside in the account that the Image Builder service runs under. - `"subnetId"`: The subnet ID to place the instance used to customize your Amazon EC2 AMI in. - `"terminateInstanceOnFailure"`: The terminate instance on failure setting of the diff --git a/src/services/iot.jl b/src/services/iot.jl index 5ef0c40168..0d8fcb757b 100644 --- a/src/services/iot.jl +++ b/src/services/iot.jl @@ -734,6 +734,10 @@ Creates an authorizer. Requires permission to access the CreateAuthorizer action # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"enableCachingForHttp"`: When true, the result from the authorizer’s Lambda function + is cached for clients that use persistent HTTP connections. The results are cached for the + time specified by the Lambda function in refreshAfterInSeconds. This value does not affect + authorization of clients that use MQTT connections. The default value is false. - `"signingDisabled"`: Specifies whether IoT validates the token signature in an authorization request. - `"status"`: The status of the create authorizer request. @@ -1204,7 +1208,7 @@ Creates a job. Requires permission to access the CreateJob action. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"abortConfig"`: Allows you to create criteria to abort a job. +- `"abortConfig"`: Allows you to create the criteria to abort a job. - `"description"`: A short text description of the job. - `"document"`: The job document. Required if you don't specify a value for documentSource. - `"documentParameters"`: Parameters of a managed template that you can specify to create @@ -1214,6 +1218,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys when specifying the document. The placeholder link is of the following form: {aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key} where bucket is your bucket name and key is the object in the bucket to which you are linking. +- `"jobExecutionsRetryConfig"`: Allows you to create the criteria to retry a job. - `"jobExecutionsRolloutConfig"`: Allows you to create a staged rollout of the job. - `"jobTemplateArn"`: The ARN of the job template used to create the job. - `"namespaceId"`: The namespace used to indicate that a job is a customer-managed job. @@ -1278,6 +1283,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys following form: {aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key} where bucket is your bucket name and key is the object in the bucket to which you are linking. - `"jobArn"`: The ARN of the job to use as the basis for the job template. +- `"jobExecutionsRetryConfig"`: Allows you to create the criteria to retry a job. - `"jobExecutionsRolloutConfig"`: - `"presignedUrlConfig"`: - `"tags"`: Metadata that can be used to manage the job template. @@ -6024,6 +6030,7 @@ ListJobExecutionsForThing action. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"jobId"`: The unique identifier you assigned to this job when it was created. - `"maxResults"`: The maximum number of results to be returned per request. - `"namespaceId"`: The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs @@ -8563,6 +8570,9 @@ Updates an authorizer. Requires permission to access the UpdateAuthorizer action # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"authorizerFunctionArn"`: The ARN of the authorizer's Lambda function. +- `"enableCachingForHttp"`: When true, the result from the authorizer’s Lambda function + is cached for the time specified in refreshAfterInSeconds. The cached result is used while + the device reuses the same HTTP connection. - `"status"`: The status of the update authorizer request. - `"tokenKeyName"`: The key used to extract the token from the HTTP headers. - `"tokenSigningPublicKeys"`: The public keys used to verify the token signature. @@ -9040,6 +9050,7 @@ action. Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"abortConfig"`: Allows you to create criteria to abort a job. - `"description"`: A short text description of the job. +- `"jobExecutionsRetryConfig"`: Allows you to create the criteria to retry a job. - `"jobExecutionsRolloutConfig"`: Allows you to create a staged rollout of the job. - `"namespaceId"`: The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs diff --git a/src/services/lakeformation.jl b/src/services/lakeformation.jl index 24fac143a3..13a5c23006 100644 --- a/src/services/lakeformation.jl +++ b/src/services/lakeformation.jl @@ -852,6 +852,135 @@ function get_table_objects( ) end +""" + get_temporary_glue_partition_credentials(partition, supported_permission_types, table_arn) + get_temporary_glue_partition_credentials(partition, supported_permission_types, table_arn, params::Dict{String,<:Any}) + +This API is identical to GetTemporaryTableCredentials except that this is used when the +target Data Catalog resource is of type Partition. Lake Formation restricts the permission +of the vended credentials with the same scope down policy which restricts access to a +single Amazon S3 prefix. + +# Arguments +- `partition`: A list of partition values identifying a single partition. +- `supported_permission_types`: A list of supported permission types for the partition. + Valid values are COLUMN_PERMISSION and CELL_FILTER_PERMISSION. +- `table_arn`: The ARN of the partitions' table. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"AuditContext"`: A structure representing context to access a resource (column names, + query ID, etc). +- `"DurationSeconds"`: The time period, between 900 and 21,600 seconds, for the timeout of + the temporary credentials. +- `"Permissions"`: Filters the request based on the user having been granted a list of + specified permissions on the requested resource(s). +""" +function get_temporary_glue_partition_credentials( + Partition, + SupportedPermissionTypes, + TableArn; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return lakeformation( + "POST", + "/GetTemporaryGluePartitionCredentials", + Dict{String,Any}( + "Partition" => Partition, + "SupportedPermissionTypes" => SupportedPermissionTypes, + "TableArn" => TableArn, + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_temporary_glue_partition_credentials( + Partition, + SupportedPermissionTypes, + TableArn, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return lakeformation( + "POST", + "/GetTemporaryGluePartitionCredentials", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "Partition" => Partition, + "SupportedPermissionTypes" => SupportedPermissionTypes, + "TableArn" => TableArn, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + +""" + get_temporary_glue_table_credentials(supported_permission_types, table_arn) + get_temporary_glue_table_credentials(supported_permission_types, table_arn, params::Dict{String,<:Any}) + +Allows a caller in a secure environment to assume a role with permission to access Amazon +S3. In order to vend such credentials, Lake Formation assumes the role associated with a +registered location, for example an Amazon S3 bucket, with a scope down policy which +restricts the access to a single prefix. + +# Arguments +- `supported_permission_types`: A list of supported permission types for the table. Valid + values are COLUMN_PERMISSION and CELL_FILTER_PERMISSION. +- `table_arn`: The ARN identifying a table in the Data Catalog for the temporary + credentials request. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"AuditContext"`: A structure representing context to access a resource (column names, + query ID, etc). +- `"DurationSeconds"`: The time period, between 900 and 21,600 seconds, for the timeout of + the temporary credentials. +- `"Permissions"`: Filters the request based on the user having been granted a list of + specified permissions on the requested resource(s). +""" +function get_temporary_glue_table_credentials( + SupportedPermissionTypes, TableArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return lakeformation( + "POST", + "/GetTemporaryGlueTableCredentials", + Dict{String,Any}( + "SupportedPermissionTypes" => SupportedPermissionTypes, "TableArn" => TableArn + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function get_temporary_glue_table_credentials( + SupportedPermissionTypes, + TableArn, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return lakeformation( + "POST", + "/GetTemporaryGlueTableCredentials", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "SupportedPermissionTypes" => SupportedPermissionTypes, + "TableArn" => TableArn, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ get_work_unit_results(query_id, work_unit_id, work_unit_token) get_work_unit_results(query_id, work_unit_id, work_unit_token, params::Dict{String,<:Any}) diff --git a/src/services/lex_models_v2.jl b/src/services/lex_models_v2.jl index 6a1cfb5d7d..c4f1cb301f 100644 --- a/src/services/lex_models_v2.jl +++ b/src/services/lex_models_v2.jl @@ -694,8 +694,8 @@ function create_slot( end """ - create_slot_type(bot_id, bot_version, locale_id, slot_type_name, value_selection_setting) - create_slot_type(bot_id, bot_version, locale_id, slot_type_name, value_selection_setting, params::Dict{String,<:Any}) + create_slot_type(bot_id, bot_version, locale_id, slot_type_name) + create_slot_type(bot_id, bot_version, locale_id, slot_type_name, params::Dict{String,<:Any}) Creates a custom slot type To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume. @@ -709,38 +709,37 @@ and a set of enumeration values, the values that a slot of this type can assume. languages. - `slot_type_name`: The name for the slot. A slot type name must be unique within the account. -- `value_selection_setting`: Determines the strategy that Amazon Lex uses to select a value - from the list of possible values. The field can be set to one of the following values: - OriginalValue - Returns the value entered by the user, if the user value is similar to the - slot value. TopResolution - If there is a resolution list for the slot, return the first - value in the resolution list. If there is no resolution list, return null. If you don't - specify the valueSelectionSetting parameter, the default is OriginalValue. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"description"`: A description of the slot type. Use the description to help identify the slot type in lists. +- `"externalSourceSetting"`: Sets the type of external information used to create the slot + type. - `"parentSlotTypeSignature"`: The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type. Only AMAZON.AlphaNumeric is supported. - `"slotTypeValues"`: A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot. +- `"valueSelectionSetting"`: Determines the strategy that Amazon Lex uses to select a value + from the list of possible values. The field can be set to one of the following values: + OriginalValue - Returns the value entered by the user, if the user value is similar to the + slot value. TopResolution - If there is a resolution list for the slot, return the first + value in the resolution list. If there is no resolution list, return null. If you don't + specify the valueSelectionSetting parameter, the default is OriginalValue. """ function create_slot_type( botId, botVersion, localeId, - slotTypeName, - valueSelectionSetting; + slotTypeName; aws_config::AbstractAWSConfig=global_aws_config(), ) return lex_models_v2( "PUT", "/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/slottypes/", - Dict{String,Any}( - "slotTypeName" => slotTypeName, "valueSelectionSetting" => valueSelectionSetting - ); + Dict{String,Any}("slotTypeName" => slotTypeName); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) @@ -750,7 +749,6 @@ function create_slot_type( botVersion, localeId, slotTypeName, - valueSelectionSetting, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config(), ) @@ -758,14 +756,7 @@ function create_slot_type( "PUT", "/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/slottypes/", Dict{String,Any}( - mergewith( - _merge, - Dict{String,Any}( - "slotTypeName" => slotTypeName, - "valueSelectionSetting" => valueSelectionSetting, - ), - params, - ), + mergewith(_merge, Dict{String,Any}("slotTypeName" => slotTypeName), params) ); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, @@ -3163,8 +3154,8 @@ function update_slot( end """ - update_slot_type(bot_id, bot_version, locale_id, slot_type_id, slot_type_name, value_selection_setting) - update_slot_type(bot_id, bot_version, locale_id, slot_type_id, slot_type_name, value_selection_setting, params::Dict{String,<:Any}) + update_slot_type(bot_id, bot_version, locale_id, slot_type_id, slot_type_name) + update_slot_type(bot_id, bot_version, locale_id, slot_type_id, slot_type_name, params::Dict{String,<:Any}) Updates the configuration of an existing slot type. @@ -3176,32 +3167,30 @@ Updates the configuration of an existing slot type. languages. - `slot_type_id`: The unique identifier of the slot type to update. - `slot_type_name`: The new name of the slot type. -- `value_selection_setting`: The strategy that Amazon Lex should use when deciding on a - value from the list of slot type values. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"description"`: The new description of the slot type. +- `"externalSourceSetting"`: - `"parentSlotTypeSignature"`: The new built-in slot type that should be used as the parent of this slot type. - `"slotTypeValues"`: A new list of values and their optional synonyms that define the values that the slot type can take. +- `"valueSelectionSetting"`: The strategy that Amazon Lex should use when deciding on a + value from the list of slot type values. """ function update_slot_type( botId, botVersion, localeId, slotTypeId, - slotTypeName, - valueSelectionSetting; + slotTypeName; aws_config::AbstractAWSConfig=global_aws_config(), ) return lex_models_v2( "PUT", "/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/slottypes/$(slotTypeId)/", - Dict{String,Any}( - "slotTypeName" => slotTypeName, "valueSelectionSetting" => valueSelectionSetting - ); + Dict{String,Any}("slotTypeName" => slotTypeName); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) @@ -3212,7 +3201,6 @@ function update_slot_type( localeId, slotTypeId, slotTypeName, - valueSelectionSetting, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config(), ) @@ -3220,14 +3208,7 @@ function update_slot_type( "PUT", "/bots/$(botId)/botversions/$(botVersion)/botlocales/$(localeId)/slottypes/$(slotTypeId)/", Dict{String,Any}( - mergewith( - _merge, - Dict{String,Any}( - "slotTypeName" => slotTypeName, - "valueSelectionSetting" => valueSelectionSetting, - ), - params, - ), + mergewith(_merge, Dict{String,Any}("slotTypeName" => slotTypeName), params) ); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, diff --git a/src/services/location.jl b/src/services/location.jl index 00b2695789..83d1086981 100644 --- a/src/services/location.jl +++ b/src/services/location.jl @@ -143,7 +143,8 @@ geofenced area, and then publishes one of the following events to Amazon EventBr ENTER if Amazon Location determines that the tracked device has entered a geofenced area. EXIT if Amazon Location determines that the tracked device has exited a geofenced area. The last geofence that a device was observed within is tracked for 30 days after the most -recent device position update. +recent device position update. Geofence evaluation uses the given device position. It +does not account for the optional Accuracy of a DevicePositionUpdate. # Arguments - `collection_name`: The geofence collection used in evaluating the position of devices @@ -275,6 +276,13 @@ maximum of one position per 30 second interval. If your update frequency is more 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. @@ -410,8 +418,8 @@ function calculate_route( end """ - create_geofence_collection(collection_name, pricing_plan) - create_geofence_collection(collection_name, pricing_plan, params::Dict{String,<:Any}) + create_geofence_collection(collection_name) + create_geofence_collection(collection_name, params::Dict{String,<:Any}) Creates a geofence collection, which manages and stores geofences. @@ -420,15 +428,15 @@ Creates a geofence collection, which manages and stores geofences. only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). Must be a unique geofence collection name. No spaces allowed. For example, ExampleGeofenceCollection. -- `pricing_plan`: Specifies the pricing plan for the geofence collection. For additional - details and restrictions on each pricing plan option, see the Amazon Location Service - pricing page. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"Description"`: An optional description for the geofence collection. - `"KmsKeyId"`: A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN. +- `"PricingPlan"`: Optionally specifies the pricing plan for the geofence collection. + Defaults to RequestBasedUsage. For additional details and restrictions on each pricing plan + option, see the Amazon Location Service pricing page. - `"PricingPlanDataSource"`: Specifies the data provider for the geofence collection. Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement For more information about Data Providers, and Pricing plans, see the Amazon Location @@ -444,19 +452,18 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys use \"aws:\" as a prefix for a key. """ function create_geofence_collection( - CollectionName, PricingPlan; aws_config::AbstractAWSConfig=global_aws_config() + CollectionName; aws_config::AbstractAWSConfig=global_aws_config() ) return location( "POST", "/geofencing/v0/collections", - Dict{String,Any}("CollectionName" => CollectionName, "PricingPlan" => PricingPlan); + Dict{String,Any}("CollectionName" => CollectionName); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) end function create_geofence_collection( CollectionName, - PricingPlan, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config(), ) @@ -464,13 +471,7 @@ function create_geofence_collection( "POST", "/geofencing/v0/collections", Dict{String,Any}( - mergewith( - _merge, - Dict{String,Any}( - "CollectionName" => CollectionName, "PricingPlan" => PricingPlan - ), - params, - ), + mergewith(_merge, Dict{String,Any}("CollectionName" => CollectionName), params) ); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, @@ -478,8 +479,8 @@ function create_geofence_collection( end """ - create_map(configuration, map_name, pricing_plan) - create_map(configuration, map_name, pricing_plan, params::Dict{String,<:Any}) + create_map(configuration, map_name) + create_map(configuration, map_name, params::Dict{String,<:Any}) Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers. @@ -489,12 +490,13 @@ sourced from global location data providers. - `map_name`: The name for the map resource. Requirements: Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). Must be a unique map resource name. No spaces allowed. For example, ExampleMap. -- `pricing_plan`: Specifies the pricing plan for your map resource. For additional details - and restrictions on each pricing plan option, see Amazon Location Service pricing. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"Description"`: An optional description for the map resource. +- `"PricingPlan"`: Optionally specifies the pricing plan for the map resource. Defaults to + RequestBasedUsage. For additional details and restrictions on each pricing plan option, see + Amazon Location Service pricing. - `"Tags"`: Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. Format: \"key\" : \"value\" Restrictions: Maximum 50 tags per resource Each resource tag must be unique @@ -504,16 +506,12 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys \"aws:\" as a prefix for a key. """ function create_map( - Configuration, MapName, PricingPlan; aws_config::AbstractAWSConfig=global_aws_config() + Configuration, MapName; aws_config::AbstractAWSConfig=global_aws_config() ) return location( "POST", "/maps/v0/maps", - Dict{String,Any}( - "Configuration" => Configuration, - "MapName" => MapName, - "PricingPlan" => PricingPlan, - ); + Dict{String,Any}("Configuration" => Configuration, "MapName" => MapName); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) @@ -521,7 +519,6 @@ end function create_map( Configuration, MapName, - PricingPlan, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config(), ) @@ -531,11 +528,7 @@ function create_map( Dict{String,Any}( mergewith( _merge, - Dict{String,Any}( - "Configuration" => Configuration, - "MapName" => MapName, - "PricingPlan" => PricingPlan, - ), + Dict{String,Any}("Configuration" => Configuration, "MapName" => MapName), params, ), ); @@ -545,12 +538,13 @@ function create_map( end """ - create_place_index(data_source, index_name, pricing_plan) - create_place_index(data_source, index_name, pricing_plan, params::Dict{String,<:Any}) + create_place_index(data_source, index_name) + create_place_index(data_source, index_name, params::Dict{String,<:Any}) Creates a place index resource in your AWS account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and -reverse geocode coordinates by using the SearchPlaceIndexForPosition operation. +reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable +autosuggestions by using the SearchPlaceIndexForSuggestions operation. # Arguments - `data_source`: Specifies the geospatial data provider for the new place index. This @@ -566,13 +560,14 @@ reverse geocode coordinates by using the SearchPlaceIndexForPosition operation. alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). Must be a unique place index resource name. No spaces allowed. For example, ExamplePlaceIndex. -- `pricing_plan`: Specifies the pricing plan for your place index resource. For additional - details and restrictions on each pricing plan option, see Amazon Location Service pricing. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"DataSourceConfiguration"`: Specifies the data storage option requesting Places. - `"Description"`: The optional description for the place index resource. +- `"PricingPlan"`: Optionally specifies the pricing plan for the place index resource. + Defaults to RequestBasedUsage. For additional details and restrictions on each pricing plan + option, see Amazon Location Service pricing. - `"Tags"`: Applies one or more tags to the place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources. Format: \"key\" : \"value\" Restrictions: Maximum 50 tags per resource. Each tag key must be unique and @@ -582,16 +577,12 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys use \"aws:\" as a prefix for a key. """ function create_place_index( - DataSource, IndexName, PricingPlan; aws_config::AbstractAWSConfig=global_aws_config() + DataSource, IndexName; aws_config::AbstractAWSConfig=global_aws_config() ) return location( "POST", "/places/v0/indexes", - Dict{String,Any}( - "DataSource" => DataSource, - "IndexName" => IndexName, - "PricingPlan" => PricingPlan, - ); + Dict{String,Any}("DataSource" => DataSource, "IndexName" => IndexName); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) @@ -599,7 +590,6 @@ end function create_place_index( DataSource, IndexName, - PricingPlan, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config(), ) @@ -609,11 +599,7 @@ function create_place_index( Dict{String,Any}( mergewith( _merge, - Dict{String,Any}( - "DataSource" => DataSource, - "IndexName" => IndexName, - "PricingPlan" => PricingPlan, - ), + Dict{String,Any}("DataSource" => DataSource, "IndexName" => IndexName), params, ), ); @@ -623,8 +609,8 @@ function create_place_index( end """ - create_route_calculator(calculator_name, data_source, pricing_plan) - create_route_calculator(calculator_name, data_source, pricing_plan, params::Dict{String,<:Any}) + create_route_calculator(calculator_name, data_source) + create_route_calculator(calculator_name, data_source, params::Dict{String,<:Any}) Creates a route calculator resource in your AWS account. You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route @@ -643,13 +629,13 @@ calculator sources traffic and road network data from your chosen data provider. coverage. Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage. For additional information , see Data providers on the Amazon Location Service Developer Guide. -- `pricing_plan`: Specifies the pricing plan for your route calculator resource. For - additional details and restrictions on each pricing plan option, see Amazon Location - Service pricing. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"Description"`: The optional description for the route calculator resource. +- `"PricingPlan"`: Optionally specifies the pricing plan for the route calculator resource. + Defaults to RequestBasedUsage. For additional details and restrictions on each pricing plan + option, see Amazon Location Service pricing. - `"Tags"`: Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. For example: { \"tag1\" : \"value1\", \"tag2\" : \"value2\"} Format: \"key\" : \"value\" @@ -660,19 +646,12 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys for a key. """ function create_route_calculator( - CalculatorName, - DataSource, - PricingPlan; - aws_config::AbstractAWSConfig=global_aws_config(), + CalculatorName, DataSource; aws_config::AbstractAWSConfig=global_aws_config() ) return location( "POST", "/routes/v0/calculators", - Dict{String,Any}( - "CalculatorName" => CalculatorName, - "DataSource" => DataSource, - "PricingPlan" => PricingPlan, - ); + Dict{String,Any}("CalculatorName" => CalculatorName, "DataSource" => DataSource); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) @@ -680,7 +659,6 @@ end function create_route_calculator( CalculatorName, DataSource, - PricingPlan, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config(), ) @@ -691,9 +669,7 @@ function create_route_calculator( mergewith( _merge, Dict{String,Any}( - "CalculatorName" => CalculatorName, - "DataSource" => DataSource, - "PricingPlan" => PricingPlan, + "CalculatorName" => CalculatorName, "DataSource" => DataSource ), params, ), @@ -704,15 +680,13 @@ function create_route_calculator( end """ - create_tracker(pricing_plan, tracker_name) - create_tracker(pricing_plan, tracker_name, params::Dict{String,<:Any}) + create_tracker(tracker_name) + create_tracker(tracker_name, params::Dict{String,<:Any}) Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices. # Arguments -- `pricing_plan`: Specifies the pricing plan for the tracker resource. For additional - details and restrictions on each pricing plan option, see Amazon Location Service pricing. - `tracker_name`: The name for the tracker resource. Requirements: Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_). Must be a unique tracker resource name. No spaces allowed. For example, ExampleTracker. @@ -731,7 +705,16 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map. + AccuracyBased - If the device has moved less than the measured accuracy, location updates + are ignored. For example, if two consecutive updates from a device have a horizontal + accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 + m. Ignored location updates are neither evaluated against linked geofence collections, nor + stored. This can reduce the effects of GPS noise when displaying device trajectories on a + map, and can help control your costs by reducing the number of geofence evaluations. This field is optional. If not specified, the default value is TimeBased. +- `"PricingPlan"`: Optionally specifies the pricing plan for the tracker resource. Defaults + to RequestBasedUsage. For additional details and restrictions on each pricing plan option, + see Amazon Location Service pricing. - `"PricingPlanDataSource"`: Specifies the data provider for the tracker resource. Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement For more information about Data Providers, and Pricing plans, see the Amazon Location @@ -746,19 +729,16 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. Cannot use \"aws:\" as a prefix for a key. """ -function create_tracker( - PricingPlan, TrackerName; aws_config::AbstractAWSConfig=global_aws_config() -) +function create_tracker(TrackerName; aws_config::AbstractAWSConfig=global_aws_config()) return location( "POST", "/tracking/v0/trackers", - Dict{String,Any}("PricingPlan" => PricingPlan, "TrackerName" => TrackerName); + Dict{String,Any}("TrackerName" => TrackerName); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, ) end function create_tracker( - PricingPlan, TrackerName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config(), @@ -767,13 +747,7 @@ function create_tracker( "POST", "/tracking/v0/trackers", Dict{String,Any}( - mergewith( - _merge, - Dict{String,Any}( - "PricingPlan" => PricingPlan, "TrackerName" => TrackerName - ), - params, - ), + mergewith(_merge, Dict{String,Any}("TrackerName" => TrackerName), params) ); aws_config=aws_config, feature_set=SERVICE_FEATURE_SET, @@ -1850,6 +1824,78 @@ function search_place_index_for_position( ) end +""" + search_place_index_for_suggestions(index_name, text) + search_place_index_for_suggestions(index_name, text, params::Dict{String,<:Any}) + +Generates suggestions for addresses and points of interest based on partial or misspelled +free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy +matching. Optional parameters let you narrow your search results by bounding box or +country, or bias your search toward a specific position on the globe. You can search for +suggested place names near a specified position by using BiasPosition, or filter results +within a bounding box by using FilterBBox. These parameters are mutually exclusive; using +both BiasPosition and FilterBBox in the same command returns an error. + +# Arguments +- `index_name`: The name of the place index resource you want to use for the search. +- `text`: The free-form partial text to use to generate place suggestions. For example, + eiffel tow. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"BiasPosition"`: An optional parameter that indicates a preference for place suggestions + that are closer to a specified position. If provided, this parameter must contain a pair + of numbers. The first number represents the X coordinate, or longitude; the second number + represents the Y coordinate, or latitude. For example, [-123.1174, 49.2847] represents the + position with longitude -123.1174 and latitude 49.2847. BiasPosition and FilterBBox are + mutually exclusive. Specifying both options results in an error. +- `"FilterBBox"`: An optional parameter that limits the search results by returning only + suggestions within a specified bounding box. If provided, this parameter must contain a + total of four consecutive numbers in two pairs. The first pair of numbers represents the X + and Y coordinates (longitude and latitude, respectively) of the southwest corner of the + bounding box; the second pair of numbers represents the X and Y coordinates (longitude and + latitude, respectively) of the northeast corner of the bounding box. For example, + [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest + 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. +- `"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. +- `"Language"`: The preferred language used to return results. The value must be a valid + BCP 47 language tag, for example, en for English. This setting affects the languages used + in the results. It does not change which results are returned. If the language is not + specified, or not supported for a particular result, the partner automatically chooses a + language for the result. Used only when the partner selected is Here. +- `"MaxResults"`: An optional parameter. The maximum number of results returned per + request. The default: 5 +""" +function search_place_index_for_suggestions( + IndexName, Text; aws_config::AbstractAWSConfig=global_aws_config() +) + return location( + "POST", + "/places/v0/indexes/$(IndexName)/search/suggestions", + Dict{String,Any}("Text" => Text); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function search_place_index_for_suggestions( + IndexName, + Text, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return location( + "POST", + "/places/v0/indexes/$(IndexName)/search/suggestions", + Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Text" => Text), params)); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ search_place_index_for_text(index_name, text) search_place_index_for_text(index_name, text, params::Dict{String,<:Any}) @@ -2190,8 +2236,15 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of - geofence evaluations and device positions to retrieve. Distance-based filtering can also - reduce the jitter effect when displaying device trajectory on a map. + geofence evaluations and historical device positions to paginate through. Distance-based + filtering can also reduce the effects of GPS noise when displaying device trajectories on a + map. AccuracyBased - If the device has moved less than the measured accuracy, location + updates are ignored. For example, if two consecutive updates from a device have a + horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved + less than 15 m. Ignored location updates are neither evaluated against linked geofence + collections, nor stored. This helps educe the effects of GPS noise when displaying device + trajectories on a map, and can help control costs by reducing the number of geofence + evaluations. - `"PricingPlan"`: Updates the pricing plan for the tracker resource. For more information about each pricing plan option restrictions, see Amazon Location Service pricing. - `"PricingPlanDataSource"`: Updates the data provider for the tracker resource. A diff --git a/src/services/lookoutmetrics.jl b/src/services/lookoutmetrics.jl index 22ab4698b6..2015892802 100644 --- a/src/services/lookoutmetrics.jl +++ b/src/services/lookoutmetrics.jl @@ -714,6 +714,61 @@ function list_anomaly_detectors( ) end +""" + list_anomaly_group_related_metrics(anomaly_detector_arn, anomaly_group_id) + list_anomaly_group_related_metrics(anomaly_detector_arn, anomaly_group_id, params::Dict{String,<:Any}) + +Returns a list of measures that are potential causes or effects of an anomaly group. + +# Arguments +- `anomaly_detector_arn`: The Amazon Resource Name (ARN) of the anomaly detector. +- `anomaly_group_id`: The ID of the anomaly group. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"MaxResults"`: The maximum number of results to return. +- `"NextToken"`: Specify the pagination token that's returned by a previous request to + retrieve the next page of results. +- `"RelationshipTypeFilter"`: Filter for potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP) or + downstream effects (EFFECT_OF_INPUT_ANOMALY_GROUP) of the anomaly group. +""" +function list_anomaly_group_related_metrics( + AnomalyDetectorArn, AnomalyGroupId; aws_config::AbstractAWSConfig=global_aws_config() +) + return lookoutmetrics( + "POST", + "/ListAnomalyGroupRelatedMetrics", + Dict{String,Any}( + "AnomalyDetectorArn" => AnomalyDetectorArn, "AnomalyGroupId" => AnomalyGroupId + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function list_anomaly_group_related_metrics( + AnomalyDetectorArn, + AnomalyGroupId, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return lookoutmetrics( + "POST", + "/ListAnomalyGroupRelatedMetrics", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "AnomalyDetectorArn" => AnomalyDetectorArn, + "AnomalyGroupId" => AnomalyGroupId, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ list_anomaly_group_summaries(anomaly_detector_arn, sensitivity_threshold) list_anomaly_group_summaries(anomaly_detector_arn, sensitivity_threshold, params::Dict{String,<:Any}) diff --git a/src/services/lookoutvision.jl b/src/services/lookoutvision.jl index 28f355d7e5..ef3bd46849 100644 --- a/src/services/lookoutvision.jl +++ b/src/services/lookoutvision.jl @@ -31,12 +31,15 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys asynchronous and might take a while to complete. To find out the current status, Check the value of Status returned in a call to DescribeDataset. - `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to - CreateDataset completes only once. You choose the value to pass. For example, An issue, - such as an network outage, might prevent you from getting a response from CreateDataset. In - this case, safely retry your call to CreateDataset by using the same ClientToken parameter - value. An error occurs if the other input parameters are not the same as in the first - request. Using a different value for ClientToken is considered a new call to CreateDataset. - An idempotency token is active for 8 hours. + CreateDataset completes only once. You choose the value to pass. For example, An issue + might prevent you from getting a response from CreateDataset. In this case, safely retry + your call to CreateDataset by using the same ClientToken parameter value. If you don't + supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This + prevents retries after a network error from making multiple dataset creation requests. + You'll need to provide your own value for other use cases. An error occurs if the other + input parameters are not the same as in the first request. Using a different value for + ClientToken is considered a new call to CreateDataset. An idempotency token is active for 8 + hours. """ function create_dataset( DatasetType, projectName; aws_config::AbstractAWSConfig=global_aws_config() @@ -96,18 +99,20 @@ require permission to the lookoutvision:TagResource operation. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"Description"`: A description for the version of the model. -- `"KmsKeyId"`: The identifier for your AWS Key Management Service (AWS KMS) customer - master key (CMK). The key is used to encrypt training and test images copied into the - service for model training. Your source images are unaffected. If this parameter is not - specified, the copied images are encrypted by a key that AWS owns and manages. +- `"KmsKeyId"`: The identifier for your AWS KMS key. The key is used to encrypt training + and test images copied into the service for model training. Your source images are + unaffected. If this parameter is not specified, the copied images are encrypted by a key + that AWS owns and manages. - `"Tags"`: A set of tags (key-value pairs) that you want to attach to the model. - `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to - CreateModel completes only once. You choose the value to pass. For example, An issue, such - as an network outage, might prevent you from getting a response from CreateModel. In this - case, safely retry your call to CreateModel by using the same ClientToken parameter value. - An error occurs if the other input parameters are not the same as in the first request. - Using a different value for ClientToken is considered a new call to CreateModel. An - idempotency token is active for 8 hours. + CreateModel completes only once. You choose the value to pass. For example, An issue might + prevent you from getting a response from CreateModel. In this case, safely retry your call + to CreateModel by using the same ClientToken parameter value. If you don't supply a value + for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries + after a network error from starting multiple training jobs. You'll need to provide your own + value for other use cases. An error occurs if the other input parameters are not the same + as in the first request. Using a different value for ClientToken is considered a new call + to CreateModel. An idempotency token is active for 8 hours. """ function create_model( OutputConfig, projectName; aws_config::AbstractAWSConfig=global_aws_config() @@ -159,12 +164,15 @@ lookoutvision:CreateProject operation. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to - CreateProject completes only once. You choose the value to pass. For example, An issue, - such as an network outage, might prevent you from getting a response from CreateProject. In - this case, safely retry your call to CreateProject by using the same ClientToken parameter - value. An error occurs if the other input parameters are not the same as in the first - request. Using a different value for ClientToken is considered a new call to CreateProject. - An idempotency token is active for 8 hours. + CreateProject completes only once. You choose the value to pass. For example, An issue + might prevent you from getting a response from CreateProject. In this case, safely retry + your call to CreateProject by using the same ClientToken parameter value. If you don't + supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This + prevents retries after a network error from making multiple project creation requests. + You'll need to provide your own value for other use cases. An error occurs if the other + input parameters are not the same as in the first request. Using a different value for + ClientToken is considered a new call to CreateProject. An idempotency token is active for 8 + hours. """ function create_project(ProjectName; aws_config::AbstractAWSConfig=global_aws_config()) return lookoutvision( @@ -221,12 +229,15 @@ lookoutvision:DeleteDataset operation. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to - DeleteDataset completes only once. You choose the value to pass. For example, An issue, - such as an network outage, might prevent you from getting a response from DeleteDataset. In - this case, safely retry your call to DeleteDataset by using the same ClientToken parameter - value. An error occurs if the other input parameters are not the same as in the first - request. Using a different value for ClientToken is considered a new call to DeleteDataset. - An idempotency token is active for 8 hours. + DeleteDataset completes only once. You choose the value to pass. For example, An issue + might prevent you from getting a response from DeleteDataset. In this case, safely retry + your call to DeleteDataset by using the same ClientToken parameter value. If you don't + supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This + prevents retries after a network error from making multiple deletetion requests. You'll + need to provide your own value for other use cases. An error occurs if the other input + parameters are not the same as in the first request. Using a different value for + ClientToken is considered a new call to DeleteDataset. An idempotency token is active for 8 + hours. """ function delete_dataset( datasetType, projectName; aws_config::AbstractAWSConfig=global_aws_config() @@ -264,8 +275,8 @@ end Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the StopModel operation. It might take a few seconds to delete a model. -To determine if a model has been deleted, call ListProjects and check if the version of the -model (ModelVersion) is in the Models array. This operation requires permissions to +To determine if a model has been deleted, call ListModels and check if the version of the +model (ModelVersion) is in the Models array. This operation requires permissions to perform the lookoutvision:DeleteModel operation. # Arguments @@ -275,12 +286,14 @@ perform the lookoutvision:DeleteModel operation. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to - DeleteModel completes only once. You choose the value to pass. For example, An issue, such - as an network outage, might prevent you from getting a response from DeleteModel. In this - case, safely retry your call to DeleteModel by using the same ClientToken parameter value. - An error occurs if the other input parameters are not the same as in the first request. - Using a different value for ClientToken is considered a new call to DeleteModel. An - idempotency token is active for 8 hours. + DeleteModel completes only once. You choose the value to pass. For example, an issue might + prevent you from getting a response from DeleteModel. In this case, safely retry your call + to DeleteModel by using the same ClientToken parameter value. If you don't supply a value + for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries + after a network error from making multiple model deletion requests. You'll need to provide + your own value for other use cases. An error occurs if the other input parameters are not + the same as in the first request. Using a different value for ClientToken is considered a + new call to DeleteModel. An idempotency token is active for 8 hours. """ function delete_model( modelVersion, projectName; aws_config::AbstractAWSConfig=global_aws_config() @@ -329,12 +342,15 @@ lookoutvision:DeleteProject operation. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to - DeleteProject completes only once. You choose the value to pass. For example, An issue, - such as an network outage, might prevent you from getting a response from DeleteProject. In - this case, safely retry your call to DeleteProject by using the same ClientToken parameter - value. An error occurs if the other input parameters are not the same as in the first - request. Using a different value for ClientToken is considered a new call to DeleteProject. - An idempotency token is active for 8 hours. + DeleteProject completes only once. You choose the value to pass. For example, An issue + might prevent you from getting a response from DeleteProject. In this case, safely retry + your call to DeleteProject by using the same ClientToken parameter value. If you don't + supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This + prevents retries after a network error from making multiple project deletion requests. + You'll need to provide your own value for other use cases. An error occurs if the other + input parameters are not the same as in the first request. Using a different value for + ClientToken is considered a new call to DeleteProject. An idempotency token is active for 8 + hours. """ function delete_project(projectName; aws_config::AbstractAWSConfig=global_aws_config()) return lookoutvision( @@ -441,6 +457,46 @@ function describe_model( ) end +""" + describe_model_packaging_job(job_name, project_name) + describe_model_packaging_job(job_name, project_name, params::Dict{String,<:Any}) + +Describes an Amazon Lookout for Vision model packaging job. This operation requires +permissions to perform the lookoutvision:DescribeModelPackagingJob operation. For more +information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon +Lookout for Vision Developer Guide. + +# Arguments +- `job_name`: The job name for the model packaging job. +- `project_name`: The name of the project that contains the model packaging job that you + want to describe. + +""" +function describe_model_packaging_job( + jobName, projectName; aws_config::AbstractAWSConfig=global_aws_config() +) + return lookoutvision( + "GET", + "/2020-11-20/projects/$(projectName)/modelpackagingjobs/$(jobName)"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function describe_model_packaging_job( + jobName, + projectName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return lookoutvision( + "GET", + "/2020-11-20/projects/$(projectName)/modelpackagingjobs/$(jobName)", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ describe_project(project_name) describe_project(project_name, params::Dict{String,<:Any}) @@ -599,12 +655,60 @@ function list_dataset_entries( ) end +""" + list_model_packaging_jobs(project_name) + list_model_packaging_jobs(project_name, params::Dict{String,<:Any}) + + Lists the model packaging jobs created for an Amazon Lookout for Vision project. This +operation requires permissions to perform the lookoutvision:ListModelPackagingJobs +operation. For more information, see Using your Amazon Lookout for Vision model on an edge +device in the Amazon Lookout for Vision Developer Guide. + +# Arguments +- `project_name`: The name of the project for which you want to list the model packaging + jobs. + +# 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 paginated call. The largest + value you can specify is 100. If you specify a value greater than 100, a + ValidationException error occurs. The default value is 100. +- `"nextToken"`: If the previous response was incomplete (because there is more results to + retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can + use this pagination token to retrieve the next set of results. +""" +function list_model_packaging_jobs( + projectName; aws_config::AbstractAWSConfig=global_aws_config() +) + return lookoutvision( + "GET", + "/2020-11-20/projects/$(projectName)/modelpackagingjobs"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function list_model_packaging_jobs( + projectName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return lookoutvision( + "GET", + "/2020-11-20/projects/$(projectName)/modelpackagingjobs", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ list_models(project_name) list_models(project_name, params::Dict{String,<:Any}) -Lists the versions of a model in an Amazon Lookout for Vision project. This operation -requires permissions to perform the lookoutvision:ListModels operation. +Lists the versions of a model in an Amazon Lookout for Vision project. The ListModels +operation is eventually consistent. Recent calls to CreateModel might take a while to +appear in the response from ListProjects. This operation requires permissions to perform +the lookoutvision:ListModels operation. # Arguments - `project_name`: The name of the project that contains the model versions that you want to @@ -645,7 +749,9 @@ end list_projects() list_projects(params::Dict{String,<:Any}) -Lists the Amazon Lookout for Vision projects in your AWS account. This operation requires +Lists the Amazon Lookout for Vision projects in your AWS account. The ListProjects +operation is eventually consistent. Recent calls to CreateProject and DeleteProject might +take a while to appear in the response from ListProjects. This operation requires permissions to perform the lookoutvision:ListProjects operation. # Optional Parameters @@ -726,21 +832,22 @@ requires permissions to perform the lookoutvision:StartModel operation. # Arguments - `min_inference_units`: The minimum number of inference units to use. A single inference - unit represents 1 hour of processing and can support up to 5 Transaction Pers Second (TPS). - Use a higher number to increase the TPS throughput of your model. You are charged for the - number of inference units that you use. + unit represents 1 hour of processing. Use a higher number to increase the TPS throughput of + your model. You are charged for the number of inference units that you use. - `model_version`: The version of the model that you want to start. - `project_name`: The name of the project that contains the model that you want to start. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to - StartModel completes only once. You choose the value to pass. For example, An issue, such - as an network outage, might prevent you from getting a response from StartModel. In this - case, safely retry your call to StartModel by using the same ClientToken parameter value. - An error occurs if the other input parameters are not the same as in the first request. - Using a different value for ClientToken is considered a new call to StartModel. An - idempotency token is active for 8 hours. + StartModel completes only once. You choose the value to pass. For example, An issue might + prevent you from getting a response from StartModel. In this case, safely retry your call + to StartModel by using the same ClientToken parameter value. If you don't supply a value + for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries + after a network error from making multiple start requests. You'll need to provide your own + value for other use cases. An error occurs if the other input parameters are not the same + as in the first request. Using a different value for ClientToken is considered a new call + to StartModel. An idempotency token is active for 8 hours. """ function start_model( MinInferenceUnits, @@ -784,6 +891,89 @@ function start_model( ) end +""" + start_model_packaging_job(configuration, model_version, project_name) + start_model_packaging_job(configuration, model_version, project_name, params::Dict{String,<:Any}) + +Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an +AWS IoT Greengrass component for a Lookout for Vision model. You can use the component to +deploy your model to an edge device managed by Greengrass. Use the +DescribeModelPackagingJob API to determine the current status of the job. The model +packaging job is complete if the value of Status is SUCCEEDED. To deploy the component to +the target device, use the component name and component version with the AWS IoT Greengrass +CreateDeployment API. This operation requires the following permissions: +lookoutvision:StartModelPackagingJobs s3:PutObject s3:GetBucketLocation +greengrass:CreateComponentVersion greengrass:DescribeComponent (Optional) +greengrass:TagResource. Only required if you want to tag the component. For more +information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon +Lookout for Vision Developer Guide. + +# Arguments +- `configuration`: The configuration for the model packaging job. +- `model_version`: The version of the model within the project that you want to package. +- `project_name`: The name of the project which contains the version of the model that you + want to package. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"Description"`: A description for the model packaging job. +- `"JobName"`: A name for the model packaging job. If you don't supply a value, the service + creates a job name for you. +- `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to + StartModelPackagingJob completes only once. You choose the value to pass. For example, An + issue might prevent you from getting a response from StartModelPackagingJob. In this case, + safely retry your call to StartModelPackagingJob by using the same ClientToken parameter + value. If you don't supply a value for ClientToken, the AWS SDK you are using inserts a + value for you. This prevents retries after a network error from making multiple dataset + creation requests. You'll need to provide your own value for other use cases. An error + occurs if the other input parameters are not the same as in the first request. Using a + different value for ClientToken is considered a new call to StartModelPackagingJob. An + idempotency token is active for 8 hours. +""" +function start_model_packaging_job( + Configuration, + ModelVersion, + projectName; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return lookoutvision( + "POST", + "/2020-11-20/projects/$(projectName)/modelpackagingjobs", + Dict{String,Any}( + "Configuration" => Configuration, + "ModelVersion" => ModelVersion, + "X-Amzn-Client-Token" => string(uuid4()), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function start_model_packaging_job( + Configuration, + ModelVersion, + projectName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return lookoutvision( + "POST", + "/2020-11-20/projects/$(projectName)/modelpackagingjobs", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "Configuration" => Configuration, + "ModelVersion" => ModelVersion, + "X-Amzn-Client-Token" => string(uuid4()), + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ stop_model(model_version, project_name) stop_model(model_version, project_name, params::Dict{String,<:Any}) @@ -800,12 +990,14 @@ lookoutvision:StopModel operation. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to - StopModel completes only once. You choose the value to pass. For example, An issue, such as - an network outage, might prevent you from getting a response from StopModel. In this case, - safely retry your call to StopModel by using the same ClientToken parameter value. An error - occurs if the other input parameters are not the same as in the first request. Using a - different value for ClientToken is considered a new call to StopModel. An idempotency token - is active for 8 hours. + StopModel completes only once. You choose the value to pass. For example, An issue might + prevent you from getting a response from StopModel. In this case, safely retry your call to + StopModel by using the same ClientToken parameter value. If you don't supply a value for + ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after + a network error from making multiple stop requests. You'll need to provide your own value + for other use cases. An error occurs if the other input parameters are not the same as in + the first request. Using a different value for ClientToken is considered a new call to + StopModel. An idempotency token is active for 8 hours. """ function stop_model( modelVersion, projectName; aws_config::AbstractAWSConfig=global_aws_config() @@ -918,11 +1110,17 @@ end update_dataset_entries(changes, dataset_type, project_name) update_dataset_entries(changes, dataset_type, project_name, params::Dict{String,<:Any}) -Adds one or more JSON Line entries to a dataset. A JSON Line includes information about an -image used for training or testing an Amazon Lookout for Vision model. The following is an -example JSON Line. Updating a dataset might take a while to complete. To check the current -status, call DescribeDataset and check the Status field in the response. This operation -requires permissions to perform the lookoutvision:UpdateDatasetEntries operation. +Adds or updates one or more JSON Line entries in a dataset. A JSON Line includes +information about an image used for training or testing an Amazon Lookout for Vision model. +To update an existing JSON Line, use the source-ref field to identify the JSON Line. The +JSON line that you supply replaces the existing JSON line. Any existing annotations that +are not in the new JSON line are removed from the dataset. For more information, see +Defining JSON lines for anomaly classification in the Amazon Lookout for Vision Developer +Guide. The images you reference in the source-ref field of a JSON line, must be in the +same S3 bucket as the existing images in the dataset. Updating a dataset might take a +while to complete. To check the current status, call DescribeDataset and check the Status +field in the response. This operation requires permissions to perform the +lookoutvision:UpdateDatasetEntries operation. # Arguments - `changes`: The entries to add to the dataset. @@ -935,11 +1133,14 @@ requires permissions to perform the lookoutvision:UpdateDatasetEntries operation Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"X-Amzn-Client-Token"`: ClientToken is an idempotency token that ensures a call to UpdateDatasetEntries completes only once. You choose the value to pass. For example, An - issue, such as an network outage, might prevent you from getting a response from - UpdateDatasetEntries. In this case, safely retry your call to UpdateDatasetEntries by using - the same ClientToken parameter value. An error occurs if the other input parameters are not - the same as in the first request. Using a different value for ClientToken is considered a - new call to UpdateDatasetEntries. An idempotency token is active for 8 hours. + issue might prevent you from getting a response from UpdateDatasetEntries. In this case, + safely retry your call to UpdateDatasetEntries by using the same ClientToken parameter + value. If you don't supply a value for ClientToken, the AWS SDK you are using inserts a + value for you. This prevents retries after a network error from making multiple updates + with the same dataset entries. You'll need to provide your own value for other use cases. + An error occurs if the other input parameters are not the same as in the first request. + Using a different value for ClientToken is considered a new call to UpdateDatasetEntries. + An idempotency token is active for 8 hours. """ function update_dataset_entries( Changes, datasetType, projectName; aws_config::AbstractAWSConfig=global_aws_config() diff --git a/src/services/mediaconnect.jl b/src/services/mediaconnect.jl index 43a62f0533..ffe5b7c722 100644 --- a/src/services/mediaconnect.jl +++ b/src/services/mediaconnect.jl @@ -1079,7 +1079,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"destination"`: The IP address where you want to send the output. - `"encryption"`: The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). -- `"maxLatency"`: The maximum latency in milliseconds for Zixi-based streams. +- `"maxLatency"`: The maximum latency in milliseconds. This parameter applies only to + RIST-based, Zixi-based, and Fujitsu-based streams. - `"mediaStreamOutputConfigurations"`: The media streams that are associated with the output, and the parameters for those associations. - `"minLatency"`: The minimum latency in milliseconds for SRT-based streams. In streams @@ -1090,6 +1091,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"port"`: The port to use when content is distributed to this output. - `"protocol"`: The protocol to use for the output. - `"remoteId"`: The remote ID for the Zixi-pull stream. +- `"senderControlPort"`: The port that the flow uses to send outbound requests to initiate + connection with the sender. +- `"senderIpAddress"`: The IP address that the flow communicates with to initiate + connection with the sender. - `"smoothingLatency"`: The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams. - `"streamId"`: The stream ID that you want to use for this transport. This parameter @@ -1143,7 +1148,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"ingestPort"`: The port that the flow will be listening on for incoming content. - `"maxBitrate"`: The smoothing max bitrate for RIST, RTP, and RTP-FEC streams. - `"maxLatency"`: The maximum latency in milliseconds. This parameter applies only to - RIST-based and Zixi-based streams. + RIST-based, Zixi-based, and Fujitsu-based streams. - `"maxSyncBuffer"`: The size of the buffer (in milliseconds) to use to sync incoming source data. - `"mediaStreamSourceConfigurations"`: The media streams that are associated with the @@ -1154,6 +1159,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys set to the highest number between the sender’s minimum latency and the receiver’s minimum latency. - `"protocol"`: The protocol that is used by the source. +- `"senderControlPort"`: The port that the flow uses to send outbound requests to initiate + connection with the sender. +- `"senderIpAddress"`: The IP address that the flow communicates with to initiate + connection with the sender. - `"streamId"`: The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams. - `"vpcInterfaceName"`: The name of the VPC interface to use for this source. diff --git a/src/services/network_firewall.jl b/src/services/network_firewall.jl index 5e24aca3fb..72d1b6dbf5 100644 --- a/src/services/network_firewall.jl +++ b/src/services/network_firewall.jl @@ -649,6 +649,42 @@ function describe_rule_group( ) end +""" + describe_rule_group_metadata() + describe_rule_group_metadata(params::Dict{String,<:Any}) + +High-level information about a rule group, returned by operations like create and describe. +You can use the information provided in the metadata to retrieve and manage a rule group. +You can retrieve all objects for a rule group by calling DescribeRuleGroup. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"RuleGroupArn"`: The descriptive name of the rule group. You can't change the name of a + rule group after you create it. You must specify the ARN or the name, and you can specify + both. +- `"RuleGroupName"`: The descriptive name of the rule group. You can't change the name of a + rule group after you create it. You must specify the ARN or the name, and you can specify + both. +- `"Type"`: Indicates whether the rule group is stateless or stateful. If the rule group is + stateless, it contains stateless rules. If it is stateful, it contains stateful rules. + This setting is required for requests that do not include the RuleGroupARN. +""" +function describe_rule_group_metadata(; aws_config::AbstractAWSConfig=global_aws_config()) + return network_firewall( + "DescribeRuleGroupMetadata"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET + ) +end +function describe_rule_group_metadata( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return network_firewall( + "DescribeRuleGroupMetadata", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ disassociate_subnets(subnet_ids) disassociate_subnets(subnet_ids, params::Dict{String,<:Any}) @@ -787,6 +823,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request. +- `"Scope"`: The scope of the request. The default setting of ACCOUNT or a setting of NULL + returns all of the rule groups in your account. A setting of MANAGED returns all available + managed rule groups. """ function list_rule_groups(; aws_config::AbstractAWSConfig=global_aws_config()) return network_firewall( @@ -1177,7 +1216,9 @@ end update_firewall_policy_change_protection(firewall_policy_change_protection) update_firewall_policy_change_protection(firewall_policy_change_protection, params::Dict{String,<:Any}) - +Modifies the flag, ChangeProtection, which indicates whether it is possible to change the +firewall. If the flag is set to TRUE, the firewall is protected from changes. This setting +helps protect against accidentally changing a firewall that's in use. # Arguments - `firewall_policy_change_protection`: A setting indicating whether the firewall is diff --git a/src/services/nimble.jl b/src/services/nimble.jl index 23881e8b72..1375632bc1 100644 --- a/src/services/nimble.jl +++ b/src/services/nimble.jl @@ -1459,7 +1459,7 @@ end list_studio_members(studio_id) list_studio_members(studio_id, params::Dict{String,<:Any}) -Get all users in a given studio membership. +Get all users in a given studio membership. ListStudioMembers only returns admin members. # Arguments - `studio_id`: The studio ID. diff --git a/src/services/outposts.jl b/src/services/outposts.jl index 187d7b1b23..e18c0eb4bd 100644 --- a/src/services/outposts.jl +++ b/src/services/outposts.jl @@ -101,7 +101,7 @@ Creates an Outpost. You can specify AvailabilityZone or AvailabilityZoneId. # Arguments - `name`: -- `site_id`: +- `site_id`: The ID or the Amazon Resource Name (ARN) of the site. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -189,7 +189,7 @@ end Deletes the Outpost. # Arguments -- `outpost_id`: The ID of the Outpost. +- `outpost_id`: The ID or the Amazon Resource Name (ARN) of the Outpost. """ function delete_outpost(OutpostId; aws_config::AbstractAWSConfig=global_aws_config()) @@ -221,7 +221,7 @@ end Deletes the site. # Arguments -- `site_id`: +- `site_id`: The ID or the Amazon Resource Name (ARN) of the site. """ function delete_site(SiteId; aws_config::AbstractAWSConfig=global_aws_config()) @@ -307,7 +307,7 @@ end Gets information about the specified Outpost. # Arguments -- `outpost_id`: The ID of the Outpost. +- `outpost_id`: The ID or the Amazon Resource Name (ARN) of the Outpost. """ function get_outpost(OutpostId; aws_config::AbstractAWSConfig=global_aws_config()) @@ -339,7 +339,7 @@ end Lists the instance types for the specified Outpost. # Arguments -- `outpost_id`: The ID of the Outpost. +- `outpost_id`: The ID or the Amazon Resource Name (ARN) of the Outpost. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -377,7 +377,7 @@ end Gets information about the specified Outpost site. # Arguments -- `site_id`: +- `site_id`: The ID or the Amazon Resource Name (ARN) of the site. """ function get_site(SiteId; aws_config::AbstractAWSConfig=global_aws_config()) @@ -405,7 +405,7 @@ end # Arguments - `address_type`: The type of the address you request. -- `site_id`: +- `site_id`: The ID or the Amazon Resource Name (ARN) of the site. """ function get_site_address( @@ -676,6 +676,43 @@ function untag_resource( ) end +""" + update_outpost(outpost_id) + update_outpost(outpost_id, params::Dict{String,<:Any}) + + Updates an Outpost. + +# Arguments +- `outpost_id`: The ID or the Amazon Resource Name (ARN) of the Outpost. + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"Description"`: +- `"Name"`: +- `"SupportedHardwareType"`: The type of hardware for this Outpost. +""" +function update_outpost(OutpostId; aws_config::AbstractAWSConfig=global_aws_config()) + return outposts( + "PATCH", + "/outposts/$(OutpostId)"; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function update_outpost( + OutpostId, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return outposts( + "PATCH", + "/outposts/$(OutpostId)", + params; + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ update_site(site_id) update_site(site_id, params::Dict{String,<:Any}) @@ -683,7 +720,7 @@ end Updates the site. # Arguments -- `site_id`: +- `site_id`: The ID or the Amazon Resource Name (ARN) of the site. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -720,7 +757,7 @@ been deactivated. # Arguments - `address`: The address for the site. - `address_type`: The type of the address. -- `site_id`: +- `site_id`: The ID or the Amazon Resource Name (ARN) of the site. """ function update_site_address( @@ -766,7 +803,7 @@ Outposts User Guide. To update a rack at a site with an order of IN_PROGRESS, y wait for the order to complete or cancel the order. # Arguments -- `site_id`: +- `site_id`: The ID or the Amazon Resource Name (ARN) of the site. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: diff --git a/src/services/qldb.jl b/src/services/qldb.jl index bfda239adf..f733599df9 100644 --- a/src/services/qldb.jl +++ b/src/services/qldb.jl @@ -48,12 +48,13 @@ end create_ledger(name, permissions_mode) create_ledger(name, permissions_mode, params::Dict{String,<:Any}) -Creates a new ledger in your account in the current Region. +Creates a new ledger in your Amazon Web Services account in the current Region. # Arguments - `name`: The name of the ledger that you want to create. The name must be unique among all - of the ledgers in your account in the current Region. Naming constraints for ledger names - are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide. + of the ledgers in your Amazon Web Services account in the current Region. Naming + constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB + Developer Guide. - `permissions_mode`: The permissions mode to assign to the ledger that you want to create. This parameter can have one of the following values: ALLOW_ALL: A legacy permissions mode that enables access control with API-level granularity for ledgers. This mode allows @@ -85,8 +86,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys symmetric and asymmetric keys in the Key Management Service Developer Guide. To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a key in a - different account, you must use the key ARN or alias ARN. For example: Key ID: - 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: + different Amazon Web Services account, you must use the key ARN or alias ARN. For example: + Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias For more information, see Key identifiers (KeyId) in the Key Management Service Developer @@ -271,8 +272,13 @@ end export_journal_to_s3(exclusive_end_time, inclusive_start_time, role_arn, s3_export_configuration, name, params::Dict{String,<:Any}) Exports journal contents within a date and time range from a ledger into a specified Amazon -Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion -format. If the ledger with the given Name doesn't exist, then throws +Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects +in either the text or binary representation of Amazon Ion format, or in JSON Lines text +format. In JSON Lines format, each journal block in the exported data object is a valid +JSON object that is delimited by a newline. You can use this format to easily integrate +JSON exports with analytics tools such as Glue and Amazon Athena because these services can +parse newline-delimited JSON automatically. For more information about the format, see JSON +Lines. If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException. If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException. You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw @@ -290,12 +296,19 @@ LimitExceededException. ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime. - `role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following: Write objects into your Amazon Simple - Storage Service (Amazon S3) bucket. (Optional) Use your customer master key (CMK) in Key - Management Service (KMS) for server-side encryption of your exported data. + Storage Service (Amazon S3) bucket. (Optional) Use your customer managed key in Key + Management Service (KMS) for server-side encryption of your exported data. To pass a role + to QLDB when requesting a journal export, you must have permissions to perform the + iam:PassRole action on the IAM role resource. This is required for all journal export + requests. - `s3_export_configuration`: The configuration settings of the Amazon S3 bucket destination for your export request. - `name`: The name of the ledger. +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"OutputFormat"`: The output format of your exported journal data. If this parameter is + not specified, the exported data defaults to ION_TEXT format. """ function export_journal_to_s3( ExclusiveEndTime, @@ -534,10 +547,10 @@ end list_journal_s3_exports(params::Dict{String,<:Any}) Returns an array of journal export job descriptions for all ledgers that are associated -with the current account and Region. This action returns a maximum of MaxResults items, and -is paginated so that you can retrieve all the items by calling ListJournalS3Exports -multiple times. This action does not return any expired export jobs. For more information, -see Export job expiration in the Amazon QLDB Developer Guide. +with the current Amazon Web Services account and Region. This action returns a maximum of +MaxResults items, and is paginated so that you can retrieve all the items by calling +ListJournalS3Exports multiple times. This action does not return any expired export jobs. +For more information, see Export job expiration in the Amazon QLDB Developer Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -612,9 +625,9 @@ end list_ledgers() list_ledgers(params::Dict{String,<:Any}) -Returns an array of ledger summaries that are associated with the current account and -Region. This action returns a maximum of 100 items and is paginated so that you can -retrieve all the items by calling ListLedgers multiple times. +Returns an array of ledger summaries that are associated with the current Amazon Web +Services account and Region. This action returns a maximum of 100 items and is paginated so +that you can retrieve all the items by calling ListLedgers multiple times. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -688,7 +701,10 @@ Amazon Kinesis Data Streams resource. - `kinesis_configuration`: The configuration settings of the Kinesis Data Streams destination for your stream request. - `role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions - for a journal stream to write data records to a Kinesis Data Streams resource. + for a journal stream to write data records to a Kinesis Data Streams resource. To pass a + role to QLDB when requesting a journal stream, you must have permissions to perform the + iam:PassRole action on the IAM role resource. This is required for all journal stream + requests. - `stream_name`: The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream. Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming @@ -859,8 +875,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys symmetric and asymmetric keys in the Key Management Service Developer Guide. To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a key in a - different account, you must use the key ARN or alias ARN. For example: Key ID: - 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: + different Amazon Web Services account, you must use the key ARN or alias ARN. For example: + Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias For more information, see Key identifiers (KeyId) in the Key Management Service Developer diff --git a/src/services/quicksight.jl b/src/services/quicksight.jl index 52c46e4a24..ec715507e9 100644 --- a/src/services/quicksight.jl +++ b/src/services/quicksight.jl @@ -272,7 +272,8 @@ end create_data_set(aws_account_id, data_set_id, import_mode, name, physical_table_map) create_data_set(aws_account_id, data_set_id, import_mode, name, physical_table_map, params::Dict{String,<:Any}) -Creates a dataset. +Creates a dataset. This operation doesn't support datasets that include uploaded files as a +source. # Arguments - `aws_account_id`: The Amazon Web Services account ID. @@ -679,11 +680,14 @@ end create_ingestion(aws_account_id, data_set_id, ingestion_id) create_ingestion(aws_account_id, data_set_id, ingestion_id, params::Dict{String,<:Any}) -Creates and starts a new SPICE ingestion on a dataset Any ingestions operating on tagged -datasets inherit the same tags automatically for use in access control. For an example, see -How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the -Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on -the ingestion resource. +Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets +in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh +datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is +measured starting 24 hours before the current date and time. Any ingestions operating on +tagged datasets inherit the same tags automatically for use in access control. For an +example, see How do I create an IAM policy to control access to Amazon EC2 resources using +tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, +but not on the ingestion resource. # Arguments - `aws_account_id`: The Amazon Web Services account ID. @@ -2008,7 +2012,8 @@ end describe_data_set(aws_account_id, data_set_id) describe_data_set(aws_account_id, data_set_id, params::Dict{String,<:Any}) -Describes a dataset. +Describes a dataset. This operation doesn't support datasets that include uploaded files as +a source. # Arguments - `aws_account_id`: The Amazon Web Services account ID. @@ -4671,7 +4676,8 @@ end update_data_set(aws_account_id, data_set_id, import_mode, name, physical_table_map) update_data_set(aws_account_id, data_set_id, import_mode, name, physical_table_map, params::Dict{String,<:Any}) -Updates a dataset. +Updates a dataset. This operation doesn't support datasets that include uploaded files as a +source. # Arguments - `aws_account_id`: The Amazon Web Services account ID. diff --git a/src/services/rds.jl b/src/services/rds.jl index 76782c55eb..ed39027f19 100644 --- a/src/services/rds.jl +++ b/src/services/rds.jl @@ -980,18 +980,18 @@ engine and specific AMI. The only supported engine is Oracle Database 19c Enterp Edition with the January 2021 or later RU/RUR. Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and -create your database. With Amazon RDS Custom, you upload your database installation files -in Amazon S3. When you create a custom engine version, you specify the files in a JSON -document called a CEV manifest. This document describes installation .zip files stored in -Amazon S3. RDS Custom creates your CEV from the installation files that you provided. This -service model is called Bring Your Own Media (BYOM). Creation takes approximately two -hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with the message Creation failed -for custom engine version, and includes details about the failure. For example, the event -prints missing files. After you create the CEV, it is available for use. You can create -multiple CEVs, and create multiple RDS Custom instances from any CEV. You can also change -the status of a CEV to make it available or inactive. The MediaImport service that imports -files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. -If you turn on data logging for Amazon RDS in CloudTrail, calls to the +create your database. With Amazon RDS Custom for Oracle, you upload your database +installation files in Amazon S3. When you create a custom engine version, you specify the +files in a JSON document called a CEV manifest. This document describes installation .zip +files stored in Amazon S3. RDS Custom creates your CEV from the installation files that you +provided. This service model is called Bring Your Own Media (BYOM). Creation takes +approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with the +message Creation failed for custom engine version, and includes details about the failure. +For example, the event prints missing files. After you create the CEV, it is available for +use. You can create multiple CEVs, and create multiple RDS Custom instances from any CEV. +You can also change the status of a CEV to make it available or inactive. The MediaImport +service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web +Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the CreateCustomDbEngineVersion event. For more information, see Creating a @@ -1004,9 +1004,9 @@ CEV in the Amazon RDS User Guide. - `engine`: The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee. - `engine_version`: The name of your CEV. The name format is 19.customized_string . For - example, a valid name is 19.my_cev1. This setting is required for RDS Custom, but optional - for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per - Region. + example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, + but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per + customer per Region. - `kmskey_id`: The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. If you have an existing symmetric KMS key in your account, you can use it with RDS Custom. No further action is @@ -1105,9 +1105,9 @@ to change. 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 (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) - aurora-postgresql mysql postgres Valid for: Aurora DB clusters and Multi-AZ - DB clusters + aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible and + MySQL 8.0-compatible Aurora) aurora-postgresql mysql postgres Valid for: + Aurora DB clusters and Multi-AZ DB clusters # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -1204,7 +1204,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys available engine versions for MySQL 5.6-compatible Aurora, use the following command: aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\" To list all of the available engine versions for - MySQL 5.7-compatible Aurora, use the following command: aws rds + MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\" To list all of the available engine versions for Aurora PostgreSQL, use the following command: aws rds describe-db-engine-versions --engine @@ -1342,9 +1342,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"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. Valid values: standard | gp2 | io1 - If you specify io1, also include a value for the Iops parameter. Default: io1 if the Iops - parameter is specified, otherwise gp2 Valid for: Multi-AZ DB clusters only + setting is required to create a Multi-AZ DB cluster. Valid values: io1 When specified, a + value for the Iops parameter is required. Default: io1 Valid for: Multi-AZ DB clusters + only - `"Tags"`: Tags to assign to the DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters - `"VpcSecurityGroupIds"`: A list of EC2 VPC security groups to associate with this DB @@ -1483,16 +1483,17 @@ preview and is subject to change. parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. Aurora MySQL Example: aurora5.6, - aurora-mysql5.7 Aurora PostgreSQL Example: aurora-postgresql9.6 RDS for MySQL - Example: mysql8.0 RDS for PostgreSQL Example: postgres12 To list all of the available - parameter group families for a DB engine, use the following command: aws rds + aurora-mysql5.7, aurora-mysql8.0 Aurora PostgreSQL Example: aurora-postgresql9.6 RDS + for MySQL Example: mysql8.0 RDS for PostgreSQL Example: postgres12 To list all of the + available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine <engine> For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command: aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql The output contains duplicates. The following are the valid DB engine values: aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL - 5.7-compatible Aurora) aurora-postgresql mysql postgres + 5.7-compatible and MySQL 8.0-compatible Aurora) aurora-postgresql mysql postgres + - `description`: The description for the DB cluster parameter group. # Optional Parameters @@ -1618,10 +1619,13 @@ Creates a new DB instance. 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 (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) - aurora-postgresql custom-oracle-ee (for RDS Custom instances) mariadb mysql - oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres - sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web + aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible and + MySQL 8.0-compatible Aurora) aurora-postgresql custom-oracle-ee (for RDS Custom for + Oracle instances) custom-sqlserver-ee (for RDS Custom for SQL Server instances) + custom-sqlserver-se (for RDS Custom for SQL Server instances) custom-sqlserver-web (for + RDS Custom for SQL Server 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: @@ -1630,48 +1634,50 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys 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): Must be an integer from 40 to 65536. Provisioned IOPS - storage (io1): Must be an integer from 40 to 65536. MySQL Constraints to the amount of - storage for each storage type are the following: General Purpose (SSD) storage (gp2): - 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): 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 following: General Purpose (SSD) storage (gp2): 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 + Purpose (SSD) storage (gp2): 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): 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 following: General Purpose (SSD) storage (gp2): Enterprise and - Standard editions: Must be an integer from 200 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 200 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 200 to 1024. Web and Express editions: Must be an - integer from 20 to 1024. + 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): 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 following: General Purpose (SSD) + storage (gp2): 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): 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 following: General Purpose (SSD) storage (gp2): + 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. - `"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. 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. - If you're creating a DB instance in an RDS on VMware environment, specify the identifier of - the custom Availability Zone to create the DB instance in. For more information about RDS - on VMware, see the RDS on VMware User Guide. + Availability Zones. Amazon Aurora Not applicable. Availability Zones are managed by the + DB cluster. 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. If you're + creating a DB instance in an RDS on VMware environment, specify the identifier of the + custom Availability Zone to create the DB instance in. For more information about RDS on + VMware, see the RDS on VMware User Guide. - `"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 or 35 for an RDS Custom DB instance + set to 0 or 35 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 @@ -1711,20 +1717,21 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys 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 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. 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 or an - underscore. Subsequent characters can be letters, underscores, or digits (0 to 9). It - can't be a word reserved by the database engine. + 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 or an underscore. Subsequent + characters can be letters, underscores, or digits (0 to 9). It can't be a word reserved + by the database engine. - `"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. @@ -1778,16 +1785,18 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys 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 A custom engine version (CEV) - that you have previously created. This setting is required for RDS Custom. The CEV name has - the following format: 19.customized_string . An example identifier is 19.my_cev1. For more - information, see Creating an RDS Custom DB instance 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. + 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 . An example identifier + 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 Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. @@ -1802,10 +1811,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys 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 Oracle + 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 for Oracle - doesn't use the default key when this parameter is empty. You must explicitly specify a key. + 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. @@ -1899,9 +1908,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys 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 Oracle 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. + 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. - `"StorageType"`: Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2 @@ -2245,10 +2254,10 @@ modified. command: aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql The output contains duplicates. The following are the valid DB engine values: aurora (for MySQL - 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) - aurora-postgresql mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 - oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex - sqlserver-web + 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible + Aurora) aurora-postgresql mariadb mysql oracle-ee oracle-ee-cdb + oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se + sqlserver-ex sqlserver-web - `dbparameter_group_name`: The name of the DB parameter group. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string. @@ -4169,10 +4178,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"DefaultOnly"`: A value that indicates whether only the default version of the specified engine or engine and major version combination is returned. - `"Engine"`: The database engine to return. Valid Values: aurora (for MySQL - 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) - aurora-postgresql mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 - oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex - sqlserver-web + 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible + Aurora) aurora-postgresql mariadb mysql oracle-ee oracle-ee-cdb + oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se + sqlserver-ex sqlserver-web - `"EngineVersion"`: The database engine version to return. Example: 5.1.49 - `"Filters"`: This parameter isn't currently supported. - `"IncludeAll"`: A value that indicates whether to include engine versions that aren't @@ -5265,10 +5274,10 @@ version, and DB instance class. # Arguments - `engine`: The name of the engine to retrieve DB instance options for. Valid Values: - aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) - aurora-postgresql mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 - oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex - sqlserver-web + aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible and + MySQL 8.0-compatible Aurora) aurora-postgresql 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: @@ -5976,8 +5985,8 @@ Amazon RDS User Guide. # Arguments - `engine`: The DB engine. The only supported value is custom-oracle-ee. - `engine_version`: The custom engine version (CEV) that you want to modify. This option is - required for RDS Custom, but optional for Amazon RDS. The combination of Engine and - EngineVersion is unique per customer per Amazon Web Services Region. + required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine + and EngineVersion is unique per customer per Amazon Web Services Region. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -6125,16 +6134,17 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys next maintenance window unless ApplyImmediately is enabled. To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command: aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\" - To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the - following command: aws rds describe-db-engine-versions --engine aurora-mysql --query - \"DBEngineVersions[].EngineVersion\" To list all of the available engine versions for - Aurora PostgreSQL, use the following command: aws rds describe-db-engine-versions --engine - aurora-postgresql --query \"DBEngineVersions[].EngineVersion\" To list all of the - available engine versions for RDS 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 + To list all of the available engine versions for MySQL 5.7-compatible and MySQL + 8.0-compatible Aurora, use the following command: aws rds describe-db-engine-versions + --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\" To list all of the + available engine versions for Aurora PostgreSQL, use the following command: aws rds + describe-db-engine-versions --engine aurora-postgresql --query + \"DBEngineVersions[].EngineVersion\" To list all of the available engine versions for RDS + 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 - `"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 to Improve Performance in the @@ -6194,9 +6204,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys scaling properties for DB clusters in serverless DB engine mode. Valid for: Aurora DB clusters only - `"StorageType"`: Specifies the storage type to be associated with the DB cluster. Valid - values: standard | gp2 | io1 If you specify io1, you must also include a value for the - Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2 Valid - for: Multi-AZ DB clusters only + values: io1 When specified, a value for the Iops parameter is required. Default: io1 + Valid for: Multi-AZ DB clusters only - `"VpcSecurityGroupIds"`: A list of VPC security groups that the DB cluster will belong to. Valid for: Aurora DB clusters and Multi-AZ DB clusters """ @@ -6475,12 +6484,12 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"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 - 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. + 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 @@ -6504,9 +6513,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys 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 or 35 for an RDS Custom - 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. + 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 certificate to associate with the DB instance. This setting doesn't apply to RDS Custom. - `"CertificateRotationRestart"`: A value that indicates whether the DB instance is @@ -6535,7 +6544,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys your engine, see DB Instance Class in the Amazon RDS User Guide. If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request. This setting - doesn't apply to RDS Custom. Default: Uses existing setting + doesn't apply to RDS Custom for Oracle. Default: Uses existing setting - `"DBParameterGroupName"`: The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the @@ -6603,9 +6612,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys 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 current minor version is lower. For information about valid - engine versions, see CreateDBInstance, or call DescribeDBEngineVersions. In RDS Custom, - this parameter is supported for read replicas only if they are in the PATCH_DB_FAILURE - lifecycle. + engine versions, see CreateDBInstance, or call DescribeDBEngineVersions. In RDS Custom for + Oracle, this parameter is supported for read replicas only if they are in the + PATCH_DB_FAILURE lifecycle. - `"Iops"`: The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for @@ -6725,7 +6734,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys 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. This setting doesn't apply to RDS Custom. + 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 @@ -6813,28 +6822,32 @@ been created or modified. - `dbparameter_group_name`: The name of the DB parameter group. Constraints: If supplied, must match the name of an existing DBParameterGroup. - `parameter`: An array of parameter names, values, and the application methods for the - parameter update. At least one parameter name, value, and application method method must be + parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a - single request. Valid Values (for the application method): immediate | pending-reboot You + single request. Valid Values (for the application method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters. When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group. When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances - associated with the parameter group. + associated with the parameter group. You can't use pending-reboot with dynamic parameters + on RDS for SQL Server DB instances. Use immediate. For more information on modifying DB + parameters, see Working with DB parameter groups in the Amazon RDS User Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"Parameters"`: An array of parameter names, values, and the application methods for the - parameter update. At least one parameter name, value, and application method method must be + parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a - single request. Valid Values (for the application method): immediate | pending-reboot You + single request. Valid Values (for the application method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters. When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group. When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances - associated with the parameter group. + associated with the parameter group. You can't use pending-reboot with dynamic parameters + on RDS for SQL Server DB instances. Use immediate. For more information on modifying DB + parameters, see Working with DB parameter groups in the Amazon RDS User Guide. """ function modify_dbparameter_group( DBParameterGroupName, Parameter; aws_config::AbstractAWSConfig=global_aws_config() @@ -7286,11 +7299,12 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]' To list all of the available engine versions for aurora-mysql - (for MySQL 5.7-compatible Aurora), use the following command: aws rds - describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == - `true`].[EngineVersion]' To list all of the available engine versions for - aurora-postgresql, use the following command: aws rds describe-db-engine-versions --engine - aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]' + (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command: aws + rds describe-db-engine-versions --engine aurora-mysql --query + '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]' To list all of the available + engine versions for aurora-postgresql, use the following command: aws rds + describe-db-engine-versions --engine aurora-postgresql --query + '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]' - `"GlobalClusterIdentifier"`: The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing global database cluster. @@ -8027,8 +8041,8 @@ information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora U 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 name of the database engine to be used for this DB cluster. Valid Values: - aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), - and aurora-postgresql + aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible and MySQL + 8.0-compatible Aurora), and aurora-postgresql - `master_user_password`: 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. @@ -8088,13 +8102,13 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\" To list all of the available engine versions for - aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command: aws rds - describe-db-engine-versions --engine aurora-mysql --query + aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following + command: aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\" To list all of the available engine versions for aurora-postgresql, use the following command: aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\" Aurora MySQL Example: - 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5 Aurora PostgreSQL - Example: 9.6.3, 10.7 + 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5, 8.0.mysql_aurora.3.01.0 + Aurora PostgreSQL Example: 9.6.3, 10.7 - `"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 @@ -8275,7 +8289,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command: aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\" To list all of the available engine versions for - MySQL 5.7-compatible Aurora, use the following command: aws rds + MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\" To list all of the available engine versions for Aurora PostgreSQL, use the following command: aws rds describe-db-engine-versions --engine @@ -8330,9 +8344,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"ScalingConfiguration"`: For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster. Valid for: Aurora DB clusters only - `"StorageType"`: Specifies the storage type to be associated with the each DB instance in - the Multi-AZ DB cluster. Valid values: standard | gp2 | io1 If you specify io1, you must - also include a value for the Iops parameter. Default: io1 if the Iops parameter is - specified, otherwise gp2 Valid for: Aurora DB clusters and Multi-AZ DB clusters + the Multi-AZ DB cluster. Valid values: io1 When specified, a value for the Iops + parameter is required. Default: io1 Valid for: Aurora DB clusters and Multi-AZ DB + clusters - `"Tags"`: The tags to be assigned to the restored DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters - `"VpcSecurityGroupIds"`: A list of VPC security groups that the new DB cluster will @@ -8508,9 +8522,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"ScalingConfiguration"`: For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster. Valid for: Aurora DB clusters only - `"StorageType"`: Specifies the storage type to be associated with the each DB instance in - the Multi-AZ DB cluster. Valid values: standard | gp2 | io1 If you specify io1, also - include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, - otherwise gp2 Valid for: Multi-AZ DB clusters only + the Multi-AZ DB cluster. Valid values: io1 When specified, a value for the Iops + parameter is required. Default: io1 Valid for: Multi-AZ DB clusters only - `"Tags"`: - `"UseLatestRestorableTime"`: A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest diff --git a/src/services/redshift.jl b/src/services/redshift.jl index 5848f345aa..f0e4245314 100644 --- a/src/services/redshift.jl +++ b/src/services/redshift.jl @@ -228,12 +228,13 @@ end authorize_data_share(consumer_identifier, data_share_arn, params::Dict{String,<:Any}) From a data producer account, authorizes the sharing of a datashare with one or more -consumer accounts. To authorize a datashare for a data consumer, the producer account must -have the correct access privileges. +consumer accounts or managing entities. To authorize a datashare for a data consumer, the +producer account must have the correct access privileges. # Arguments - `consumer_identifier`: The identifier of the data consumer that is authorized to access - the datashare. This identifier is an Amazon Web Services account ID. + the datashare. This identifier is an Amazon Web Services account ID or a keyword, such as + ADX. - `data_share_arn`: The Amazon Resource Name (ARN) of the datashare that producers are to authorize sharing for. @@ -1615,7 +1616,8 @@ From the producer account, removes authorization from the specified datashare. # Arguments - `consumer_identifier`: The identifier of the data consumer that is to have authorization - removed from the datashare. This identifier is an Amazon Web Services account ID. + removed from the datashare. This identifier is an Amazon Web Services account ID or a + keyword, such as ADX. - `data_share_arn`: The Amazon Resource Name (ARN) of the datashare to remove authorization from. diff --git a/src/services/rekognition.jl b/src/services/rekognition.jl index db13306f20..65dfaab6e9 100644 --- a/src/services/rekognition.jl +++ b/src/services/rekognition.jl @@ -22,7 +22,7 @@ as base64-encoded image bytes or as references to images in an Amazon S3 bucket. the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the -response provides a bounding box of the face, facial landmarks, pose details (pitch, role, +response provides a bounding box of the face, facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a @@ -1154,15 +1154,15 @@ reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image byt supported. The image must be either a .png or .jpeg formatted file. The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each TextDetection element provides information about a single word or line of text that was -detected in the image. A word is one or more ISO basic latin script characters that are -not separated by spaces. DetectText can detect up to 100 words in an image. A line is a -string of equally spaced words. A line isn't necessarily a complete sentence. For example, -a driver's license number is detected as a line. A line ends when there is no aligned text -after it. Also, a line ends when there is a large gap between words, relative to the length -of the words. This means, depending on the gap between words, Amazon Rekognition may detect -multiple lines in text aligned in the same direction. Periods don't represent the end of a -line. If a sentence spans multiple lines, the DetectText operation returns multiple lines. -To determine whether a TextDetection element is a line of text or a word, use the +detected in the image. A word is one or more script characters that are not separated by +spaces. DetectText can detect up to 100 words in an image. A line is a string of equally +spaced words. A line isn't necessarily a complete sentence. For example, a driver's license +number is detected as a line. A line ends when there is no aligned text after it. Also, a +line ends when there is a large gap between words, relative to the length of the words. +This means, depending on the gap between words, Amazon Rekognition may detect multiple +lines in text aligned in the same direction. Periods don't represent the end of a line. If +a sentence spans multiple lines, the DetectText operation returns multiple lines. To +determine whether a TextDetection element is a line of text or a word, use the TextDetection object Type field. To be detected, text must be within +/- 90 degrees orientation of the horizontal axis. For more information, see DetectText in the Amazon Rekognition Developer Guide. @@ -1798,12 +1798,12 @@ assigned by the service for each face that's detected and stored. An image ID, assigned by the service for the input image. If you request all facial attributes (by using the detectionAttributes parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other -facial attributes. If you provide the same image, specify the same collection, and use the -same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate -face metadata. The input image is passed either as base64-encoded image bytes, or as a -reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon -Rekognition operations, passing image bytes isn't supported. The image must be formatted as -a PNG or JPEG file. This operation requires permissions to perform the +facial attributes. If you provide the same image, specify the same collection, use the same +external ID, and use the same model version in the IndexFaces operation, Amazon Rekognition +doesn't save duplicate face metadata. The input image is passed either as base64-encoded +image bytes, or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI +to call Amazon Rekognition operations, passing image bytes isn't supported. The image must +be formatted as a PNG or JPEG file. This operation requires permissions to perform the rekognition:IndexFaces action. # Arguments diff --git a/src/services/route53_recovery_control_config.jl b/src/services/route53_recovery_control_config.jl index f8fa29b482..728e1c52e7 100644 --- a/src/services/route53_recovery_control_config.jl +++ b/src/services/route53_recovery_control_config.jl @@ -12,14 +12,16 @@ Create a new cluster. A cluster is a set of redundant Regional endpoints against can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the -Amazon Route 53 Application Recovery Controller cluster data plane. +cluster data plane. # Arguments - `cluster_name`: The name of the cluster. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"ClientToken"`: Unique client idempotency token. +- `"ClientToken"`: A unique, case-sensitive string of up to 64 ASCII characters. To make an + idempotent API request with an action, specify a client token in the request. +- `"Tags"`: The tags associated with the cluster. """ function create_cluster(ClusterName; aws_config::AbstractAWSConfig=global_aws_config()) return route53_recovery_control_config( @@ -59,8 +61,8 @@ end Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app -failovers in a single transaction, for example, to fail over an Availability Zone or AWS -Region. +failovers in a single transaction, for example, to fail over an Availability Zone or Amazon +Web Services Region. # Arguments - `cluster_arn`: The Amazon Resource Name (ARN) of the cluster for the control panel. @@ -68,7 +70,9 @@ Region. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"ClientToken"`: Unique client idempotency token. +- `"ClientToken"`: A unique, case-sensitive string of up to 64 ASCII characters. To make an + idempotent API request with an action, specify a client token in the request. +- `"Tags"`: The tags associated with the control panel. """ function create_control_panel( ClusterArn, ControlPanelName; aws_config::AbstractAWSConfig=global_aws_config() @@ -127,7 +131,8 @@ Controller. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"ClientToken"`: Unique client idempotency token. +- `"ClientToken"`: A unique, case-sensitive string of up to 64 ASCII characters. To make an + idempotent API request with an action, specify a client token in the request. - `"ControlPanelArn"`: The Amazon Resource Name (ARN) of the control panel that includes the routing control. """ @@ -176,20 +181,25 @@ end create_safety_rule(params::Dict{String,<:Any}) Creates a safety rule in a control panel. Safety rules let you add safeguards around -enabling and disabling routing controls, to help prevent unexpected outcomes. There are two -types of safety rules: assertion rules and gating rules. Assertion rule: An assertion rule -enforces that, when a routing control state is changed, the criteria set by the rule -configuration is met. Otherwise, the change to the routing control is not accepted. Gating -rule: A gating rule verifies that a set of gating controls evaluates as true, based on a -rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 -Application Recovery Controller allows a set of routing control state changes to run and -complete against the set of target controls. +changing routing control states, and for enabling and disabling routing controls, to help +prevent unexpected outcomes. There are two types of safety rules: assertion rules and +gating rules. Assertion rule: An assertion rule enforces that, when you change a routing +control state, that a certain criteria is met. For example, the criteria might be that at +least one routing control state is On after the transation so that traffic continues to +flow to at least one cell for the application. This ensures that you avoid a fail-open +scenario. Gating rule: A gating rule lets you configure a gating routing control as an +overall \"on/off\" switch for a group of routing controls. Or, you can configure more +complex gating scenarios, for example by configuring multiple gating routing controls. For +more information, see Safety rules in the Amazon Route 53 Application Recovery Controller +Developer Guide. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"AssertionRule"`: -- `"ClientToken"`: Unique client idempotency token. -- `"GatingRule"`: +- `"AssertionRule"`: The assertion rule requested. +- `"ClientToken"`: A unique, case-sensitive string of up to 64 ASCII characters. To make an + idempotent API request with an action, specify a client token in the request. +- `"GatingRule"`: The gating rule requested. +- `"Tags"`: The tags associated with the safety rule. """ function create_safety_rule(; aws_config::AbstractAWSConfig=global_aws_config()) return route53_recovery_control_config( @@ -253,8 +263,7 @@ end Deletes a control panel. # Arguments -- `control_panel_arn`: The Amazon Resource Name (ARN) of the control panel that you're - deleting. +- `control_panel_arn`: The Amazon Resource Name (ARN) of the control panel. """ function delete_control_panel( @@ -323,7 +332,7 @@ end Deletes a safety rule./> # Arguments -- `safety_rule_arn`: The request body that you include when you update a safety rule. +- `safety_rule_arn`: The ARN of the safety rule. """ function delete_safety_rule( @@ -358,8 +367,7 @@ Display the details about a cluster. The response includes the cluster name, end status, and Amazon Resource Name (ARN). # Arguments -- `cluster_arn`: The Amazon Resource Name (ARN) of the cluster that you're getting details - for. +- `cluster_arn`: The Amazon Resource Name (ARN) of the cluster. """ function describe_cluster(ClusterArn; aws_config::AbstractAWSConfig=global_aws_config()) @@ -391,8 +399,7 @@ end Displays details about a control panel. # Arguments -- `control_panel_arn`: The Amazon Resource Name (ARN) of the control panel that you're - getting details for. +- `control_panel_arn`: The Amazon Resource Name (ARN) of the control panel. """ function describe_control_panel( @@ -430,8 +437,7 @@ Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recove Controller. # Arguments -- `routing_control_arn`: The Amazon Resource Name (ARN) of the routing control that you're - getting details for. +- `routing_control_arn`: The Amazon Resource Name (ARN) of the routing control. """ function describe_routing_control( @@ -462,11 +468,10 @@ end describe_safety_rule(safety_rule_arn) describe_safety_rule(safety_rule_arn, params::Dict{String,<:Any}) -Describes the safety rules (that is, the assertion rules and gating rules) for the routing -controls in a control panel. +Returns information about a safety rule. # Arguments -- `safety_rule_arn`: The request body that you include when you update a safety rule. +- `safety_rule_arn`: The ARN of the safety rule. """ function describe_safety_rule( @@ -501,8 +506,7 @@ Returns an array of all Amazon Route 53 health checks associated with a specific control. # Arguments -- `routing_control_arn`: The Amazon Resource Name (ARN) of the routing control that you're - getting details for. +- `routing_control_arn`: The Amazon Resource Name (ARN) of the routing control. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -561,7 +565,7 @@ end list_control_panels() list_control_panels(params::Dict{String,<:Any}) -Returns an array of control panels for a cluster. +Returns an array of control panels in an account or in a cluster. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -596,8 +600,7 @@ You can map the routing control state to the state of an Amazon Route 53 health which can be used to control routing. # Arguments -- `control_panel_arn`: The Amazon Resource Name (ARN) of the control panel that you're - getting routing control details for. +- `control_panel_arn`: The Amazon Resource Name (ARN) of the control panel. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -636,8 +639,7 @@ List the safety rules (the assertion rules and gating rules) that you've defined routing controls in a control panel. # Arguments -- `control_panel_arn`: The Amazon Resource Name (ARN) of the control panel that you're - getting details for. +- `control_panel_arn`: The Amazon Resource Name (ARN) of the control panel. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -668,6 +670,112 @@ function list_safety_rules( ) end +""" + list_tags_for_resource(resource_arn) + list_tags_for_resource(resource_arn, params::Dict{String,<:Any}) + +Lists the tags for a resource. + +# Arguments +- `resource_arn`: The Amazon Resource Name (ARN) for the resource that's tagged. + +""" +function list_tags_for_resource( + ResourceArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return route53_recovery_control_config( + "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 route53_recovery_control_config( + "GET", + "/tags/$(ResourceArn)", + 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}) + +Adds a tag to a resource. + +# Arguments +- `resource_arn`: The Amazon Resource Name (ARN) for the resource that's tagged. +- `tags`: The tags associated with the resource. + +""" +function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config()) + return route53_recovery_control_config( + "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 route53_recovery_control_config( + "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 from a resource. + +# Arguments +- `resource_arn`: The Amazon Resource Name (ARN) for the resource that's tagged. +- `tag_keys`: Keys for the tags to be removed. + +""" +function untag_resource( + ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config() +) + return route53_recovery_control_config( + "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 route53_recovery_control_config( + "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_control_panel(control_panel_arn, control_panel_name) update_control_panel(control_panel_arn, control_panel_name, params::Dict{String,<:Any}) @@ -772,14 +880,14 @@ end update_safety_rule() update_safety_rule(params::Dict{String,<:Any}) -Update a safety rule (an assertion rule or gating rule) for the routing controls in a -control panel. You can only update the name and the waiting period for a safety rule. To -make other updates, delete the safety rule and create a new safety rule. +Update a safety rule (an assertion rule or gating rule). You can only update the name and +the waiting period for a safety rule. To make other updates, delete the safety rule and +create a new one. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"AssertionRuleUpdate"`: -- `"GatingRuleUpdate"`: +- `"AssertionRuleUpdate"`: The assertion rule to update. +- `"GatingRuleUpdate"`: The gating rule to update. """ function update_safety_rule(; aws_config::AbstractAWSConfig=global_aws_config()) return route53_recovery_control_config( diff --git a/src/services/route_53.jl b/src/services/route_53.jl index 7039104537..55d7162966 100644 --- a/src/services/route_53.jl +++ b/src/services/route_53.jl @@ -343,8 +343,10 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys element, omit HostedZoneConfig and the other elements. - `"VPC"`: (Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone. You can specify only one Amazon - VPC when you create a private hosted zone. To associate additional Amazon VPCs with the - hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone. + VPC when you create a private hosted zone. If you are associating a VPC with a hosted zone + with this request, the paramaters VPCId and VPCRegion are also required. To associate + additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you + create a hosted zone. """ function create_hosted_zone( CallerReference, Name; aws_config::AbstractAWSConfig=global_aws_config() @@ -388,16 +390,16 @@ KSKs per hosted zone. # Arguments - `caller_reference`: A unique string that identifies the request. - `hosted_zone_id`: The unique string (ID) used to identify a hosted zone. -- `key_management_service_arn`: The Amazon resource name (ARN) for a customer managed - customer master key (CMK) in Key Management Service (KMS). The KeyManagementServiceArn must - be unique for each key-signing key (KSK) in a single hosted zone. To see an example of - KeyManagementServiceArn that grants the correct permissions for DNSSEC, scroll down to - Example. You must configure the customer managed CMK as follows: Status Enabled Key - spec ECC_NIST_P256 Key usage Sign and verify Key policy The key policy must give - permission for the following actions: DescribeKey GetPublicKey Sign The key policy - must also include the Amazon Route 53 service in the principal for your account. Specify - the following: \"Service\": \"dnssec-route53.amazonaws.com\" For more information - about working with a customer managed CMK in KMS, see Key Management Service concepts. +- `key_management_service_arn`: The Amazon resource name (ARN) for a customer managed key + in Key Management Service (KMS). The KeyManagementServiceArn must be unique for each + key-signing key (KSK) in a single hosted zone. To see an example of KeyManagementServiceArn + that grants the correct permissions for DNSSEC, scroll down to Example. You must configure + the customer managed customer managed key as follows: Status Enabled Key spec + ECC_NIST_P256 Key usage Sign and verify Key policy The key policy must give permission + for the following actions: DescribeKey GetPublicKey Sign The key policy must also + include the Amazon Route 53 service in the principal for your account. Specify the + following: \"Service\": \"dnssec-route53.amazonaws.com\" For more information about + working with a customer managed key in KMS, see Key Management Service concepts. - `name`: A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same hosted zone. @@ -990,7 +992,8 @@ end Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be deactivated before you can delete it regardless of whether the hosted zone is -enabled for DNSSEC signing. +enabled for DNSSEC signing. You can use DeactivateKeySigningKey to deactivate the key +before you delete it. Use GetDNSSEC to verify that the KSK is in an INACTIVE status. # Arguments - `hosted_zone_id`: A unique string used to identify a hosted zone. @@ -3008,9 +3011,9 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"InsufficientDataHealthStatus"`: When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check: Healthy: Route 53 considers the health check to be healthy. Unhealthy: - Route 53 considers the health check to be unhealthy. LastKnownStatus: Route 53 uses the - status of the health check from the last time CloudWatch had sufficient data to determine - the alarm state. For new health checks that have no last known status, the default status + Route 53 considers the health check to be unhealthy. LastKnownStatus: By default, Route + 53 uses the status of the health check from the last time CloudWatch had sufficient data to + determine the alarm state. For new health checks that have no last known status, the status for the health check is healthy. - `"Inverted"`: Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be diff --git a/src/services/route_53_domains.jl b/src/services/route_53_domains.jl index cbae19f1e4..0e46e7aa35 100644 --- a/src/services/route_53_domains.jl +++ b/src/services/route_53_domains.jl @@ -8,15 +8,18 @@ using AWS.UUIDs accept_domain_transfer_from_another_aws_account(domain_name, password) accept_domain_transfer_from_another_aws_account(domain_name, password, params::Dict{String,<:Any}) -Accepts the transfer of a domain from another AWS account to the current AWS account. You -initiate a transfer between AWS accounts using TransferDomainToAnotherAwsAccount. Use -either ListOperations or GetOperationDetail to determine whether the operation succeeded. -GetOperationDetail provides additional information, for example, Domain Transfer from Aws -Account 111122223333 has been cancelled. +Accepts the transfer of a domain from another Amazon Web Services account to the +currentAmazon Web Services account. You initiate a transfer between Amazon Web Services +accounts using TransferDomainToAnotherAwsAccount. If you use the CLI command at +accept-domain-transfer-from-another-aws-account, use JSON format as input instead of text +because otherwise CLI will throw an error from domain transfer input that includes single +quotes. Use either ListOperations or GetOperationDetail to determine whether the operation +succeeded. GetOperationDetail provides additional information, for example, Domain Transfer +from Aws Account 111122223333 has been cancelled. # Arguments -- `domain_name`: The name of the domain that was specified when another AWS account - submitted a TransferDomainToAnotherAwsAccount request. +- `domain_name`: The name of the domain that was specified when another Amazon Web Services + account submitted a TransferDomainToAnotherAwsAccount request. - `password`: The password that was returned by the TransferDomainToAnotherAwsAccount request. @@ -55,16 +58,17 @@ end cancel_domain_transfer_to_another_aws_account(domain_name) cancel_domain_transfer_to_another_aws_account(domain_name, params::Dict{String,<:Any}) -Cancels the transfer of a domain from the current AWS account to another AWS account. You -initiate a transfer between AWS accounts using TransferDomainToAnotherAwsAccount. You -must cancel the transfer before the other AWS account accepts the transfer using +Cancels the transfer of a domain from the current Amazon Web Services account to another +Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts +using TransferDomainToAnotherAwsAccount. You must cancel the transfer before the other +Amazon Web Services account accepts the transfer using AcceptDomainTransferFromAnotherAwsAccount. Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. # Arguments - `domain_name`: The name of the domain for which you want to cancel the transfer to - another AWS account. + another Amazon Web Services account. """ function cancel_domain_transfer_to_another_aws_account( @@ -187,6 +191,47 @@ function check_domain_transferability( ) end +""" + delete_domain(domain_name) + delete_domain(domain_name, params::Dict{String,<:Any}) + +This operation deletes the specified domain. This action is permanent. For more +information, see Deleting a domain name registration. To transfer the domain registration +to another registrar, use the transfer process that’s provided by the registrar to which +you want to transfer the registration. Otherwise, the following apply: You can’t get a +refund for the cost of a deleted domain registration. The registry for the top-level +domain might hold the domain name for a brief time before releasing it for other users to +register (varies by registry). When the registration has been deleted, we'll send you a +confirmation to the registrant contact. The email will come from +noreply@domainnameverification.net or noreply@registrar.amazon.com. + +# Arguments +- `domain_name`: Name of the domain to be deleted. + +""" +function delete_domain(DomainName; aws_config::AbstractAWSConfig=global_aws_config()) + return route_53_domains( + "DeleteDomain", + Dict{String,Any}("DomainName" => DomainName); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function delete_domain( + DomainName, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return route_53_domains( + "DeleteDomain", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ delete_tags_for_domain(domain_name, tags_to_delete) delete_tags_for_domain(domain_name, tags_to_delete, params::Dict{String,<:Any}) @@ -312,10 +357,11 @@ end This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is -billed to your AWS account. The period during which you can renew a domain name varies by -TLD. For a list of TLDs and their renewal policies, see Domains That You Can Register with -Amazon Route 53 in the Amazon Route 53 Developer Guide. Route 53 requires that you renew -before the end of the renewal period so we can complete processing before the deadline. +billed to your Amazon Web Services account. The period during which you can renew a domain +name varies by TLD. For a list of TLDs and their renewal policies, see Domains That You Can +Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Route 53 requires +that you renew before the end of the renewal period so we can complete processing before +the deadline. # Arguments - `domain_name`: The name of the domain that you want to enable automatic renewal for. @@ -423,8 +469,8 @@ end get_domain_detail(domain_name, params::Dict{String,<:Any}) This operation returns detailed information about a specified domain that is associated -with the current AWS account. Contact information for the domain is also returned as part -of the output. +with the current Amazon Web Services account. Contact information for the domain is also +returned as part of the output. # Arguments - `domain_name`: The name of the domain that you want to get detailed information about. @@ -561,17 +607,22 @@ end list_domains(params::Dict{String,<:Any}) This operation returns all the domain names registered with Amazon Route 53 for the current -AWS account. +Amazon Web Services account if no filtering conditions are used. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"FilterConditions"`: A complex type that contains information about the filters applied + during the ListDomains request. The filter conditions can include domain name and domain + expiration. - `"Marker"`: For an initial request for a list of domains, omit this element. If the - number of domains that are associated with the current AWS account is greater than the - value that you specified for MaxItems, you can use Marker to return additional domains. Get - the value of NextPageMarker from the previous response, and submit another request that - includes the value of NextPageMarker in the Marker element. Constraints: The marker must - match the value specified in the previous request. + number of domains that are associated with the current Amazon Web Services account is + greater than the value that you specified for MaxItems, you can use Marker to return + additional domains. Get the value of NextPageMarker from the previous response, and submit + another request that includes the value of NextPageMarker in the Marker element. + Constraints: The marker must match the value specified in the previous request. - `"MaxItems"`: Number of domains to be returned. Default: 20 +- `"SortCondition"`: A complex type that contains information about the requested ordering + of domains in the returned list. """ function list_domains(; aws_config::AbstractAWSConfig=global_aws_config()) return route_53_domains( @@ -591,7 +642,8 @@ end list_operations(params::Dict{String,<:Any}) Returns information about all of the operations that return an operation ID and that have -ever been performed on domains that were registered by the current account. +ever been performed on domains that were registered by the current account. This command +runs only in the us-east-1 Region. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -618,6 +670,40 @@ function list_operations( ) end +""" + list_prices() + list_prices(params::Dict{String,<:Any}) + +Lists the following prices for either all the TLDs supported by Route 53, or the specified +TLD: Registration Transfer Owner change Domain renewal Domain restoration + +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"Marker"`: For an initial request for a list of prices, omit this element. If the number + of prices that are not yet complete is greater than the value that you specified for + MaxItems, you can use Marker to return additional prices. Get the value of NextPageMarker + from the previous response, and submit another request that includes the value of + NextPageMarker in the Marker element. Used only for all TLDs. If you specify a TLD, don't + specify a Marker. +- `"MaxItems"`: Number of Prices to be returned. Used only for all TLDs. If you specify a + TLD, don't specify a MaxItems. +- `"Tld"`: The TLD for which you want to receive the pricing information. For example. + .net. If a Tld value is not provided, a list of prices for all TLDs supported by Route 53 + is returned. +""" +function list_prices(; aws_config::AbstractAWSConfig=global_aws_config()) + return route_53_domains( + "ListPrices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET + ) +end +function list_prices( + params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config() +) + return route_53_domains( + "ListPrices", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET + ) +end + """ list_tags_for_domain(domain_name) list_tags_for_domain(domain_name, params::Dict{String,<:Any}) @@ -668,11 +754,13 @@ year. We'll notify you in advance of the renewal date so you can choose whether 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 registrant, admin, and tech -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 AWS account an -amount based on the top-level domain. For more information, see Amazon Route 53 Pricing. +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. # Arguments - `admin_contact`: Provides detailed contact information. For information about the values @@ -705,17 +793,21 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys 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. Default: true + information that you entered for the admin contact. You must specify the same privacy + setting for the administrative, registrant, and technical 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 associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the - information that you entered for the registrant contact (the domain owner). Default: true + information that you entered for the registrant contact (the domain owner). You must + specify the same privacy setting for the administrative, registrant, and technical + contacts. Default: true - `"PrivacyProtectTechContact"`: 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 technical contact. Default: true + you entered for the technical contact. You must specify the same privacy setting for the + administrative, registrant, and technical contacts. Default: true """ function register_domain( AdminContact, @@ -771,15 +863,15 @@ end reject_domain_transfer_from_another_aws_account(domain_name) reject_domain_transfer_from_another_aws_account(domain_name, params::Dict{String,<:Any}) -Rejects the transfer of a domain from another AWS account to the current AWS account. You -initiate a transfer between AWS accounts using TransferDomainToAnotherAwsAccount. Use -either ListOperations or GetOperationDetail to determine whether the operation succeeded. -GetOperationDetail provides additional information, for example, Domain Transfer from Aws -Account 111122223333 has been cancelled. +Rejects the transfer of a domain from another Amazon Web Services account to the current +Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts +using TransferDomainToAnotherAwsAccount. Use either ListOperations or GetOperationDetail +to determine whether the operation succeeded. GetOperationDetail provides additional +information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. # Arguments -- `domain_name`: The name of the domain that was specified when another AWS account - submitted a TransferDomainToAnotherAwsAccount request. +- `domain_name`: The name of the domain that was specified when another Amazon Web Services + account submitted a TransferDomainToAnotherAwsAccount request. """ function reject_domain_transfer_from_another_aws_account( @@ -812,10 +904,11 @@ end renew_domain(current_expiry_year, domain_name, params::Dict{String,<:Any}) This operation renews a domain for the specified number of years. The cost of renewing your -domain is billed to your AWS account. We recommend that you renew your domain several weeks -before the expiration date. Some TLD registries delete domains before the expiration date -if you haven't renewed far enough in advance. For more information about renewing domain -registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide. +domain is billed to your Amazon Web Services account. We recommend that you renew your +domain several weeks before the expiration date. Some TLD registries delete domains before +the expiration date if you haven't renewed far enough in advance. For more information +about renewing domain registration, see Renewing Registration for a Domain in the Amazon +Route 53 Developer Guide. # Arguments - `current_expiry_year`: The year when the registration for the domain is set to expire. @@ -943,14 +1036,14 @@ about transferring domains, see the following topics: For transfer requirement 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 AWS 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 will not -renew your domain registration and could end your DNS service at any time. If the +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 +will not renew your domain registration and could end your DNS service at any time. If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable. If the transfer is successful, this @@ -985,17 +1078,21 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys 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. Default: true + information that you entered for the admin contact. You must specify the same privacy + setting for the administrative, registrant, and technical 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 associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the - information that you entered for the registrant contact (domain owner). Default: true + information that you entered for the registrant contact (domain owner). You must specify + the same privacy setting for the administrative, registrant, and technical contacts. + Default: true - `"PrivacyProtectTechContact"`: 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 technical contact. Default: true + you entered for the technical contact. You must specify the same privacy setting for the + administrative, registrant, and technical contacts. Default: true """ function transfer_domain( AdminContact, @@ -1051,26 +1148,27 @@ end transfer_domain_to_another_aws_account(account_id, domain_name) transfer_domain_to_another_aws_account(account_id, domain_name, params::Dict{String,<:Any}) -Transfers a domain from the current AWS account to another AWS account. Note the following: - The AWS account that you're transferring the domain to must accept the transfer. If the -other account doesn't accept the transfer within 3 days, we cancel the transfer. See +Transfers a domain from the current Amazon Web Services account to another Amazon Web +Services account. Note the following: The Amazon Web Services account that you're +transferring the domain to must accept the transfer. If the other account doesn't accept +the transfer within 3 days, we cancel the transfer. See AcceptDomainTransferFromAnotherAwsAccount. You can cancel the transfer before the other account accepts it. See CancelDomainTransferToAnotherAwsAccount. The other account can reject the transfer. See RejectDomainTransferFromAnotherAwsAccount. When you transfer a -domain from one AWS account to another, Route 53 doesn't transfer the hosted zone that is -associated with the domain. DNS resolution isn't affected if the domain and the hosted zone -are owned by separate accounts, so transferring the hosted zone is optional. For -information about transferring the hosted zone to another AWS account, see Migrating a -Hosted Zone to a Different AWS Account in the Amazon Route 53 Developer Guide. Use either -ListOperations or GetOperationDetail to determine whether the operation succeeded. -GetOperationDetail provides additional information, for example, Domain Transfer from Aws -Account 111122223333 has been cancelled. +domain from one Amazon Web Services account to another, Route 53 doesn't transfer the +hosted zone that is associated with the domain. DNS resolution isn't affected if the domain +and the hosted zone are owned by separate accounts, so transferring the hosted zone is +optional. For information about transferring the hosted zone to another Amazon Web Services +account, see Migrating a Hosted Zone to a Different Amazon Web Services Account in the +Amazon Route 53 Developer Guide. Use either ListOperations or GetOperationDetail to +determine whether the operation succeeded. GetOperationDetail provides additional +information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. # Arguments -- `account_id`: The account ID of the AWS account that you want to transfer the domain to, - for example, 111122223333. -- `domain_name`: The name of the domain that you want to transfer from the current AWS - account to another account. +- `account_id`: The account ID of the Amazon Web Services account that you want to transfer + the domain to, for example, 111122223333. +- `domain_name`: The name of the domain that you want to transfer from the current Amazon + Web Services account to another account. """ function transfer_domain_to_another_aws_account( @@ -1154,11 +1252,12 @@ end 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. This operation affects only the contact -information for the specified contact type (registrant, administrator, or tech). 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 +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 +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 disabling the privacy service via API, you consent to the publication of the contact information provided for this domain via the public WHOIS database. You certify that you are the registrant of this domain name and have the authority to make this decision. You @@ -1176,17 +1275,20 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys 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. + for the admin contact. You must specify the same privacy setting for the administrative, + registrant, and technical contacts. - `"RegistrantPrivacy"`: 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 registrant contact (domain owner). + you entered for the registrant contact (domain owner). You must specify the same privacy + setting for the administrative, registrant, and technical contacts. - `"TechPrivacy"`: 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 technical contact. + for the technical contact. You must specify the same privacy setting for the + administrative, registrant, and technical contacts. """ function update_domain_contact_privacy( DomainName; aws_config::AbstractAWSConfig=global_aws_config() @@ -1307,20 +1409,20 @@ end view_billing() view_billing(params::Dict{String,<:Any}) -Returns all the domain-related billing records for the current AWS account for a specified -period +Returns all the domain-related billing records for the current Amazon Web Services account +for a specified period # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"End"`: The end date and time for the time period for which you want a list of billing records. Specify the date and time in Unix time format and Coordinated Universal time (UTC). - `"Marker"`: For an initial request for a list of billing records, omit this element. If - the number of billing records that are associated with the current AWS account during the - specified period is greater than the value that you specified for MaxItems, you can use - Marker to return additional billing records. Get the value of NextPageMarker from the - previous response, and submit another request that includes the value of NextPageMarker in - the Marker element. Constraints: The marker must match the value of NextPageMarker that - was returned in the previous response. + the number of billing records that are associated with the current Amazon Web Services + account during the specified period is greater than the value that you specified for + MaxItems, you can use Marker to return additional billing records. Get the value of + NextPageMarker from the previous response, and submit another request that includes the + value of NextPageMarker in the Marker element. Constraints: The marker must match the + value of NextPageMarker that was returned in the previous response. - `"MaxItems"`: The number of billing records to be returned. Default: 20 - `"Start"`: The beginning date and time for the time period for which you want a list of billing records. Specify the date and time in Unix time format and Coordinated Universal diff --git a/src/services/s3.jl b/src/services/s3.jl index 5e2609d9c9..873fa30b45 100644 --- a/src/services/s3.jl +++ b/src/services/s3.jl @@ -438,14 +438,14 @@ where the bucket is to be created. If you create a bucket in a Region other than 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 includes the BucketOwnerEnforced value for the x-amz-object-ownership header, your -request can either not specify an ACL or specify bucket owner full control ACLs, such as -the bucket-owner-full-control canned ACL or an equivalent ACL expressed in the XML format. -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 +request sets bucket owner enforced for 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 @@ -3094,9 +3094,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys one specified, otherwise return a 304 (not modified). - `"If-Unmodified-Since"`: Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed). -- `"Range"`: Downloads the specified range bytes of an object. For more information about - the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35. - Amazon S3 doesn't support retrieving multiple ranges of data per GET request. +- `"Range"`: Because HeadObject returns only the metadata for an object, this parameter has + no effect. - `"partNumber"`: Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object. @@ -5910,33 +5909,33 @@ specify a data serialization format (JSON, CSV, or Apache Parquet) of the object uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. This action is not supported by Amazon S3 on Outposts. For more information about -Amazon S3 Select, see Selecting Content from Objects in the Amazon S3 User Guide. For more -information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select -and S3 Glacier Select in the Amazon S3 User Guide. Permissions You must have -s3:GetObject permission for this operation. Amazon S3 Select does not support anonymous -access. For more information about permissions, see Specifying Permissions in a Policy in -the Amazon S3 User Guide. Object Data Formats You can use Amazon S3 Select to query -objects that have the following format properties: CSV, JSON, and Parquet - Objects must -be in CSV, JSON, or Parquet format. UTF-8 - UTF-8 is the only encoding type Amazon S3 -Select supports. GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or -BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for -CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP -or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects. - Server-side encryption - Amazon S3 Select supports querying objects that are protected -with server-side encryption. For objects that are encrypted with customer-provided -encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are -documented in the GetObject. For more information about SSE-C, see Server-Side Encryption -(Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide. For objects that are -encrypted with Amazon S3 managed encryption keys (SSE-S3) and Amazon Web Services KMS keys -(SSE-KMS), server-side encryption is handled transparently, so you don't need to specify -anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, -see Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide. Working -with the Response Body Given the response size is unknown, Amazon S3 Select streams the -response as a series of messages and includes a Transfer-Encoding header with chunked as -its value in the response. For more 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 +Amazon S3 Select, see Selecting Content from Objects and SELECT Command in the Amazon S3 +User Guide. For more information about using SQL with Amazon S3 Select, see SQL Reference +for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide. Permissions You +must have s3:GetObject permission for this operation. Amazon S3 Select does not support +anonymous access. For more information about permissions, see Specifying Permissions in a +Policy in the Amazon S3 User Guide. Object Data Formats You can use Amazon S3 Select to +query objects that have the following format properties: CSV, JSON, and Parquet - +Objects must be in CSV, JSON, or Parquet format. UTF-8 - UTF-8 is the only encoding type +Amazon S3 Select supports. GZIP or BZIP2 - CSV and JSON files can be compressed using +GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select +supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet +using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for +Parquet objects. Server-side encryption - Amazon S3 Select supports querying objects +that are protected with server-side encryption. For objects that are encrypted with +customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers +that are documented in the GetObject. For more information about SSE-C, see Server-Side +Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide. For +objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and Amazon Web +Services KMS keys (SSE-KMS), server-side encryption is handled transparently, so you don't +need to specify anything. For more information about server-side encryption, including +SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon S3 User +Guide. Working with the Response Body Given the response size is unknown, Amazon S3 +Select streams the response as a series of messages and includes a Transfer-Encoding header +with chunked as its value in the response. For more 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 diff --git a/src/services/sagemaker.jl b/src/services/sagemaker.jl index e1219b8fd3..eb9c5b0bef 100644 --- a/src/services/sagemaker.jl +++ b/src/services/sagemaker.jl @@ -977,7 +977,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. - `"DomainSettings"`: A collection of Domain settings. -- `"HomeEfsFileSystemKmsKeyId"`: This member is deprecated and replaced with KmsKeyId. +- `"HomeEfsFileSystemKmsKeyId"`: Use KmsKeyId. - `"KmsKeyId"`: SageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key. @@ -2699,28 +2699,31 @@ function create_notebook_instance_lifecycle_config( end """ - create_pipeline(client_request_token, pipeline_definition, pipeline_name, role_arn) - create_pipeline(client_request_token, pipeline_definition, pipeline_name, role_arn, params::Dict{String,<:Any}) + create_pipeline(client_request_token, pipeline_name, role_arn) + create_pipeline(client_request_token, pipeline_name, role_arn, params::Dict{String,<:Any}) Creates a pipeline using a JSON pipeline definition. # Arguments - `client_request_token`: A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. -- `pipeline_definition`: The JSON pipeline definition of the pipeline. - `pipeline_name`: The name of the pipeline. - `role_arn`: The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"ParallelismConfiguration"`: This is the configuration that controls the parallelism of + the pipeline. If specified, it applies to all runs of this pipeline by default. +- `"PipelineDefinition"`: The JSON pipeline definition of the pipeline. +- `"PipelineDefinitionS3Location"`: The location of the pipeline definition stored in + Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. - `"PipelineDescription"`: A description of the pipeline. - `"PipelineDisplayName"`: The display name of the pipeline. - `"Tags"`: A list of tags to apply to the created pipeline. """ function create_pipeline( ClientRequestToken, - PipelineDefinition, PipelineName, RoleArn; aws_config::AbstractAWSConfig=global_aws_config(), @@ -2729,7 +2732,6 @@ function create_pipeline( "CreatePipeline", Dict{String,Any}( "ClientRequestToken" => ClientRequestToken, - "PipelineDefinition" => PipelineDefinition, "PipelineName" => PipelineName, "RoleArn" => RoleArn, ); @@ -2739,7 +2741,6 @@ function create_pipeline( end function create_pipeline( ClientRequestToken, - PipelineDefinition, PipelineName, RoleArn, params::AbstractDict{String}; @@ -2752,7 +2753,6 @@ function create_pipeline( _merge, Dict{String,Any}( "ClientRequestToken" => ClientRequestToken, - "PipelineDefinition" => PipelineDefinition, "PipelineName" => PipelineName, "RoleArn" => RoleArn, ), @@ -9755,6 +9755,10 @@ Retry the execution of the pipeline. the idempotency of the operation. An idempotent operation completes no more than once. - `pipeline_execution_arn`: The Amazon Resource Name (ARN) of the pipeline execution. +# Optional Parameters +Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"ParallelismConfiguration"`: This configuration, if specified, overrides the parallelism + configuration of the parent pipeline. """ function retry_pipeline_execution( ClientRequestToken, @@ -10042,6 +10046,8 @@ Starts a pipeline execution. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"ParallelismConfiguration"`: This configuration, if specified, overrides the parallelism + configuration of the parent pipeline for this specific run. - `"PipelineExecutionDescription"`: The description of the pipeline execution. - `"PipelineExecutionDisplayName"`: The display name of the pipeline execution. - `"PipelineParameters"`: Contains a list of pipeline parameters. This list can be empty. @@ -10398,13 +10404,13 @@ end Stops a pipeline execution. Callback Step A pipeline execution won't stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with -a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the -specified SQS queue. The body of the SQS message contains a \"Status\" field which is set -to \"Stopping\". You should add logic to your Amazon SQS message consumer to take any -needed action (for example, resource cleanup) upon receipt of the message followed by a +a running callback step, Amazon SageMaker Pipelines sends an additional Amazon SQS message +to the specified SQS queue. The body of the SQS message contains a \"Status\" field which +is set to \"Stopping\". You should add logic to your Amazon SQS message consumer to take +any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure. Only when -SageMaker Pipelines receives one of these calls will it stop the pipeline execution. -Lambda Step A pipeline execution can't be stopped while a lambda step is running because +Amazon SageMaker Pipelines receives one of these calls will it stop the pipeline execution. + Lambda Step A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the @@ -10537,13 +10543,13 @@ end stop_transform_job(transform_job_name) stop_transform_job(transform_job_name, params::Dict{String,<:Any}) -Stops a transform job. When Amazon SageMaker receives a StopTransformJob request, the +Stops a batch transform job. When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is -set to Stopped. When you stop a transform job before it is completed, Amazon SageMaker -doesn't store the job's output in Amazon S3. +set to Stopped. When you stop a batch transform job before it is completed, Amazon +SageMaker doesn't store the job's output in Amazon S3. # Arguments -- `transform_job_name`: The name of the transform job to stop. +- `transform_job_name`: The name of the batch transform job to stop. """ function stop_transform_job( @@ -11371,7 +11377,11 @@ Updates a pipeline. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"ParallelismConfiguration"`: If specified, it applies to all executions of this pipeline + by default. - `"PipelineDefinition"`: The JSON pipeline definition. +- `"PipelineDefinitionS3Location"`: The location of the pipeline definition stored in + Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. - `"PipelineDescription"`: The description of the pipeline. - `"PipelineDisplayName"`: The display name of the pipeline. - `"RoleArn"`: The Amazon Resource Name (ARN) that the pipeline uses to execute. @@ -11410,6 +11420,8 @@ Updates a pipeline execution. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: +- `"ParallelismConfiguration"`: This configuration, if specified, overrides the parallelism + configuration of the parent pipeline for this specific run. - `"PipelineExecutionDescription"`: The description of the pipeline execution. - `"PipelineExecutionDisplayName"`: The display name of the pipeline execution. """ diff --git a/src/services/savingsplans.jl b/src/services/savingsplans.jl index 20a8f6d038..3023a981e6 100644 --- a/src/services/savingsplans.jl +++ b/src/services/savingsplans.jl @@ -12,7 +12,7 @@ Creates a Savings Plan. # Arguments - `commitment`: The hourly commitment, in USD. This is a value between 0.001 and 1 million. - You cannot specify more than three digits after the decimal point. + You cannot specify more than five digits after the decimal point. - `savings_plan_offering_id`: The ID of the offering. # Optional Parameters diff --git a/src/services/secrets_manager.jl b/src/services/secrets_manager.jl index 124c081edd..106b7e631c 100644 --- a/src/services/secrets_manager.jl +++ b/src/services/secrets_manager.jl @@ -8,29 +8,17 @@ using AWS.UUIDs cancel_rotate_secret(secret_id) cancel_rotate_secret(secret_id, params::Dict{String,<:Any}) -Disables automatic scheduled rotation and cancels the rotation of a secret if currently in -progress. To re-enable scheduled rotation, call RotateSecret with -AutomaticallyRotateAfterDays set to a value greater than 0. This immediately rotates your -secret and then enables the automatic schedule. If you cancel a rotation while in -progress, it can leave the VersionStage labels in an unexpected state. Depending on the +Turns off automatic rotation, and if a rotation is currently in progress, cancels the +rotation. To turn on automatic rotation again, call RotateSecret. If you cancel a rotation +in progress, it can leave the VersionStage labels in an unexpected state. Depending on the step of the rotation in progress, you might need to remove the staging label AWSPENDING -from the partially created version, specified by the VersionId response value. You should -also evaluate the partially rotated new version to see if it should be deleted, which you -can do by removing all staging labels from the new version VersionStage field. To -successfully start a rotation, the staging label AWSPENDING must be in one of the following -states: Not attached to any version at all Attached to the same version as the staging -label AWSCURRENT If the staging label AWSPENDING attached to a different version than -the version with AWSCURRENT then the attempt to rotate fails. Minimum permissions To run -this command, you must have the following permissions: secretsmanager:CancelRotateSecret - Related operations To configure rotation for a secret or to manually trigger a -rotation, use RotateSecret. To get the rotation configuration details for a secret, use -DescribeSecret. To list all of the currently available secrets, use ListSecrets. To -list all of the versions currently associated with a secret, use ListSecretVersionIds. +from the partially created version, specified by the VersionId response value. We recommend +you also evaluate the partially rotated new version to see if it should be deleted. You can +delete a version by removing all staging labels from it. # Arguments -- `secret_id`: Specifies the secret to cancel a rotation request. You can specify either - the Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend - that you specify a complete ARN rather than a partial ARN. +- `secret_id`: The ARN or name of the secret. For an ARN, we recommend that you specify a + complete ARN rather than a partial ARN. """ function cancel_rotate_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config()) @@ -60,64 +48,38 @@ end create_secret(name) create_secret(name, params::Dict{String,<:Any}) -Creates a new secret. A secret in Secrets Manager consists of both the protected secret -data and the important information needed to manage the secret. Secrets Manager stores the -encrypted secret data in one of a collection of \"versions\" associated with the secret. -Each version contains a copy of the encrypted secret data. Each version is associated with -one or more \"staging labels\" that identify where the version is in the rotation cycle. -The SecretVersionsToStages field of the secret contains the mapping of staging labels to -the active versions of the secret. Versions without a staging label are considered -deprecated and not included in the list. You provide the secret data to be encrypted by -putting text in either the SecretString parameter or binary data in the SecretBinary -parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager -also creates an initial secret version and automatically attaches the staging label -AWSCURRENT to the new version. If you call an operation to encrypt or decrypt the -SecretString or SecretBinary for a secret in the same account as the calling user and that -secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the -account's default Amazon Web Services managed customer master key (CMK) with the alias -aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager -creates it for you automatically. All users and roles in the same Amazon Web Services -account automatically have access to use the default CMK. Note that if an Secrets Manager -API call results in Amazon Web Services creating the account's Amazon Web Services-managed -CMK, it can result in a one-time significant delay in returning the result. If the secret -resides in a different Amazon Web Services account from the credentials calling an API that -requires encryption or decryption of the secret value then you must create and use a custom -Amazon Web Services KMS CMK because you can't access the default CMK for the account using -credentials from a different Amazon Web Services account. Store the ARN of the CMK in the -secret when you create the secret or when you update it by including it in the KMSKeyId. If -you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials -from a different account then the Amazon Web Services KMS key policy must grant -cross-account access to that other account's user or role for both the kms:GenerateDataKey -and kms:Decrypt operations. Minimum permissions To run this command, you must have -the following permissions: secretsmanager:CreateSecret kms:GenerateDataKey - needed -only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You -do not need this permission to use the account default Amazon Web Services managed CMK for -Secrets Manager. kms:Decrypt - needed only if you use a customer-managed Amazon Web -Services KMS key to encrypt the secret. You do not need this permission to use the account -default Amazon Web Services managed CMK for Secrets Manager. secretsmanager:TagResource - -needed only if you include the Tags parameter. Related operations To delete a -secret, use DeleteSecret. To modify an existing secret, use UpdateSecret. To create a -new version of a secret, use PutSecretValue. To retrieve the encrypted secure string and -secure binary values, use GetSecretValue. To retrieve all other details for a secret, use -DescribeSecret. This does not include the encrypted secure string and secure binary values. - To retrieve the list of secret versions associated with the current secret, use -DescribeSecret and examine the SecretVersionsToStages response value. +Creates a new secret. A secret is a set of credentials, such as a user name and password, +that you store in an encrypted form in Secrets Manager. The secret also includes the +connection information to access a database or other service, which Secrets Manager doesn't +encrypt. A secret in Secrets Manager consists of both the protected secret data and the +important information needed to manage the secret. For information about creating a secret +in the console, see Create a secret. To create a secret, you can provide the secret value +to be encrypted in either the SecretString parameter or the SecretBinary parameter, but not +both. If you include SecretString or SecretBinary then Secrets Manager creates an initial +secret version and automatically attaches the staging label AWSCURRENT to it. If you don't +specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key +aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager +creates it for you automatically. All users and roles in the Amazon Web Services account +automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result +in a one-time significant delay in returning the result. If the secret is in a different +Amazon Web Services account from the credentials calling the API, then you can't use +aws/secretsmanager to encrypt the secret, and you must create and use a customer managed +KMS key. # Arguments -- `name`: Specifies the friendly name of the new secret. The secret name must be ASCII - letters, digits, or the following characters : /_+=.@- Do not end your secret name with a - hyphen followed by six characters. If you do so, you risk confusion and unexpected results - when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and - six random characters at the end of the ARN. +- `name`: The name of the new secret. The secret name can contain ASCII letters, numbers, + and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by + six characters. If you do so, you risk confusion and unexpected results when searching for + a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random + characters after the secret name at the end of the ARN. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"AddReplicaRegions"`: (Optional) Add a list of regions to replicate secrets. Secrets - Manager replicates the KMSKeyID objects to the list of regions specified in the parameter. -- `"ClientRequestToken"`: (Optional) If you include SecretString or SecretBinary, then an - initial version is created as part of the secret, and this parameter specifies a unique +- `"AddReplicaRegions"`: A list of Regions and KMS keys to replicate secrets. +- `"ClientRequestToken"`: If you include SecretString or SecretBinary, then Secrets Manager + creates an initial version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the - Amazon Web Services SDK to call this operation, then you can leave this parameter empty. + Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken @@ -133,60 +95,49 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version. This value becomes the VersionId of the new version. -- `"Description"`: (Optional) Specifies a user-provided description of the secret. -- `"ForceOverwriteReplicaSecret"`: (Optional) If set, the replication overwrites a secret - with the same name in the destination region. -- `"KmsKeyId"`: (Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services - KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values - in the versions stored in this secret. You can specify any of the supported ways to - identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different - account, you can use only the key ARN or the alias ARN. If you don't specify this value, - then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the - one named aws/secretsmanager). If a Amazon Web Services KMS CMK with that name doesn't yet - exist, then Secrets Manager creates it for you automatically the first time it needs to - encrypt a version's SecretString or SecretBinary fields. You can use the account default - CMK to encrypt and decrypt only if you call this operation using credentials from the same - account that owns the secret. If the secret resides in a different account, then you must - create a custom CMK and specify the ARN in this field. -- `"SecretBinary"`: (Optional) Specifies binary data that you want to encrypt and store in - the new version of the secret. To use this parameter in the command-line tools, we - recommend that you store your binary data in a file and then use the appropriate technique - for your tool to pass the contents of the file as a parameter. Either SecretString or - SecretBinary must have a value, but not both. They cannot both be empty. This parameter is - not available using the Secrets Manager console. It can be accessed only by using the - Amazon Web Services CLI or one of the Amazon Web Services SDKs. -- `"SecretString"`: (Optional) Specifies text data that you want to encrypt and store in - this new version of the secret. Either SecretString or SecretBinary must have a value, but - not both. They cannot both be empty. If you create a secret by using the Secrets Manager - console then Secrets Manager puts the protected secret text in only the SecretString - parameter. The Secrets Manager console stores the information as a JSON structure of - key/value pairs that the Lambda rotation function knows how to parse. For storing multiple - values, we recommend that you use a JSON text string argument and specify key/value pairs. - For more information, see Specifying parameter values for the Amazon Web Services CLI in - the Amazon Web Services CLI User Guide. -- `"Tags"`: (Optional) Specifies a list of user-defined tags that are attached to the - secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends - tags to the existing list of tags. To remove tags, you must use UntagResource. Secrets - Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag - from one with key \"abc\". If you check tags in IAM policy Condition elements as part of - your security strategy, then adding or removing a tag can change permissions. If the - successful completion of this operation would result in you losing your permissions for - this secret, then this operation is blocked and returns an Access Denied error. This - parameter requires a JSON text string argument. For information on how to format a JSON - parameter for the various command line tool environments, see Using JSON for Parameters in - the CLI User Guide. For example: +- `"Description"`: The description of the secret. +- `"ForceOverwriteReplicaSecret"`: Specifies whether to overwrite a secret with the same + name in the destination Region. +- `"KmsKeyId"`: The ARN, key ID, or alias of the KMS key that Secrets Manager uses to + encrypt the secret value in the secret. To use a KMS key in a different account, use the + key ARN or the alias ARN. If you don't specify this value, then Secrets Manager uses the + key aws/secretsmanager. If that key doesn't yet exist, then Secrets Manager creates it for + you automatically the first time it encrypts the secret value. If the secret is in a + different Amazon Web Services account from the credentials calling the API, then you can't + use aws/secretsmanager to encrypt the secret, and you must create and use a customer + managed KMS key. +- `"SecretBinary"`: The binary data to encrypt and store in the new version of the secret. + We recommend that you store your binary data in a file and then pass the contents of the + file as a parameter. Either SecretString or SecretBinary must have a value, but not both. + This parameter is not available in the Secrets Manager console. +- `"SecretString"`: The text data to encrypt and store in this new version of the secret. + We recommend you use a JSON structure of key/value pairs for your secret value. Either + SecretString or SecretBinary must have a value, but not both. If you create a secret by + using the Secrets Manager console then Secrets Manager puts the protected secret text in + only the SecretString parameter. The Secrets Manager console stores the information as a + JSON structure of key/value pairs that a Lambda rotation function can parse. +- `"Tags"`: A list of tags to attach to the secret. Each tag is a key and value pair of + strings in a JSON text string, for example: [{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"productio - n\"}] If your command-line tool or SDK requires quotation marks around the parameter, you - should use single quotes to avoid confusion with the double quotes required in the JSON - text. The following basic restrictions apply to tags: Maximum number of tags per - secret—50 Maximum key length—127 Unicode characters in UTF-8 Maximum value - length—255 Unicode characters in UTF-8 Tag keys and values are case sensitive. Do not - use the aws: prefix in your tag names or values because Amazon Web Services reserves it for - Amazon Web Services use. You can't edit or delete tag names or values with this prefix. - Tags with this prefix do not count against your tags per secret limit. If you use your - tagging schema across multiple services and resources, remember other services might have - restrictions on allowed characters. Generally allowed characters: letters, spaces, and - numbers representable in UTF-8, plus the following special characters: + - = . _ : / @. + n\"}] Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a + different tag from one with key \"abc\". If you check tags in permissions policies as part + of your security strategy, then adding or removing a tag can change permissions. If the + completion of this operation would result in you losing your permissions for this secret, + then Secrets Manager blocks the operation and returns an Access Denied error. For more + information, see Control access to secrets using tags and Limit access to identities with + tags that match secrets' tags. For information about how to format a JSON parameter for the + various command line tool environments, see Using JSON for Parameters. If your command-line + tool or SDK requires quotation marks around the parameter, you should use single quotes to + avoid confusion with the double quotes required in the JSON text. The following + restrictions apply to tags: Maximum number of tags per secret: 50 Maximum key length: + 127 Unicode characters in UTF-8 Maximum value length: 255 Unicode characters in UTF-8 + Tag keys and values are case sensitive. Do not use the aws: prefix in your tag names or + values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit + or delete tag names or values with this prefix. Tags with this prefix do not count against + your tags per secret limit. If you use your tagging schema across multiple services and + resources, other services might have restrictions on allowed characters. Generally allowed + characters: letters, spaces, and numbers representable in UTF-8, plus the following special + characters: + - = . _ : / @. """ function create_secret(Name; aws_config::AbstractAWSConfig=global_aws_config()) return secrets_manager( @@ -217,18 +168,12 @@ end delete_resource_policy(secret_id) delete_resource_policy(secret_id, params::Dict{String,<:Any}) -Deletes the resource-based permission policy attached to the secret. Minimum permissions -To run this command, you must have the following permissions: -secretsmanager:DeleteResourcePolicy Related operations To attach a resource policy to -a secret, use PutResourcePolicy. To retrieve the current resource-based policy attached -to a secret, use GetResourcePolicy. To list all of the currently available secrets, use -ListSecrets. +Deletes the resource-based permission policy attached to the secret. To attach a policy to +a secret, use PutResourcePolicy. # Arguments -- `secret_id`: Specifies the secret that you want to delete the attached resource-based - policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of - the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial - ARN. +- `secret_id`: The ARN or name of the secret to delete the attached resource-based policy + for. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. """ function delete_resource_policy(SecretId; aws_config::AbstractAWSConfig=global_aws_config()) @@ -258,49 +203,42 @@ end delete_secret(secret_id) delete_secret(secret_id, params::Dict{String,<:Any}) -Deletes an entire secret and all of the versions. You can optionally include a recovery -window during which you can restore the secret. If you don't specify a recovery window -value, the operation defaults to 30 days. Secrets Manager attaches a DeletionDate stamp to -the secret that specifies the end of the recovery window. At the end of the recovery -window, Secrets Manager deletes the secret permanently. At any time before recovery window -ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the -secret. You cannot access the encrypted secret information in any secret scheduled for -deletion. If you need to access that information, you must cancel the deletion with -RestoreSecret and then retrieve the information. There is no explicit operation to -delete a version of a secret. Instead, remove all staging labels from the VersionStage -field of a version. That marks the version as deprecated and allows Secrets Manager to -delete it as needed. Versions without any staging labels do not show up in -ListSecretVersionIds unless you specify IncludeDeprecated. The permanent secret deletion -at the end of the waiting period is performed as a background task with low priority. There -is no guarantee of a specific time after the recovery window for the actual delete -operation to occur. Minimum permissions To run this command, you must have the -following permissions: secretsmanager:DeleteSecret Related operations To create a -secret, use CreateSecret. To cancel deletion of a version of a secret before the recovery -window has expired, use RestoreSecret. +Deletes a secret and all of its versions. You can specify a recovery window during which +you can restore the secret. The minimum recovery window is 7 days. The default recovery +window is 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that +specifies the end of the recovery window. At the end of the recovery window, Secrets +Manager deletes the secret permanently. For information about deleting a secret in the +console, see +https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html. +Secrets Manager performs the permanent secret deletion at the end of the waiting period as +a background task with low priority. There is no guarantee of a specific time after the +recovery window for the permanent delete to occur. At any time before recovery window ends, +you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret. +In a secret scheduled for deletion, you cannot access the encrypted secret value. To access +that information, first cancel the deletion with RestoreSecret and then retrieve the +information. # Arguments -- `secret_id`: Specifies the secret to delete. You can specify either the Amazon Resource - Name (ARN) or the friendly name of the secret. For an ARN, we recommend that you specify a - complete ARN rather than a partial ARN. +- `secret_id`: The ARN or name of the secret to delete. For an ARN, we recommend that you + specify a complete ARN rather than a partial ARN. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"ForceDeleteWithoutRecovery"`: (Optional) Specifies that the secret is to be deleted - without any recovery window. You can't use both this parameter and the RecoveryWindowInDays - parameter in the same API call. An asynchronous background process performs the actual - deletion, so there can be a short delay before the operation completes. If you write code - to delete and then immediately recreate a secret with the same name, ensure that your code - includes appropriate back off and retry logic. Use this parameter with caution. This - parameter causes the operation to skip the normal waiting period before the permanent - deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays - parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you - have no opportunity to recover the secret. You lose the secret permanently. If you use - this parameter and include a previously deleted or nonexistent secret, the operation does - not return the error ResourceNotFoundException in order to correctly handle retries. -- `"RecoveryWindowInDays"`: (Optional) Specifies the number of days that Secrets Manager - waits before Secrets Manager can delete the secret. You can't use both this parameter and - the ForceDeleteWithoutRecovery parameter in the same API call. This value can range from 7 - to 30 days with a default value of 30. +- `"ForceDeleteWithoutRecovery"`: Specifies whether to delete the secret without any + recovery window. You can't use both this parameter and RecoveryWindowInDays in the same + call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window. + Secrets Manager performs the actual deletion with an asynchronous background process, so + there might be a short delay before the secret is permanently deleted. If you delete a + secret and then immediately create a secret with the same name, use appropriate back off + and retry logic. Use this parameter with caution. This parameter causes the operation to + skip the normal recovery window before the permanent deletion that Secrets Manager would + normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the + ForceDeleteWithouRecovery parameter, then you have no opportunity to recover the secret. + You lose the secret permanently. +- `"RecoveryWindowInDays"`: The number of days from 7 to 30 that Secrets Manager waits + before permanently deleting the secret. You can't use both this parameter and + ForceDeleteWithoutRecovery in the same call. If you don't use either, then Secrets Manager + defaults to a 30 day recovery window. """ function delete_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config()) return secrets_manager( @@ -329,18 +267,12 @@ end describe_secret(secret_id) describe_secret(secret_id, params::Dict{String,<:Any}) -Retrieves the details of a secret. It does not include the encrypted fields. Secrets -Manager only returns fields populated with a value in the response. Minimum permissions -To run this command, you must have the following permissions: -secretsmanager:DescribeSecret Related operations To create a secret, use -CreateSecret. To modify a secret, use UpdateSecret. To retrieve the encrypted secret -information in a version of the secret, use GetSecretValue. To list all of the secrets in -the Amazon Web Services account, use ListSecrets. +Retrieves the details of a secret. It does not include the encrypted secret value. Secrets +Manager only returns fields that have a value in the response. # Arguments -- `secret_id`: The identifier of the secret whose details you want to retrieve. You can - specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an - ARN, we recommend that you specify a complete ARN rather than a partial ARN. +- `secret_id`: The ARN or name of the secret. For an ARN, we recommend that you specify a + complete ARN rather than a partial ARN. """ function describe_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config()) @@ -370,39 +302,28 @@ end get_random_password() get_random_password(params::Dict{String,<:Any}) -Generates a random password of the specified complexity. This operation is intended for use -in the Lambda rotation function. Per best practice, we recommend that you specify the -maximum length and include every character type that the system you are generating a -password for can support. Minimum permissions To run this command, you must have the -following permissions: secretsmanager:GetRandomPassword +Generates a random password. We recommend that you specify the maximum length and include +every character type that the system you are generating a password for can support. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"ExcludeCharacters"`: A string that includes characters that should not be included in - the generated password. The default is that all characters from the included sets can be - used. -- `"ExcludeLowercase"`: Specifies that the generated password should not include lowercase - letters. The default if you do not include this switch parameter is that lowercase letters - can be included. -- `"ExcludeNumbers"`: Specifies that the generated password should not include digits. The - default if you do not include this switch parameter is that digits can be included. -- `"ExcludePunctuation"`: Specifies that the generated password should not include - punctuation characters. The default if you do not include this switch parameter is that - punctuation characters can be included. The following are the punctuation characters that - can be included in the generated password if you don't explicitly exclude them with - ExcludeCharacters or ExcludePunctuation: ! \" # % & ' ( ) * + , - . / : ; < = > - ? @ [ ] ^ _ ` { | } ~ -- `"ExcludeUppercase"`: Specifies that the generated password should not include uppercase - letters. The default if you do not include this switch parameter is that uppercase letters - can be included. -- `"IncludeSpace"`: Specifies that the generated password can include the space character. - The default if you do not include this switch parameter is that the space character is not - included. -- `"PasswordLength"`: The desired length of the generated password. The default value if - you do not include this parameter is 32 characters. -- `"RequireEachIncludedType"`: A boolean value that specifies whether the generated - password must include at least one of every allowed character type. The default value is - True and the operation requires at least one of every character type. +- `"ExcludeCharacters"`: A string of the characters that you don't want in the password. +- `"ExcludeLowercase"`: Specifies whether to exclude lowercase letters from the password. + If you don't include this switch, the password can contain lowercase letters. +- `"ExcludeNumbers"`: Specifies whether to exclude numbers from the password. If you don't + include this switch, the password can contain numbers. +- `"ExcludePunctuation"`: Specifies whether to exclude the following punctuation characters + from the password: ! \" # % & ' ( ) * + , - . / : ; < = > ? @ [ ] ^ _ ` { | } + ~. If you don't include this switch, the password can contain punctuation. +- `"ExcludeUppercase"`: Specifies whether to exclude uppercase letters from the password. + If you don't include this switch, the password can contain uppercase letters. +- `"IncludeSpace"`: Specifies whether to include the space character. If you include this + switch, the password can contain space characters. +- `"PasswordLength"`: The length of the password. If you don't include this parameter, the + default length is 32 characters. +- `"RequireEachIncludedType"`: Specifies whether to include at least one upper and + lowercase letter, one number, and one punctuation. If you don't include this switch, the + password contains at least one of every character type. """ function get_random_password(; aws_config::AbstractAWSConfig=global_aws_config()) return secrets_manager( @@ -421,20 +342,13 @@ end get_resource_policy(secret_id) get_resource_policy(secret_id, params::Dict{String,<:Any}) -Retrieves the JSON text of the resource-based policy document attached to the specified -secret. The JSON request string input and response output displays formatted code with -white space and line breaks for better readability. Submit your input as a single line JSON -string. Minimum permissions To run this command, you must have the following permissions: - secretsmanager:GetResourcePolicy Related operations To attach a resource policy to -a secret, use PutResourcePolicy. To delete the resource-based policy attached to a -secret, use DeleteResourcePolicy. To list all of the currently available secrets, use -ListSecrets. +Retrieves the JSON text of the resource-based policy document attached to the secret. For +more information about permissions policies attached to a secret, see Permissions policies +attached to a secret. # Arguments -- `secret_id`: Specifies the secret that you want to retrieve the attached resource-based - policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of - the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial - ARN. +- `secret_id`: The ARN or name of the secret to retrieve the attached resource-based policy + for. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. """ function get_resource_policy(SecretId; aws_config::AbstractAWSConfig=global_aws_config()) @@ -465,32 +379,28 @@ end get_secret_value(secret_id, params::Dict{String,<:Any}) Retrieves the contents of the encrypted fields SecretString or SecretBinary from the -specified version of a secret, whichever contains content. Minimum permissions To run -this command, you must have the following permissions: secretsmanager:GetSecretValue -kms:Decrypt - required only if you use a customer-managed Amazon Web Services KMS key to -encrypt the secret. You do not need this permission to use the account's default Amazon Web -Services managed CMK for Secrets Manager. Related operations To create a new version -of the secret with different encrypted information, use PutSecretValue. To retrieve the -non-encrypted details for the secret, use DescribeSecret. +specified version of a secret, whichever contains content. For information about retrieving +the secret value in the console, see Retrieve secrets. To run this command, you must have +secretsmanager:GetSecretValue permissions. If the secret is encrypted using a +customer-managed key instead of the Amazon Web Services managed key aws/secretsmanager, +then you also need kms:Decrypt permissions for that key. # Arguments -- `secret_id`: Specifies the secret containing the version that you want to retrieve. You - can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For - an ARN, we recommend that you specify a complete ARN rather than a partial ARN. +- `secret_id`: The ARN or name of the secret to retrieve. For an ARN, we recommend that you + specify a complete ARN rather than a partial ARN. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"VersionId"`: Specifies the unique identifier of the version of the secret that you want - to retrieve. If you specify both this parameter and VersionStage, the two parameters must - refer to the same secret version. If you don't specify either a VersionStage or VersionId - then the default is to perform the operation on the version with the VersionStage value of - AWSCURRENT. This value is typically a UUID-type value with 32 hexadecimal digits. -- `"VersionStage"`: Specifies the secret version that you want to retrieve by the staging - label attached to the version. Staging labels are used to keep track of different versions - during the rotation process. If you specify both this parameter and VersionId, the two - parameters must refer to the same secret version . If you don't specify either a - VersionStage or VersionId, then the default is to perform the operation on the version with - the VersionStage value of AWSCURRENT. +- `"VersionId"`: The unique identifier of the version of the secret to retrieve. If you + include both this parameter and VersionStage, the two parameters must refer to the same + secret version. If you don't specify either a VersionStage or VersionId, then Secrets + Manager returns the AWSCURRENT version. This value is typically a UUID-type value with 32 + hexadecimal digits. +- `"VersionStage"`: The staging label of the version of the secret to retrieve. Secrets + Manager uses staging labels to keep track of different versions during the rotation + process. If you include both this parameter and VersionId, the two parameters must refer to + the same secret version. If you don't specify either a VersionStage or VersionId, Secrets + Manager returns the AWSCURRENT version. """ function get_secret_value(SecretId; aws_config::AbstractAWSConfig=global_aws_config()) return secrets_manager( @@ -519,39 +429,26 @@ end list_secret_version_ids(secret_id) list_secret_version_ids(secret_id, params::Dict{String,<:Any}) -Lists all of the versions attached to the specified secret. The output does not include the -SecretString or SecretBinary fields. By default, the list includes only versions that have -at least one staging label in VersionStage attached. Always check the NextToken response -parameter when calling any of the List* operations. These operations can occasionally -return an empty or shorter than expected list of results even when there more results -become available. When this happens, the NextToken response parameter contains a value to -pass to the next call to the same API to request the next part of the list. Minimum -permissions To run this command, you must have the following permissions: -secretsmanager:ListSecretVersionIds Related operations To list the secrets in an -account, use ListSecrets. +Lists the versions for a secret. To list the secrets in the account, use ListSecrets. To +get the secret value from SecretString or SecretBinary, call GetSecretValue. Minimum +permissions To run this command, you must have secretsmanager:ListSecretVersionIds +permissions. # Arguments -- `secret_id`: The identifier for the secret containing the versions you want to list. You - can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For - an ARN, we recommend that you specify a complete ARN rather than a partial ARN. +- `secret_id`: The ARN or name of the secret whose versions you want to list. For an ARN, + we recommend that you specify a complete ARN rather than a partial ARN. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"IncludeDeprecated"`: (Optional) Specifies that you want the results to include versions - that do not have any staging labels attached to them. Such versions are considered - deprecated and are subject to deletion by Secrets Manager as needed. -- `"MaxResults"`: (Optional) Limits the number of results you want to include in the - response. If you don't include this parameter, it defaults to a value that's specific to - the operation. If additional items exist beyond the maximum you specify, the NextToken - response element is present and has a value (isn't null). Include that value as the - NextToken request parameter in the next call to the operation to get the next part of the - results. Note that Secrets Manager might return fewer results than the maximum even when - there are more results available. You should check NextToken after every operation to - ensure that you receive all of the results. -- `"NextToken"`: (Optional) Use this parameter in a request if you receive a NextToken - response in a previous request indicating there's more output available. In a subsequent - call, set it to the value of the previous call NextToken response to indicate where the - output should continue from. +- `"IncludeDeprecated"`: Specifies whether to include versions of secrets that don't have + any staging labels attached to them. Versions without staging labels are considered + deprecated and are subject to deletion by Secrets Manager. +- `"MaxResults"`: The number of results to include in the response. If there are more + results available, in the response, Secrets Manager includes NextToken. To get the next + results, call ListSecretVersionIds again with the value from NextToken. +- `"NextToken"`: A token that indicates where the output should continue from, if a + previous call did not show all results. To get the next results, call ListSecretVersionIds + again with this value. """ function list_secret_version_ids( SecretId; aws_config::AbstractAWSConfig=global_aws_config() @@ -582,33 +479,21 @@ end list_secrets() list_secrets(params::Dict{String,<:Any}) -Lists all of the secrets that are stored by Secrets Manager in the Amazon Web Services -account. To list the versions currently stored for a specific secret, use -ListSecretVersionIds. The encrypted fields SecretString and SecretBinary are not included -in the output. To get that information, call the GetSecretValue operation. Always check -the NextToken response parameter when calling any of the List* operations. These operations -can occasionally return an empty or shorter than expected list of results even when there -more results become available. When this happens, the NextToken response parameter contains -a value to pass to the next call to the same API to request the next part of the list. -Minimum permissions To run this command, you must have the following permissions: -secretsmanager:ListSecrets Related operations To list the versions attached to a -secret, use ListSecretVersionIds. +Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account. +To list the versions of a secret, use ListSecretVersionIds. To get the secret value from +SecretString or SecretBinary, call GetSecretValue. For information about finding secrets in +the console, see Enhanced search capabilities for secrets in Secrets Manager. Minimum +permissions To run this command, you must have secretsmanager:ListSecrets permissions. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"Filters"`: Lists the secret request filters. -- `"MaxResults"`: (Optional) Limits the number of results you want to include in the - response. If you don't include this parameter, it defaults to a value that's specific to - the operation. If additional items exist beyond the maximum you specify, the NextToken - response element is present and has a value (isn't null). Include that value as the - NextToken request parameter in the next call to the operation to get the next part of the - results. Note that Secrets Manager might return fewer results than the maximum even when - there are more results available. You should check NextToken after every operation to - ensure that you receive all of the results. -- `"NextToken"`: (Optional) Use this parameter in a request if you receive a NextToken - response in a previous request indicating there's more output available. In a subsequent - call, set it to the value of the previous call NextToken response to indicate where the - output should continue from. +- `"Filters"`: The filters to apply to the list of secrets. +- `"MaxResults"`: The number of results to include in the response. If there are more + results available, in the response, Secrets Manager includes NextToken. To get the next + results, call ListSecrets again with the value from NextToken. +- `"NextToken"`: A token that indicates where the output should continue from, if a + previous call did not show all results. To get the next results, call ListSecrets again + with this value. - `"SortOrder"`: Lists secrets in the requested order. """ function list_secrets(; aws_config::AbstractAWSConfig=global_aws_config()) @@ -628,34 +513,22 @@ end put_resource_policy(resource_policy, secret_id) put_resource_policy(resource_policy, secret_id, params::Dict{String,<:Any}) -Attaches the contents of the specified resource-based permission policy to a secret. A -resource-based policy is optional. Alternatively, you can use IAM identity-based policies -that specify the secret's Amazon Resource Name (ARN) in the policy statement's Resources -element. You can also use a combination of both identity-based and resource-based policies. -The affected users and roles receive the permissions that are permitted by all of the -relevant policies. For more information, see Using Resource-Based Policies for Amazon Web -Services Secrets Manager. For the complete description of the Amazon Web Services policy -syntax and grammar, see IAM JSON Policy Reference in the IAM User Guide. Minimum -permissions To run this command, you must have the following permissions: -secretsmanager:PutResourcePolicy Related operations To retrieve the resource policy -attached to a secret, use GetResourcePolicy. To delete the resource-based policy attached -to a secret, use DeleteResourcePolicy. To list all of the currently available secrets, -use ListSecrets. +Attaches a resource-based permission policy to a secret. A resource-based policy is +optional. For more information, see Authentication and access control for Secrets Manager +For information about attaching a policy in the console, see Attach a permissions policy to +a secret. # Arguments -- `resource_policy`: A JSON-formatted string constructed according to the grammar and - syntax for an Amazon Web Services resource-based policy. The policy in the string - identifies who can access or manage this secret and its versions. For information on how to - format a JSON parameter for the various command line tool environments, see Using JSON for - Parameters in the CLI User Guide. -- `secret_id`: Specifies the secret that you want to attach the resource-based policy. You - can specify either the ARN or the friendly name of the secret. For an ARN, we recommend - that you specify a complete ARN rather than a partial ARN. +- `resource_policy`: A JSON-formatted string for an Amazon Web Services resource-based + policy. For example policies, see Permissions policy examples. +- `secret_id`: The ARN or name of the secret to attach the resource-based policy. For an + ARN, we recommend that you specify a complete ARN rather than a partial ARN. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"BlockPublicPolicy"`: (Optional) If you set the parameter, BlockPublicPolicy to true, - then you block resource-based policies that allow broad access to the secret. +- `"BlockPublicPolicy"`: Specifies whether to block resource-based policies that allow + broad access to the secret. By default, Secrets Manager blocks policies that allow broad + access, for example those that use a wildcard for the principal. """ function put_resource_policy( ResourcePolicy, SecretId; aws_config::AbstractAWSConfig=global_aws_config() @@ -693,99 +566,65 @@ end put_secret_value(secret_id) put_secret_value(secret_id, params::Dict{String,<:Any}) -Stores a new encrypted secret value in the specified secret. To do this, the operation -creates a new version and attaches it to the secret. The version can contain a new -SecretString value or a new SecretBinary value. You can also specify the staging labels -that are initially attached to the new version. We recommend you avoid calling -PutSecretValue at a sustained rate of more than once every 10 minutes. When you update the -secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes -outdated versions when there are more than 100, but it does not remove versions created -less than 24 hours ago. If you call PutSecretValue more than once every 10 minutes, you -create more versions than Secrets Manager removes, and you will reach the quota for secret -versions. If this operation creates the first version for the secret then Secrets Manager -automatically attaches the staging label AWSCURRENT to the new version. If you do not -specify a value for VersionStages then Secrets Manager automatically moves the staging -label AWSCURRENT to this new version. If this operation moves the staging label -AWSCURRENT from another version to this version, then Secrets Manager also automatically -moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from. This -operation is idempotent. If a version with a VersionId with the same value as the -ClientRequestToken parameter already exists and you specify the same secret data, the -operation succeeds but does nothing. However, if the secret data is different, then the -operation fails because you cannot modify an existing version; you can only create new -ones. If you call an operation to encrypt or decrypt the SecretString or SecretBinary -for a secret in the same account as the calling user and that secret doesn't specify a -Amazon Web Services KMS encryption key, Secrets Manager uses the account's default Amazon -Web Services managed customer master key (CMK) with the alias aws/secretsmanager. If this -key doesn't already exist in your account then Secrets Manager creates it for you -automatically. All users and roles in the same Amazon Web Services account automatically -have access to use the default CMK. Note that if an Secrets Manager API call results in -Amazon Web Services creating the account's Amazon Web Services-managed CMK, it can result -in a one-time significant delay in returning the result. If the secret resides in a -different Amazon Web Services account from the credentials calling an API that requires -encryption or decryption of the secret value then you must create and use a custom Amazon -Web Services KMS CMK because you can't access the default CMK for the account using -credentials from a different Amazon Web Services account. Store the ARN of the CMK in the -secret when you create the secret or when you update it by including it in the KMSKeyId. If -you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials -from a different account then the Amazon Web Services KMS key policy must grant -cross-account access to that other account's user or role for both the kms:GenerateDataKey -and kms:Decrypt operations. Minimum permissions To run this command, you must have the -following permissions: secretsmanager:PutSecretValue kms:GenerateDataKey - needed only -if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You do not -need this permission to use the account's default Amazon Web Services managed CMK for -Secrets Manager. Related operations To retrieve the encrypted value you store in the -version of a secret, use GetSecretValue. To create a secret, use CreateSecret. To get -the details for a secret, use DescribeSecret. To list the versions attached to a secret, -use ListSecretVersionIds. +Creates a new version with a new encrypted secret value and attaches it to the secret. The +version can contain a new SecretString value or a new SecretBinary value. We recommend you +avoid calling PutSecretValue at a sustained rate of more than once every 10 minutes. When +you update the secret value, Secrets Manager creates a new version of the secret. Secrets +Manager removes outdated versions when there are more than 100, but it does not remove +versions created less than 24 hours ago. If you call PutSecretValue more than once every 10 +minutes, you create more versions than Secrets Manager removes, and you will reach the +quota for secret versions. You can specify the staging labels to attach to the new version +in VersionStages. If you don't include VersionStages, then Secrets Manager automatically +moves the staging label AWSCURRENT to this version. If this operation creates the first +version for the secret, then Secrets Manager automatically attaches the staging label +AWSCURRENT to it . If this operation moves the staging label AWSCURRENT from another +version to this version, then Secrets Manager also automatically moves the staging label +AWSPREVIOUS to the version that AWSCURRENT was removed from. This operation is idempotent. +If a version with a VersionId with the same value as the ClientRequestToken parameter +already exists, and you specify the same secret data, the operation succeeds but does +nothing. However, if the secret data is different, then the operation fails because you +can't modify an existing version; you can only create new ones. # Arguments -- `secret_id`: Specifies the secret to which you want to add a new version. You can specify - either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must - already exist. For an ARN, we recommend that you specify a complete ARN rather than a - partial ARN. +- `secret_id`: The ARN or name of the secret to add a new version to. For an ARN, we + recommend that you specify a complete ARN rather than a partial ARN. If the secret doesn't + already exist, use CreateSecret instead. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"ClientRequestToken"`: (Optional) Specifies a unique identifier for the new version of - the secret. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK - to call this operation, then you can leave this parameter empty. The CLI or SDK generates a - random UUID for you and includes that in the request. If you don't use the SDK and instead - generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate - a ClientRequestToken yourself for new versions and include that value in the request. - This value helps ensure idempotency. Secrets Manager uses this value to prevent the - accidental creation of duplicate versions if there are failures and retries during the - Lambda rotation function's processing. We recommend that you generate a UUID-type value to - ensure uniqueness within the specified secret. If the ClientRequestToken value isn't - already associated with a version of the secret then a new version of the secret is - created. If a version with this value already exists and that version's SecretString or - SecretBinary values are the same as those in the request then the request is ignored (the - operation is idempotent). If a version with this value already exists and the version of - the SecretString and SecretBinary values are different from those in the request then the - request fails because you cannot modify an existing secret version. You can only create new - versions to store new secret values. This value becomes the VersionId of the new version. -- `"SecretBinary"`: (Optional) Specifies binary data that you want to encrypt and store in - the new version of the secret. To use this parameter in the command-line tools, we - recommend that you store your binary data in a file and then use the appropriate technique - for your tool to pass the contents of the file as a parameter. Either SecretBinary or - SecretString must have a value, but not both. They cannot both be empty. This parameter is - not accessible if the secret using the Secrets Manager console. -- `"SecretString"`: (Optional) Specifies text data that you want to encrypt and store in - this new version of the secret. Either SecretString or SecretBinary must have a value, but - not both. They cannot both be empty. If you create this secret by using the Secrets Manager - console then Secrets Manager puts the protected secret text in only the SecretString - parameter. The Secrets Manager console stores the information as a JSON structure of - key/value pairs that the default Lambda rotation function knows how to parse. For storing - multiple values, we recommend that you use a JSON text string argument and specify - key/value pairs. For more information, see Specifying parameter values for the Amazon Web - Services CLI in the Amazon Web Services CLI User Guide. -- `"VersionStages"`: (Optional) Specifies a list of staging labels that are attached to - this version of the secret. These staging labels are used to track the versions through the - rotation process by the Lambda rotation function. A staging label must be unique to a - single version of the secret. If you specify a staging label that's already associated with - a different version of the same secret then that staging label is automatically removed - from the other version and attached to this version. If you do not specify a value for - VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this - new version. +- `"ClientRequestToken"`: A unique identifier for the new version of the secret. If you + use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this + operation, then you can leave this parameter empty because they generate a random UUID for + you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets + Manager service endpoint, then you must generate a ClientRequestToken yourself for new + versions and include that value in the request. This value helps ensure idempotency. + Secrets Manager uses this value to prevent the accidental creation of duplicate versions if + there are failures and retries during the Lambda rotation function processing. We recommend + that you generate a UUID-type value to ensure uniqueness within the specified secret. If + the ClientRequestToken value isn't already associated with a version of the secret then a + new version of the secret is created. If a version with this value already exists and + that version's SecretString or SecretBinary values are the same as those in the request + then the request is ignored. The operation is idempotent. If a version with this value + already exists and the version of the SecretString and SecretBinary values are different + from those in the request, then the request fails because you can't modify a secret + version. You can only create new versions to store new secret values. This value becomes + the VersionId of the new version. +- `"SecretBinary"`: The binary data to encrypt and store in the new version of the secret. + To use this parameter in the command-line tools, we recommend that you store your binary + data in a file and then pass the contents of the file as a parameter. You must include + SecretBinary or SecretString, but not both. You can't access this value from the Secrets + Manager console. +- `"SecretString"`: The text to encrypt and store in the new version of the secret. You + must include SecretBinary or SecretString, but not both. We recommend you create the secret + string as JSON key/value pairs, as shown in the example. +- `"VersionStages"`: A list of staging labels to attach to this version of the secret. + Secrets Manager uses staging labels to track versions of a secret through the rotation + process. If you specify a staging label that's already associated with a different version + of the same secret, then Secrets Manager removes the label from the other version and + attaches it to this version. If you specify AWSCURRENT, and it is already attached to + another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the + version that AWSCURRENT was removed from. If you don't include VersionStages, then Secrets + Manager automatically moves the staging label AWSCURRENT to this version. """ function put_secret_value(SecretId; aws_config::AbstractAWSConfig=global_aws_config()) return secrets_manager( @@ -820,11 +659,12 @@ end remove_regions_from_replication(remove_replica_regions, secret_id) remove_regions_from_replication(remove_replica_regions, secret_id, params::Dict{String,<:Any}) -Remove regions from replication. +For a secret that is replicated to other Regions, deletes the secret replicas from the +Regions you specify. # Arguments -- `remove_replica_regions`: Remove replication from specific Regions. -- `secret_id`: Remove a secret by SecretId from replica Regions. +- `remove_replica_regions`: The Regions of the replicas to remove. +- `secret_id`: The ARN or name of the secret. """ function remove_regions_from_replication( @@ -865,17 +705,16 @@ end replicate_secret_to_regions(add_replica_regions, secret_id) replicate_secret_to_regions(add_replica_regions, secret_id, params::Dict{String,<:Any}) -Converts an existing secret to a multi-Region secret and begins replication the secret to a -list of new regions. +Replicates the secret to a new Regions. See Multi-Region secrets. # Arguments -- `add_replica_regions`: Add Regions to replicate the secret. -- `secret_id`: Use the Secret Id to replicate a secret to regions. +- `add_replica_regions`: A list of Regions in which to replicate the secret. +- `secret_id`: The ARN or name of the secret to replicate. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"ForceOverwriteReplicaSecret"`: (Optional) If set, Secrets Manager replication - overwrites a secret with the same name in the destination region. +- `"ForceOverwriteReplicaSecret"`: Specifies whether to overwrite a secret with the same + name in the destination Region. """ function replicate_secret_to_regions( AddReplicaRegions, SecretId; aws_config::AbstractAWSConfig=global_aws_config() @@ -913,15 +752,12 @@ end restore_secret(secret_id) restore_secret(secret_id, params::Dict{String,<:Any}) -Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. This -makes the secret accessible to query once again. Minimum permissions To run this command, -you must have the following permissions: secretsmanager:RestoreSecret Related -operations To delete a secret, use DeleteSecret. +Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can +access a secret again after it has been restored. # Arguments -- `secret_id`: Specifies the secret that you want to restore from a previously scheduled - deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the - secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. +- `secret_id`: The ARN or name of the secret to restore. For an ARN, we recommend that you + specify a complete ARN rather than a partial ARN. """ function restore_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config()) @@ -951,57 +787,42 @@ end rotate_secret(secret_id) rotate_secret(secret_id, params::Dict{String,<:Any}) -Configures and starts the asynchronous process of rotating this secret. If you include the -configuration parameters, the operation sets those values for the secret and then -immediately starts a rotation. If you do not include the configuration parameters, the -operation starts a rotation with the values already stored in the secret. After the -rotation completes, the protected service and its clients all use the new version of the -secret. This required configuration information includes the ARN of an Amazon Web Services -Lambda function and optionally, the time between scheduled rotations. The Lambda rotation -function creates a new version of the secret and creates or updates the credentials on the -protected service to match. After testing the new credentials, the function marks the new -secret with the staging label AWSCURRENT so that your clients all immediately begin to use -the new version. For more information about rotating secrets and how to configure a Lambda -function to rotate the secrets for your protected service, see Rotating Secrets in Amazon -Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide. Secrets -Manager schedules the next rotation when the previous one completes. Secrets Manager -schedules the date by adding the rotation interval (number of days) to the actual date of -the last rotation. The service chooses the hour within that 24-hour date window randomly. -The minute is also chosen somewhat randomly, but weighted towards the top of the hour and -influenced by a variety of factors that help distribute load. The rotation function must -end with the versions of the secret in one of two states: The AWSPENDING and AWSCURRENT -staging labels are attached to the same version of the secret, or The AWSPENDING staging -label is not attached to any version of the secret. If the AWSPENDING staging label is -present but not attached to the same version as AWSCURRENT then any later invocation of -RotateSecret assumes that a previous rotation request is still in progress and returns an -error. Minimum permissions To run this command, you must have the following permissions: - secretsmanager:RotateSecret lambda:InvokeFunction (on the function specified in the -secret's metadata) Related operations To list the secrets in your account, use -ListSecrets. To get the details for a version of a secret, use DescribeSecret. To -create a new version of a secret, use CreateSecret. To attach staging labels to or remove -staging labels from a version of a secret, use UpdateSecretVersionStage. +Configures and starts the asynchronous process of rotating the secret. If you include the +configuration parameters, the operation sets the values for the secret and then immediately +starts a rotation. If you don't include the configuration parameters, the operation starts +a rotation with the values already stored in the secret. For more information about +rotation, see Rotate secrets. To configure rotation, you include the ARN of an Amazon Web +Services Lambda function and the schedule for the rotation. The Lambda rotation function +creates a new version of the secret and creates or updates the credentials on the database +or service to match. After testing the new credentials, the function marks the new secret +version with the staging label AWSCURRENT. Then anyone who retrieves the secret gets the +new version. For more information, see How rotation works. When rotation is successful, the +AWSPENDING staging label might be attached to the same version as the AWSCURRENT version, +or it might not be attached to any version. If the AWSPENDING staging label is present but +not attached to the same version as AWSCURRENT, then any later invocation of RotateSecret +assumes that a previous rotation request is still in progress and returns an error. To run +this command, you must have secretsmanager:RotateSecret permissions and +lambda:InvokeFunction permissions on the function specified in the secret's metadata. # Arguments -- `secret_id`: Specifies the secret that you want to rotate. You can specify either the - Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend - that you specify a complete ARN rather than a partial ARN. +- `secret_id`: The ARN or name of the secret to rotate. For an ARN, we recommend that you + specify a complete ARN rather than a partial ARN. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"ClientRequestToken"`: (Optional) Specifies a unique identifier for the new version of - the secret that helps ensure idempotency. If you use the Amazon Web Services CLI or one of - the Amazon Web Services SDK to call this operation, then you can leave this parameter - empty. The CLI or SDK generates a random UUID for you and includes that in the request for - this parameter. If you don't use the SDK and instead generate a raw HTTP request to the - Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for - new versions and include that value in the request. You only need to specify your own value - if you implement your own retry logic and want to ensure that a given secret is not created - twice. We recommend that you generate a UUID-type value to ensure uniqueness within the - specified secret. Secrets Manager uses this value to prevent the accidental creation of - duplicate versions if there are failures and retries during the function's processing. This - value becomes the VersionId of the new version. -- `"RotationLambdaARN"`: (Optional) Specifies the ARN of the Lambda function that can - rotate the secret. +- `"ClientRequestToken"`: A unique identifier for the new version of the secret that helps + ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of + duplicate versions if there are failures and retries during rotation. This value becomes + the VersionId of the new version. If you use the Amazon Web Services CLI or one of the + Amazon Web Services SDK to call this operation, then you can leave this parameter empty. + The CLI or SDK generates a random UUID for you and includes that in the request for this + parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets + Manager service endpoint, then you must generate a ClientRequestToken yourself for new + versions and include that value in the request. You only need to specify this value if you + implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt + to create a secret version twice. We recommend that you generate a UUID-type value to + ensure uniqueness within the specified secret. +- `"RotationLambdaARN"`: The ARN of the Lambda rotation function that can rotate the secret. - `"RotationRules"`: A structure that defines the rotation configuration for this secret. """ function rotate_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config()) @@ -1037,11 +858,12 @@ end stop_replication_to_replica(secret_id) stop_replication_to_replica(secret_id, params::Dict{String,<:Any}) -Removes the secret from replication and promotes the secret to a regional secret in the -replica Region. +Removes the link between the replica secret and the primary secret and promotes the replica +to a primary secret in the replica Region. You must call this operation from the Region in +which you want to promote the replica to a primary secret. # Arguments -- `secret_id`: Response to StopReplicationToReplica of a secret, based on the SecretId. +- `secret_id`: The ARN of the primary secret. """ function stop_replication_to_replica( @@ -1073,35 +895,31 @@ end tag_resource(secret_id, tags) tag_resource(secret_id, tags, params::Dict{String,<:Any}) -Attaches one or more tags, each consisting of a key name and a value, to the specified -secret. Tags are part of the secret's overall metadata, and are not associated with any -specific version of the secret. This operation only appends tags to the existing list of -tags. To remove tags, you must use UntagResource. The following basic restrictions apply to -tags: Maximum number of tags per secret—50 Maximum key length—127 Unicode -characters in UTF-8 Maximum value length—255 Unicode characters in UTF-8 Tag keys and -values are case sensitive. Do not use the aws: prefix in your tag names or values because -Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag -names or values with this prefix. Tags with this prefix do not count against your tags per -secret limit. If you use your tagging schema across multiple services and resources, -remember other services might have restrictions on allowed characters. Generally allowed -characters: letters, spaces, and numbers representable in UTF-8, plus the following special -characters: + - = . _ : / @. If you use tags as part of your security strategy, then -adding or removing a tag can change permissions. If successfully completing this operation -would result in you losing your permissions for this secret, then the operation is blocked -and returns an Access Denied error. Minimum permissions To run this command, you must -have the following permissions: secretsmanager:TagResource Related operations To -remove one or more tags from the collection attached to a secret, use UntagResource. To -view the list of tags attached to a secret, use DescribeSecret. +Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the +secret's metadata. They are not associated with specific versions of the secret. This +operation appends tags to the existing list of tags. The following restrictions apply to +tags: Maximum number of tags per secret: 50 Maximum key length: 127 Unicode characters +in UTF-8 Maximum value length: 255 Unicode characters in UTF-8 Tag keys and values are +case sensitive. Do not use the aws: prefix in your tag names or values because Amazon Web +Services reserves it for Amazon Web Services use. You can't edit or delete tag names or +values with this prefix. Tags with this prefix do not count against your tags per secret +limit. If you use your tagging schema across multiple services and resources, other +services might have restrictions on allowed characters. Generally allowed characters: +letters, spaces, and numbers representable in UTF-8, plus the following special characters: ++ - = . _ : / @. If you use tags as part of your security strategy, then adding or +removing a tag can change permissions. If successfully completing this operation would +result in you losing your permissions for this secret, then the operation is blocked and +returns an Access Denied error. # Arguments -- `secret_id`: The identifier for the secret that you want to attach tags to. You can - specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an - ARN, we recommend that you specify a complete ARN rather than a partial ARN. -- `tags`: The tags to attach to the secret. Each element in the list consists of a Key and - a Value. This parameter to the API requires a JSON text string argument. For storing - multiple values, we recommend that you use a JSON text string argument and specify - key/value pairs. For more information, see Specifying parameter values for the Amazon Web - Services CLI in the Amazon Web Services CLI User Guide. +- `secret_id`: The identifier for the secret to attach tags to. You can specify either the + Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend + that you specify a complete ARN rather than a partial ARN. +- `tags`: The tags to attach to the secret as a JSON text string argument. Each element in + the list consists of a Key and a Value. For storing multiple values, we recommend that you + use a JSON text string argument and specify key/value pairs. For more information, see + Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI + User Guide. """ function tag_resource(SecretId, Tags; aws_config::AbstractAWSConfig=global_aws_config()) @@ -1134,26 +952,20 @@ end untag_resource(secret_id, tag_keys) untag_resource(secret_id, tag_keys, params::Dict{String,<:Any}) -Removes one or more tags from the specified secret. This operation is idempotent. If a -requested tag is not attached to the secret, no error is returned and the secret metadata -is unchanged. If you use tags as part of your security strategy, then removing a tag can -change permissions. If successfully completing this operation would result in you losing -your permissions for this secret, then the operation is blocked and returns an Access -Denied error. Minimum permissions To run this command, you must have the following -permissions: secretsmanager:UntagResource Related operations To add one or more -tags to the collection attached to a secret, use TagResource. To view the list of tags -attached to a secret, use DescribeSecret. +Removes specific tags from a secret. This operation is idempotent. If a requested tag is +not attached to the secret, no error is returned and the secret metadata is unchanged. If +you use tags as part of your security strategy, then removing a tag can change permissions. +If successfully completing this operation would result in you losing your permissions for +this secret, then the operation is blocked and returns an Access Denied error. # Arguments -- `secret_id`: The identifier for the secret that you want to remove tags from. You can - specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an - ARN, we recommend that you specify a complete ARN rather than a partial ARN. +- `secret_id`: The ARN or name of the secret. For an ARN, we recommend that you specify a + complete ARN rather than a partial ARN. - `tag_keys`: A list of tag key names to remove from the secret. You don't specify the - value. Both the key and its associated value are removed. This parameter to the API - requires a JSON text string argument. For storing multiple values, we recommend that you - use a JSON text string argument and specify key/value pairs. For more information, see - Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI - User Guide. + value. Both the key and its associated value are removed. This parameter requires a JSON + text string argument. For storing multiple values, we recommend that you use a JSON text + string argument and specify key/value pairs. For more information, see Specifying parameter + values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. """ function untag_resource( @@ -1190,102 +1002,61 @@ end update_secret(secret_id) update_secret(secret_id, params::Dict{String,<:Any}) -Modifies many of the details of the specified secret. To change the secret value, you can -also use PutSecretValue. To change the rotation configuration of a secret, use RotateSecret -instead. We recommend you avoid calling UpdateSecret at a sustained rate of more than once -every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager -creates a new version of the secret. Secrets Manager removes outdated versions when there -are more than 100, but it does not remove versions created less than 24 hours ago. If you -update the secret value more than once every 10 minutes, you create more versions than -Secrets Manager removes, and you will reach the quota for secret versions. The Secrets -Manager console uses only the SecretString parameter and therefore limits you to encrypting -and storing only a text string. To encrypt and store binary data as part of the version of -a secret, you must use either the Amazon Web Services CLI or one of the Amazon Web Services -SDKs. If a version with a VersionId with the same value as the ClientRequestToken -parameter already exists, the operation results in an error. You cannot modify an existing -version, you can only create a new version. If you include SecretString or SecretBinary -to create a new secret version, Secrets Manager automatically attaches the staging label -AWSCURRENT to the new version. If you call an operation to encrypt or decrypt the -SecretString or SecretBinary for a secret in the same account as the calling user and that -secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the -account's default Amazon Web Services managed customer master key (CMK) with the alias -aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager -creates it for you automatically. All users and roles in the same Amazon Web Services -account automatically have access to use the default CMK. Note that if an Secrets Manager -API call results in Amazon Web Services creating the account's Amazon Web Services-managed -CMK, it can result in a one-time significant delay in returning the result. If the secret -resides in a different Amazon Web Services account from the credentials calling an API that -requires encryption or decryption of the secret value then you must create and use a custom -Amazon Web Services KMS CMK because you can't access the default CMK for the account using -credentials from a different Amazon Web Services account. Store the ARN of the CMK in the -secret when you create the secret or when you update it by including it in the KMSKeyId. If -you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials -from a different account then the Amazon Web Services KMS key policy must grant -cross-account access to that other account's user or role for both the kms:GenerateDataKey -and kms:Decrypt operations. Minimum permissions To run this command, you must have the -following permissions: secretsmanager:UpdateSecret kms:GenerateDataKey - needed only if -you use a custom Amazon Web Services KMS key to encrypt the secret. You do not need this -permission to use the account's Amazon Web Services managed CMK for Secrets Manager. -kms:Decrypt - needed only if you use a custom Amazon Web Services KMS key to encrypt the -secret. You do not need this permission to use the account's Amazon Web Services managed -CMK for Secrets Manager. Related operations To create a new secret, use CreateSecret. - To add only a new version to an existing secret, use PutSecretValue. To get the details -for a secret, use DescribeSecret. To list the versions contained in a secret, use -ListSecretVersionIds. +Modifies the details of a secret, including metadata and the secret value. To change the +secret value, you can also use PutSecretValue. To change the rotation configuration of a +secret, use RotateSecret instead. We recommend you avoid calling UpdateSecret at a +sustained rate of more than once every 10 minutes. When you call UpdateSecret to update the +secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes +outdated versions when there are more than 100, but it does not remove versions created +less than 24 hours ago. If you update the secret value more than once every 10 minutes, you +create more versions than Secrets Manager removes, and you will reach the quota for secret +versions. If you include SecretString or SecretBinary to create a new secret version, +Secrets Manager automatically attaches the staging label AWSCURRENT to the new version. If +you call this operation with a VersionId that matches an existing version's +ClientRequestToken, the operation results in an error. You can't modify an existing +version, you can only create a new version. To remove a version, remove all staging labels +from it. See UpdateSecretVersionStage. If you don't specify an KMS encryption key, Secrets +Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn't +already exist in your account, then Secrets Manager creates it for you automatically. All +users and roles in the Amazon Web Services account automatically have access to use +aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay +in returning the result. If the secret is in a different Amazon Web Services account from +the credentials calling the API, then you can't use aws/secretsmanager to encrypt the +secret, and you must create and use a customer managed key. To run this command, you must +have secretsmanager:UpdateSecret permissions. If you use a customer managed key, you must +also have kms:GenerateDataKey and kms:Decrypt permissions . # Arguments -- `secret_id`: Specifies the secret that you want to modify or to which you want to add a - new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of - the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial - ARN. +- `secret_id`: The ARN or name of the secret. For an ARN, we recommend that you specify a + complete ARN rather than a partial ARN. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"ClientRequestToken"`: (Optional) If you want to add a new version to the secret, this - parameter specifies a unique identifier for the new version that helps ensure idempotency. - If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this - operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID - for you and includes that in the request. If you don't use the SDK and instead generate a - raw HTTP request to the Secrets Manager service endpoint, then you must generate a - ClientRequestToken yourself for new versions and include that value in the request. You - typically only need to interact with this value if you implement your own retry logic and - want to ensure that a given secret is not created twice. We recommend that you generate a - UUID-type value to ensure uniqueness within the specified secret. Secrets Manager uses - this value to prevent the accidental creation of duplicate versions if there are failures - and retries during the Lambda rotation function's processing. If the ClientRequestToken - value isn't already associated with a version of the secret then a new version of the - secret is created. If a version with this value already exists and that version's - SecretString and SecretBinary values are the same as those in the request then the request - is ignored (the operation is idempotent). If a version with this value already exists - and that version's SecretString and SecretBinary values are different from the request then - an error occurs because you cannot modify an existing secret value. This value becomes - the VersionId of the new version. -- `"Description"`: (Optional) Specifies an updated user-provided description of the secret. -- `"KmsKeyId"`: (Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS - customer master key (CMK) that Secrets Manager uses to encrypt the protected text in new - versions of this secret as well as any existing versions of this secret that have the - staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging - labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide. You can - only use the account's default CMK to encrypt and decrypt if you call this operation using - credentials from the same account that owns the secret. If the secret is in a different - account, then you must create a custom CMK and provide the ARN of that CMK in this field. - The user making the call must have permissions to both the secret and the CMK in their - respective accounts. -- `"SecretBinary"`: (Optional) Specifies updated binary data that you want to encrypt and - store in the new version of the secret. To use this parameter in the command-line tools, we - recommend that you store your binary data in a file and then use the appropriate technique - for your tool to pass the contents of the file as a parameter. Either SecretBinary or - SecretString must have a value, but not both. They cannot both be empty. This parameter is - not accessible using the Secrets Manager console. -- `"SecretString"`: (Optional) Specifies updated text data that you want to encrypt and - store in this new version of the secret. Either SecretBinary or SecretString must have a - value, but not both. They cannot both be empty. If you create this secret by using the - Secrets Manager console then Secrets Manager puts the protected secret text in only the - SecretString parameter. The Secrets Manager console stores the information as a JSON - structure of key/value pairs that the default Lambda rotation function knows how to parse. - For storing multiple values, we recommend that you use a JSON text string argument and - specify key/value pairs. For more information, see Specifying parameter values for the - Amazon Web Services CLI in the Amazon Web Services CLI User Guide. +- `"ClientRequestToken"`: If you include SecretString or SecretBinary, then Secrets Manager + creates a new version for the secret, and this parameter specifies the unique identifier + for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web + Services SDKs to call this operation, then you can leave this parameter empty. The CLI or + SDK generates a random UUID for you and includes it as the value for this parameter in the + request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets + Manager service endpoint, then you must generate a ClientRequestToken yourself for the new + version and include the value in the request. This value becomes the VersionId of the new + version. +- `"Description"`: The description of the secret. +- `"KmsKeyId"`: The ARN, key ID, or alias of the KMS key that Secrets Manager uses to + encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT, + AWSPENDING, or AWSPREVIOUS. For more information about versions and staging labels, see + Concepts: Version. You can only use the Amazon Web Services managed key aws/secretsmanager + if you call this operation using credentials from the same Amazon Web Services account that + owns the secret. If the secret is in a different account, then you must use a customer + managed key and provide the ARN of that KMS key in this field. The user making the call + must have permissions to both the secret and the KMS key in their respective accounts. +- `"SecretBinary"`: The binary data to encrypt and store in the new version of the secret. + We recommend that you store your binary data in a file and then pass the contents of the + file as a parameter. Either SecretBinary or SecretString must have a value, but not both. + You can't access this parameter in the Secrets Manager console. +- `"SecretString"`: The text data to encrypt and store in the new version of the secret. We + recommend you use a JSON structure of key/value pairs for your secret value. Either + SecretBinary or SecretString must have a value, but not both. """ function update_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config()) return secrets_manager( @@ -1320,42 +1091,35 @@ end update_secret_version_stage(secret_id, version_stage) update_secret_version_stage(secret_id, version_stage, params::Dict{String,<:Any}) -Modifies the staging labels attached to a version of a secret. Staging labels are used to -track a version as it progresses through the secret rotation process. You can attach a -staging label to only one version of a secret at a time. If a staging label to be added is -already attached to another version, then it is moved--removed from the other version first -and then attached to this one. For more information about staging labels, see Staging -Labels in the Amazon Web Services Secrets Manager User Guide. The staging labels that you -specify in the VersionStage parameter are added to the existing list of staging -labels--they don't replace it. You can move the AWSCURRENT staging label to this version by -including it in this call. Whenever you move AWSCURRENT, Secrets Manager automatically -moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from. If this -action results in the last label being removed from a version, then the version is -considered to be 'deprecated' and can be deleted by Secrets Manager. Minimum permissions -To run this command, you must have the following permissions: -secretsmanager:UpdateSecretVersionStage Related operations To get the list of staging -labels that are currently associated with a version of a secret, use DescribeSecret and -examine the SecretVersionsToStages response value. +Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging +labels to track a version as it progresses through the secret rotation process. Each +staging label can be attached to only one version at a time. To add a staging label to a +version when it is already attached to another version, Secrets Manager first removes it +from the other version first and then attaches it to this one. For more information about +versions and staging labels, see Concepts: Version. The staging labels that you specify in +the VersionStage parameter are added to the existing list of staging labels for the +version. You can move the AWSCURRENT staging label to this version by including it in this +call. Whenever you move AWSCURRENT, Secrets Manager automatically moves the label +AWSPREVIOUS to the version that AWSCURRENT was removed from. If this action results in the +last label being removed from a version, then the version is considered to be 'deprecated' +and can be deleted by Secrets Manager. # Arguments -- `secret_id`: Specifies the secret with the version with the list of staging labels you - want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name - of the secret. For an ARN, we recommend that you specify a complete ARN rather than a - partial ARN. +- `secret_id`: The ARN or the name of the secret with the version and staging labelsto + modify. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. - `version_stage`: The staging label to add to this version. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"MoveToVersionId"`: (Optional) The secret version ID that you want to add the staging - label. If you want to remove a label from a version, then do not specify this parameter. If - the staging label is already attached to a different version of the secret, then you must - also specify the RemoveFromVersionId parameter. -- `"RemoveFromVersionId"`: Specifies the secret version ID of the version that the staging - label is to be removed from. If the staging label you are trying to attach to one version - is already attached to a different version, then you must include this parameter and - specify the version that the label is to be removed from. If the label is attached and you - either do not specify this parameter, or the version ID does not match, then the operation - fails. +- `"MoveToVersionId"`: The ID of the version to add the staging label to. To remove a label + from a version, then do not specify this parameter. If the staging label is already + attached to a different version of the secret, then you must also specify the + RemoveFromVersionId parameter. +- `"RemoveFromVersionId"`: The ID of the version that the staging label is to be removed + from. If the staging label you are trying to attach to one version is already attached to a + different version, then you must include this parameter and specify the version that the + label is to be removed from. If the label is attached and you either do not specify this + parameter, or the version ID does not match, then the operation fails. """ function update_secret_version_stage( SecretId, VersionStage; aws_config::AbstractAWSConfig=global_aws_config() @@ -1391,29 +1155,21 @@ end validate_resource_policy(resource_policy) validate_resource_policy(resource_policy, params::Dict{String,<:Any}) -Validates that the resource policy does not grant a wide range of IAM principals access to -your secret. The JSON request string input and response output displays formatted code with -white space and line breaks for better readability. Submit your input as a single line JSON -string. A resource-based policy is optional for secrets. The API performs three checks when -validating the secret: Sends a call to Zelkova, an automated reasoning engine, to ensure -your Resource Policy does not allow broad access to your secret. Checks for correct -syntax in a policy. Verifies the policy does not lock out a caller. Minimum -Permissions You must have the permissions required to access the following APIs: -secretsmanager:PutResourcePolicy secretsmanager:ValidateResourcePolicy +Validates that a resource policy does not grant a wide range of principals access to your +secret. A resource-based policy is optional for secrets. The API performs three checks when +validating the policy: Sends a call to Zelkova, an automated reasoning engine, to ensure +your resource policy does not allow broad access to your secret, for example policies that +use a wildcard for the principal. Checks for correct syntax in a policy. Verifies the +policy does not lock out a caller. # Arguments -- `resource_policy`: A JSON-formatted string constructed according to the grammar and - syntax for an Amazon Web Services resource-based policy. The policy in the string - identifies who can access or manage this secret and its versions. For information on how to - format a JSON parameter for the various command line tool environments, see Using JSON for - Parameters in the CLI User Guide.publi +- `resource_policy`: A JSON-formatted string that contains an Amazon Web Services + resource-based policy. The policy in the string identifies who can access or manage this + secret and its versions. For example policies, see Permissions policy examples. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"SecretId"`: (Optional) The identifier of the secret with the resource-based policy you - want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly - name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a - partial ARN. +- `"SecretId"`: This field is reserved for internal use. """ function validate_resource_policy( ResourcePolicy; aws_config::AbstractAWSConfig=global_aws_config() diff --git a/src/services/securityhub.jl b/src/services/securityhub.jl index 1629d8a2f1..85d5fc0885 100644 --- a/src/services/securityhub.jl +++ b/src/services/securityhub.jl @@ -203,15 +203,19 @@ end batch_import_findings(findings) batch_import_findings(findings, params::Dict{String,<:Any}) -Imports security findings generated from an integrated product into Security Hub. This -action is requested by the integrated product to import its findings into Security Hub. The -maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger -than 240 Kb. After a finding is created, BatchImportFindings cannot be used to update the -following finding fields and objects, which Security Hub customers use to manage their -investigation workflow. Note UserDefinedFields VerificationState Workflow -Finding providers also should not use BatchImportFindings to update the following -attributes. Confidence Criticality RelatedFindings Severity Types -Instead, finding providers use FindingProviderFields to provide values for these attributes. +Imports security findings generated by a finding provider into Security Hub. This action is +requested by the finding provider to import its findings into Security Hub. +BatchImportFindings must be called by one of the following: The account that is +associated with the findings. The identifier of the associated account is the value of the +AwsAccountId attribute for the finding. An account that is allow-listed for an official +Security Hub partner integration. The maximum allowed size for a finding is 240 Kb. An +error is returned for any finding larger than 240 Kb. After a finding is created, +BatchImportFindings cannot be used to update the following finding fields and objects, +which Security Hub customers use to manage their investigation workflow. Note +UserDefinedFields VerificationState Workflow Finding providers also should not +use BatchImportFindings to update the following attributes. Confidence Criticality + RelatedFindings Severity Types Instead, finding providers use +FindingProviderFields to provide values for these attributes. # Arguments - `findings`: A list of findings to import. To successfully import a finding, it must diff --git a/src/services/sms.jl b/src/services/sms.jl index 5f6f0760f4..d3ee0e4360 100644 --- a/src/services/sms.jl +++ b/src/services/sms.jl @@ -17,8 +17,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys idempotency of application creation. - `"description"`: The description of the new application - `"name"`: The name of the new application. -- `"roleName"`: The name of the service role in the customer's account to be used by AWS - SMS. +- `"roleName"`: The name of the service role in the customer's account to be used by Server + Migration Service. - `"serverGroups"`: The server groups to include in the application. - `"tags"`: The tags to be associated with the application. """ @@ -36,7 +36,8 @@ end create_replication_job(seed_replication_time, server_id, params::Dict{String,<:Any}) Creates a replication job. The replication job schedules periodic replication runs to -replicate your server to AWS. Each replication run creates an Amazon Machine Image (AMI). +replicate your server to Amazon Web Services. Each replication run creates an Amazon +Machine Image (AMI). # Arguments - `seed_replication_time`: The seed replication time. @@ -55,7 +56,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys replication run. - `"numberOfRecentAmisToKeep"`: The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created. -- `"roleName"`: The name of the IAM role to be used by the AWS SMS. +- `"roleName"`: The name of the IAM role to be used by the Server Migration Service. - `"runOnce"`: Indicates whether to run the replication job one time. """ function create_replication_job( @@ -97,7 +98,8 @@ end delete_app(params::Dict{String,<:Any}) Deletes the specified application. Optionally deletes the launched stack associated with -the application and all AWS SMS replication jobs for servers in the application. +the application and all Server Migration Service replication jobs for servers in the +application. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -212,8 +214,9 @@ end delete_replication_job(replication_job_id, params::Dict{String,<:Any}) Deletes the specified replication job. After you delete a replication job, there are no -further replication runs. AWS deletes the contents of the Amazon S3 bucket used to store -AWS SMS artifacts. The AMIs created by the replication runs are not deleted. +further replication runs. Amazon Web Services deletes the contents of the Amazon S3 bucket +used to store Server Migration Service artifacts. The AMIs created by the replication runs +are not deleted. # Arguments - `replication_job_id`: The ID of the replication job. @@ -273,8 +276,8 @@ end disassociate_connector(connector_id) disassociate_connector(connector_id, params::Dict{String,<:Any}) -Disassociates the specified connector from AWS SMS. After you disassociate a connector, it -is no longer available to support replication jobs. +Disassociates the specified connector from Server Migration Service. After you disassociate +a connector, it is no longer available to support replication jobs. # Arguments - `connector_id`: The ID of the connector. @@ -332,13 +335,13 @@ end generate_template() generate_template(params::Dict{String,<:Any}) -Generates an AWS CloudFormation template based on the current launch configuration and -writes it to an Amazon S3 object in the customer’s Amazon S3 bucket. +Generates an CloudFormation template based on the current launch configuration and writes +it to an Amazon S3 object in the customer’s Amazon S3 bucket. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"appId"`: The ID of the application associated with the AWS CloudFormation template. -- `"templateFormat"`: The format for generating the AWS CloudFormation template. +- `"appId"`: The ID of the application associated with the CloudFormation template. +- `"templateFormat"`: The format for generating the CloudFormation template. """ function generate_template(; aws_config::AbstractAWSConfig=global_aws_config()) return sms("GenerateTemplate"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET) @@ -491,7 +494,7 @@ end get_connectors() get_connectors(params::Dict{String,<:Any}) -Describes the connectors registered with the AWS SMS. +Describes the connectors registered with the Server Migration Service. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -607,13 +610,13 @@ end import_app_catalog() import_app_catalog(params::Dict{String,<:Any}) -Allows application import from AWS Migration Hub. +Allows application import from Migration Hub. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"roleName"`: The name of the service role. If you omit this parameter, we create a - service-linked role for AWS Migration Hub in your account. Otherwise, the role that you - provide must have the policy and trust policy described in the AWS Migration Hub User Guide. + service-linked role for Migration Hub in your account. Otherwise, the role that you provide + must have the policy and trust policy described in the Migration Hub User Guide. """ function import_app_catalog(; aws_config::AbstractAWSConfig=global_aws_config()) return sms("ImportAppCatalog"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET) @@ -655,7 +658,7 @@ end launch_app() launch_app(params::Dict{String,<:Any}) -Launches the specified application as a stack in AWS CloudFormation. +Launches the specified application as a stack in CloudFormation. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -697,7 +700,8 @@ end notify_app_validation_output(app_id) notify_app_validation_output(app_id, params::Dict{String,<:Any}) -Provides information to AWS SMS about whether application validation is successful. +Provides information to Server Migration Service about whether application validation is +successful. # Arguments - `app_id`: The ID of the application. @@ -738,8 +742,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"appId"`: The ID of the application. - `"autoLaunch"`: Indicates whether the application is configured to launch automatically after replication is complete. -- `"roleName"`: The name of service role in the customer's account that AWS CloudFormation - uses to launch the application. +- `"roleName"`: The name of service role in the customer's account that CloudFormation uses + to launch the application. - `"serverGroupLaunchConfigurations"`: Information about the launch configurations for server groups in the application. """ @@ -984,7 +988,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"appId"`: The ID of the application. - `"description"`: The new description of the application. - `"name"`: The new name of the application. -- `"roleName"`: The name of the service role in the customer's account used by AWS SMS. +- `"roleName"`: The name of the service role in the customer's account used by Server + Migration Service. - `"serverGroups"`: The server groups in the application to update. - `"tags"`: The tags to associate with the application. """ @@ -1021,7 +1026,7 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"nextReplicationRunStartTime"`: The start time of the next replication run. - `"numberOfRecentAmisToKeep"`: The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created. -- `"roleName"`: The name of the IAM role to be used by AWS SMS. +- `"roleName"`: The name of the IAM role to be used by Server Migration Service. """ function update_replication_job( replicationJobId; aws_config::AbstractAWSConfig=global_aws_config() diff --git a/src/services/support.jl b/src/services/support.jl index 83aeecad45..a6c26e7074 100644 --- a/src/services/support.jl +++ b/src/services/support.jl @@ -11,10 +11,11 @@ using AWS.UUIDs Adds one or more attachments to an attachment set. An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime returned in the response is when -the set expires. You must have a Business or Enterprise Support plan to use the AWS -Support API. If you call the AWS Support API from an account that does not have a -Business or Enterprise Support plan, the SubscriptionRequiredException error message -appears. For information about changing your support plan, see AWS Support. +the set expires. You must have a Business, Enterprise On-Ramp, or Enterprise Support +plan to use the Amazon Web Services Support API. If you call the Amazon Web Services +Support API from an account that does not have a Business, Enterprise On-Ramp, or +Enterprise Support plan, the SubscriptionRequiredException error message appears. For +information about changing your support plan, see Amazon Web Services Support. # Arguments - `attachments`: One or more attachments to add to the set. You can add up to three @@ -59,13 +60,15 @@ end add_communication_to_case(communication_body) add_communication_to_case(communication_body, params::Dict{String,<:Any}) -Adds additional customer communication to an AWS Support case. Use the caseId parameter to -identify the case to which to add communication. You can list a set of email addresses to -copy on the communication by using the ccEmailAddresses parameter. The communicationBody -value contains the text of the communication. You must have a Business or Enterprise -Support plan to use the AWS Support API. If you call the AWS Support API from an account -that does not have a Business or Enterprise Support plan, the SubscriptionRequiredException -error message appears. For information about changing your support plan, see AWS Support. +Adds additional customer communication to an Amazon Web Services Support case. Use the +caseId parameter to identify the case to which to add communication. You can list a set of +email addresses to copy on the communication by using the ccEmailAddresses parameter. The +communicationBody value contains the text of the communication. You must have a +Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services +Support API. If you call the Amazon Web Services Support API from an account that does +not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +SubscriptionRequiredException error message appears. For information about changing your +support plan, see Amazon Web Services Support. # Arguments - `communication_body`: The body of an email communication to add to the support case. @@ -111,49 +114,53 @@ end create_case(communication_body, subject) create_case(communication_body, subject, params::Dict{String,<:Any}) -Creates a case in the AWS Support Center. This operation is similar to how you create a -case in the AWS Support Center Create Case page. The AWS Support API doesn't support -requesting service limit increases. You can submit a service limit increase in the -following ways: Submit a request from the AWS Support Center Create Case page. Use the -Service Quotas RequestServiceQuotaIncrease operation. A successful CreateCase request -returns an AWS Support case number. You can use the DescribeCases operation and specify the -case number to get existing AWS Support cases. After you create a case, use the -AddCommunicationToCase operation to add additional communication or attachments to an -existing case. The caseId is separate from the displayId that appears in the AWS Support -Center. Use the DescribeCases operation to get the displayId. You must have a Business -or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API -from an account that does not have a Business or Enterprise Support plan, the +Creates a case in the Amazon Web Services Support Center. This operation is similar to how +you create a case in the Amazon Web Services Support Center Create Case page. The Amazon +Web Services Support API doesn't support requesting service limit increases. You can submit +a service limit increase in the following ways: Submit a request from the Amazon Web +Services Support Center Create Case page. Use the Service Quotas +RequestServiceQuotaIncrease operation. A successful CreateCase request returns an Amazon +Web Services Support case number. You can use the DescribeCases operation and specify the +case number to get existing Amazon Web Services Support cases. After you create a case, use +the AddCommunicationToCase operation to add additional communication or attachments to an +existing case. The caseId is separate from the displayId that appears in the Amazon Web +Services Support Center. Use the DescribeCases operation to get the displayId. You must +have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web +Services Support API. If you call the Amazon Web Services Support API from an account +that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your -support plan, see AWS Support. +support plan, see Amazon Web Services Support. # Arguments - `communication_body`: The communication body text that describes the issue. This text - appears in the Description field on the AWS Support Center Create Case page. + appears in the Description field on the Amazon Web Services Support Center Create Case page. - `subject`: The title of the support case. The title appears in the Subject field on the - AWS Support Center Create Case page. + Amazon Web Services Support Center Create Case page. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: - `"attachmentSetId"`: The ID of a set of one or more attachments for the case. Create the set by using the AddAttachmentsToSet operation. - `"categoryCode"`: The category of problem for the support case. You also use the - DescribeServices operation to get the category code for a service. Each AWS service defines - its own set of category codes. -- `"ccEmailAddresses"`: A list of email addresses that AWS Support copies on case - correspondence. AWS Support identifies the account that creates the case when you specify - your AWS credentials in an HTTP POST method or use the AWS SDKs. + DescribeServices operation to get the category code for a service. Each Amazon Web Services + service defines its own set of category codes. +- `"ccEmailAddresses"`: A list of email addresses that Amazon Web Services Support copies + on case correspondence. Amazon Web Services Support identifies the account that creates the + case when you specify your Amazon Web Services credentials in an HTTP POST method or use + the Amazon Web Services SDKs. - `"issueType"`: The type of issue for the case. You can specify customer-service or technical. If you don't specify a value, the default is technical. -- `"language"`: The language in which AWS Support handles the case. You must specify the - ISO 639-1 code for the language parameter if you want support in that language. Currently, - English (\"en\") and Japanese (\"ja\") are supported. -- `"serviceCode"`: The code for the AWS service. You can use the DescribeServices operation - to get the possible serviceCode values. +- `"language"`: The language in which Amazon Web Services Support handles the case. You + must specify the ISO 639-1 code for the language parameter if you want support in that + language. Currently, English (\"en\") and Japanese (\"ja\") are supported. +- `"serviceCode"`: The code for the Amazon Web Services service. You can use the + DescribeServices operation to get the possible serviceCode values. - `"severityCode"`: A value that indicates the urgency of the case. This value determines - the response time according to your service level agreement with AWS Support. You can use - the DescribeSeverityLevels operation to get the possible values for severityCode. For more - information, see SeverityLevel and Choosing a Severity in the AWS Support User Guide. The - availability of severity levels depends on the support plan for the AWS account. + the response time according to your service level agreement with Amazon Web Services + Support. You can use the DescribeSeverityLevels operation to get the possible values for + severityCode. For more information, see SeverityLevel and Choosing a Severity in the + Amazon Web Services Support User Guide. The availability of severity levels depends on the + support plan for the Amazon Web Services account. """ function create_case( communicationBody, subject; aws_config::AbstractAWSConfig=global_aws_config() @@ -195,10 +202,12 @@ Returns the attachment that has the specified ID. Attachments can include screen error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the -DescribeCommunications operation. You must have a Business or Enterprise Support plan to -use the AWS Support API. If you call the AWS Support API from an account that does not -have a Business or Enterprise Support plan, the SubscriptionRequiredException error message -appears. For information about changing your support plan, see AWS Support. +DescribeCommunications operation. You must have a Business, Enterprise On-Ramp, or +Enterprise Support plan to use the Amazon Web Services Support API. If you call the +Amazon Web Services Support API from an account that does not have a Business, Enterprise +On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message +appears. For information about changing your support plan, see Amazon Web Services Support. + # Arguments - `attachment_id`: The ID of the attachment to return. Attachment IDs are returned by the @@ -241,10 +250,11 @@ to return. The response returns the following in JSON format: One or more Case data types. One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects. Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an -error. You must have a Business or Enterprise Support plan to use the AWS Support API. - If you call the AWS Support API from an account that does not have a Business or -Enterprise Support plan, the SubscriptionRequiredException error message appears. For -information about changing your support plan, see AWS Support. +error. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use +the Amazon Web Services Support API. If you call the Amazon Web Services Support API +from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support +plan, the SubscriptionRequiredException error message appears. For information about +changing your support plan, see Amazon Web Services Support. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: @@ -254,14 +264,15 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys Case communications are available for 12 months after creation. - `"caseIdList"`: A list of ID numbers of the support cases you want returned. The maximum number of cases is 100. -- `"displayId"`: The ID displayed for a case in the AWS Support Center user interface. +- `"displayId"`: The ID displayed for a case in the Amazon Web Services Support Center user + interface. - `"includeCommunications"`: Specifies whether to include communications in the DescribeCases response. By default, communications are included. - `"includeResolvedCases"`: Specifies whether to include resolved support cases in the DescribeCases response. By default, resolved cases aren't included. -- `"language"`: The ISO 639-1 code for the language in which AWS provides support. AWS - Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must - be passed explicitly for operations that take them. +- `"language"`: The ISO 639-1 code for the language in which Amazon Web Services provides + support. Amazon Web Services Support currently supports English (\"en\") and Japanese + (\"ja\"). Language parameters must be passed explicitly for operations that take them. - `"maxResults"`: The maximum number of results to return before paginating. - `"nextToken"`: A resumption point for pagination. """ @@ -286,10 +297,12 @@ results to a specific case. Case data is available for 12 months after creation. was created more than 12 months ago, a request for data might cause an error. You can use the maxResults and nextToken parameters to control the pagination of the results. Set maxResults to the number of cases that you want to display on each page, and use nextToken -to specify the resumption of pagination. You must have a Business or Enterprise Support -plan to use the AWS Support API. If you call the AWS Support API from an account that -does not have a Business or Enterprise Support plan, the SubscriptionRequiredException -error message appears. For information about changing your support plan, see AWS Support. +to specify the resumption of pagination. You must have a Business, Enterprise On-Ramp, +or Enterprise Support plan to use the Amazon Web Services Support API. If you call the +Amazon Web Services Support API from an account that does not have a Business, Enterprise +On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message +appears. For information about changing your support plan, see Amazon Web Services Support. + # Arguments - `case_id`: The support case ID requested or returned in the call. The case ID is an @@ -328,24 +341,27 @@ end describe_services() describe_services(params::Dict{String,<:Any}) -Returns the current list of AWS services and a list of service categories for each service. -You then use service names and categories in your CreateCase requests. Each AWS service has -its own set of categories. The service codes and category codes correspond to the values -that appear in the Service and Category lists on the AWS Support Center Create Case page. -The values in those fields don't necessarily match the service codes and categories -returned by the DescribeServices operation. Always use the service codes and categories -that the DescribeServices operation returns, so that you have the most recent set of -service and category codes. You must have a Business or Enterprise Support plan to use -the AWS Support API. If you call the AWS Support API from an account that does not have -a Business or Enterprise Support plan, the SubscriptionRequiredException error message -appears. For information about changing your support plan, see AWS Support. +Returns the current list of Amazon Web Services services and a list of service categories +for each service. You then use service names and categories in your CreateCase requests. +Each Amazon Web Services service has its own set of categories. The service codes and +category codes correspond to the values that appear in the Service and Category lists on +the Amazon Web Services Support Center Create Case page. The values in those fields don't +necessarily match the service codes and categories returned by the DescribeServices +operation. Always use the service codes and categories that the DescribeServices operation +returns, so that you have the most recent set of service and category codes. You must +have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web +Services Support API. If you call the Amazon Web Services Support API from an account +that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +SubscriptionRequiredException error message appears. For information about changing your +support plan, see Amazon Web Services Support. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"language"`: The ISO 639-1 code for the language in which AWS provides support. AWS - Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must - be passed explicitly for operations that take them. -- `"serviceCodeList"`: A JSON-formatted list of service codes available for AWS services. +- `"language"`: The ISO 639-1 code for the language in which Amazon Web Services provides + support. Amazon Web Services Support currently supports English (\"en\") and Japanese + (\"ja\"). Language parameters must be passed explicitly for operations that take them. +- `"serviceCodeList"`: A JSON-formatted list of service codes available for Amazon Web + Services services. """ function describe_services(; aws_config::AbstractAWSConfig=global_aws_config()) return support( @@ -366,16 +382,17 @@ end Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a -CreateCase request. You must have a Business or Enterprise Support plan to use the AWS -Support API. If you call the AWS Support API from an account that does not have a -Business or Enterprise Support plan, the SubscriptionRequiredException error message -appears. For information about changing your support plan, see AWS Support. +CreateCase request. You must have a Business, Enterprise On-Ramp, or Enterprise Support +plan to use the Amazon Web Services Support API. If you call the Amazon Web Services +Support API from an account that does not have a Business, Enterprise On-Ramp, or +Enterprise Support plan, the SubscriptionRequiredException error message appears. For +information about changing your support plan, see Amazon Web Services Support. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"language"`: The ISO 639-1 code for the language in which AWS provides support. AWS - Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must - be passed explicitly for operations that take them. +- `"language"`: The ISO 639-1 code for the language in which Amazon Web Services provides + support. Amazon Web Services Support currently supports English (\"en\") and Japanese + (\"ja\"). Language parameters must be passed explicitly for operations that take them. """ function describe_severity_levels(; aws_config::AbstractAWSConfig=global_aws_config()) return support( @@ -397,15 +414,16 @@ end describe_trusted_advisor_check_refresh_statuses(check_ids) describe_trusted_advisor_check_refresh_statuses(check_ids, params::Dict{String,<:Any}) -Returns the refresh status of the AWS Trusted Advisor checks that have the specified check -IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. Some +Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. +You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. Some checks are refreshed automatically, and you can't return their refresh statuses by using the DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for -these checks, you might see an InvalidParameterValue error. You must have a Business or -Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from -an account that does not have a Business or Enterprise Support plan, the -SubscriptionRequiredException error message appears. For information about changing your -support plan, see AWS Support. +these checks, you might see an InvalidParameterValue error. You must have a Business, +Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. + If you call the Amazon Web Services Support API from an account that does not have a +Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException +error message appears. For information about changing your support plan, see Amazon Web +Services Support. # Arguments - `check_ids`: The IDs of the Trusted Advisor checks to get the status. If you specify the @@ -442,26 +460,28 @@ end describe_trusted_advisor_check_result(check_id) describe_trusted_advisor_check_result(check_id, params::Dict{String,<:Any}) -Returns the results of the AWS Trusted Advisor check that has the specified check ID. You -can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. The response +Returns the results of the Trusted Advisor check that has the specified check ID. You can +get the check IDs by calling the DescribeTrustedAdvisorChecks operation. The response contains a TrustedAdvisorCheckResult object, which contains these three objects: TrustedAdvisorCategorySpecificSummary TrustedAdvisorResourceDetail TrustedAdvisorResourcesSummary In addition, the response contains these fields: status - The alert status of the check can be ok (green), warning (yellow), error (red), or not_available. timestamp - The time of the last refresh of the check. checkId - The -unique identifier for the check. You must have a Business or Enterprise Support plan -to use the AWS Support API. If you call the AWS Support API from an account that does -not have a Business or Enterprise Support plan, the SubscriptionRequiredException error -message appears. For information about changing your support plan, see AWS Support. +unique identifier for the check. You must have a Business, Enterprise On-Ramp, or +Enterprise Support plan to use the Amazon Web Services Support API. If you call the +Amazon Web Services Support API from an account that does not have a Business, Enterprise +On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message +appears. For information about changing your support plan, see Amazon Web Services Support. + # Arguments - `check_id`: The unique identifier for the Trusted Advisor check. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: -- `"language"`: The ISO 639-1 code for the language in which AWS provides support. AWS - Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must - be passed explicitly for operations that take them. +- `"language"`: The ISO 639-1 code for the language in which Amazon Web Services provides + support. Amazon Web Services Support currently supports English (\"en\") and Japanese + (\"ja\"). Language parameters must be passed explicitly for operations that take them. """ function describe_trusted_advisor_check_result( checkId; aws_config::AbstractAWSConfig=global_aws_config() @@ -488,13 +508,14 @@ end describe_trusted_advisor_check_summaries(check_ids) describe_trusted_advisor_check_summaries(check_ids, params::Dict{String,<:Any}) -Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you +Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. The response contains an array of TrustedAdvisorCheckSummary objects. You must have a -Business or Enterprise Support plan to use the AWS Support API. If you call the AWS -Support API from an account that does not have a Business or Enterprise Support plan, the +Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services +Support API. If you call the Amazon Web Services Support API from an account that does +not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your -support plan, see AWS Support. +support plan, see Amazon Web Services Support. # Arguments - `check_ids`: The IDs of the Trusted Advisor checks. @@ -529,21 +550,22 @@ end describe_trusted_advisor_checks(language) describe_trusted_advisor_checks(language, params::Dict{String,<:Any}) -Returns information about all available AWS Trusted Advisor checks, including the name, ID, -category, description, and metadata. You must specify a language code. The AWS Support API -currently supports English (\"en\") and Japanese (\"ja\"). The response contains a -TrustedAdvisorCheckDescription object for each check. You must set the AWS Region to -us-east-1. You must have a Business or Enterprise Support plan to use the AWS Support -API. If you call the AWS Support API from an account that does not have a Business or -Enterprise Support plan, the SubscriptionRequiredException error message appears. For -information about changing your support plan, see AWS Support. The names and descriptions -for Trusted Advisor checks are subject to change. We recommend that you specify the check -ID in your code to uniquely identify a check. +Returns information about all available Trusted Advisor checks, including the name, ID, +category, description, and metadata. You must specify a language code. The Amazon Web +Services Support API currently supports English (\"en\") and Japanese (\"ja\"). The +response contains a TrustedAdvisorCheckDescription object for each check. You must set the +Amazon Web Services Region to us-east-1. You must have a Business, Enterprise On-Ramp, +or Enterprise Support plan to use the Amazon Web Services Support API. If you call the +Amazon Web Services Support API from an account that does not have a Business, Enterprise +On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message +appears. For information about changing your support plan, see Amazon Web Services Support. + The names and descriptions for Trusted Advisor checks are subject to change. We recommend +that you specify the check ID in your code to uniquely identify a check. # Arguments -- `language`: The ISO 639-1 code for the language in which AWS provides support. AWS - Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must - be passed explicitly for operations that take them. +- `language`: The ISO 639-1 code for the language in which Amazon Web Services provides + support. Amazon Web Services Support currently supports English (\"en\") and Japanese + (\"ja\"). Language parameters must be passed explicitly for operations that take them. """ function describe_trusted_advisor_checks( @@ -575,14 +597,16 @@ end refresh_trusted_advisor_check(check_id) refresh_trusted_advisor_check(check_id, params::Dict{String,<:Any}) -Refreshes the AWS Trusted Advisor check that you specify using the check ID. You can get -the check IDs by calling the DescribeTrustedAdvisorChecks operation. Some checks are -refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to refresh -them, you might see the InvalidParameterValue error. The response contains a -TrustedAdvisorCheckRefreshStatus object. You must have a Business or Enterprise Support -plan to use the AWS Support API. If you call the AWS Support API from an account that -does not have a Business or Enterprise Support plan, the SubscriptionRequiredException -error message appears. For information about changing your support plan, see AWS Support. +Refreshes the Trusted Advisor check that you specify using the check ID. You can get the +check IDs by calling the DescribeTrustedAdvisorChecks operation. Some checks are refreshed +automatically. If you call the RefreshTrustedAdvisorCheck operation to refresh them, you +might see the InvalidParameterValue error. The response contains a +TrustedAdvisorCheckRefreshStatus object. You must have a Business, Enterprise On-Ramp, +or Enterprise Support plan to use the Amazon Web Services Support API. If you call the +Amazon Web Services Support API from an account that does not have a Business, Enterprise +On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message +appears. For information about changing your support plan, see Amazon Web Services Support. + # Arguments - `check_id`: The unique identifier for the Trusted Advisor check to refresh. Specifying @@ -616,10 +640,11 @@ end resolve_case(params::Dict{String,<:Any}) Resolves a support case. This operation takes a caseId and returns the initial and final -state of the case. You must have a Business or Enterprise Support plan to use the AWS -Support API. If you call the AWS Support API from an account that does not have a -Business or Enterprise Support plan, the SubscriptionRequiredException error message -appears. For information about changing your support plan, see AWS Support. +state of the case. You must have a Business, Enterprise On-Ramp, or Enterprise Support +plan to use the Amazon Web Services Support API. If you call the Amazon Web Services +Support API from an account that does not have a Business, Enterprise On-Ramp, or +Enterprise Support plan, the SubscriptionRequiredException error message appears. For +information about changing your support plan, see Amazon Web Services Support. # Optional Parameters Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are: diff --git a/src/services/transfer.jl b/src/services/transfer.jl index 49a737fabe..6c51bd88f2 100644 --- a/src/services/transfer.jl +++ b/src/services/transfer.jl @@ -171,14 +171,19 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to - call for authentication using the IdentityProviderDetails parameter. Use the LAMBDA value - to directly use a Lambda function as your identity provider. If you choose this value, you - must specify the ARN for the lambda function in the Function parameter for the + call for authentication using the IdentityProviderDetails parameter. Use the AWS_LAMBDA + value to directly use a Lambda function as your identity provider. If you choose this + value, you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type. - `"LoggingRole"`: Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs. +- `"ProtocolDetails"`: The protocol settings that are configured for your server. Use the + PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single + dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load + balancer. Use the TlsSessionResumptionMode parameter to determine whether or not your + Transfer server resumes recent, negotiated sessions through a unique session ID. - `"Protocols"`: Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are: SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH FTPS @@ -275,7 +280,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems. - `"SshPublicKeyBody"`: The public portion of the Secure Shell (SSH) key used to - authenticate the user to the server. + authenticate the user to the server. Currently, Transfer Family does not accept + elliptical curve keys (keys beginning with ecdsa). - `"Tags"`: Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose. """ @@ -1550,7 +1556,8 @@ Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys - `"ProtocolDetails"`: The protocol settings that are configured for your server. Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or - load balancer. + load balancer. Use the TlsSessionResumptionMode parameter to determine whether or not your + Transfer server resumes recent, negotiated sessions through a unique session ID. - `"Protocols"`: Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are: Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH File diff --git a/src/services/workmail.jl b/src/services/workmail.jl index 7e2ea94363..e0f097fd51 100644 --- a/src/services/workmail.jl +++ b/src/services/workmail.jl @@ -575,6 +575,42 @@ function delete_alias( ) end +""" + delete_email_monitoring_configuration(organization_id) + delete_email_monitoring_configuration(organization_id, params::Dict{String,<:Any}) + +Deletes the email monitoring configuration for a specified organization. + +# Arguments +- `organization_id`: The ID of the organization from which the email monitoring + configuration is deleted. + +""" +function delete_email_monitoring_configuration( + OrganizationId; aws_config::AbstractAWSConfig=global_aws_config() +) + return workmail( + "DeleteEmailMonitoringConfiguration", + Dict{String,Any}("OrganizationId" => OrganizationId); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function delete_email_monitoring_configuration( + OrganizationId, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return workmail( + "DeleteEmailMonitoringConfiguration", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("OrganizationId" => OrganizationId), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ delete_group(group_id, organization_id) delete_group(group_id, organization_id, params::Dict{String,<:Any}) @@ -1054,6 +1090,42 @@ function deregister_mail_domain( ) end +""" + describe_email_monitoring_configuration(organization_id) + describe_email_monitoring_configuration(organization_id, params::Dict{String,<:Any}) + +Describes the current email monitoring configuration for a specified organization. + +# Arguments +- `organization_id`: The ID of the organization for which the email monitoring + configuration is described. + +""" +function describe_email_monitoring_configuration( + OrganizationId; aws_config::AbstractAWSConfig=global_aws_config() +) + return workmail( + "DescribeEmailMonitoringConfiguration", + Dict{String,Any}("OrganizationId" => OrganizationId); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function describe_email_monitoring_configuration( + OrganizationId, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return workmail( + "DescribeEmailMonitoringConfiguration", + Dict{String,Any}( + mergewith(_merge, Dict{String,Any}("OrganizationId" => OrganizationId), params) + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ describe_group(group_id, organization_id) describe_group(group_id, organization_id, params::Dict{String,<:Any}) @@ -2310,6 +2382,60 @@ function put_access_control_rule( ) end +""" + put_email_monitoring_configuration(log_group_arn, organization_id, role_arn) + put_email_monitoring_configuration(log_group_arn, organization_id, role_arn, params::Dict{String,<:Any}) + +Creates or updates the email monitoring configuration for a specified organization. + +# Arguments +- `log_group_arn`: The Amazon Resource Name (ARN) of the CloudWatch Log group associated + with the email monitoring configuration. +- `organization_id`: The ID of the organization for which the email monitoring + configuration is set. +- `role_arn`: The Amazon Resource Name (ARN) of the IAM Role associated with the email + monitoring configuration. + +""" +function put_email_monitoring_configuration( + LogGroupArn, OrganizationId, RoleArn; aws_config::AbstractAWSConfig=global_aws_config() +) + return workmail( + "PutEmailMonitoringConfiguration", + Dict{String,Any}( + "LogGroupArn" => LogGroupArn, + "OrganizationId" => OrganizationId, + "RoleArn" => RoleArn, + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end +function put_email_monitoring_configuration( + LogGroupArn, + OrganizationId, + RoleArn, + params::AbstractDict{String}; + aws_config::AbstractAWSConfig=global_aws_config(), +) + return workmail( + "PutEmailMonitoringConfiguration", + Dict{String,Any}( + mergewith( + _merge, + Dict{String,Any}( + "LogGroupArn" => LogGroupArn, + "OrganizationId" => OrganizationId, + "RoleArn" => RoleArn, + ), + params, + ), + ); + aws_config=aws_config, + feature_set=SERVICE_FEATURE_SET, + ) +end + """ put_inbound_dmarc_settings(enforced, organization_id) put_inbound_dmarc_settings(enforced, organization_id, params::Dict{String,<:Any})