EC2 Image Builder is a fully managed AWS service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date \"golden\" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.
", + "service": "EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date \"golden\" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.
", "operations": { "CancelImageCreation": "CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
", "CreateComponent": "Creates a new component that can be used to build, validate, test, and assess your image.
", @@ -34,7 +34,7 @@ "ListContainerRecipes": "Returns a list of container recipes.
", "ListDistributionConfigurations": "Returns a list of distribution configurations.
", "ListImageBuildVersions": "Returns a list of image build versions.
", - "ListImagePackages": "List the Packages that are associated with an Image Build Version, as determined by AWS Systems Manager Inventory at build time.
", + "ListImagePackages": "List the Packages that are associated with an Image Build Version, as determined by Amazon EC2 Systems Manager Inventory at build time.
", "ListImagePipelineImages": "Returns a list of images created by the specified pipeline.
", "ListImagePipelines": "Returns a list of image pipelines.
", "ListImageRecipes": "Returns a list of image recipes.
", @@ -64,11 +64,18 @@ "base": null, "refs": { "AmiDistributionConfiguration$targetAccountIds": "The ID of an account to which you want to distribute an image.
", - "LaunchPermissionConfiguration$userIds": "The AWS account ID.
" + "LaunchPermissionConfiguration$userIds": "The account ID.
" + } + }, + "AdditionalInstanceConfiguration": { + "base": "In addition to your infrastruction configuration, these settings provide an extra layer of control over your build instances. For instances where Image Builder installs the SSM agent, you can choose whether to keep it for the AMI that you create. You can also specify commands to run on launch for all of your build instances.
", + "refs": { + "CreateImageRecipeRequest$additionalInstanceConfiguration": "Specify additional settings and launch scripts for your build instances.
", + "ImageRecipe$additionalInstanceConfiguration": "Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.
" } }, "Ami": { - "base": "Details of an EC2 AMI.
", + "base": "Details of an Amazon EC2 AMI.
", "refs": { "AmiList$member": null } @@ -82,7 +89,7 @@ "AmiList": { "base": null, "refs": { - "OutputResources$amis": "The EC2 AMIs created by this image.
" + "OutputResources$amis": "The Amazon EC2 AMIs created by this image.
" } }, "AmiNameString": { @@ -104,7 +111,7 @@ "Boolean": { "base": null, "refs": { - "LaunchTemplateConfiguration$setDefaultVersion": "Set the specified EC2 launch template as the default launch template for the specified account.
", + "LaunchTemplateConfiguration$setDefaultVersion": "Set the specified Amazon EC2 launch template as the default launch template for the specified account.
", "ListComponentsRequest$byName": "Returns the list of component build versions for the specified semantic version.
", "ListImagesRequest$byName": "Requests a list of images with a specific recipe name.
" } @@ -205,6 +212,62 @@ "ImportComponentRequest$format": "The format of the resource that you want to import as a component.
" } }, + "ComponentParameter": { + "base": "Contains a key/value pair that sets the named component parameter.
", + "refs": { + "ComponentParameterList$member": null + } + }, + "ComponentParameterDescription": { + "base": null, + "refs": { + "ComponentParameterDetail$description": "Describes this parameter.
" + } + }, + "ComponentParameterDetail": { + "base": "Defines a parameter that is used to provide configuration details for the component.
", + "refs": { + "ComponentParameterDetailList$member": null + } + }, + "ComponentParameterDetailList": { + "base": null, + "refs": { + "Component$parameters": "Contains parameter details for each of the parameters that are defined for the component.
" + } + }, + "ComponentParameterList": { + "base": null, + "refs": { + "ComponentConfiguration$parameters": "A group of parameter settings that are used to configure the component for a specific recipe.
" + } + }, + "ComponentParameterName": { + "base": null, + "refs": { + "ComponentParameter$name": "The name of the component parameter to set.
", + "ComponentParameterDetail$name": "The name of this input parameter.
" + } + }, + "ComponentParameterType": { + "base": null, + "refs": { + "ComponentParameterDetail$type": "The type of input this parameter provides. The currently supported value is \"string\".
" + } + }, + "ComponentParameterValue": { + "base": null, + "refs": { + "ComponentParameterValueList$member": null + } + }, + "ComponentParameterValueList": { + "base": null, + "refs": { + "ComponentParameter$value": "Sets the value for the named component parameter.
", + "ComponentParameterDetail$defaultValue": "The default value of this parameter if no input is provided.
" + } + }, "ComponentSummary": { "base": "A high-level summary of a component.
", "refs": { @@ -977,7 +1040,7 @@ } }, "InfrastructureConfigurationSummary": { - "base": "The infrastructure used when building EC2 AMIs.
", + "base": "The infrastructure used when building Amazon EC2 AMIs.
", "refs": { "InfrastructureConfigurationSummaryList$member": null } @@ -1024,10 +1087,10 @@ "InstanceProfileNameType": { "base": null, "refs": { - "CreateInfrastructureConfigurationRequest$instanceProfileName": "The instance profile to associate with the instance used to customize your EC2 AMI.
", + "CreateInfrastructureConfigurationRequest$instanceProfileName": "The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
", "InfrastructureConfiguration$instanceProfileName": "The instance profile of the infrastructure configuration.
", "InfrastructureConfigurationSummary$instanceProfileName": "The instance profile of the infrastructure configuration.
", - "UpdateInfrastructureConfigurationRequest$instanceProfileName": "The instance profile to associate with the instance used to customize your EC2 AMI.
" + "UpdateInfrastructureConfigurationRequest$instanceProfileName": "The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
" } }, "InstanceType": { @@ -1076,13 +1139,13 @@ } }, "LaunchPermissionConfiguration": { - "base": "Describes the configuration for a launch permission. The launch permission modification request is sent to the EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to all. See the examples for making an AMI public at EC2 ModifyImageAttribute.
Describes the configuration for a launch permission. The launch permission modification request is sent to the Amazon EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to all. See the examples for making an AMI public at Amazon EC2 ModifyImageAttribute.
Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
" + "AmiDistributionConfiguration$launchPermission": "Launch permissions can be used to configure which accounts can use the AMI to launch instances.
" } }, "LaunchTemplateConfiguration": { - "base": "Identifies an EC2 launch template to use for a specific account.
", + "base": "Identifies an Amazon EC2 launch template to use for a specific account.
", "refs": { "LaunchTemplateConfigurationList$member": null } @@ -1096,7 +1159,7 @@ "LaunchTemplateId": { "base": null, "refs": { - "LaunchTemplateConfiguration$launchTemplateId": "Identifies the EC2 launch template to use.
" + "LaunchTemplateConfiguration$launchTemplateId": "Identifies the Amazon EC2 launch template to use.
" } }, "LicenseConfigurationArn": { @@ -1242,10 +1305,10 @@ "NonEmptyString": { "base": null, "refs": { - "Ami$region": "The AWS Region of the EC2 AMI.
", - "Ami$image": "The AMI ID of the EC2 AMI.
", - "Ami$name": "The name of the EC2 AMI.
", - "Ami$description": "The description of the EC2 AMI. Minimum and maximum length are in characters.
", + "Ami$region": "The Region of the Amazon EC2 AMI.
", + "Ami$image": "The AMI ID of the Amazon EC2 AMI.
", + "Ami$name": "The name of the Amazon EC2 AMI.
", + "Ami$description": "The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.
", "Ami$accountId": "The account ID of the owner of the AMI.
", "AmiDistributionConfiguration$description": "The description of the distribution configuration. Minimum and maximum length are in characters.
", "AmiDistributionConfiguration$kmsKeyId": "The KMS key identifier used to encrypt the distributed image.
", @@ -1284,11 +1347,11 @@ "CreateImagePipelineResponse$requestId": "The request ID that uniquely identifies this request.
", "CreateImageRecipeRequest$description": "The description of the image recipe.
", "CreateImageRecipeRequest$parentImage": "The parent image of the image recipe. The value of the string can be the ARN of the parent image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.
The working directory to be used during build and test workflows.
", + "CreateImageRecipeRequest$workingDirectory": "The working directory used during build and test workflows.
", "CreateImageRecipeResponse$requestId": "The request ID that uniquely identifies this request.
", "CreateImageResponse$requestId": "The request ID that uniquely identifies this request.
", "CreateInfrastructureConfigurationRequest$description": "The description of the infrastructure configuration.
", - "CreateInfrastructureConfigurationRequest$subnetId": "The subnet ID in which to place the instance used to customize your EC2 AMI.
", + "CreateInfrastructureConfigurationRequest$subnetId": "The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.
", "CreateInfrastructureConfigurationRequest$keyPair": "The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image.
", "CreateInfrastructureConfigurationResponse$requestId": "The request ID that uniquely identifies this request.
", "DeleteComponentResponse$requestId": "The request ID that uniquely identifies this request.
", @@ -1333,7 +1396,7 @@ "ImportComponentResponse$requestId": "The request ID that uniquely identifies this request.
", "InfrastructureConfiguration$description": "The description of the infrastructure configuration.
", "InfrastructureConfiguration$subnetId": "The subnet ID of the infrastructure configuration.
", - "InfrastructureConfiguration$keyPair": "The EC2 key pair of the infrastructure configuration.
", + "InfrastructureConfiguration$keyPair": "The Amazon EC2 key pair of the infrastructure configuration.
", "InfrastructureConfiguration$snsTopicArn": "The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration.
", "InfrastructureConfigurationSummary$description": "The description of the infrastructure configuration.
", "InstanceBlockDeviceMapping$deviceName": "The device to which these mappings apply.
", @@ -1369,7 +1432,7 @@ "UpdateImagePipelineRequest$description": "The description of the image pipeline.
", "UpdateImagePipelineResponse$requestId": "The request ID that uniquely identifies this request.
", "UpdateInfrastructureConfigurationRequest$description": "The description of the infrastructure configuration.
", - "UpdateInfrastructureConfigurationRequest$subnetId": "The subnet ID to place the instance used to customize your EC2 AMI in.
", + "UpdateInfrastructureConfigurationRequest$subnetId": "The subnet ID to place the instance used to customize your Amazon EC2 AMI in.
", "UpdateInfrastructureConfigurationRequest$keyPair": "The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image.
", "UpdateInfrastructureConfigurationResponse$requestId": "The request ID that uniquely identifies this request.
" } @@ -1389,6 +1452,7 @@ "ImageTestsConfiguration$imageTestsEnabled": "Defines if tests should be executed when building this image.
", "InfrastructureConfiguration$terminateInstanceOnFailure": "The terminate instance on failure configuration of the infrastructure configuration.
", "ListImagesRequest$includeDeprecated": "Includes deprecated images in the response list.
", + "SystemsManagerAgent$uninstallAfterBuild": "This property defaults to true. If Image Builder installs the SSM agent on a build instance, it removes the agent before creating a snapshot for the AMI. To ensure that the AMI you create includes the SSM agent, set this property to false.
", "UpdateImagePipelineRequest$enhancedImageMetadataEnabled": "Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
", "UpdateInfrastructureConfigurationRequest$terminateInstanceOnFailure": "The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.
" } @@ -1634,9 +1698,9 @@ "SecurityGroupIds": { "base": null, "refs": { - "CreateInfrastructureConfigurationRequest$securityGroupIds": "The security group IDs to associate with the instance used to customize your EC2 AMI.
", + "CreateInfrastructureConfigurationRequest$securityGroupIds": "The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
", "InfrastructureConfiguration$securityGroupIds": "The security group IDs of the infrastructure configuration.
", - "UpdateInfrastructureConfigurationRequest$securityGroupIds": "The security group IDs to associate with the instance used to customize your EC2 AMI.
" + "UpdateInfrastructureConfigurationRequest$securityGroupIds": "The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
" } }, "ServiceException": { @@ -1679,6 +1743,12 @@ "LaunchPermissionConfiguration$userGroups": "The name of the group.
" } }, + "SystemsManagerAgent": { + "base": "Contains settings for the SSM agent on your build instance.
", + "refs": { + "AdditionalInstanceConfiguration$systemsManagerAgent": "Contains settings for the SSM agent on your build instance.
" + } + }, "TagKey": { "base": null, "refs": { @@ -1796,9 +1866,15 @@ "Uri": { "base": null, "refs": { - "CreateComponentRequest$uri": "The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.
The S3 URI for the Dockerfile that will be used to build your container image.
", - "ImportComponentRequest$uri": "The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.
The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.
The Amazon S3 URI for the Dockerfile that will be used to build your container image.
", + "ImportComponentRequest$uri": "The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.
Use this property to provide commands or a command script to run when you launch your build instance.
The userDataOverride property replaces any commands that Image Builder might have added to ensure that SSM is installed on your Linux build instance. If you override the user data, make sure that you add commands to install SSM, if it is not pre-installed on your source image.
Overview
This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, see What is AWS Lambda, and for information about how the service works, see AWS Lambda: How it Works in the AWS Lambda Developer Guide.
", + "service": "Overview
This is the Lambda API Reference. The Lambda Developer Guide provides additional information. For the service overview, see What is Lambda, and for information about how the service works, see Lambda: How it Works in the Lambda Developer Guide.
", "operations": { - "AddLayerVersionPermission": "Adds permissions to the resource-based policy of a version of an AWS Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization.
To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.
", - "AddPermission": "Grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.
To grant permission to another account, specify the account ID as the Principal. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For AWS services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Lambda Function Policies.
", + "AddLayerVersionPermission": "Adds permissions to the resource-based policy of a version of an Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, or all Amazon Web Services accounts.
To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.
", + "AddPermission": "Grants an Amazon Web Services service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.
To grant permission to another account, specify the account ID as the Principal. For Amazon Web Services services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Lambda Function Policies.
", "CreateAlias": "Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.
You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.
Creates a code signing configuration. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail).
", - "CreateEventSourceMapping": "Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.
For details about each event source type, see the following topics.
The following error handling options are only available for stream sources (DynamoDB and Kinesis):
BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry.
DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic.
MaximumRecordAgeInSeconds - Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
MaximumRetryAttempts - Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
ParallelizationFactor - Process multiple batches from each shard concurrently.
Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.
When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Function States.
A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.
The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).
You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set set of signing profiles, which define the trusted publishers for this function.
If another account or an AWS service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias.
To invoke your function directly, use Invoke. To invoke your function in response to events in other AWS services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions.
", + "CreateEventSourceMapping": "Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and triggers the function.
For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.
The following error handling options are only available for stream sources (DynamoDB and Kinesis):
BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry.
DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic.
MaximumRecordAgeInSeconds - Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
MaximumRetryAttempts - Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
ParallelizationFactor - Process multiple batches from each shard concurrently.
Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.
You set the package type to Image if the deployment package is a container image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.
You set the package type to Zip if the deployment package is a .zip file archive. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties.
When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Function States.
A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.
The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).
You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set set of signing profiles, which define the trusted publishers for this function.
If another account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias.
To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions.
", "DeleteAlias": "Deletes a Lambda function alias.
", "DeleteCodeSigningConfig": "Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it.
", "DeleteEventSourceMapping": "Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
When you delete an event source mapping, it enters a Deleting state and might not be completely deleted for several seconds.
Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted.
To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For AWS services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.
", + "DeleteFunction": "Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted.
To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.
", "DeleteFunctionCodeSigningConfig": "Removes the code signing configuration from the function.
", "DeleteFunctionConcurrency": "Removes a concurrent execution limit from a function.
", "DeleteFunctionEventInvokeConfig": "Deletes the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
", - "DeleteLayerVersion": "Deletes a version of an AWS Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.
", + "DeleteLayerVersion": "Deletes a version of an Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.
", "DeleteProvisionedConcurrencyConfig": "Deletes the provisioned concurrency configuration for a function.
", - "GetAccountSettings": "Retrieves details about your account's limits and usage in an AWS Region.
", + "GetAccountSettings": "Retrieves details about your account's limits and usage in an Amazon Web Services Region.
", "GetAlias": "Returns details about a Lambda function alias.
", "GetCodeSigningConfig": "Returns information about the specified code signing configuration.
", "GetEventSourceMapping": "Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
", @@ -26,9 +26,9 @@ "GetFunctionConcurrency": "Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.
", "GetFunctionConfiguration": "Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.
To get all of a function's details, including function-level settings, use GetFunction.
", "GetFunctionEventInvokeConfig": "Retrieves the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
", - "GetLayerVersion": "Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
", - "GetLayerVersionByArn": "Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
", - "GetLayerVersionPolicy": "Returns the permission policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.
", + "GetLayerVersion": "Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
", + "GetLayerVersionByArn": "Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
", + "GetLayerVersionPolicy": "Returns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.
", "GetPolicy": "Returns the resource-based IAM policy for a function, version, or alias.
", "GetProvisionedConcurrencyConfig": "Retrieves the provisioned concurrency configuration for a function's alias or version.
", "Invoke": "Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set InvocationType to Event.
For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace.
When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Retry Behavior.
For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.
The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, limit errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if executing the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded).
For functions with a long timeout, your client might be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.
This operation requires permission for the lambda:InvokeFunction action.
", @@ -39,26 +39,26 @@ "ListFunctionEventInvokeConfigs": "Retrieves a list of configurations for asynchronous invocation for a function.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
", "ListFunctions": "Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.
Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version.
The ListFunctions action returns a subset of the FunctionConfiguration fields. To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode) for a function or version, use GetFunction.
List the functions that use the specified code signing configuration. You can use this method prior to deleting a code signing configuration, to verify that no functions are using it.
", - "ListLayerVersions": "Lists the versions of an AWS Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime.
", - "ListLayers": "Lists AWS Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime.
", + "ListLayerVersions": "Lists the versions of an Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime.
", + "ListLayers": "Lists Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime.
", "ListProvisionedConcurrencyConfigs": "Retrieves a list of provisioned concurrency configurations for a function.
", "ListTags": "Returns a function's tags. You can also view tags with GetFunction.
", "ListVersionsByFunction": "Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call.
", - "PublishLayerVersion": "Creates an AWS Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same layer name, a new version is created.
Add layers to your function with CreateFunction or UpdateFunctionConfiguration.
", - "PublishVersion": "Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.
AWS Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version.
Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.
", + "PublishLayerVersion": "Creates an Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same layer name, a new version is created.
Add layers to your function with CreateFunction or UpdateFunctionConfiguration.
", + "PublishVersion": "Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.
Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version.
Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.
", "PutFunctionCodeSigningConfig": "Update the code signing configuration for the function. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.
", "PutFunctionConcurrency": "Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.
Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function.
Use GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Managing Concurrency.
", "PutFunctionEventInvokeConfig": "Configures options for asynchronous invocation on a function, version, or alias. If a configuration already exists for a function, version, or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without affecting existing settings for other options, use UpdateFunctionEventInvokeConfig.
By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with UpdateFunctionConfiguration.
To send an invocation record to a queue, topic, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue.
", "PutProvisionedConcurrencyConfig": "Adds a provisioned concurrency configuration to a function's alias or version.
", - "RemoveLayerVersionPermission": "Removes a statement from the permissions policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.
", - "RemovePermission": "Revokes function-use permission from an AWS service or another account. You can get the ID of the statement from the output of GetPolicy.
", + "RemoveLayerVersionPermission": "Removes a statement from the permissions policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.
", + "RemovePermission": "Revokes function-use permission from an Amazon Web Services service or another account. You can get the ID of the statement from the output of GetPolicy.
", "TagResource": "Adds tags to a function.
", "UntagResource": "Removes tags from a function.
", "UpdateAlias": "Updates the configuration of a Lambda function alias.
", "UpdateCodeSigningConfig": "Update the code signing configuration. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.
", - "UpdateEventSourceMapping": "Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location.
The following error handling options are only available for stream sources (DynamoDB and Kinesis):
BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry.
DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic.
MaximumRecordAgeInSeconds - Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
MaximumRetryAttempts - Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
ParallelizationFactor - Process multiple batches from each shard concurrently.
Updates an event source mapping. You can change the function that Lambda invokes, or pause invocation and resume later from the same location.
The following error handling options are only available for stream sources (DynamoDB and Kinesis):
BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry.
DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic.
MaximumRecordAgeInSeconds - Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
MaximumRetryAttempts - Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
ParallelizationFactor - Process multiple batches from each shard concurrently.
Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see Configuring code signing.
The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.
For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function.
Modify the version-specific settings of a Lambda function.
When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Function States.
These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.
To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an account or AWS service, use AddPermission.
", + "UpdateFunctionConfiguration": "Modify the version-specific settings of a Lambda function.
When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Function States.
These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.
To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an account or Amazon Web Services service, use AddPermission.
", "UpdateFunctionEventInvokeConfig": "Updates the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
" }, "shapes": { @@ -153,7 +153,7 @@ "Arn": { "base": null, "refs": { - "AddPermissionRequest$SourceArn": "For AWS services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.
", + "AddPermissionRequest$SourceArn": "For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.
", "CreateEventSourceMappingRequest$EventSourceArn": "The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis - The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - The ARN of the stream.
Amazon Simple Queue Service - The ARN of the queue.
Amazon Managed Streaming for Apache Kafka - The ARN of the cluster.
The Amazon Resource Name (ARN) of the event source.
", "FunctionConfiguration$SigningProfileVersionArn": "The ARN of the signing profile version.
", @@ -175,19 +175,19 @@ "BisectBatchOnFunctionError": { "base": null, "refs": { - "CreateEventSourceMappingRequest$BisectBatchOnFunctionError": "(Streams) If the function returns an error, split the batch in two and retry.
", - "EventSourceMappingConfiguration$BisectBatchOnFunctionError": "(Streams) If the function returns an error, split the batch in two and retry. The default value is false.
", - "UpdateEventSourceMappingRequest$BisectBatchOnFunctionError": "(Streams) If the function returns an error, split the batch in two and retry.
" + "CreateEventSourceMappingRequest$BisectBatchOnFunctionError": "(Streams only) If the function returns an error, split the batch in two and retry.
", + "EventSourceMappingConfiguration$BisectBatchOnFunctionError": "(Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
", + "UpdateEventSourceMappingRequest$BisectBatchOnFunctionError": "(Streams only) If the function returns an error, split the batch in two and retry.
" } }, "Blob": { "base": null, "refs": { - "FunctionCode$ZipFile": "The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
", + "FunctionCode$ZipFile": "The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.
", "InvocationRequest$Payload": "The JSON that you want to provide to your Lambda function as input.
", "InvocationResponse$Payload": "The response from the function, or an error object.
", - "LayerVersionContentInput$ZipFile": "The base64-encoded contents of the layer archive. AWS SDK and AWS CLI clients handle the encoding for you.
", - "UpdateFunctionCodeRequest$ZipFile": "The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
" + "LayerVersionContentInput$ZipFile": "The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.
", + "UpdateFunctionCodeRequest$ZipFile": "The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.
" } }, "BlobStream": { @@ -205,7 +205,7 @@ } }, "CodeSigningConfig": { - "base": "Details about a Code signing configuration.
", + "base": "Details about a Code signing configuration.
", "refs": { "CodeSigningConfigList$member": null, "CreateCodeSigningConfigResponse$CodeSigningConfig": "The code signing configuration.
", @@ -245,7 +245,7 @@ } }, "CodeSigningPolicies": { - "base": "Code signing configuration policies specifies the validation failure action for signature mismatch or expiry.
", + "base": "Code signing configuration policies specify the validation failure action for signature mismatch or expiry.
", "refs": { "CodeSigningConfig$CodeSigningPolicies": "The code signing policy controls the validation failure action for signature mismatch or expiry.
", "CreateCodeSigningConfigRequest$CodeSigningPolicies": "The code signing policies define the actions to take if the validation checks fail.
", @@ -404,11 +404,11 @@ "DestinationConfig": { "base": "A configuration object that specifies the destination of an event after Lambda processes it.
", "refs": { - "CreateEventSourceMappingRequest$DestinationConfig": "(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
", - "EventSourceMappingConfiguration$DestinationConfig": "(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
", + "CreateEventSourceMappingRequest$DestinationConfig": "(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
", + "EventSourceMappingConfiguration$DestinationConfig": "(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
", "FunctionEventInvokeConfig$DestinationConfig": "A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of an SQS queue.
Topic - The ARN of an SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of an SQS queue.
Topic - The ARN of an SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
", + "UpdateEventSourceMappingRequest$DestinationConfig": "(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
", "UpdateFunctionEventInvokeConfigRequest$DestinationConfig": "A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of an SQS queue.
Topic - The ARN of an SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
AWS Lambda was throttled by Amazon EC2 during Lambda function initialization using the execution role provided for the Lambda function.
", + "base": "Lambda was throttled by Amazon EC2 during Lambda function initialization using the execution role provided for the Lambda function.
", "refs": { } }, "EC2UnexpectedException": { - "base": "AWS Lambda received an unexpected EC2 client exception while setting up for the Lambda function.
", + "base": "Lambda received an unexpected EC2 client exception while setting up for the Lambda function.
", "refs": { } }, @@ -448,7 +448,7 @@ } }, "ENILimitReachedException": { - "base": "AWS Lambda was not able to create an elastic network interface in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached.
", + "base": "Lambda was not able to create an elastic network interface in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached.
", "refs": { } }, @@ -484,7 +484,7 @@ } }, "Environment": { - "base": "A function's environment variable settings.
", + "base": "A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.
", "refs": { "CreateFunctionRequest$Environment": "Environment variables that are accessible from function code during execution.
", "UpdateFunctionConfigurationRequest$Environment": "Environment variables that are accessible from function code during execution.
" @@ -499,7 +499,7 @@ "EnvironmentResponse": { "base": "The results of an operation to update or read environment variables. If the operation is successful, the response contains the environment variables. If it failed, the response contains details about the error.
", "refs": { - "FunctionConfiguration$Environment": "The function's environment variables.
" + "FunctionConfiguration$Environment": "The function's environment variables.
" } }, "EnvironmentVariableName": { @@ -517,12 +517,12 @@ "EnvironmentVariables": { "base": null, "refs": { - "Environment$Variables": "Environment variable key-value pairs.
", + "Environment$Variables": "Environment variable key-value pairs. For more information, see Using Lambda environment variables.
", "EnvironmentResponse$Variables": "Environment variable key-value pairs.
" } }, "EventSourceMappingConfiguration": { - "base": "A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.
", + "base": "A mapping between an Amazon Web Services resource and an Lambda function. See CreateEventSourceMapping for details.
", "refs": { "EventSourceMappingsList$member": null } @@ -553,7 +553,7 @@ } }, "FileSystemConfig": { - "base": "Details about the connection between a Lambda function and an Amazon EFS file system.
", + "base": "Details about the connection between a Lambda function and an Amazon EFS file system.
", "refs": { "FileSystemConfigList$member": null } @@ -562,7 +562,7 @@ "base": null, "refs": { "CreateFunctionRequest$FileSystemConfigs": "Connection settings for an Amazon EFS file system.
", - "FunctionConfiguration$FileSystemConfigs": "Connection settings for an Amazon EFS file system.
", + "FunctionConfiguration$FileSystemConfigs": "Connection settings for an Amazon EFS file system.
", "UpdateFunctionConfigurationRequest$FileSystemConfigs": "Connection settings for an Amazon EFS file system.
" } }, @@ -670,9 +670,9 @@ "FunctionResponseTypeList": { "base": null, "refs": { - "CreateEventSourceMappingRequest$FunctionResponseTypes": "(Streams) A list of current response type enums applied to the event source mapping.
", - "EventSourceMappingConfiguration$FunctionResponseTypes": "(Streams) A list of current response type enums applied to the event source mapping.
", - "UpdateEventSourceMappingRequest$FunctionResponseTypes": "(Streams) A list of current response type enums applied to the event source mapping.
" + "CreateEventSourceMappingRequest$FunctionResponseTypes": "(Streams only) A list of current response type enums applied to the event source mapping.
", + "EventSourceMappingConfiguration$FunctionResponseTypes": "(Streams only) A list of current response type enums applied to the event source mapping.
", + "UpdateEventSourceMappingRequest$FunctionResponseTypes": "(Streams only) A list of current response type enums applied to the event source mapping.
" } }, "FunctionVersion": { @@ -813,7 +813,7 @@ "ImageConfig": { "base": "Configuration values that override the container image Dockerfile settings. See Container settings.
", "refs": { - "CreateFunctionRequest$ImageConfig": "Container image configuration values that override the values in the container image Dockerfile.
", + "CreateFunctionRequest$ImageConfig": "Container image configuration values that override the values in the container image Dockerfile.
", "ImageConfigResponse$ImageConfig": "Configuration values that override the container image Dockerfile.
", "UpdateFunctionConfigurationRequest$ImageConfig": "Container image configuration values that override the values in the container image Dockerfile.
" } @@ -868,7 +868,7 @@ } }, "InvalidZipFileException": { - "base": "AWS Lambda could not unzip the deployment package.
", + "base": "Lambda could not unzip the deployment package.
", "refs": { } }, @@ -916,9 +916,9 @@ "KMSKeyArn": { "base": null, "refs": { - "CreateFunctionRequest$KMSKeyArn": "The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
", + "CreateFunctionRequest$KMSKeyArn": "The ARN of the Amazon Web Services Key Management Service (KMS) key that's used to encrypt your function's environment variables. If it's not provided, Lambda uses a default service key.
", "FunctionConfiguration$KMSKeyArn": "The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
", - "UpdateFunctionConfigurationRequest$KMSKeyArn": "The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
" + "UpdateFunctionConfigurationRequest$KMSKeyArn": "The ARN of the Amazon Web Services Key Management Service (KMS) key that's used to encrypt your function's environment variables. If it's not provided, Lambda uses a default service key.
" } }, "KMSNotFoundException": { @@ -945,7 +945,7 @@ } }, "Layer": { - "base": "An AWS Lambda layer.
", + "base": "An Lambda layer.
", "refs": { "LayersReferenceList$member": null } @@ -987,7 +987,7 @@ "LayerPermissionAllowedPrincipal": { "base": null, "refs": { - "AddLayerVersionPermissionRequest$Principal": "An account ID, or * to grant permission to all AWS accounts.
An account ID, or * to grant layer usage permission to all accounts in an organization, or all Amazon Web Services accounts (if organizationId is not specified). For the last case, make sure that you really do want all Amazon Web Services accounts to have usage permission to this layer.
A ZIP archive that contains the contents of an AWS Lambda layer. You can specify either an Amazon S3 location, or upload a layer archive directly.
", + "base": "A ZIP archive that contains the contents of an Lambda layer. You can specify either an Amazon S3 location, or upload a layer archive directly.
", "refs": { "PublishLayerVersionRequest$Content": "The function layer archive.
" } }, "LayerVersionContentOutput": { - "base": "Details about a version of an AWS Lambda layer.
", + "base": "Details about a version of an Lambda layer.
", "refs": { "GetLayerVersionResponse$Content": "Details about the layer version.
", "PublishLayerVersionResponse$Content": "Details about the layer version.
" @@ -1034,7 +1034,7 @@ } }, "LayerVersionsListItem": { - "base": "Details about a version of an AWS Lambda layer.
", + "base": "Details about a version of an Lambda layer.
", "refs": { "LayerVersionsList$member": null, "LayersListItem$LatestMatchingVersion": "The newest version of the layer.
" @@ -1047,7 +1047,7 @@ } }, "LayersListItem": { - "base": "Details about an AWS Lambda layer.
", + "base": "Details about an Lambda layer.
", "refs": { "LayersList$member": null } @@ -1194,7 +1194,7 @@ "refs": { "AccountLimit$TotalCodeSize": "The amount of storage space that you can use for all deployment packages and layer archives.
", "AccountLimit$CodeSizeUnzipped": "The maximum size of a function's deployment package and layers when they're extracted.
", - "AccountLimit$CodeSizeZipped": "The maximum size of a deployment package when it's uploaded directly to AWS Lambda. Use Amazon S3 for larger files.
", + "AccountLimit$CodeSizeZipped": "The maximum size of a deployment package when it's uploaded directly to Lambda. Use Amazon S3 for larger files.
", "AccountUsage$TotalCodeSize": "The amount of storage space, in bytes, that's being used by deployment packages and layer archives.
", "AccountUsage$FunctionCount": "The number of Lambda functions.
", "FunctionConfiguration$CodeSize": "The size of the function's deployment package, in bytes.
", @@ -1205,7 +1205,7 @@ "MasterRegion": { "base": null, "refs": { - "ListFunctionsRequest$MasterRegion": "For Lambda@Edge functions, the AWS Region of the master function. For example, us-east-1 filters the list of functions to only include Lambda@Edge functions replicated from a master function in US East (N. Virginia). If specified, you must set FunctionVersion to ALL.
For Lambda@Edge functions, the Region of the master function. For example, us-east-1 filters the list of functions to only include Lambda@Edge functions replicated from a master function in US East (N. Virginia). If specified, you must set FunctionVersion to ALL.
The maximum number of event source mappings to return.
", "ListFunctionsByCodeSigningConfigRequest$MaxItems": "Maximum number of items to return.
", "ListFunctionsRequest$MaxItems": "The maximum number of functions to return in the response. Note that ListFunctions returns a maximum of 50 items in each response, even if you set the number higher.
The maximum number of versions to return.
" + "ListVersionsByFunctionRequest$MaxItems": "The maximum number of versions to return. Note that ListVersionsByFunction returns a maximum of 50 items in each response, even if you set the number higher.
(Streams) Discard records older than the specified age. The default value is infinite (-1).
", - "EventSourceMappingConfiguration$MaximumRecordAgeInSeconds": "(Streams) Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
", - "UpdateEventSourceMappingRequest$MaximumRecordAgeInSeconds": "(Streams) Discard records older than the specified age. The default value is infinite (-1).
" + "CreateEventSourceMappingRequest$MaximumRecordAgeInSeconds": "(Streams only) Discard records older than the specified age. The default value is infinite (-1).
", + "EventSourceMappingConfiguration$MaximumRecordAgeInSeconds": "(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
", + "UpdateEventSourceMappingRequest$MaximumRecordAgeInSeconds": "(Streams only) Discard records older than the specified age. The default value is infinite (-1).
" } }, "MaximumRetryAttempts": { @@ -1273,17 +1273,17 @@ "MaximumRetryAttemptsEventSourceMapping": { "base": null, "refs": { - "CreateEventSourceMappingRequest$MaximumRetryAttempts": "(Streams) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
", - "EventSourceMappingConfiguration$MaximumRetryAttempts": "(Streams) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
", - "UpdateEventSourceMappingRequest$MaximumRetryAttempts": "(Streams) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
" + "CreateEventSourceMappingRequest$MaximumRetryAttempts": "(Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
", + "EventSourceMappingConfiguration$MaximumRetryAttempts": "(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
", + "UpdateEventSourceMappingRequest$MaximumRetryAttempts": "(Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
" } }, "MemorySize": { "base": null, "refs": { - "CreateFunctionRequest$MemorySize": "The amount of memory available to the function at runtime. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
", + "CreateFunctionRequest$MemorySize": "The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
", "FunctionConfiguration$MemorySize": "The amount of memory available to the function at runtime.
", - "UpdateFunctionConfigurationRequest$MemorySize": "The amount of memory available to the function at runtime. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
" + "UpdateFunctionConfigurationRequest$MemorySize": "The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
" } }, "NameSpacedFunctionArn": { @@ -1349,9 +1349,9 @@ "ParallelizationFactor": { "base": null, "refs": { - "CreateEventSourceMappingRequest$ParallelizationFactor": "(Streams) The number of batches to process from each shard concurrently.
", - "EventSourceMappingConfiguration$ParallelizationFactor": "(Streams) The number of batches to process from each shard concurrently. The default value is 1.
", - "UpdateEventSourceMappingRequest$ParallelizationFactor": "(Streams) The number of batches to process from each shard concurrently.
" + "CreateEventSourceMappingRequest$ParallelizationFactor": "(Streams only) The number of batches to process from each shard concurrently.
", + "EventSourceMappingConfiguration$ParallelizationFactor": "(Streams only) The number of batches to process from each shard concurrently. The default value is 1.
", + "UpdateEventSourceMappingRequest$ParallelizationFactor": "(Streams only) The number of batches to process from each shard concurrently.
" } }, "PolicyLengthExceededException": { @@ -1376,7 +1376,7 @@ "Principal": { "base": null, "refs": { - "AddPermissionRequest$Principal": "The AWS service or account that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.
The Amazon Web Services service or account that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.
An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
", + "FunctionCode$S3Bucket": "An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.
", "LayerVersionContentInput$S3Bucket": "The Amazon S3 bucket of the layer archive.
", - "UpdateFunctionCodeRequest$S3Bucket": "An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
" + "UpdateFunctionCodeRequest$S3Bucket": "An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.
" } }, "S3Key": { @@ -1601,7 +1601,7 @@ } }, "ServiceException": { - "base": "The AWS Lambda service encountered an internal error.
", + "base": "The Lambda service encountered an internal error.
", "refs": { } }, @@ -1628,7 +1628,7 @@ "SourceAccessType": { "base": null, "refs": { - "SourceAccessConfiguration$Type": "The type of authentication protocol or the VPC components for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".
BASIC_AUTH - (MQ) The Secrets Manager secret that stores your broker credentials.
VPC_SUBNET - The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your Self-Managed Apache Kafka cluster.
VPC_SECURITY_GROUP - The VPC security group used to manage access to your Self-Managed Apache Kafka brokers.
SASL_SCRAM_256_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your Self-Managed Apache Kafka brokers.
SASL_SCRAM_512_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your Self-Managed Apache Kafka brokers.
The type of authentication protocol or the VPC components for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".
BASIC_AUTH - (MQ) The Secrets Manager secret that stores your broker credentials.
VPC_SUBNET - The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your Self-Managed Apache Kafka cluster.
VPC_SECURITY_GROUP - The VPC security group used to manage access to your Self-Managed Apache Kafka brokers.
SASL_SCRAM_256_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your Self-Managed Apache Kafka brokers.
SASL_SCRAM_512_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your Self-Managed Apache Kafka brokers.
VIRTUAL_HOST - The name of the virtual host in your RabbitMQ broker. Lambda will use this host as the event source.
The error code.
", "EventSourceMappingConfiguration$UUID": "The identifier of the event source mapping.
", - "EventSourceMappingConfiguration$LastProcessingResult": "The result of the last AWS Lambda invocation of your Lambda function.
", + "EventSourceMappingConfiguration$LastProcessingResult": "The result of the last Lambda invocation of your Lambda function.
", "EventSourceMappingConfiguration$State": "The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.
Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
", - "FunctionCode$ImageUri": "URI of a container image in the Amazon ECR registry.
", + "FunctionCode$ImageUri": "URI of a container image in the Amazon ECR registry.
", "FunctionCodeLocation$RepositoryType": "The service that's hosting the file.
", "FunctionCodeLocation$Location": "A presigned URL that you can use to download the deployment package.
", "FunctionCodeLocation$ImageUri": "URI of a container image in the Amazon ECR registry.
", @@ -1811,7 +1811,7 @@ } }, "SubnetIPAddressLimitReachedException": { - "base": "AWS Lambda was not able to set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.
", + "base": "Lambda was not able to set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.
", "refs": { } }, @@ -1870,9 +1870,9 @@ "Timeout": { "base": null, "refs": { - "CreateFunctionRequest$Timeout": "The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.
", + "CreateFunctionRequest$Timeout": "The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For additional information, see Lambda execution environment.
", "FunctionConfiguration$Timeout": "The amount of time in seconds that Lambda allows a function to run before stopping it.
", - "UpdateFunctionConfigurationRequest$Timeout": "The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.
" + "UpdateFunctionConfigurationRequest$Timeout": "The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For additional information, see Lambda execution environment.
" } }, "Timestamp": { @@ -1907,16 +1907,16 @@ } }, "TracingConfig": { - "base": "The function's AWS X-Ray tracing configuration. To sample and record incoming requests, set Mode to Active.
The function's X-Ray tracing configuration. To sample and record incoming requests, set Mode to Active.
Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.
Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.
Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.
Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.
The function's AWS X-Ray tracing configuration.
", + "base": "The function's X-Ray tracing configuration.
", "refs": { - "FunctionConfiguration$TracingConfig": "The function's AWS X-Ray tracing configuration.
" + "FunctionConfiguration$TracingConfig": "The function's X-Ray tracing configuration.
" } }, "TracingMode": { @@ -1929,9 +1929,9 @@ "TumblingWindowInSeconds": { "base": null, "refs": { - "CreateEventSourceMappingRequest$TumblingWindowInSeconds": "(Streams) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
", - "EventSourceMappingConfiguration$TumblingWindowInSeconds": "(Streams) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
", - "UpdateEventSourceMappingRequest$TumblingWindowInSeconds": "(Streams) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
" + "CreateEventSourceMappingRequest$TumblingWindowInSeconds": "(Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
", + "EventSourceMappingConfiguration$TumblingWindowInSeconds": "(Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
", + "UpdateEventSourceMappingRequest$TumblingWindowInSeconds": "(Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
" } }, "URI": { @@ -2005,8 +2005,8 @@ "VpcConfig": { "base": "The VPC security groups and subnets that are attached to a Lambda function. For more information, see VPC Settings.
", "refs": { - "CreateFunctionRequest$VpcConfig": "For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
", - "UpdateFunctionConfigurationRequest$VpcConfig": "For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
" + "CreateFunctionRequest$VpcConfig": "For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
", + "UpdateFunctionConfigurationRequest$VpcConfig": "For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
" } }, "VpcConfigResponse": { diff --git a/models/apis/lambda/2015-03-31/examples-1.json b/models/apis/lambda/2015-03-31/examples-1.json index a60fc3bd040..0ea7e3b0bbe 100644 --- a/models/apis/lambda/2015-03-31/examples-1.json +++ b/models/apis/lambda/2015-03-31/examples-1.json @@ -1,1513 +1,5 @@ { "version": "1.0", "examples": { - "AddLayerVersionPermission": [ - { - "input": { - "Action": "lambda:GetLayerVersion", - "LayerName": "my-layer", - "Principal": "223456789012", - "StatementId": "xaccount", - "VersionNumber": 1 - }, - "output": { - "RevisionId": "35d87451-f796-4a3f-a618-95a3671b0a0c", - "Statement": "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:GetLayerVersion\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1\"}" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example grants permission for the account 223456789012 to use version 1 of a layer named my-layer.", - "id": "to-add-permissions-to-a-layer-version-1586479797163", - "title": "To add permissions to a layer version" - } - ], - "AddPermission": [ - { - "input": { - "Action": "lambda:InvokeFunction", - "FunctionName": "my-function", - "Principal": "s3.amazonaws.com", - "SourceAccount": "123456789012", - "SourceArn": "arn:aws:s3:::my-bucket-1xpuxmplzrlbh/*", - "StatementId": "s3" - }, - "output": { - "Statement": "{\"Sid\":\"s3\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"s3.amazonaws.com\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\",\"Condition\":{\"StringEquals\":{\"AWS:SourceAccount\":\"123456789012\"},\"ArnLike\":{\"AWS:SourceArn\":\"arn:aws:s3:::my-bucket-1xpuxmplzrlbh\"}}}" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example adds permission for Amazon S3 to invoke a Lambda function named my-function for notifications from a bucket named my-bucket-1xpuxmplzrlbh in account 123456789012.", - "id": "add-permission-1474651469455", - "title": "To grant Amazon S3 permission to invoke a function" - }, - { - "input": { - "Action": "lambda:InvokeFunction", - "FunctionName": "my-function", - "Principal": "223456789012", - "StatementId": "xaccount" - }, - "output": { - "Statement": "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\"}" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example adds permission for account 223456789012 invoke a Lambda function named my-function.", - "id": "add-permission-1474651469456", - "title": "To grant another account permission to invoke a function" - } - ], - "CreateAlias": [ - { - "input": { - "Description": "alias for live version of function", - "FunctionName": "my-function", - "FunctionVersion": "1", - "Name": "LIVE" - }, - "output": { - "AliasArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:LIVE", - "Description": "alias for live version of function", - "FunctionVersion": "1", - "Name": "LIVE", - "RevisionId": "873282ed-xmpl-4dc8-a069-d0c647e470c6" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example creates an alias named LIVE that points to version 1 of the my-function Lambda function.", - "id": "to-create-an-alias-for-a-lambda-function-1586480324259", - "title": "To create an alias for a Lambda function" - } - ], - "CreateEventSourceMapping": [ - { - "input": { - "BatchSize": 5, - "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:my-queue", - "FunctionName": "my-function" - }, - "output": { - "BatchSize": 5, - "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:my-queue", - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "LastModified": 1569284520.333, - "State": "Creating", - "StateTransitionReason": "USER_INITIATED", - "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example creates a mapping between an SQS queue and the my-function Lambda function.", - "id": "to-create-a-mapping-between-an-event-source-and-an-aws-lambda-function-1586480555467", - "title": "To create a mapping between an event source and an AWS Lambda function" - } - ], - "CreateFunction": [ - { - "input": { - "Code": { - "S3Bucket": "my-bucket-1xpuxmplzrlbh", - "S3Key": "function.zip" - }, - "Description": "Process image objects from Amazon S3.", - "Environment": { - "Variables": { - "BUCKET": "my-bucket-1xpuxmplzrlbh", - "PREFIX": "inbound" - } - }, - "FunctionName": "my-function", - "Handler": "index.handler", - "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", - "MemorySize": 256, - "Publish": true, - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "Tags": { - "DEPARTMENT": "Assets" - }, - "Timeout": 15, - "TracingConfig": { - "Mode": "Active" - } - }, - "output": { - "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", - "CodeSize": 5797206, - "Description": "Process image objects from Amazon S3.", - "Environment": { - "Variables": { - "BUCKET": "my-bucket-1xpuxmplzrlbh", - "PREFIX": "inbound" - } - }, - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", - "LastModified": "2020-04-10T19:06:32.563+0000", - "LastUpdateStatus": "Successful", - "MemorySize": 256, - "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "State": "Active", - "Timeout": 15, - "TracingConfig": { - "Mode": "Active" - }, - "Version": "1" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example creates a function with a deployment package in Amazon S3 and enables X-Ray tracing and environment variable encryption.", - "id": "to-create-a-function-1586492061186", - "title": "To create a function" - } - ], - "DeleteAlias": [ - { - "input": { - "FunctionName": "my-function", - "Name": "BLUE" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example deletes an alias named BLUE from a function named my-function", - "id": "to-delete-a-lambda-function-alias-1481660370804", - "title": "To delete a Lambda function alias" - } - ], - "DeleteEventSourceMapping": [ - { - "input": { - "UUID": "14e0db71-xmpl-4eb5-b481-8945cf9d10c2" - }, - "output": { - "BatchSize": 5, - "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:my-queue", - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function", - "LastModified": "${timestamp}", - "State": "Enabled", - "StateTransitionReason": "USER_INITIATED", - "UUID": "14e0db71-xmpl-4eb5-b481-8945cf9d10c2" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example deletes an event source mapping. To get a mapping's UUID, use ListEventSourceMappings.", - "id": "to-delete-a-lambda-function-event-source-mapping-1481658973862", - "title": "To delete a Lambda function event source mapping" - } - ], - "DeleteFunction": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "1" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example deletes version 1 of a Lambda function named my-function.", - "id": "to-delete-a-lambda-function-1481648553696", - "title": "To delete a version of a Lambda function" - } - ], - "DeleteFunctionConcurrency": [ - { - "input": { - "FunctionName": "my-function" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example deletes the reserved concurrent execution limit from a function named my-function.", - "id": "to-remove-the-reserved-concurrent-execution-limit-from-a-function-1586480714680", - "title": "To remove the reserved concurrent execution limit from a function" - } - ], - "DeleteFunctionEventInvokeConfig": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "GREEN" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example deletes the asynchronous invocation configuration for the GREEN alias of a function named my-function.", - "id": "to-delete-an-asynchronous-invocation-configuration-1586481102187", - "title": "To delete an asynchronous invocation configuration" - } - ], - "DeleteLayerVersion": [ - { - "input": { - "LayerName": "my-layer", - "VersionNumber": 2 - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example deletes version 2 of a layer named my-layer.", - "id": "to-delete-a-version-of-a-lambda-layer-1586481157547", - "title": "To delete a version of a Lambda layer" - } - ], - "DeleteProvisionedConcurrencyConfig": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "GREEN" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example deletes the provisioned concurrency configuration for the GREEN alias of a function named my-function.", - "id": "to-delete-a-provisioned-concurrency-configuration-1586481032551", - "title": "To delete a provisioned concurrency configuration" - } - ], - "GetAccountSettings": [ - { - "input": { - }, - "output": { - "AccountLimit": { - "CodeSizeUnzipped": 262144000, - "CodeSizeZipped": 52428800, - "ConcurrentExecutions": 1000, - "TotalCodeSize": 80530636800, - "UnreservedConcurrentExecutions": 1000 - }, - "AccountUsage": { - "FunctionCount": 4, - "TotalCodeSize": 9426 - } - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "This operation takes no parameters and returns details about storage and concurrency quotas in the current Region.", - "id": "to-get-account-settings-1481657495274", - "title": "To get account settings" - } - ], - "GetAlias": [ - { - "input": { - "FunctionName": "my-function", - "Name": "BLUE" - }, - "output": { - "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE", - "Description": "Production environment BLUE.", - "FunctionVersion": "3", - "Name": "BLUE", - "RevisionId": "594f41fb-xmpl-4c20-95c7-6ca5f2a92c93" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns details about an alias named BLUE for a function named my-function", - "id": "to-retrieve-a-lambda-function-alias-1481648742254", - "title": "To get a Lambda function alias" - } - ], - "GetEventSourceMapping": [ - { - "input": { - "UUID": "14e0db71-xmpl-4eb5-b481-8945cf9d10c2" - }, - "output": { - "BatchSize": 500, - "BisectBatchOnFunctionError": false, - "DestinationConfig": { - }, - "EventSourceArn": "arn:aws:sqs:us-east-2:123456789012:mySQSqueue", - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:myFunction", - "LastModified": "${timestamp}", - "LastProcessingResult": "No records processed", - "MaximumRecordAgeInSeconds": 604800, - "MaximumRetryAttempts": 10000, - "State": "Creating", - "StateTransitionReason": "User action", - "UUID": "14e0db71-xmpl-4eb5-b481-8945cf9d10c2" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns details about an event source mapping. To get a mapping's UUID, use ListEventSourceMappings.", - "id": "to-get-a-lambda-functions-event-source-mapping-1481661622799", - "title": "To get a Lambda function's event source mapping" - } - ], - "GetFunction": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "1" - }, - "output": { - "Code": { - "Location": "https://awslambda-us-west-2-tasks.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-function-e7d9d1ed-xmpl-4f79-904a-4b87f2681f30?versionId=sH3TQwBOaUy...", - "RepositoryType": "S3" - }, - "Configuration": { - "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", - "CodeSize": 5797206, - "Description": "Process image objects from Amazon S3.", - "Environment": { - "Variables": { - "BUCKET": "my-bucket-1xpuxmplzrlbh", - "PREFIX": "inbound" - } - }, - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", - "LastModified": "2020-04-10T19:06:32.563+0000", - "LastUpdateStatus": "Successful", - "MemorySize": 256, - "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "State": "Active", - "Timeout": 15, - "TracingConfig": { - "Mode": "Active" - }, - "Version": "$LATEST" - }, - "Tags": { - "DEPARTMENT": "Assets" - } - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns code and configuration details for version 1 of a function named my-function.", - "id": "to-get-a-lambda-function-1481661622799", - "title": "To get a Lambda function" - } - ], - "GetFunctionConcurrency": [ - { - "input": { - "FunctionName": "my-function" - }, - "output": { - "ReservedConcurrentExecutions": 250 - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns the reserved concurrency setting for a function named my-function.", - "id": "to-get-the-reserved-concurrency-setting-for-a-function-1586481279992", - "title": "To get the reserved concurrency setting for a function" - } - ], - "GetFunctionConfiguration": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "1" - }, - "output": { - "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", - "CodeSize": 5797206, - "Description": "Process image objects from Amazon S3.", - "Environment": { - "Variables": { - "BUCKET": "my-bucket-1xpuxmplzrlbh", - "PREFIX": "inbound" - } - }, - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", - "LastModified": "2020-04-10T19:06:32.563+0000", - "LastUpdateStatus": "Successful", - "MemorySize": 256, - "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "State": "Active", - "Timeout": 15, - "TracingConfig": { - "Mode": "Active" - }, - "Version": "$LATEST" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns and configuration details for version 1 of a function named my-function.", - "id": "to-get-a-lambda-functions-event-source-mapping-1481661622799", - "title": "To get a Lambda function's event source mapping" - } - ], - "GetFunctionEventInvokeConfig": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "BLUE" - }, - "output": { - "DestinationConfig": { - "OnFailure": { - "Destination": "arn:aws:sqs:us-east-2:123456789012:failed-invocations" - }, - "OnSuccess": { - } - }, - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", - "LastModified": "${timestamp}", - "MaximumEventAgeInSeconds": 3600, - "MaximumRetryAttempts": 0 - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns the asynchronous invocation configuration for the BLUE alias of a function named my-function.", - "id": "to-get-an-asynchronous-invocation-configuration-1586481338463", - "title": "To get an asynchronous invocation configuration" - } - ], - "GetLayerVersion": [ - { - "input": { - "LayerName": "my-layer", - "VersionNumber": 1 - }, - "output": { - "CompatibleRuntimes": [ - "python3.6", - "python3.7" - ], - "Content": { - "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", - "CodeSize": 169, - "Location": "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH..." - }, - "CreatedDate": "2018-11-14T23:03:52.894+0000", - "Description": "My Python layer", - "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", - "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1", - "LicenseInfo": "MIT", - "Version": 1 - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns information for version 1 of a layer named my-layer.", - "id": "to-get-information-about-a-lambda-layer-version-1586481457839", - "title": "To get information about a Lambda layer version" - } - ], - "GetLayerVersionByArn": [ - { - "input": { - "Arn": "arn:aws:lambda:ca-central-1:123456789012:layer:blank-python-lib:3" - }, - "output": { - "CompatibleRuntimes": [ - "python3.8" - ], - "Content": { - "CodeSha256": "6x+xmpl/M3BnQUk7gS9sGmfeFsR/npojXoA3fZUv4eU=", - "CodeSize": 9529009, - "Location": "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/blank-python-lib-e5212378-xmpl-44ee-8398-9d8ec5113949?versionId=WbZnvf..." - }, - "CreatedDate": "2020-03-31T00:35:18.949+0000", - "Description": "Dependencies for the blank-python sample app.", - "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib", - "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib:3", - "Version": 3 - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns information about the layer version with the specified Amazon Resource Name (ARN).", - "id": "to-get-information-about-a-lambda-layer-version-1586481457839", - "title": "To get information about a Lambda layer version" - } - ], - "GetPolicy": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "1" - }, - "output": { - "Policy": "{\"Version\":\"2012-10-17\",\"Id\":\"default\",\"Statement\":[{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function:1\"}]}", - "RevisionId": "4843f2f6-7c59-4fda-b484-afd0bc0e22b8" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns the resource-based policy for version 1 of a Lambda function named my-function.", - "id": "to-retrieve-a-lambda-function-policy-1481649319053", - "title": "To retrieve a Lambda function policy" - } - ], - "GetProvisionedConcurrencyConfig": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "BLUE" - }, - "output": { - "AllocatedProvisionedConcurrentExecutions": 100, - "AvailableProvisionedConcurrentExecutions": 100, - "LastModified": "2019-12-31T20:28:49+0000", - "RequestedProvisionedConcurrentExecutions": 100, - "Status": "READY" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns details for the provisioned concurrency configuration for the BLUE alias of the specified function.", - "id": "to-get-a-provisioned-concurrency-configuration-1586490192690", - "title": "To get a provisioned concurrency configuration" - }, - { - "input": { - "FunctionName": "my-function", - "Qualifier": "BLUE" - }, - "output": { - "AllocatedProvisionedConcurrentExecutions": 100, - "AvailableProvisionedConcurrentExecutions": 100, - "LastModified": "2019-12-31T20:28:49+0000", - "RequestedProvisionedConcurrentExecutions": 100, - "Status": "READY" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example displays details for the provisioned concurrency configuration for the BLUE alias of the specified function.", - "id": "to-view-a-provisioned-concurrency-configuration-1586490192690", - "title": "To view a provisioned concurrency configuration" - } - ], - "Invoke": [ - { - "input": { - "FunctionName": "my-function", - "Payload": "{}", - "Qualifier": "1" - }, - "output": { - "Payload": "200 SUCCESS", - "StatusCode": 200 - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example invokes version 1 of a function named my-function with an empty event payload.", - "id": "to-invoke-a-lambda-function-1481659683915", - "title": "To invoke a Lambda function" - }, - { - "input": { - "FunctionName": "my-function", - "InvocationType": "Event", - "Payload": "{}", - "Qualifier": "1" - }, - "output": { - "Payload": "", - "StatusCode": 202 - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example invokes version 1 of a function named my-function asynchronously.", - "id": "to-invoke-a-lambda-function-async-1481659683915", - "title": "To invoke a Lambda function asynchronously" - } - ], - "InvokeAsync": [ - { - "input": { - "FunctionName": "my-function", - "InvokeArgs": "{}" - }, - "output": { - "Status": 202 - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example invokes a Lambda function asynchronously", - "id": "to-invoke-a-lambda-function-asynchronously-1481649694923", - "title": "To invoke a Lambda function asynchronously" - } - ], - "ListAliases": [ - { - "input": { - "FunctionName": "my-function" - }, - "output": { - "Aliases": [ - { - "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BETA", - "Description": "Production environment BLUE.", - "FunctionVersion": "2", - "Name": "BLUE", - "RevisionId": "a410117f-xmpl-494e-8035-7e204bb7933b", - "RoutingConfig": { - "AdditionalVersionWeights": { - "1": 0.7 - } - } - }, - { - "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", - "Description": "Production environment GREEN.", - "FunctionVersion": "1", - "Name": "GREEN", - "RevisionId": "21d40116-xmpl-40ba-9360-3ea284da1bb5" - } - ] - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns a list of aliases for a function named my-function.", - "id": "to-list-a-functions-aliases-1481650199732", - "title": "To list a function's aliases" - } - ], - "ListEventSourceMappings": [ - { - "input": { - "FunctionName": "my-function" - }, - "output": { - "EventSourceMappings": [ - { - "BatchSize": 5, - "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue", - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "LastModified": 1569284520.333, - "State": "Enabled", - "StateTransitionReason": "USER_INITIATED", - "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" - } - ] - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns a list of the event source mappings for a function named my-function.", - "id": "to-list-the-event-source-mappings-for-a-function-1586490285906", - "title": "To list the event source mappings for a function" - } - ], - "ListFunctionEventInvokeConfigs": [ - { - "input": { - "FunctionName": "my-function" - }, - "output": { - "FunctionEventInvokeConfigs": [ - { - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", - "LastModified": 1577824406.719, - "MaximumEventAgeInSeconds": 1800, - "MaximumRetryAttempts": 2 - }, - { - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", - "LastModified": 1577824396.653, - "MaximumEventAgeInSeconds": 3600, - "MaximumRetryAttempts": 0 - } - ] - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns a list of asynchronous invocation configurations for a function named my-function.", - "id": "to-view-a-list-of-asynchronous-invocation-configurations-1586490355611", - "title": "To view a list of asynchronous invocation configurations" - } - ], - "ListFunctions": [ - { - "input": { - }, - "output": { - "Functions": [ - { - "CodeSha256": "dBG9m8SGdmlEjw/JYXlhhvCrAv5TxvXsbL/RMr0fT/I=", - "CodeSize": 294, - "Description": "", - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:helloworld", - "FunctionName": "helloworld", - "Handler": "helloworld.handler", - "LastModified": "2019-09-23T18:32:33.857+0000", - "MemorySize": 128, - "RevisionId": "1718e831-badf-4253-9518-d0644210af7b", - "Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4", - "Runtime": "nodejs10.x", - "Timeout": 3, - "TracingConfig": { - "Mode": "PassThrough" - }, - "Version": "$LATEST" - }, - { - "CodeSha256": "sU0cJ2/hOZevwV/lTxCuQqK3gDZP3i8gUoqUUVRmY6E=", - "CodeSize": 266, - "Description": "", - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "LastModified": "2019-10-01T16:47:28.490+0000", - "MemorySize": 256, - "RevisionId": "93017fc9-59cb-41dc-901b-4845ce4bf668", - "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", - "Runtime": "nodejs10.x", - "Timeout": 3, - "TracingConfig": { - "Mode": "PassThrough" - }, - "Version": "$LATEST", - "VpcConfig": { - "SecurityGroupIds": [ - - ], - "SubnetIds": [ - - ], - "VpcId": "" - } - } - ], - "NextMarker": "" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "This operation returns a list of Lambda functions.", - "id": "to-get-a-list-of-lambda-functions-1481650507425", - "title": "To get a list of Lambda functions" - } - ], - "ListLayerVersions": [ - { - "input": { - "LayerName": "blank-java-lib" - }, - "output": { - "LayerVersions": [ - { - "CompatibleRuntimes": [ - "java8" - ], - "CreatedDate": "2020-03-18T23:38:42.284+0000", - "Description": "Dependencies for the blank-java sample app.", - "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-java-lib:7", - "Version": 7 - }, - { - "CompatibleRuntimes": [ - "java8" - ], - "CreatedDate": "2020-03-17T07:24:21.960+0000", - "Description": "Dependencies for the blank-java sample app.", - "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-java-lib:6", - "Version": 6 - } - ] - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example displays information about the versions for the layer named blank-java-lib", - "id": "to-list-versions-of-a-layer-1586490857297", - "title": "To list versions of a layer" - } - ], - "ListLayers": [ - { - "input": { - "CompatibleRuntime": "python3.7" - }, - "output": { - "Layers": [ - { - "LatestMatchingVersion": { - "CompatibleRuntimes": [ - "python3.6", - "python3.7" - ], - "CreatedDate": "2018-11-15T00:37:46.592+0000", - "Description": "My layer", - "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:2", - "Version": 2 - }, - "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", - "LayerName": "my-layer" - } - ] - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns information about layers that are compatible with the Python 3.7 runtime.", - "id": "to-list-the-layers-that-are-compatible-with-your-functions-runtime-1586490857297", - "title": "To list the layers that are compatible with your function's runtime" - } - ], - "ListProvisionedConcurrencyConfigs": [ - { - "input": { - "FunctionName": "my-function" - }, - "output": { - "ProvisionedConcurrencyConfigs": [ - { - "AllocatedProvisionedConcurrentExecutions": 100, - "AvailableProvisionedConcurrentExecutions": 100, - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", - "LastModified": "2019-12-31T20:29:00+0000", - "RequestedProvisionedConcurrentExecutions": 100, - "Status": "READY" - }, - { - "AllocatedProvisionedConcurrentExecutions": 100, - "AvailableProvisionedConcurrentExecutions": 100, - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", - "LastModified": "2019-12-31T20:28:49+0000", - "RequestedProvisionedConcurrentExecutions": 100, - "Status": "READY" - } - ] - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns a list of provisioned concurrency configurations for a function named my-function.", - "id": "to-get-a-list-of-provisioned-concurrency-configurations-1586491032592", - "title": "To get a list of provisioned concurrency configurations" - } - ], - "ListTags": [ - { - "input": { - "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function" - }, - "output": { - "Tags": { - "Category": "Web Tools", - "Department": "Sales" - } - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example displays the tags attached to the my-function Lambda function.", - "id": "to-retrieve-the-list-of-tags-for-a-lambda-function-1586491111498", - "title": "To retrieve the list of tags for a Lambda function" - } - ], - "ListVersionsByFunction": [ - { - "input": { - "FunctionName": "my-function" - }, - "output": { - "Versions": [ - { - "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", - "CodeSize": 5797206, - "Description": "Process image objects from Amazon S3.", - "Environment": { - "Variables": { - "BUCKET": "my-bucket-1xpuxmplzrlbh", - "PREFIX": "inbound" - } - }, - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", - "LastModified": "2020-04-10T19:06:32.563+0000", - "MemorySize": 256, - "RevisionId": "850ca006-2d98-4ff4-86db-8766e9d32fe9", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "Timeout": 15, - "TracingConfig": { - "Mode": "Active" - }, - "Version": "$LATEST" - }, - { - "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", - "CodeSize": 5797206, - "Description": "Process image objects from Amazon S3.", - "Environment": { - "Variables": { - "BUCKET": "my-bucket-1xpuxmplzrlbh", - "PREFIX": "inbound" - } - }, - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", - "LastModified": "2020-04-10T19:06:32.563+0000", - "MemorySize": 256, - "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "Timeout": 5, - "TracingConfig": { - "Mode": "Active" - }, - "Version": "1" - } - ] - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example returns a list of versions of a function named my-function", - "id": "to-list-versions-1481650603750", - "title": "To list versions of a function" - } - ], - "PublishLayerVersion": [ - { - "input": { - "CompatibleRuntimes": [ - "python3.6", - "python3.7" - ], - "Content": { - "S3Bucket": "lambda-layers-us-west-2-123456789012", - "S3Key": "layer.zip" - }, - "Description": "My Python layer", - "LayerName": "my-layer", - "LicenseInfo": "MIT" - }, - "output": { - "CompatibleRuntimes": [ - "python3.6", - "python3.7" - ], - "Content": { - "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", - "CodeSize": 169, - "Location": "https://awslambda-us-west-2-layers.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH..." - }, - "CreatedDate": "2018-11-14T23:03:52.894+0000", - "Description": "My Python layer", - "LayerArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer", - "LayerVersionArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer:1", - "LicenseInfo": "MIT", - "Version": 1 - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example creates a new Python library layer version. The command retrieves the layer content a file named layer.zip in the specified S3 bucket.", - "id": "to-create-a-lambda-layer-version-1586491213595", - "title": "To create a Lambda layer version" - } - ], - "PublishVersion": [ - { - "input": { - "CodeSha256": "", - "Description": "", - "FunctionName": "myFunction" - }, - "output": { - "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", - "CodeSize": 5797206, - "Description": "Process image objects from Amazon S3.", - "Environment": { - "Variables": { - "BUCKET": "my-bucket-1xpuxmplzrlbh", - "PREFIX": "inbound" - } - }, - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", - "LastModified": "2020-04-10T19:06:32.563+0000", - "LastUpdateStatus": "Successful", - "MemorySize": 256, - "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "State": "Active", - "Timeout": 5, - "TracingConfig": { - "Mode": "Active" - }, - "Version": "1" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "This operation publishes a version of a Lambda function", - "id": "to-publish-a-version-of-a-lambda-function-1481650704986", - "title": "To publish a version of a Lambda function" - } - ], - "PutFunctionConcurrency": [ - { - "input": { - "FunctionName": "my-function", - "ReservedConcurrentExecutions": 100 - }, - "output": { - "ReservedConcurrentExecutions": 100 - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example configures 100 reserved concurrent executions for the my-function function.", - "id": "to-configure-a-reserved-concurrency-limit-for-a-function-1586491405956", - "title": "To configure a reserved concurrency limit for a function" - } - ], - "PutFunctionEventInvokeConfig": [ - { - "input": { - "FunctionName": "my-function", - "MaximumEventAgeInSeconds": 3600, - "MaximumRetryAttempts": 0 - }, - "output": { - "DestinationConfig": { - "OnFailure": { - }, - "OnSuccess": { - } - }, - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST", - "LastModified": "${timestamp}", - "MaximumEventAgeInSeconds": 3600, - "MaximumRetryAttempts": 0 - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example sets a maximum event age of one hour and disables retries for the specified function.", - "id": "to-configure-error-handling-for-asynchronous-invocation-1586491524021", - "title": "To configure error handling for asynchronous invocation" - } - ], - "PutProvisionedConcurrencyConfig": [ - { - "input": { - "FunctionName": "my-function", - "ProvisionedConcurrentExecutions": 100, - "Qualifier": "BLUE" - }, - "output": { - "AllocatedProvisionedConcurrentExecutions": 0, - "LastModified": "2019-11-21T19:32:12+0000", - "RequestedProvisionedConcurrentExecutions": 100, - "Status": "IN_PROGRESS" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example allocates 100 provisioned concurrency for the BLUE alias of the specified function.", - "id": "to-allocate-provisioned-concurrency-1586491651377", - "title": "To allocate provisioned concurrency" - } - ], - "RemoveLayerVersionPermission": [ - { - "input": { - "LayerName": "my-layer", - "StatementId": "xaccount", - "VersionNumber": 1 - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example deletes permission for an account to configure a layer version.", - "id": "to-delete-layer-version-permissions-1586491829416", - "title": "To delete layer-version permissions" - } - ], - "RemovePermission": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "PROD", - "StatementId": "xaccount" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example removes a permissions statement named xaccount from the PROD alias of a function named my-function.", - "id": "to-remove-a-lambda-functions-permissions-1481661337021", - "title": "To remove a Lambda function's permissions" - } - ], - "TagResource": [ - { - "input": { - "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "Tags": { - "DEPARTMENT": "Department A" - } - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example adds a tag with the key name DEPARTMENT and a value of 'Department A' to the specified Lambda function.", - "id": "to-add-tags-to-an-existing-lambda-function-1586491890446", - "title": "To add tags to an existing Lambda function" - } - ], - "UntagResource": [ - { - "input": { - "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "TagKeys": [ - "DEPARTMENT" - ] - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example removes the tag with the key name DEPARTMENT tag from the my-function Lambda function.", - "id": "to-remove-tags-from-an-existing-lambda-function-1586491956425", - "title": "To remove tags from an existing Lambda function" - } - ], - "UpdateAlias": [ - { - "input": { - "FunctionName": "my-function", - "FunctionVersion": "2", - "Name": "BLUE", - "RoutingConfig": { - "AdditionalVersionWeights": { - "1": 0.7 - } - } - }, - "output": { - "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE", - "Description": "Production environment BLUE.", - "FunctionVersion": "2", - "Name": "BLUE", - "RevisionId": "594f41fb-xmpl-4c20-95c7-6ca5f2a92c93", - "RoutingConfig": { - "AdditionalVersionWeights": { - "1": 0.7 - } - } - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example updates the alias named BLUE to send 30% of traffic to version 2 and 70% to version 1.", - "id": "to-update-a-function-alias-1481650817950", - "title": "To update a function alias" - } - ], - "UpdateEventSourceMapping": [ - { - "input": { - "BatchSize": 123, - "Enabled": true, - "FunctionName": "myFunction", - "UUID": "1234xCy789012" - }, - "output": { - "BatchSize": 123, - "EventSourceArn": "arn:aws:s3:::examplebucket/*", - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", - "LastModified": "2016-11-21T19:49:20.006+0000", - "LastProcessingResult": "", - "State": "", - "StateTransitionReason": "", - "UUID": "1234xCy789012" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "This operation updates a Lambda function event source mapping", - "id": "to-update-a-lambda-function-event-source-mapping-1481650907413", - "title": "To update a Lambda function event source mapping" - } - ], - "UpdateFunctionCode": [ - { - "input": { - "FunctionName": "my-function", - "S3Bucket": "my-bucket-1xpuxmplzrlbh", - "S3Key": "function.zip" - }, - "output": { - "CodeSha256": "PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=", - "CodeSize": 308, - "Description": "", - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "LastModified": "2019-08-14T22:26:11.234+0000", - "MemorySize": 128, - "RevisionId": "873282ed-xmpl-4dc8-a069-d0c647e470c6", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "Timeout": 3, - "TracingConfig": { - "Mode": "PassThrough" - }, - "Version": "$LATEST" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example replaces the code of the unpublished ($LATEST) version of a function named my-function with the contents of the specified zip file in Amazon S3.", - "id": "to-update-a-lambda-functions-code-1481650992672", - "title": "To update a Lambda function's code" - } - ], - "UpdateFunctionConfiguration": [ - { - "input": { - "FunctionName": "my-function", - "MemorySize": 256 - }, - "output": { - "CodeSha256": "PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=", - "CodeSize": 308, - "Description": "", - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "LastModified": "2019-08-14T22:26:11.234+0000", - "MemorySize": 256, - "RevisionId": "873282ed-xmpl-4dc8-a069-d0c647e470c6", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "Timeout": 3, - "TracingConfig": { - "Mode": "PassThrough" - }, - "Version": "$LATEST" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example modifies the memory size to be 256 MB for the unpublished ($LATEST) version of a function named my-function.", - "id": "to-update-a-lambda-functions-configuration-1481651096447", - "title": "To update a Lambda function's configuration" - } - ], - "UpdateFunctionEventInvokeConfig": [ - { - "input": { - "DestinationConfig": { - "OnFailure": { - "Destination": "arn:aws:sqs:us-east-2:123456789012:destination" - } - }, - "FunctionName": "my-function" - }, - "output": { - "DestinationConfig": { - "OnFailure": { - "Destination": "arn:aws:sqs:us-east-2:123456789012:destination" - }, - "OnSuccess": { - } - }, - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST", - "LastModified": 1573687896.493, - "MaximumEventAgeInSeconds": 3600, - "MaximumRetryAttempts": 0 - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "The following example adds an on-failure destination to the existing asynchronous invocation configuration for a function named my-function.", - "id": "to-update-an-asynchronous-invocation-configuration-1586492061186", - "title": "To update an asynchronous invocation configuration" - } - ] } } diff --git a/models/apis/macie2/2020-01-01/docs-2.json b/models/apis/macie2/2020-01-01/docs-2.json index 783d4b9d859..906a96796f5 100644 --- a/models/apis/macie2/2020-01-01/docs-2.json +++ b/models/apis/macie2/2020-01-01/docs-2.json @@ -1,6 +1,6 @@ { "version" : "2.0", - "service" : "Amazon Macie is a fully managed data security and data privacy service that uses machine learning and pattern matching to discover and protect your sensitive data in AWS. Macie automates the discovery of sensitive data, such as PII and intellectual property, to provide you with insight into the data that your organization stores in AWS. Macie also provides an inventory of your Amazon S3 buckets, which it continually monitors foryou. If Macie detects sensitive data or potential data access issues, it generates detailed findings for you to review and act upon as necessary.
", + "service" : "Amazon Macie is a fully managed data security and data privacy service that uses machine learning and pattern matching to discover and protect your sensitive data in AWS. Macie automates the discovery of sensitive data, such as PII and intellectual property, to provide you with insight into the data that your organization stores in AWS. Macie also provides an inventory of your Amazon S3 buckets, which it continually monitors for you. If Macie detects sensitive data or potential data access issues, it generates detailed findings for you to review and act upon as necessary.
", "operations" : { "AcceptInvitation" : "Accepts an Amazon Macie membership invitation that was received from a specific account.
", "BatchGetCustomDataIdentifiers" : "Retrieves information about one or more custom data identifiers.
", @@ -9,7 +9,7 @@ "CreateFindingsFilter" : "Creates and defines the criteria and other settings for a findings filter.
", "CreateInvitations" : "Sends an Amazon Macie membership invitation to one or more accounts.
", "CreateMember" : "Associates an account with an Amazon Macie administrator account.
", - "CreateSampleFindings" : "Creates sample findings.
", + "CreateSampleFindings" : "Creates sample findings.
", "DeclineInvitations" : "Declines Amazon Macie membership invitations that were received from specific accounts.
", "DeleteCustomDataIdentifier" : "Soft deletes a custom data identifier.
", "DeleteFindingsFilter" : "Deletes a findings filter.
", @@ -17,14 +17,14 @@ "DeleteMember" : "Deletes the association between an Amazon Macie administrator account and an account.
", "DescribeBuckets" : "Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes.
", "DescribeClassificationJob" : "Retrieves the status and settings for a classification job.
", - "DescribeOrganizationConfiguration" : "Retrieves the Amazon Macie configuration settings for an AWS organization.
", + "DescribeOrganizationConfiguration" : "Retrieves the Amazon Macie configuration settings for an Amazon Web Services organization.
", "DisableMacie" : "Disables an Amazon Macie account and deletes Macie resources for the account.
", - "DisableOrganizationAdminAccount" : "Disables an account as the delegated Amazon Macie administrator account for an AWS organization.
", + "DisableOrganizationAdminAccount" : "Disables an account as the delegated Amazon Macie administrator account for an Amazon Web Services organization.
", "DisassociateFromAdministratorAccount" : "Disassociates a member account from its Amazon Macie administrator account.
", "DisassociateFromMasterAccount" : "(Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the DisassociateFromAdministratorAccount operation.
", "DisassociateMember" : "Disassociates an Amazon Macie administrator account from a member account.
", "EnableMacie" : "Enables Amazon Macie and specifies the configuration settings for a Macie account.
", - "EnableOrganizationAdminAccount" : "Designates an account as the delegated Amazon Macie administrator account for an AWS organization.
", + "EnableOrganizationAdminAccount" : "Designates an account as the delegated Amazon Macie administrator account for an Amazon Web Services organization.
", "GetAdministratorAccount" : "Retrieves information about the Amazon Macie administrator account for an account.
", "GetBucketStatistics" : "Retrieves (queries) aggregated statistical data for all the S3 buckets that Amazon Macie monitors and analyzes.
", "GetClassificationExportConfiguration" : "Retrieves the configuration settings for storing data classification results.
", @@ -32,7 +32,7 @@ "GetFindingStatistics" : "Retrieves (queries) aggregated statistical data about findings.
", "GetFindings" : "Retrieves the details of one or more findings.
", "GetFindingsFilter" : "Retrieves the criteria and other settings for a findings filter.
", - "GetFindingsPublicationConfiguration" : "Retrieves the configuration settings for publishing findings to AWS Security Hub.
", + "GetFindingsPublicationConfiguration" : "Retrieves the configuration settings for publishing findings to Security Hub.
", "GetInvitationsCount" : "Retrieves the count of Amazon Macie membership invitations that were received by an account.
", "GetMacieSession" : "Retrieves the current status and configuration settings for an Amazon Macie account.
", "GetMasterAccount" : "(Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the GetAdministratorAccount operation.
", @@ -41,15 +41,15 @@ "GetUsageTotals" : "Retrieves (queries) aggregated usage data for an account.
", "ListClassificationJobs" : "Retrieves a subset of information about one or more classification jobs.
", "ListCustomDataIdentifiers" : "Retrieves a subset of information about all the custom data identifiers for an account.
", - "ListFindings" : "Retrieves a subset of information about one or more findings.
", + "ListFindings" : "Retrieves a subset of information about one or more findings.
", "ListFindingsFilters" : "Retrieves a subset of information about all the findings filters for an account.
", "ListInvitations" : "Retrieves information about all the Amazon Macie membership invitations that were received by an account.
", "ListMembers" : "Retrieves information about the accounts that are associated with an Amazon Macie administrator account.
", - "ListOrganizationAdminAccounts" : "Retrieves information about the delegated Amazon Macie administrator account for an AWS organization.
", + "ListOrganizationAdminAccounts" : "Retrieves information about the delegated Amazon Macie administrator account for an Amazon Web Services organization.
", "ListTagsForResource" : "Retrieves the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.
", "PutClassificationExportConfiguration" : "Creates or updates the configuration settings for storing data classification results.
", - "PutFindingsPublicationConfiguration" : "Updates the configuration settings for publishing findings to AWS Security Hub.
", - "SearchResources" : "Retrieves (queries) statistical data and other information about AWS resources that Amazon Macie monitors and analyzes.
", + "PutFindingsPublicationConfiguration" : "Updates the configuration settings for publishing findings to Security Hub.
", + "SearchResources" : "Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.
", "TagResource" : "Adds or updates one or more tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.
", "TestCustomDataIdentifier" : "Tests a custom data identifier.
", "UntagResource" : "Removes one or more tags (keys and values) from a classification job, custom data identifier, findings filter, or member account.
", @@ -57,11 +57,11 @@ "UpdateFindingsFilter" : "Updates the criteria and other settings for a findings filter.
", "UpdateMacieSession" : "Suspends or re-enables an Amazon Macie account, or updates the configuration settings for a Macie account.
", "UpdateMemberSession" : "Enables an Amazon Macie administrator to suspend or re-enable a member account.
", - "UpdateOrganizationConfiguration" : "Updates the Amazon Macie configuration settings for an AWS organization.
" + "UpdateOrganizationConfiguration" : "Updates the Amazon Macie configuration settings for an Amazon Web Services organization.
" }, "shapes" : { "AcceptInvitationRequest" : { - "base" : "Specifies an Amazon Macie membership invitation to accept. In the request, you have to specify the ID for the AWS account that sent the invitation. Otherwise, a validation error occurs. To specify this ID, we recommend that you use the administratorAccountId property instead of the masterAccount property. The masterAccount property has been deprecated and is retained only for backward compatibility.
", + "base" : "Specifies an Amazon Macie membership invitation to accept. In the request, you have to specify the ID for the Amazon Web Services account that sent the invitation. Otherwise, a validation error occurs. To specify this ID, we recommend that you use the administratorAccountId property instead of the masterAccount property. The masterAccount property has been deprecated and is retained only for backward compatibility.
", "refs" : { } }, "AccessControlList" : { @@ -75,9 +75,9 @@ "refs" : { } }, "AccountDetail" : { - "base" : "Specifies details for an account to associate with an Amazon Macie administrator account.
", + "base" : "Specifies the details of an account to associate with an Amazon Macie administrator account.
", "refs" : { - "CreateMemberRequest$Account" : "The details for the account to associate with the administrator account.
" + "CreateMemberRequest$Account" : "The details of the account to associate with the administrator account.
" } }, "AccountLevelPermissions" : { @@ -87,13 +87,13 @@ } }, "AdminAccount" : { - "base" : "Provides information about the delegated Amazon Macie administrator account for an AWS organization.
", + "base" : "Provides information about the delegated Amazon Macie administrator account for an Amazon Web Services organization.
", "refs" : { "__listOfAdminAccount$member" : null } }, "AdminStatus" : { - "base" : "The current status of an account as the delegated Amazon Macie administrator account for an AWS organization. Possible values are:
", + "base" : "The current status of an account as the delegated Amazon Macie administrator account for an Amazon Web Services organization. Possible values are:
", "refs" : { "AdminAccount$Status" : "The current status of the account as the delegated administrator of Amazon Macie for the organization.
" } @@ -112,21 +112,21 @@ } }, "AssumedRole" : { - "base" : "Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the AssumeRole operation of the AWS Security Token Service (AWS STS) API.
", + "base" : "Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the AssumeRole operation of the Security Token Service (STS) API.
", "refs" : { - "UserIdentity$AssumedRole" : "If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the AWS Security Token Service (AWS STS) API, the identifiers, session context, and other details about the identity.
" + "UserIdentity$AssumedRole" : "If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.
" } }, "AwsAccount" : { - "base" : "Provides information about an AWS account and entity that performed an action on an affected resource. The action was performed using the credentials for an AWS account other than your own account.
", + "base" : "Provides information about an Amazon Web Services account and entity that performed an action on an affected resource. The action was performed using the credentials for an Amazon Web Services account other than your own account.
", "refs" : { - "UserIdentity$AwsAccount" : "If the action was performed using the credentials for another AWS account, the details of that account.
" + "UserIdentity$AwsAccount" : "If the action was performed using the credentials for another Amazon Web Services account, the details of that account.
" } }, "AwsService" : { - "base" : "Provides information about an AWS service that performed an action on an affected resource.
", + "base" : "Provides information about an Amazon Web Service that performed an action on an affected resource.
", "refs" : { - "UserIdentity$AwsService" : "If the action was performed by an AWS account that belongs to an AWS service, the name of the service.
" + "UserIdentity$AwsService" : "If the action was performed by an Amazon Web Services account that belongs to an Amazon Web Service, the name of the service.
" } }, "BatchGetCustomDataIdentifierSummary" : { @@ -146,7 +146,7 @@ "BlockPublicAccess" : { "base" : "Provides information about the block public access settings for an S3 bucket. These settings can apply to a bucket at the account level or bucket level. For detailed information about each setting, see Blocking public access to your Amazon S3 storage in the Amazon Simple Storage Service User Guide.
", "refs" : { - "AccountLevelPermissions$BlockPublicAccess" : "The block public access settings for the AWS account that owns the bucket.
", + "AccountLevelPermissions$BlockPublicAccess" : "The block public access settings for the Amazon Web Services account that owns the bucket.
", "BucketLevelPermissions$BlockPublicAccess" : "The block public access settings for the bucket.
" } }, @@ -163,9 +163,9 @@ } }, "BucketCountBySharedAccessType" : { - "base" : "Provides information about the number of S3 buckets that are or aren't shared with other AWS accounts.
", + "base" : "Provides information about the number of S3 buckets that are or aren't shared with other Amazon Web Services accounts.
", "refs" : { - "GetBucketStatisticsResponse$BucketCountBySharedAccessType" : "The total number of buckets that are or aren't shared with another AWS account.
" + "GetBucketStatisticsResponse$BucketCountBySharedAccessType" : "The total number of buckets that are or aren't shared with another Amazon Web Services account.
" } }, "BucketCountPolicyAllowsUnencryptedObjectUploads" : { @@ -238,7 +238,7 @@ "Cells" : { "base" : "Specifies the location of occurrences of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.
", "refs" : { - "Occurrences$Cells" : "An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell or field that contains the data. This value is null for all other types of files.
" + "Occurrences$Cells" : "An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.
Each Cell object specifies a cell or field that contains the sensitive data.
" } }, "ClassificationDetails" : { @@ -258,7 +258,7 @@ "ClassificationResult" : { "base" : "Provides the details of a sensitive data finding, including the types, number of occurrences, and locations of the sensitive data that was detected.
", "refs" : { - "ClassificationDetails$Result" : "The status and other details for the finding.
" + "ClassificationDetails$Result" : "The status and other details of the finding.
" } }, "ClassificationResultStatus" : { @@ -304,7 +304,7 @@ "refs" : { } }, "CreateMemberRequest" : { - "base" : "Specifies an AWS account to associate with an Amazon Macie administrator account.
", + "base" : "Specifies an Amazon Web Services account to associate with an Amazon Macie administrator account.
", "refs" : { } }, "CreateMemberResponse" : { @@ -424,7 +424,7 @@ "refs" : { } }, "DescribeOrganizationConfigurationResponse" : { - "base" : "Provides information about the Amazon Macie configuration settings for an AWS organization.
", + "base" : "Provides information about the Amazon Macie configuration settings for an Amazon Web Services organization.
", "refs" : { } }, "DomainDetails" : { @@ -448,7 +448,7 @@ "refs" : { } }, "EnableOrganizationAdminAccountRequest" : { - "base" : "Specifies an account to designate as a delegated Amazon Macie administrator account for an AWS organization. To submit this request, you must be a user of the management account for the AWS organization.
", + "base" : "Specifies an account to designate as a delegated Amazon Macie administrator account for an Amazon Web Services organization. To submit this request, you must be a user of the management account for the Amazon Web Services organization.
", "refs" : { } }, "EncryptionType" : { @@ -464,9 +464,9 @@ } }, "FederatedUser" : { - "base" : "Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the GetFederationToken operation of the AWS Security Token Service (AWS STS) API.
", + "base" : "Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the GetFederationToken operation of the Security Token Service (STS) API.
", "refs" : { - "UserIdentity$FederatedUser" : "If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the AWS Security Token Service (AWS STS) API, the identifiers, session context, and other details about the identity.
" + "UserIdentity$FederatedUser" : "If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.
" } }, "Finding" : { @@ -510,11 +510,11 @@ } }, "FindingPublishingFrequency" : { - "base" : "The frequency with which Amazon Macie publishes updates to policy findings for an account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). For more information, see Monitoring and processing findings in the Amazon Macie User Guide. Valid values are:
", + "base" : "The frequency with which Amazon Macie publishes updates to policy findings for an account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). For more information, see Monitoring and processing findings in the Amazon Macie User Guide. Valid values are:
", "refs" : { - "EnableMacieRequest$FindingPublishingFrequency" : "Specifies how often to publish updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).", - "GetMacieSessionResponse$FindingPublishingFrequency" : "The frequency with which Macie publishes updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).
", - "UpdateMacieSessionRequest$FindingPublishingFrequency" : "Specifies how often to publish updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events)." + "EnableMacieRequest$FindingPublishingFrequency" : "Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).
", + "GetMacieSessionResponse$FindingPublishingFrequency" : "The frequency with which Macie publishes updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).
", + "UpdateMacieSessionRequest$FindingPublishingFrequency" : "Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).
" } }, "FindingStatisticsSortAttributeName" : { @@ -584,7 +584,7 @@ "refs" : { } }, "GetFindingsPublicationConfigurationResponse" : { - "base" : "Provides information about the current configuration settings for publishing findings to AWS Security Hub automatically.
", + "base" : "Provides information about the current configuration settings for publishing findings to Security Hub automatically.
", "refs" : { } }, "GetFindingsRequest" : { @@ -636,9 +636,9 @@ } }, "IamUser" : { - "base" : "Provides information about an AWS Identity and Access Management (IAM) user who performed an action on an affected resource.
", + "base" : "Provides information about an Identity and Access Management (IAM) user who performed an action on an affected resource.
", "refs" : { - "UserIdentity$IamUser" : "If the action was performed using the credentials for an AWS Identity and Access Management (IAM) user, the name and other details about the user.
" + "UserIdentity$IamUser" : "If the action was performed using the credentials for an Identity and Access Management (IAM) user, the name and other details about the user.
" } }, "InternalServerException" : { @@ -648,8 +648,8 @@ "Invitation" : { "base" : "Provides information about an Amazon Macie membership invitation that was received by an account.
", "refs" : { - "GetAdministratorAccountResponse$Administrator" : "The AWS account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.
", - "GetMasterAccountResponse$Master" : "(Deprecated) The AWS account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.
", + "GetAdministratorAccountResponse$Administrator" : "The Amazon Web Services account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.
", + "GetMasterAccountResponse$Master" : "(Deprecated) The Amazon Web Services account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.
", "__listOfInvitation$member" : null } }, @@ -848,7 +848,7 @@ "refs" : { } }, "ListOrganizationAdminAccountsResponse" : { - "base" : "Provides information about the delegated Amazon Macie administrator accounts for an AWS organization.
", + "base" : "Provides information about the delegated Amazon Macie administrator accounts for an Amazon Web Services organization.
", "refs" : { } }, "ListTagsForResourceResponse" : { @@ -871,7 +871,7 @@ } }, "MatchingResource" : { - "base" : "Provides statistical data and other information about an AWS resource that Amazon Macie monitors and analyzes.
", + "base" : "Provides statistical data and other information about an Amazon Web Services resource that Amazon Macie monitors and analyzes.
", "refs" : { "__listOfMatchingResource$member" : null } @@ -933,7 +933,7 @@ "Pages" : { "base" : "Specifies the location of occurrences of sensitive data in an Adobe Portable Document Format file.
", "refs" : { - "Occurrences$Pages" : "An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data. This value is null for all other types of files.
" + "Occurrences$Pages" : "An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.
Each Page object specifies a page that contains the sensitive data.
" } }, "PolicyDetails" : { @@ -951,11 +951,11 @@ "refs" : { } }, "PutFindingsPublicationConfigurationRequest" : { - "base" : "Specifies configuration settings for publishing findings to AWS Security Hub automatically.
", + "base" : "Specifies configuration settings for publishing findings to Security Hub automatically.
", "refs" : { } }, "Range" : { - "base" : "Provides details about the location of an occurrence of sensitive data in a Microsoft Word document or non-binary text file.
", + "base" : "Specifies the location of an occurrence of sensitive data in a non-binary text file, such as an HTML, TXT, or XML file.
", "refs" : { "Page$LineRange" : "Reserved for future use.
", "Page$OffsetRange" : "Reserved for future use.
", @@ -963,22 +963,22 @@ } }, "Ranges" : { - "base" : "Provides details about the location of occurrences of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.
", + "base" : null, "refs" : { - "Occurrences$LineRanges" : "An array of objects, one for each occurrence of sensitive data in a Microsoft Word document or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.
This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.
", + "Occurrences$LineRanges" : "An array of objects, one for each occurrence of sensitive data in a non-binary text file, such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.
This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.
", "Occurrences$OffsetRanges" : "Reserved for future use.
" } }, "Record" : { - "base" : "Specifies the location of an occurrence of sensitive data in an Apache Avro object container or Apache Parquet file.
", + "base" : "Specifies the location of an occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file.
", "refs" : { "Records$member" : null } }, "Records" : { - "base" : "Specifies the location of occurrences of sensitive data in an Apache Parquet file.
", + "base" : null, "refs" : { - "Occurrences$Records" : "An array of objects, one for each occurrence of sensitive data in an Apache Avro object container or Apache Parquet file. Each object specifies the record index and the path to the field in the record that contains the data. This value is null for all other types of files.
" + "Occurrences$Records" : "An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.
For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.
" } }, "RelationshipStatus" : { @@ -990,9 +990,9 @@ } }, "ReplicationDetails" : { - "base" : "Provides information about settings that define whether one or more objects in an S3 bucket are replicated to S3 buckets for other AWS accounts and, if so, which accounts.
", + "base" : "Provides information about settings that define whether one or more objects in an S3 bucket are replicated to S3 buckets for other Amazon Web Services accounts and, if so, which accounts.
", "refs" : { - "BucketMetadata$ReplicationDetails" : "Specifies whether the bucket is configured to replicate one or more objects to buckets for other AWS accounts and, if so, which accounts.
" + "BucketMetadata$ReplicationDetails" : "Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.
" } }, "ResourceNotFoundException" : { @@ -1006,9 +1006,9 @@ } }, "S3Bucket" : { - "base" : "Provides information about an S3 bucket that a finding applies to.
", + "base" : "Provides information about the S3 bucket that a finding applies to.
", "refs" : { - "ResourcesAffected$S3Bucket" : "An array of objects, one for each S3 bucket that the finding applies to. Each object provides a set of metadata about an affected S3 bucket.
" + "ResourcesAffected$S3Bucket" : "The details of the S3 bucket that the finding applies to.
" } }, "S3BucketCriteriaForJob" : { @@ -1019,7 +1019,7 @@ } }, "S3BucketDefinitionForJob" : { - "base" : "Specifies an AWS account that owns S3 buckets for a classification job to analyze, and one or more specific buckets to analyze for that account.
", + "base" : "Specifies an Amazon Web Services account that owns S3 buckets for a classification job to analyze, and one or more specific buckets to analyze for that account.
", "refs" : { "__listOfS3BucketDefinitionForJob$member" : null } @@ -1027,7 +1027,7 @@ "S3BucketOwner" : { "base" : "Provides information about the user who owns an S3 bucket.
", "refs" : { - "S3Bucket$Owner" : "The display name and AWS account ID for the user who owns the bucket.
" + "S3Bucket$Owner" : "The display name and Amazon Web Services account ID for the user who owns the bucket.
" } }, "S3Destination" : { @@ -1044,9 +1044,9 @@ } }, "S3Object" : { - "base" : "Provides information about an S3 object that a finding applies to.
", + "base" : "Provides information about the S3 object that a finding applies to.
", "refs" : { - "ResourcesAffected$S3Object" : "An array of objects, one for each S3 object that the finding applies to. Each object provides a set of metadata about an affected S3 object.
" + "ResourcesAffected$S3Object" : "The details of the S3 object that the finding applies to.
" } }, "ScopeFilterKey" : { @@ -1075,28 +1075,28 @@ } }, "SearchResourcesCriteria" : { - "base" : "Specifies a property- or tag-based filter condition for including or excluding AWS resources from the query results.
", + "base" : "Specifies a property- or tag-based filter condition for including or excluding Amazon Web Services resources from the query results.
", "refs" : { "__listOfSearchResourcesCriteria$member" : null } }, "SearchResourcesCriteriaBlock" : { - "base" : "Specifies property- and tag-based conditions that define filter criteria for including or excluding AWS resources from the query results.
", + "base" : "Specifies property- and tag-based conditions that define filter criteria for including or excluding Amazon Web Services resources from the query results.
", "refs" : { "SearchResourcesBucketCriteria$Excludes" : "The property- and tag-based conditions that determine which buckets to exclude from the results.
", "SearchResourcesBucketCriteria$Includes" : "The property- and tag-based conditions that determine which buckets to include in the results.
" } }, "SearchResourcesRequest" : { - "base" : "Specifies criteria for filtering, sorting, and paginating the results of a query for statistical data and other information about AWS resources that Amazon Macie monitors and analyzes.
", + "base" : "Specifies criteria for filtering, sorting, and paginating the results of a query for statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.
", "refs" : { } }, "SearchResourcesResponse" : { - "base" : "Provides the results of a query that retrieved statistical data and other information about AWS resources that Amazon Macie monitors and analyzes.
", + "base" : "Provides the results of a query that retrieved statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.
", "refs" : { } }, "SearchResourcesSimpleCriterion" : { - "base" : "Specifies a property-based filter condition that determines which AWS resources are included or excluded from the query results.
", + "base" : "Specifies a property-based filter condition that determines which Amazon Web Services resources are included or excluded from the query results.
", "refs" : { "SearchResourcesCriteria$SimpleCriterion" : "A property-based condition that defines a property, operator, and one or more values for including or excluding resources from the results.
" } @@ -1114,13 +1114,13 @@ } }, "SearchResourcesSortCriteria" : { - "base" : "Specifies criteria for sorting the results of a query for information about AWS resources that Amazon Macie monitors and analyzes.
", + "base" : "Specifies criteria for sorting the results of a query for information about Amazon Web Services resources that Amazon Macie monitors and analyzes.
", "refs" : { "SearchResourcesRequest$SortCriteria" : "The criteria to use to sort the results.
" } }, "SearchResourcesTagCriterion" : { - "base" : "Specifies a tag-based filter condition that determines which AWS resources are included or excluded from the query results.
", + "base" : "Specifies a tag-based filter condition that determines which Amazon Web Services resources are included or excluded from the query results.
", "refs" : { "SearchResourcesCriteria$TagCriterion" : "A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding resources from the results.
" } @@ -1132,10 +1132,10 @@ } }, "SecurityHubConfiguration" : { - "base" : "Specifies configuration settings that determine which findings are published to AWS Security Hub automatically. For information about how Macie publishes findings to Security Hub, see Amazon Macie integration with Security Hub in the Amazon Macie User Guide.
", + "base" : "Specifies configuration settings that determine which findings are published to Security Hub automatically. For information about how Macie publishes findings to Security Hub, see Amazon Macie integration with Security Hub in the Amazon Macie User Guide.
", "refs" : { - "GetFindingsPublicationConfigurationResponse$SecurityHubConfiguration" : "The configuration settings that determine which findings are published to AWS Security Hub.
", - "PutFindingsPublicationConfigurationRequest$SecurityHubConfiguration" : "The configuration settings that determine which findings to publish to AWS Security Hub.
" + "GetFindingsPublicationConfigurationResponse$SecurityHubConfiguration" : "The configuration settings that determine which findings are published to Security Hub.
", + "PutFindingsPublicationConfigurationRequest$SecurityHubConfiguration" : "The configuration settings that determine which findings to publish to Security Hub.
" } }, "SensitiveData" : { @@ -1153,7 +1153,7 @@ "SensitiveDataItemCategory" : { "base" : "The category of sensitive data that was detected and produced the finding. Possible values are:
", "refs" : { - "SensitiveDataItem$Category" : "The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or AWS secret keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as driver's license identification numbers.
" + "SensitiveDataItem$Category" : "The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as driver's license identification numbers.
" } }, "ServerSideEncryption" : { @@ -1207,7 +1207,7 @@ "SharedAccess" : { "base" : null, "refs" : { - "BucketMetadata$SharedAccess" : "Specifies whether the bucket is shared with another AWS account. Possible values are:
EXTERNAL - The bucket is shared with an AWS account that isn't part of the same Amazon Macie organization.
INTERNAL - The bucket is shared with an AWS account that's part of the same Amazon Macie organization.
NOT_SHARED - The bucket isn't shared with other AWS accounts.
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
Specifies whether the bucket is shared with another Amazon Web Services account. Possible values are:
EXTERNAL - The bucket is shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.
INTERNAL - The bucket is shared with an Amazon Web Services account that's part of the same Amazon Macie organization.
NOT_SHARED - The bucket isn't shared with other Amazon Web Services accounts.
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
The type of server-side encryption that's used by default when storing new objects in the bucket. Possible values are:
AES256 - New objects are encrypted with an Amazon S3 managed key and use Amazon S3 managed encryption (SSE-S3).
aws:kms - New objects are encrypted with an AWS KMS CMK, specified by the kmsMasterKeyId property, and use AWS managed AWS KMS encryption (AWS-KMS) or customer managed AWS KMS encryption (SSE-KMS).
NONE - New objects aren't encrypted by default. Default encryption is disabled for the bucket.
The type of server-side encryption that's used by default when storing new objects in the bucket. Possible values are:
AES256 - New objects are encrypted with an Amazon S3 managed key and use Amazon S3 managed encryption (SSE-S3).
aws:kms - New objects are encrypted with an KMS CMK, specified by the kmsMasterKeyId property, and use Amazon Web Services managed KMS encryption (AWS-KMS) or customer managed KMS encryption (SSE-KMS).
NONE - New objects aren't encrypted by default. Default encryption is disabled for the bucket.
Specifies whether to enable Amazon Macie automatically for accounts that are added to an AWS organization.
", + "base" : "Specifies whether to enable Amazon Macie automatically for accounts that are added to an Amazon Web Services organization.
", "refs" : { } }, "UsageByAccount" : { @@ -1430,9 +1430,9 @@ } }, "UserIdentityRoot" : { - "base" : "Provides information about an AWS account and entity that performed an action on an affected resource. The action was performed using the credentials for your AWS account.
", + "base" : "Provides information about an Amazon Web Services account and entity that performed an action on an affected resource. The action was performed using the credentials for your Amazon Web Services account.
", "refs" : { - "UserIdentity$Root" : "If the action was performed using the credentials for your AWS account, the details of your account.
" + "UserIdentity$Root" : "If the action was performed using the credentials for your Amazon Web Services account, the details of your account.
" } }, "UserIdentityType" : { @@ -1473,21 +1473,21 @@ "BucketPolicy$AllowsPublicWriteAccess" : "Specifies whether the bucket policy allows the general public to have write access to the bucket.
", "ClassificationResult$AdditionalOccurrences" : "Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.
This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (ClassificationDetails.detailedResultsLocation).
", "CreateClassificationJobRequest$InitialRun" : "Specifies whether to analyze all existing, eligible objects immediately after the job is created.
", - "CreateInvitationsRequest$DisableEmailNotification" : "Specifies whether to send an email notification to the root user of each account that the invitation will be sent to. This notification is in addition to an alert that the root user receives in AWS Personal Health Dashboard. To send an email notification to the root user of each account, set this value to true.
", + "CreateInvitationsRequest$DisableEmailNotification" : "Specifies whether to send an email notification to the root user of each account that the invitation will be sent to. This notification is in addition to an alert that the root user receives in Personal Health Dashboard. To send an email notification to the root user of each account, set this value to true.
", "DescribeClassificationJobResponse$InitialRun" : "Specifies whether the job is configured to analyze all existing, eligible objects immediately after it's created.
", - "DescribeOrganizationConfigurationResponse$AutoEnable" : "Specifies whether Amazon Macie is enabled automatically for accounts that are added to the AWS organization.
", - "DescribeOrganizationConfigurationResponse$MaxAccountLimitReached" : "Specifies whether the maximum number of Amazon Macie member accounts are part of the AWS organization.
", - "Finding$Archived" : "Specifies whether the finding is archived.
", + "DescribeOrganizationConfigurationResponse$AutoEnable" : "Specifies whether Amazon Macie is enabled automatically for accounts that are added to the Amazon Web Services organization.
", + "DescribeOrganizationConfigurationResponse$MaxAccountLimitReached" : "Specifies whether the maximum number of Amazon Macie member accounts are part of the Amazon Web Services organization.
", + "Finding$Archived" : "Specifies whether the finding is archived (suppressed).
", "Finding$Sample" : "Specifies whether the finding is a sample finding. A sample finding is a finding that uses example data to demonstrate what a finding might contain.
", "GetCustomDataIdentifierResponse$Deleted" : "Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.
", "ReplicationDetails$Replicated" : "Specifies whether the bucket is configured to replicate one or more objects to any destination.
", - "ReplicationDetails$ReplicatedExternally" : "Specifies whether the bucket is configured to replicate one or more objects to an AWS account that isn't part of the same Amazon Macie organization.
", + "ReplicationDetails$ReplicatedExternally" : "Specifies whether the bucket is configured to replicate one or more objects to an Amazon Web Services account that isn't part of the same Amazon Macie organization.
", "S3Object$PublicAccess" : "Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
", - "SecurityHubConfiguration$PublishClassificationFindings" : "Specifies whether to publish sensitive data findings to AWS Security Hub. If you set this value to true, Amazon Macie automatically publishes all sensitive data findings that weren't suppressed by a findings filter. The default value is false.
", - "SecurityHubConfiguration$PublishPolicyFindings" : "Specifies whether to publish policy findings to AWS Security Hub. If you set this value to true, Amazon Macie automatically publishes all new and updated policy findings that weren't suppressed by a findings filter. The default value is true.
", + "SecurityHubConfiguration$PublishClassificationFindings" : "Specifies whether to publish sensitive data findings to Security Hub. If you set this value to true, Amazon Macie automatically publishes all sensitive data findings that weren't suppressed by a findings filter. The default value is false.
", + "SecurityHubConfiguration$PublishPolicyFindings" : "Specifies whether to publish policy findings to Security Hub. If you set this value to true, Amazon Macie automatically publishes all new and updated policy findings that weren't suppressed by a findings filter. The default value is true.
", "ServiceLimit$IsServiceLimited" : "Specifies whether the account has met the quota that corresponds to the metric specified by the UsageByAccount.type field in the response.
", "SessionContextAttributes$MfaAuthenticated" : "Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.
", - "UpdateOrganizationConfigurationRequest$AutoEnable" : "Specifies whether to enable Amazon Macie automatically for each account, when the account is added to the AWS organization.
" + "UpdateOrganizationConfigurationRequest$AutoEnable" : "Specifies whether to enable Amazon Macie automatically for each account, when the account is added to the Amazon Web Services organization.
" } }, "__double" : { @@ -1503,7 +1503,7 @@ "base" : null, "refs" : { "CreateClassificationJobRequest$SamplingPercentage" : "The sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.
", - "CreateCustomDataIdentifierRequest$MaximumMatchDistance" : "The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.
", + "CreateCustomDataIdentifierRequest$MaximumMatchDistance" : "The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1-300 characters. The default value is 50.
", "CreateFindingsFilterRequest$Position" : "The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.
", "DescribeBucketsRequest$MaxResults" : "The maximum number of items to include in each page of the response. The default value is 50.
", "DescribeClassificationJobResponse$SamplingPercentage" : "The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.
", @@ -1516,7 +1516,7 @@ "ListFindingsRequest$MaxResults" : "The maximum number of items to include in each page of the response.
", "MonthlySchedule$DayOfMonth" : "The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 31.
If this value exceeds the number of days in a certain month, Macie doesn't run the job that month. Macie runs the job only during months that have the specified day. For example, if this value is 31 and a month has only 30 days, Macie doesn't run the job that month. To run the job every month, specify a value that's less than 29.
", "SearchResourcesRequest$MaxResults" : "The maximum number of items to include in each page of the response. The default value is 50.
", - "TestCustomDataIdentifierRequest$MaximumMatchDistance" : "The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.
", + "TestCustomDataIdentifierRequest$MaximumMatchDistance" : "The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1-300 characters. The default value is 50.
", "TestCustomDataIdentifierResponse$MatchCount" : "The number of instances of sample text that matched the detection criteria specified in the custom data identifier.
", "UpdateFindingsFilterRequest$Position" : "The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.
" } @@ -1621,8 +1621,8 @@ "__listOfS3BucketDefinitionForJob" : { "base" : null, "refs" : { - "JobSummary$BucketDefinitions" : "An array of objects, one for each AWS account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.
", - "S3JobDefinition$BucketDefinitions" : "An array of objects, one for each AWS account that owns specific S3 buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.
" + "JobSummary$BucketDefinitions" : "An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.
", + "S3JobDefinition$BucketDefinitions" : "An array of objects, one for each Amazon Web Services account that owns specific S3 buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.
" } }, "__listOfSearchResourcesCriteria" : { @@ -1689,28 +1689,28 @@ "BucketCriteriaAdditionalProperties$Eq" : "The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.
", "BucketCriteriaAdditionalProperties$Neq" : "The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.
", "CreateClassificationJobRequest$CustomDataIdentifierIds" : "The custom data identifiers to use for data analysis and classification.
", - "CreateCustomDataIdentifierRequest$IgnoreWords" : "An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4 - 90 characters. Ignore words are case sensitive.
", - "CreateCustomDataIdentifierRequest$Keywords" : "An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3 - 90 characters. Keywords aren't case sensitive.
", - "CreateInvitationsRequest$AccountIds" : "An array that lists AWS account IDs, one for each account to send the invitation to.
", + "CreateCustomDataIdentifierRequest$IgnoreWords" : "An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 characters. Ignore words are case sensitive.
", + "CreateCustomDataIdentifierRequest$Keywords" : "An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 characters. Keywords aren't case sensitive.
", + "CreateInvitationsRequest$AccountIds" : "An array that lists Amazon Web Services account IDs, one for each account to send the invitation to.
", "CriterionAdditionalProperties$Eq" : "The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.
", "CriterionAdditionalProperties$EqExactMatch" : "The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.
You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.
", "CriterionAdditionalProperties$Neq" : "The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Macie uses OR logic to join the values.
", - "DeclineInvitationsRequest$AccountIds" : "An array that lists AWS account IDs, one for each account that sent an invitation to decline.
", - "DeleteInvitationsRequest$AccountIds" : "An array that lists AWS account IDs, one for each account that sent an invitation to delete.
", + "DeclineInvitationsRequest$AccountIds" : "An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to decline.
", + "DeleteInvitationsRequest$AccountIds" : "An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to delete.
", "DescribeClassificationJobResponse$CustomDataIdentifierIds" : "The custom data identifiers that the job uses to analyze data.
", "GetCustomDataIdentifierResponse$IgnoreWords" : "An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.
", "GetCustomDataIdentifierResponse$Keywords" : "An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.
", "GetFindingsRequest$FindingIds" : "An array of strings that lists the unique identifiers for the findings to retrieve.
", "ListFindingsResponse$FindingIds" : "An array of strings, where each string is the unique identifier for a finding that meets the filter criteria specified in the request.
", "ListJobsFilterTerm$Values" : "An array that lists one or more values to use to filter the results.
", - "ReplicationDetails$ReplicationAccounts" : "An array of AWS account IDs, one for each AWS account that the bucket is configured to replicate one or more objects to.
", + "ReplicationDetails$ReplicationAccounts" : "An array of Amazon Web Services account IDs, one for each Amazon Web Services account that the bucket is configured to replicate one or more objects to.
", "S3BucketDefinitionForJob$Buckets" : "An array that lists the names of the buckets.
", - "SearchResourcesSimpleCriterion$Values" : "An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:
ACCOUNT_ID - A string that represents the unique identifier for the AWS account that owns the resource.
S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of an S3 bucket.
S3_BUCKET_NAME - A string that represents the name of an S3 bucket.
S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of an S3 bucket.
Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in values.
", - "SimpleCriterionForJob$Values" : "An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:
ACCOUNT_ID - A string that represents the unique identifier for the AWS account that owns the bucket.
S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of a bucket.
S3_BUCKET_NAME - A string that represents the name of a bucket.
S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of a bucket.
Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.
", + "SearchResourcesSimpleCriterion$Values" : "An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:
ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the resource.
S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of an S3 bucket.
S3_BUCKET_NAME - A string that represents the name of an S3 bucket.
S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of an S3 bucket.
Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in values.
", + "SimpleCriterionForJob$Values" : "An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:
ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.
S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of a bucket.
S3_BUCKET_NAME - A string that represents the name of a bucket.
S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of a bucket.
Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.
", "SimpleScopeTerm$Values" : "An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.
Valid values for each supported property (key) are:
OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.
OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.
Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.
", - "TestCustomDataIdentifierRequest$IgnoreWords" : "An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4 - 90 characters. Ignore words are case sensitive.
", - "TestCustomDataIdentifierRequest$Keywords" : "An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3 - 90 characters. Keywords aren't case sensitive.
", - "UsageStatisticsFilter$Values" : "An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.
Valid values for each supported field are:
accountId - The unique identifier for an AWS account.
freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, when the free trial started for an account.
serviceLimit - A Boolean (true or false) value that indicates whether an account has reached its monthly quota.
total - A string that represents the current estimated cost for an account.
An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 characters. Ignore words are case sensitive.
", + "TestCustomDataIdentifierRequest$Keywords" : "An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 characters. Keywords aren't case sensitive.
", + "UsageStatisticsFilter$Values" : "An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.
Valid values for each supported field are:
accountId - The unique identifier for an Amazon Web Services account.
freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, when the free trial started for an account.
serviceLimit - A Boolean (true or false) value that indicates whether an account has reached its monthly quota.
total - A string that represents the current estimated cost for an account.
The total number of buckets that allow the general public to have read access to the bucket.
", "BucketCountByEffectivePermission$PubliclyWritable" : "The total number of buckets that allow the general public to have write access to the bucket.
", "BucketCountByEffectivePermission$Unknown" : "The total number of buckets that Amazon Macie wasn't able to evaluate permissions settings for. Macie can't determine whether these buckets are publicly accessible.
", - "BucketCountByEncryptionType$KmsManaged" : "The total number of buckets that use an AWS Key Management Service (AWS KMS) customer master key (CMK) to encrypt new objects by default. These buckets use AWS managed AWS KMS encryption (AWS-KMS) or customer managed AWS KMS encryption (SSE-KMS) by default.
", + "BucketCountByEncryptionType$KmsManaged" : "The total number of buckets that use an Key Management Service (KMS) customer master key (CMK) to encrypt new objects by default. These buckets use Amazon Web Services managed KMS encryption (AWS-KMS) or customer managed KMS encryption (SSE-KMS) by default.
", "BucketCountByEncryptionType$S3Managed" : "The total number of buckets that use an Amazon S3 managed key to encrypt new objects by default. These buckets use Amazon S3 managed encryption (SSE-S3) by default.
", "BucketCountByEncryptionType$Unencrypted" : "The total number of buckets that don't encrypt new objects by default. Default encryption is disabled for these buckets.
", "BucketCountByEncryptionType$Unknown" : "The total number of buckets that Amazon Macie doesn't have current encryption metadata for. Macie can't provide current data about the default encryption settings for these buckets.
", - "BucketCountBySharedAccessType$External" : "The total number of buckets that are shared with an AWS account that isn't part of the same Amazon Macie organization.
", - "BucketCountBySharedAccessType$Internal" : "The total number of buckets that are shared with an AWS account that's part of the same Amazon Macie organization.
", - "BucketCountBySharedAccessType$NotShared" : "The total number of buckets that aren't shared with other AWS accounts.
", - "BucketCountBySharedAccessType$Unknown" : "The total number of buckets that Amazon Macie wasn't able to evaluate shared access settings for. Macie can't determine whether these buckets are shared with other AWS accounts.
", + "BucketCountBySharedAccessType$External" : "The total number of buckets that are shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.
", + "BucketCountBySharedAccessType$Internal" : "The total number of buckets that are shared with an Amazon Web Services account that's part of the same Amazon Macie organization.
", + "BucketCountBySharedAccessType$NotShared" : "The total number of buckets that aren't shared with other Amazon Web Services accounts.
", + "BucketCountBySharedAccessType$Unknown" : "The total number of buckets that Amazon Macie wasn't able to evaluate shared access settings for. Macie can't determine whether these buckets are shared with other Amazon Web Services accounts.
", "BucketCountPolicyAllowsUnencryptedObjectUploads$AllowsUnencryptedObjectUploads" : "The total number of buckets that don't have a bucket policy or have a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, the policy doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
", "BucketCountPolicyAllowsUnencryptedObjectUploads$DeniesUnencryptedObjectUploads" : "The total number of buckets whose bucket policies require server-side encryption of new objects. PutObject requests for these buckets must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
", "BucketCountPolicyAllowsUnencryptedObjectUploads$Unknown" : "The total number of buckets that Amazon Macie wasn't able to evaluate server-side encryption requirements for. Macie can't determine whether the bucket policies for these buckets require server-side encryption of new objects.
", @@ -1740,8 +1740,8 @@ "BucketMetadata$ObjectCount" : "The total number of objects in the bucket.
", "BucketMetadata$SizeInBytes" : "The total storage size, in bytes, of the bucket.
If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.
", "BucketMetadata$SizeInBytesCompressed" : "The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.
If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.
", - "Cell$Column" : "The column number of the column that contains the data. For a Microsoft Excel workbook, this value correlates to the alphabetical character(s) for a column identifier. For example, 1 for column A, 2 for column B, and so on.
", - "Cell$Row" : "The row number of the row that contains the data.
", + "Cell$Column" : "The column number of the column that contains the sensitive data. For a Microsoft Excel workbook, this value correlates to the alphabetical character(s) for a column identifier, for example: 1 for column A, 2 for column B, and so on.
", + "Cell$Row" : "The row number of the row that contains the sensitive data.
", "ClassificationResult$SizeClassified" : "The total size, in bytes, of the data that the finding applies to.
", "CriterionAdditionalProperties$Gt" : "The value for the property is greater than the specified value.
", "CriterionAdditionalProperties$Gte" : "The value for the property is greater than or equal to the specified value.
", @@ -1765,18 +1765,18 @@ "MatchingBucket$SizeInBytes" : "The total storage size, in bytes, of the bucket.
If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.
", "MatchingBucket$SizeInBytesCompressed" : "The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.
If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.
", "ObjectCountByEncryptionType$CustomerManaged" : "The total number of objects that are encrypted with a customer-managed key. The objects use customer-provided server-side encryption (SSE-C).
", - "ObjectCountByEncryptionType$KmsManaged" : "The total number of objects that are encrypted with an AWS Key Management Service (AWS KMS) customer master key (CMK). The objects use AWS managed AWS KMS encryption (AWS-KMS) or customer managed AWS KMS encryption (SSE-KMS).
", + "ObjectCountByEncryptionType$KmsManaged" : "The total number of objects that are encrypted with an Key Management Service (KMS) customer master key (CMK). The objects use Amazon Web Services managed KMS encryption (AWS-KMS) or customer managed KMS encryption (SSE-KMS).
", "ObjectCountByEncryptionType$S3Managed" : "The total number of objects that are encrypted with an Amazon S3 managed key. The objects use Amazon S3 managed encryption (SSE-S3).
", "ObjectCountByEncryptionType$Unencrypted" : "The total number of objects that aren't encrypted or use client-side encryption.
", "ObjectCountByEncryptionType$Unknown" : "The total number of objects that Amazon Macie doesn't have current encryption metadata for. Macie can't provide current data about the encryption settings for these objects.
", "ObjectLevelStatistics$FileType" : "The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects don't have a file name extension for a supported file or storage format.
", "ObjectLevelStatistics$StorageClass" : "The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.
", "ObjectLevelStatistics$Total" : "The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.
", - "Page$PageNumber" : "The page number of the page that contains the data.
", + "Page$PageNumber" : "The page number of the page that contains the sensitive data.
", "Range$End" : "The number of lines from the beginning of the file to the end of the sensitive data.
", "Range$Start" : "The number of lines from the beginning of the file to the beginning of the sensitive data.
", - "Range$StartColumn" : "The column number for the column that contains the data, if the file contains structured data.
", - "Record$RecordIndex" : "The record index, starting from 0, for the record that contains the data.
", + "Range$StartColumn" : "The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.
", + "Record$RecordIndex" : "For an Avro object container or Parquet file, the record index, starting from 0, for the record that contains the sensitive data. For a JSON Lines file, the line index, starting from 0, for the line that contains the sensitive data. This value is always 0 for JSON files.
", "S3Object$Size" : "The total storage size, in bytes, of the object.
", "SensitiveDataItem$TotalCount" : "The total number of occurrences of the sensitive data that was detected.
", "ServiceLimit$Value" : "The value for the metric specified by the UsageByAccount.type field in the response.
", @@ -1786,40 +1786,40 @@ "__string" : { "base" : null, "refs" : { - "AcceptInvitationRequest$AdministratorAccountId" : "The AWS account ID for the account that sent the invitation.
", + "AcceptInvitationRequest$AdministratorAccountId" : "The Amazon Web Services account ID for the account that sent the invitation.
", "AcceptInvitationRequest$InvitationId" : "The unique identifier for the invitation to accept.
", - "AcceptInvitationRequest$MasterAccount" : "(Deprecated) The AWS account ID for the account that sent the invitation. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.
", + "AcceptInvitationRequest$MasterAccount" : "(Deprecated) The Amazon Web Services account ID for the account that sent the invitation. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.
", "AccessDeniedException$Message" : "The explanation of the error that occurred.
", - "AccountDetail$AccountId" : "The AWS account ID for the account.
", + "AccountDetail$AccountId" : "The Amazon Web Services account ID for the account.
", "AccountDetail$Email" : "The email address for the account.
", - "AdminAccount$AccountId" : "The AWS account ID for the account.
", + "AdminAccount$AccountId" : "The Amazon Web Services account ID for the account.
", "ApiCallDetails$Api" : "The name of the operation that was invoked most recently and produced the finding.
", - "ApiCallDetails$ApiServiceName" : "The URL of the AWS service that provides the operation, for example: s3.amazonaws.com.
", - "AssumedRole$AccessKeyId" : "The AWS access key ID that identifies the credentials.
", - "AssumedRole$AccountId" : "The unique identifier for the AWS account that owns the entity that was used to get the credentials.
", + "ApiCallDetails$ApiServiceName" : "The URL of the Amazon Web Service that provides the operation, for example: s3.amazonaws.com.
", + "AssumedRole$AccessKeyId" : "The Amazon Web Services access key ID that identifies the credentials.
", + "AssumedRole$AccountId" : "The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.
", "AssumedRole$Arn" : "The Amazon Resource Name (ARN) of the entity that was used to get the credentials.
", "AssumedRole$PrincipalId" : "The unique identifier for the entity that was used to get the credentials.
", - "AwsAccount$AccountId" : "The unique identifier for the AWS account.
", + "AwsAccount$AccountId" : "The unique identifier for the Amazon Web Services account.
", "AwsAccount$PrincipalId" : "The unique identifier for the entity that performed the action.
", - "AwsService$InvokedBy" : "The name of the AWS service that performed the action.
", + "AwsService$InvokedBy" : "The name of the Amazon Web Service that performed the action.
", "BatchGetCustomDataIdentifierSummary$Arn" : "The Amazon Resource Name (ARN) of the custom data identifier.
", "BatchGetCustomDataIdentifierSummary$Description" : "The custom description of the custom data identifier.
", "BatchGetCustomDataIdentifierSummary$Id" : "The unique identifier for the custom data identifier.
", "BatchGetCustomDataIdentifierSummary$Name" : "The custom name of the custom data identifier.
", "BucketCriteriaAdditionalProperties$Prefix" : "The name of the bucket begins with the specified value.
", - "BucketMetadata$AccountId" : "The unique identifier for the AWS account that owns the bucket.
", + "BucketMetadata$AccountId" : "The unique identifier for the Amazon Web Services account that owns the bucket.
", "BucketMetadata$BucketArn" : "The Amazon Resource Name (ARN) of the bucket.
", "BucketMetadata$BucketName" : "The name of the bucket.
", - "BucketMetadata$Region" : "The AWS Region that hosts the bucket.
", - "BucketServerSideEncryption$KmsMasterKeyId" : "The Amazon Resource Name (ARN) or unique identifier (key ID) for the AWS Key Management Service (AWS KMS) customer master key (CMK) that's used by default to encrypt objects that are added to the bucket. This value is null if the bucket uses an Amazon S3 managed key to encrypt new objects or the bucket doesn't encrypt new objects by default.
", + "BucketMetadata$Region" : "The Amazon Web Services Region that hosts the bucket.
", + "BucketServerSideEncryption$KmsMasterKeyId" : "The Amazon Resource Name (ARN) or unique identifier (key ID) for the Key Management Service (KMS) customer master key (CMK) that's used by default to encrypt objects that are added to the bucket. This value is null if the bucket uses an Amazon S3 managed key to encrypt new objects or the bucket doesn't encrypt new objects by default.
", "BucketSortCriteria$AttributeName" : "The name of the bucket property to sort the results by. This value can be one of the following properties that Amazon Macie defines as bucket metadata: accountId, bucketName, classifiableObjectCount, classifiableSizeInBytes, objectCount, or sizeInBytes.
", - "Cell$CellReference" : "The location of the cell, as an absolute cell reference, that contains the data. For example, Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.
", - "Cell$ColumnName" : "The name of the column that contains the data, if available. This value is also null if Amazon Macie detects sensitive data in the name of any column in the file.
", + "Cell$CellReference" : "The location of the cell, as an absolute cell reference, that contains the sensitive data, for example Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.
", + "Cell$ColumnName" : "The name of the column that contains the sensitive data, if available.
", "ClassificationDetails$DetailedResultsLocation" : "The path to the folder or file (in Amazon S3) that contains the corresponding sensitive data discovery result for the finding. If a finding applies to a large archive or compressed file, this value is the path to a folder. Otherwise, this value is the path to a file.
", "ClassificationDetails$JobArn" : "The Amazon Resource Name (ARN) of the classification job that produced the finding.
", "ClassificationDetails$JobId" : "The unique identifier for the classification job that produced the finding.
", "ClassificationResult$MimeType" : "The type of content, as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe Portable Document Format file.
", - "ClassificationResultStatus$Code" : "The status of the finding. Possible values are:
COMPLETE - Amazon Macie successfully completed its analysis of the object that the finding applies to.
PARTIAL - Macie analyzed only a subset of the data in the object that the finding applies to. For example, the object is an archive file that contains files in an unsupported format.
SKIPPED - Macie wasn't able to analyze the object that the finding applies to. For example, the object is a malformed file or a file that uses an unsupported format.
The status of the finding. Possible values are:
COMPLETE - Amazon Macie successfully completed its analysis of the S3 object that the finding applies to.
PARTIAL - Macie analyzed only a subset of the data in the S3 object that the finding applies to. For example, the object is an archive file that contains files in an unsupported format.
SKIPPED - Macie wasn't able to analyze the S3 object that the finding applies to. For example, the object is a file in an unsupported format.
A brief description of the status of the finding. Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding.
", "ConflictException$Message" : "The explanation of the error that occurred.
", "CreateClassificationJobRequest$ClientToken" : "A unique, case-sensitive token that you provide to ensure the idempotency of the request.
", @@ -1855,23 +1855,23 @@ "DescribeClassificationJobResponse$Name" : "The custom name of the job.
", "DomainDetails$DomainName" : "The name of the domain.
", "EnableMacieRequest$ClientToken" : "A unique, case-sensitive token that you provide to ensure the idempotency of the request.
", - "EnableOrganizationAdminAccountRequest$AdminAccountId" : "The AWS account ID for the account to designate as the delegated Amazon Macie administrator account for the organization.
", + "EnableOrganizationAdminAccountRequest$AdminAccountId" : "The Amazon Web Services account ID for the account to designate as the delegated Amazon Macie administrator account for the organization.
", "EnableOrganizationAdminAccountRequest$ClientToken" : "A unique, case-sensitive token that you provide to ensure the idempotency of the request.
", - "FederatedUser$AccessKeyId" : "The AWS access key ID that identifies the credentials.
", - "FederatedUser$AccountId" : "The unique identifier for the AWS account that owns the entity that was used to get the credentials.
", + "FederatedUser$AccessKeyId" : "The Amazon Web Services access key ID that identifies the credentials.
", + "FederatedUser$AccountId" : "The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.
", "FederatedUser$Arn" : "The Amazon Resource Name (ARN) of the entity that was used to get the credentials.
", "FederatedUser$PrincipalId" : "The unique identifier for the entity that was used to get the credentials.
", - "Finding$AccountId" : "The unique identifier for the AWS account that the finding applies to. This is typically the account that owns the affected resource.
", + "Finding$AccountId" : "The unique identifier for the Amazon Web Services account that the finding applies to. This is typically the account that owns the affected resource.
", "Finding$Description" : "The description of the finding.
", "Finding$Id" : "The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.
", - "Finding$Partition" : "The AWS partition that Amazon Macie created the finding in.
", - "Finding$Region" : "The AWS Region that Amazon Macie created the finding in.
", + "Finding$Partition" : "The Amazon Web Services partition that Amazon Macie created the finding in.
", + "Finding$Region" : "The Amazon Web Services Region that Amazon Macie created the finding in.
", "Finding$SchemaVersion" : "The version of the schema that was used to define the data structures in the finding.
", "Finding$Title" : "The brief description of the finding.
", "FindingsFilterListItem$Arn" : "The Amazon Resource Name (ARN) of the filter.
", "FindingsFilterListItem$Id" : "The unique identifier for the filter.
", "FindingsFilterListItem$Name" : "The custom name of the filter.
", - "GetBucketStatisticsRequest$AccountId" : "The unique identifier for the AWS account.
", + "GetBucketStatisticsRequest$AccountId" : "The unique identifier for the Amazon Web Services account.
", "GetCustomDataIdentifierResponse$Arn" : "The Amazon Resource Name (ARN) of the custom data identifier.
", "GetCustomDataIdentifierResponse$Description" : "The custom description of the custom data identifier.
", "GetCustomDataIdentifierResponse$Id" : "The unique identifier for the custom data identifier.
", @@ -1881,21 +1881,21 @@ "GetFindingsFilterResponse$Description" : "The custom description of the filter.
", "GetFindingsFilterResponse$Id" : "The unique identifier for the filter.
", "GetFindingsFilterResponse$Name" : "The custom name of the filter.
", - "GetMacieSessionResponse$ServiceRole" : "The Amazon Resource Name (ARN) of the service-linked role that allows Macie to monitor and analyze data in AWS resources for the account.
", - "GetMemberResponse$AccountId" : "The AWS account ID for the account.
", - "GetMemberResponse$AdministratorAccountId" : "The AWS account ID for the administrator account.
", + "GetMacieSessionResponse$ServiceRole" : "The Amazon Resource Name (ARN) of the service-linked role that allows Macie to monitor and analyze data in Amazon Web Services resources for the account.
", + "GetMemberResponse$AccountId" : "The Amazon Web Services account ID for the account.
", + "GetMemberResponse$AdministratorAccountId" : "The Amazon Web Services account ID for the administrator account.
", "GetMemberResponse$Arn" : "The Amazon Resource Name (ARN) of the account.
", "GetMemberResponse$Email" : "The email address for the account.
", - "GetMemberResponse$MasterAccountId" : "(Deprecated) The AWS account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.
", + "GetMemberResponse$MasterAccountId" : "(Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.
", "GetUsageStatisticsRequest$NextToken" : "The nextToken string that specifies which page of results to return in a paginated response.
", "GetUsageStatisticsResponse$NextToken" : "The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
", "GroupCount$GroupKey" : "The name of the property that defines the group in the query results, as specified by the groupBy property in the query request.
", - "IamUser$AccountId" : "The unique identifier for the AWS account that's associated with the IAM user who performed the action.
", + "IamUser$AccountId" : "The unique identifier for the Amazon Web Services account that's associated with the IAM user who performed the action.
", "IamUser$Arn" : "The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user who performed the action.
", "IamUser$PrincipalId" : "The unique identifier for the IAM user who performed the action.
", "IamUser$UserName" : "The user name of the IAM user who performed the action.
", "InternalServerException$Message" : "The explanation of the error that occurred.
", - "Invitation$AccountId" : "The AWS account ID for the account that sent the invitation.
", + "Invitation$AccountId" : "The Amazon Web Services account ID for the account that sent the invitation.
", "Invitation$InvitationId" : "The unique identifier for the invitation. Amazon Macie uses this identifier to validate the inviter account with the invitee account.
", "IpAddressDetails$IpAddressV4" : "The Internet Protocol version 4 (IPv4) address of the device.
", "IpCity$Name" : "The name of the city.
", @@ -1920,24 +1920,24 @@ "ListInvitationsResponse$NextToken" : "The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
", "ListMembersResponse$NextToken" : "The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
", "ListOrganizationAdminAccountsResponse$NextToken" : "The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
", - "MatchingBucket$AccountId" : "The unique identifier for the AWS account that owns the bucket.
", + "MatchingBucket$AccountId" : "The unique identifier for the Amazon Web Services account that owns the bucket.
", "MatchingBucket$BucketName" : "The name of the bucket.
", - "Member$AccountId" : "The AWS account ID for the account.
", - "Member$AdministratorAccountId" : "The AWS account ID for the administrator account.
", + "Member$AccountId" : "The Amazon Web Services account ID for the account.
", + "Member$AdministratorAccountId" : "The Amazon Web Services account ID for the administrator account.
", "Member$Arn" : "The Amazon Resource Name (ARN) of the account.
", "Member$Email" : "The email address for the account.
", - "Member$MasterAccountId" : "(Deprecated) The AWS account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.
", + "Member$MasterAccountId" : "(Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.
", "PutFindingsPublicationConfigurationRequest$ClientToken" : "A unique, case-sensitive token that you provide to ensure the idempotency of the request.
", - "Record$JsonPath" : "The path, as a JSONPath expression, to the field in the record that contains the data. If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field.
If the name of an element exceeds 20 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.
", + "Record$JsonPath" : "The path, as a JSONPath expression, to the sensitive data. For an Avro object container or Parquet file, this is the path to the field in the record (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the path to the field or array that contains the data. If the data is a value in an array, the path also indicates which value contains the data.
If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field. If the name of an element exceeds 20 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.
", "ResourceNotFoundException$Message" : "The explanation of the error that occurred.
", "S3Bucket$Arn" : "The Amazon Resource Name (ARN) of the bucket.
", "S3Bucket$Name" : "The name of the bucket.
", - "S3BucketDefinitionForJob$AccountId" : "The unique identifier for the AWS account that owns the buckets.
", + "S3BucketDefinitionForJob$AccountId" : "The unique identifier for the Amazon Web Services account that owns the buckets.
", "S3BucketOwner$DisplayName" : "The display name of the user who owns the bucket.
", - "S3BucketOwner$Id" : "The AWS account ID for the user who owns the bucket.
", + "S3BucketOwner$Id" : "The Amazon Web Services account ID for the user who owns the bucket.
", "S3Destination$BucketName" : "The name of the bucket.
", "S3Destination$KeyPrefix" : "The path prefix to use in the path to the location in the bucket. This prefix specifies where to store classification results in the bucket.
", - "S3Destination$KmsKeyArn" : "The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for encryption of the results. This must be the ARN of an existing CMK that's in the same AWS Region as the bucket.
", + "S3Destination$KmsKeyArn" : "The Amazon Resource Name (ARN) of the Key Management Service (KMS) customer master key (CMK) to use for encryption of the results. This must be the ARN of an existing CMK that's in the same Amazon Web Services Region as the bucket.
", "S3Object$BucketArn" : "The Amazon Resource Name (ARN) of the bucket that contains the object.
", "S3Object$ETag" : "The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.
", "S3Object$Extension" : "The file name extension of the object. If the object doesn't have a file name extension, this value is \"\".
", @@ -1948,9 +1948,9 @@ "SearchResourcesResponse$NextToken" : "The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
", "SearchResourcesTagCriterionPair$Key" : "The value for the tag key to use in the condition.
", "SearchResourcesTagCriterionPair$Value" : "The tag value to use in the condition.
", - "ServerSideEncryption$KmsMasterKeyId" : "The Amazon Resource Name (ARN) or unique identifier (key ID) for the AWS Key Management Service (AWS KMS) customer master key (CMK) that's used to encrypt data in the bucket or the object. If an AWS KMS CMK isn't used, this value is null.
", + "ServerSideEncryption$KmsMasterKeyId" : "The Amazon Resource Name (ARN) or unique identifier (key ID) for the Key Management Service (KMS) customer master key (CMK) that's used to encrypt data in the bucket or the object. If an KMS CMK isn't used, this value is null.
", "ServiceQuotaExceededException$Message" : "The explanation of the error that occurred.
", - "SessionIssuer$AccountId" : "The unique identifier for the AWS account that owns the entity that was used to get the credentials.
", + "SessionIssuer$AccountId" : "The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.
", "SessionIssuer$Arn" : "The Amazon Resource Name (ARN) of the source account, IAM user, or role that was used to get the credentials.
", "SessionIssuer$PrincipalId" : "The unique identifier for the entity that was used to get the credentials.
", "SessionIssuer$Type" : "The source of the temporary security credentials, such as Root, IAMUser, or Role.
", @@ -1965,20 +1965,20 @@ "TestCustomDataIdentifierRequest$Regex" : "The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.
", "TestCustomDataIdentifierRequest$SampleText" : "The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.
", "ThrottlingException$Message" : "The explanation of the error that occurred.
", - "UnprocessedAccount$AccountId" : "The AWS account ID for the account that the request applies to.
", + "UnprocessedAccount$AccountId" : "The Amazon Web Services account ID for the account that the request applies to.
", "UnprocessedAccount$ErrorMessage" : "The reason why the request hasn't been processed.
", + "UpdateFindingsFilterRequest$ClientToken" : "A unique, case-sensitive token that you provide to ensure the idempotency of the request.
", "UpdateFindingsFilterRequest$Description" : "A custom description of the filter. The description can contain as many as 512 characters.
We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.
", "UpdateFindingsFilterRequest$Name" : "A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.
We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.
", "UpdateFindingsFilterResponse$Arn" : "The Amazon Resource Name (ARN) of the filter that was updated.
", "UpdateFindingsFilterResponse$Id" : "The unique identifier for the filter that was updated.
", - "UpdateFindingsFilterRequest$ClientToken" : "A unique, case-sensitive token that you provide to ensure the idempotency of the request.
", "UsageByAccount$EstimatedCost" : "The estimated value for the metric.
", - "UsageRecord$AccountId" : "The unique identifier for the AWS account that the data applies to.
", + "UsageRecord$AccountId" : "The unique identifier for the Amazon Web Services account that the data applies to.
", "UsageTotal$EstimatedCost" : "The estimated value for the metric.
", - "UserIdentityRoot$AccountId" : "The unique identifier for the AWS account.
", + "UserIdentityRoot$AccountId" : "The unique identifier for the Amazon Web Services account.
", "UserIdentityRoot$Arn" : "The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user or role that performed the action.
", "UserIdentityRoot$PrincipalId" : "The unique identifier for the entity that performed the action.
", - "UserPausedDetails$JobImminentExpirationHealthEventArn" : "The Amazon Resource Name (ARN) of the AWS Health event that Amazon Macie sent to notify you of the job or job run's pending expiration and cancellation. This value is null if a job has been paused for less than 23 days.
", + "UserPausedDetails$JobImminentExpirationHealthEventArn" : "The Amazon Resource Name (ARN) of the Health event that Amazon Macie sent to notify you of the job or job run's pending expiration and cancellation. This value is null if a job has been paused for less than 23 days.
", "ValidationException$Message" : "The explanation of the error that occurred.
", "__listOf__string$member" : null } @@ -2016,4 +2016,4 @@ } } } -} \ No newline at end of file +} diff --git a/models/apis/mgn/2020-02-26/api-2.json b/models/apis/mgn/2020-02-26/api-2.json index bfd924586d9..f4312b5051f 100644 --- a/models/apis/mgn/2020-02-26/api-2.json +++ b/models/apis/mgn/2020-02-26/api-2.json @@ -40,7 +40,8 @@ "output":{"shape":"ReplicationConfigurationTemplate"}, "errors":[ {"shape":"UninitializedAccountException"}, - {"shape":"ValidationException"} + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} ] }, "DeleteJob":{ @@ -377,6 +378,7 @@ {"shape":"UninitializedAccountException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, {"shape":"ConflictException"} ], "idempotent":true @@ -393,7 +395,8 @@ "errors":[ {"shape":"UninitializedAccountException"}, {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"} + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} ] } }, @@ -1173,7 +1176,6 @@ "ReplicationConfigurationEbsEncryption":{ "type":"string", "enum":[ - "NONE", "DEFAULT", "CUSTOM" ] diff --git a/models/apis/sns/2010-03-31/docs-2.json b/models/apis/sns/2010-03-31/docs-2.json index 0db6e28df69..e7735a12f1c 100644 --- a/models/apis/sns/2010-03-31/docs-2.json +++ b/models/apis/sns/2010-03-31/docs-2.json @@ -2,45 +2,45 @@ "version": "2.0", "service": "Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer Guide.
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.
", "operations": { - "AddPermission": "Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
", + "AddPermission": "Adds a statement to a topic's access control policy, granting access for the specified accounts to the specified actions.
", "CheckIfPhoneNumberIsOptedOut": "Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to \"true\".
Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.
PlatformPrincipal and PlatformCredential are received from the notification service.
For ADM, PlatformPrincipal is client id and PlatformCredential is client secret.
For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.
For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate and PlatformCredential is private key.
For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal and the PlatformCredential is API key.
For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.
For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.
You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. You can use the returned EndpointArn to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.
When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.
Adds a destination phone number to an AWS account in the SMS sandbox and sends a one-time password (OTP) to that phone number.
When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
", - "CreateTopic": "Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
", + "CreateSMSSandboxPhoneNumber": "Adds a destination phone number to an account in the SMS sandbox and sends a one-time password (OTP) to that phone number.
When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
", + "CreateTopic": "Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
", "DeleteEndpoint": "Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.
", "DeletePlatformApplication": "Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.
", - "DeleteSMSSandboxPhoneNumber": "Deletes an AWS account's verified or pending phone number from the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
", + "DeleteSMSSandboxPhoneNumber": "Deletes an account's verified or pending phone number from the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
", "DeleteTopic": "Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
", "GetEndpointAttributes": "Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
", "GetPlatformApplicationAttributes": "Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.
", "GetSMSAttributes": "Returns the settings for sending SMS messages from your account.
These settings are set with the SetSMSAttributes action.
Retrieves the SMS sandbox status for the calling AWS account in the target AWS Region.
When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
", + "GetSMSSandboxAccountStatus": "Retrieves the SMS sandbox status for the calling account in the target Region.
When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
", "GetSubscriptionAttributes": "Returns all of the properties of a subscription.
", "GetTopicAttributes": "Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
", "ListEndpointsByPlatformApplication": "Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.
This action is throttled at 30 transactions per second (TPS).
", - "ListOriginationNumbers": "Lists the calling AWS account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.
", + "ListOriginationNumbers": "Lists the calling account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.
", "ListPhoneNumbersOptedOut": "Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.
Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.
This action is throttled at 15 transactions per second (TPS).
", - "ListSMSSandboxPhoneNumbers": "Lists the calling AWS account's current verified and pending destination phone numbers in the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
", + "ListSMSSandboxPhoneNumbers": "Lists the calling account's current verified and pending destination phone numbers in the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
", "ListSubscriptions": "Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.
This action is throttled at 30 transactions per second (TPS).
", "ListSubscriptionsByTopic": "Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.
This action is throttled at 30 transactions per second (TPS).
", "ListTagsForResource": "List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.
", "ListTopics": "Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.
This action is throttled at 30 transactions per second (TPS).
", "OptInPhoneNumber": "Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
You can opt in a phone number only once every 30 days.
", - "Publish": "Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).
If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.
To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
You can publish messages only to topics and endpoints in the same AWS Region.
Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).
If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.
To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
You can publish messages only to topics and endpoints in the same Region.
Removes a statement from a topic's access control policy.
", "SetEndpointAttributes": "Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
", "SetPlatformApplicationAttributes": "Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.
", "SetSMSAttributes": "Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Publishing to a mobile phone in the Amazon SNS Developer Guide.
To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action.
Allows a subscription owner to set an attribute of the subscription to a new value.
", "SetTopicAttributes": "Allows a topic owner to set an attribute of the topic to a new value.
", - "Subscribe": "Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same AWS account, the endpoint owner must run the ConfirmSubscription action to confirm the subscription.
You call the ConfirmSubscription action with the token from the subscription response. Confirmation tokens are valid for three days.
This action is throttled at 100 transactions per second (TPS).
", - "TagResource": "Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
When you use topic tags, keep the following guidelines in mind:
Adding more than 50 tags to a topic isn't recommended.
Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging actions are limited to 10 TPS per AWS account, per AWS region. If your application requires a higher throughput, file a technical support request.
Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.
This action is throttled at 100 transactions per second (TPS).
", + "Subscribe": "Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same account, the endpoint owner must run the ConfirmSubscription action to confirm the subscription.
You call the ConfirmSubscription action with the token from the subscription response. Confirmation tokens are valid for three days.
This action is throttled at 100 transactions per second (TPS).
", + "TagResource": "Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
When you use topic tags, keep the following guidelines in mind:
Adding more than 50 tags to a topic isn't recommended.
Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging actions are limited to 10 TPS per account, per Region. If your application requires a higher throughput, file a technical support request.
Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.
This action is throttled at 100 transactions per second (TPS).
", "UntagResource": "Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
", - "VerifySMSSandboxPhoneNumber": "Verifies a destination phone number with a one-time password (OTP) for the calling AWS account.
When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
" + "VerifySMSSandboxPhoneNumber": "Verifies a destination phone number with a one-time password (OTP) for the calling account.
When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
" }, "shapes": { "ActionsList": { @@ -141,7 +141,7 @@ "DelegatesList": { "base": null, "refs": { - "AddPermissionInput$AWSAccountId": "The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.
" + "AddPermissionInput$AWSAccountId": "The account IDs of the users (principals) who will be given access to the specified actions. The users must have account, but do not need to be signed up for this service.
" } }, "DeleteEndpointInput": { @@ -181,7 +181,7 @@ } }, "FilterPolicyLimitExceededException": { - "base": "Indicates that the number of filter polices in your AWS account exceeds the limit. To add more filter polices, submit an SNS Limit Increase case in the AWS Support Center.
", + "base": "Indicates that the number of filter polices in your account exceeds the limit. To add more filter polices, submit an SNS Limit Increase case in the Amazon Web Services Support Center.
", "refs": { } }, @@ -282,7 +282,7 @@ } }, "KMSInvalidStateException": { - "base": "The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
", + "base": "The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the Key Management Service Developer Guide.
", "refs": { } }, @@ -292,12 +292,12 @@ } }, "KMSOptInRequired": { - "base": "The AWS access key ID needs a subscription for the service.
", + "base": "The Amazon Web Services access key ID needs a subscription for the service.
", "refs": { } }, "KMSThrottlingException": { - "base": "The request was denied due to request throttling. For more information about throttling, see Limits in the AWS Key Management Service Developer Guide.
", + "base": "The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide.
", "refs": { } }, @@ -427,7 +427,7 @@ "PlatformApplication$Attributes": "Attributes for platform application object.
", "SetEndpointAttributesInput$Attributes": "A map of the endpoint attributes. Attributes in this map include the following:
CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.
A map of the platform application attributes. Attributes in this map include the following:
PlatformCredential – The credential received from the notification service. For APNS and APNS_SANDBOX, PlatformCredential is private key. For GCM (Firebase Cloud Messaging), PlatformCredential is API key. For ADM, PlatformCredential is client secret.
PlatformPrincipal – The principal received from the notification service. For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal. For ADM, PlatformPrincipal is client id.
EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.
EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.
EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.
EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.
The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
Time that the message was published (in UTC)
Message ID
Destination phone number
Message type
Delivery status
Message price (in USD)
Part number (a message is split into multiple parts if it is too long for a single message)
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.
" + "SetSMSAttributesInput$attributes": "The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
Time that the message was published (in UTC)
Message ID
Destination phone number
Message type
Delivery status
Message price (in USD)
Part number (a message is split into multiple parts if it is too long for a single message)
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principal to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.
" } }, "MaxItems": { @@ -488,7 +488,7 @@ } }, "OptedOutException": { - "base": "Indicates that the specified phone number opted out of receiving SMS messages from your AWS account. You can't send SMS messages to phone numbers that opt out.
", + "base": "Indicates that the specified phone number opted out of receiving SMS messages from your account. You can't send SMS messages to phone numbers that opt out.
", "refs": { } }, @@ -565,7 +565,7 @@ } }, "SMSSandboxPhoneNumber": { - "base": "A verified or pending destination phone number in the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
", + "base": "A verified or pending destination phone number in the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
", "refs": { "SMSSandboxPhoneNumberList$member": null } @@ -674,8 +674,8 @@ "SubscriptionAttributesMap": { "base": null, "refs": { - "GetSubscriptionAttributesResponse$Attributes": "A map of the subscription's attributes. Attributes in this map include the following:
ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.
DeliveryPolicy – The JSON serialization of the subscription's delivery policy.
EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.
FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.
Owner – The AWS account ID of the subscription's owner.
PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.
RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.
RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
SubscriptionArn – The subscription's ARN.
TopicArn – The topic ARN that the subscription is associated with.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
A map of the subscription's attributes. Attributes in this map include the following:
ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.
DeliveryPolicy – The JSON serialization of the subscription's delivery policy.
EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.
FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.
Owner – The account ID of the subscription's owner.
PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.
RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.
RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
SubscriptionArn – The subscription's ARN.
TopicArn – The topic ARN that the subscription is associated with.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the Subscribe action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName – The display name to use for a topic with SMS subscriptions.
FifoTopic – Set to true to create a FIFO topic.
Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
The following attribute applies only to server-side encryption:
KmsMasterKeyId – The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic – When this is set to true, a FIFO topic is created.
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
A map of the topic's attributes. Attributes in this map include the following:
DeliveryPolicy – The JSON serialization of the topic's delivery policy.
DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.
Owner – The AWS account ID of the topic's owner.
Policy – The JSON serialization of the topic's access control policy.
SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.
SubscriptionsDeleted – The number of deleted subscriptions for the topic.
SubscriptionsPending – The number of subscriptions pending confirmation for the topic.
TopicArn – The topic's ARN.
EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic – When this is set to true, a FIFO topic is created.
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName – The display name to use for a topic with SMS subscriptions.
FifoTopic – Set to true to create a FIFO topic.
Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
The following attribute applies only to server-side encryption:
KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic – When this is set to true, a FIFO topic is created.
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
A map of the topic's attributes. Attributes in this map include the following:
DeliveryPolicy – The JSON serialization of the topic's delivery policy.
DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.
Owner – The account ID of the topic's owner.
Policy – The JSON serialization of the topic's access control policy.
SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.
SubscriptionsDeleted – The number of deleted subscriptions for the topic.
SubscriptionsPending – The number of subscriptions pending confirmation for the topic.
TopicArn – The topic's ARN.
EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId - The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic – When this is set to true, a FIFO topic is created.
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that this action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName – The display name to use for a topic with SMS subscriptions.
Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName – The display name to use for a topic with SMS subscriptions.
Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.
The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the http protocol, the (public) endpoint is a URL beginning with http://.
For the https protocol, the (public) endpoint is a URL beginning with https://.
For the email protocol, the endpoint is an email address.
For the email-json protocol, the endpoint is an email address.
For the sms protocol, the endpoint is a phone number of an SMS-enabled device.
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the http protocol, the (public) endpoint is a URL beginning with http://.
For the https protocol, the (public) endpoint is a URL beginning with https://.
For the email protocol, the endpoint is an email address.
For the email-json protocol, the endpoint is an email address.
For the sms protocol, the endpoint is a phone number of an SMS-enabled device.
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
For the lambda protocol, the endpoint is the ARN of an Lambda function.
For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
The subscription's endpoint (format depends on the protocol).
" } }, @@ -917,7 +917,7 @@ "protocol": { "base": null, "refs": { - "SubscribeInput$Protocol": "The protocol that you want to use. Supported protocols include:
http – delivery of JSON-encoded message via HTTP POST
https – delivery of JSON-encoded message via HTTPS POST
email – delivery of message via SMTP
email-json – delivery of JSON-encoded message via SMTP
sms – delivery of message via SMS
sqs – delivery of JSON-encoded message to an Amazon SQS queue
application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device
lambda – delivery of JSON-encoded message to an AWS Lambda function
firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
The protocol that you want to use. Supported protocols include:
http – delivery of JSON-encoded message via HTTP POST
https – delivery of JSON-encoded message via HTTPS POST
email – delivery of message via SMTP
email-json – delivery of JSON-encoded message via SMTP
sms – delivery of message via SMS
sqs – delivery of JSON-encoded message to an Amazon SQS queue
application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device
lambda – delivery of JSON-encoded message to an Lambda function
firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
The subscription's protocol.
" } }, diff --git a/models/apis/sns/2010-03-31/paginators-1.json b/models/apis/sns/2010-03-31/paginators-1.json index 556f76acdef..d977afab872 100644 --- a/models/apis/sns/2010-03-31/paginators-1.json +++ b/models/apis/sns/2010-03-31/paginators-1.json @@ -11,6 +11,11 @@ "output_token": "NextToken", "result_key": "PhoneNumbers" }, + "ListPhoneNumbersOptedOut": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "phoneNumbers" + }, "ListPlatformApplications": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 72ae6c9cd76..feeb900dfb2 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -747,6 +747,7 @@ "ap-southeast-2" : { }, "eu-central-1" : { }, "eu-west-1" : { }, + "eu-west-2" : { }, "fips" : { "credentialScope" : { "region" : "us-west-2" @@ -4617,6 +4618,12 @@ }, "hostname" : "oidc.eu-west-2.amazonaws.com" }, + "eu-west-3" : { + "credentialScope" : { + "region" : "eu-west-3" + }, + "hostname" : "oidc.eu-west-3.amazonaws.com" + }, "us-east-1" : { "credentialScope" : { "region" : "us-east-1" diff --git a/service/eks/api.go b/service/eks/api.go index bf996100ef3..e7574900133 100644 --- a/service/eks/api.go +++ b/service/eks/api.go @@ -10249,6 +10249,9 @@ const ( // AddonIssueCodeAdmissionRequestDenied is a AddonIssueCode enum value AddonIssueCodeAdmissionRequestDenied = "AdmissionRequestDenied" + + // AddonIssueCodeUnsupportedAddonModification is a AddonIssueCode enum value + AddonIssueCodeUnsupportedAddonModification = "UnsupportedAddonModification" ) // AddonIssueCode_Values returns all elements of the AddonIssueCode enum @@ -10260,6 +10263,7 @@ func AddonIssueCode_Values() []string { AddonIssueCodeInsufficientNumberOfReplicas, AddonIssueCodeConfigurationConflict, AddonIssueCodeAdmissionRequestDenied, + AddonIssueCodeUnsupportedAddonModification, } } @@ -10408,6 +10412,9 @@ const ( // ErrorCodeAdmissionRequestDenied is a ErrorCode enum value ErrorCodeAdmissionRequestDenied = "AdmissionRequestDenied" + + // ErrorCodeUnsupportedAddonModification is a ErrorCode enum value + ErrorCodeUnsupportedAddonModification = "UnsupportedAddonModification" ) // ErrorCode_Values returns all elements of the ErrorCode enum @@ -10428,6 +10435,7 @@ func ErrorCode_Values() []string { ErrorCodeInsufficientNumberOfReplicas, ErrorCodeConfigurationConflict, ErrorCodeAdmissionRequestDenied, + ErrorCodeUnsupportedAddonModification, } } diff --git a/service/imagebuilder/api.go b/service/imagebuilder/api.go index 10650d168d3..0bc159621ca 100644 --- a/service/imagebuilder/api.go +++ b/service/imagebuilder/api.go @@ -3609,7 +3609,7 @@ func (c *Imagebuilder) ListImagePackagesRequest(input *ListImagePackagesInput) ( // ListImagePackages API operation for EC2 Image Builder. // // List the Packages that are associated with an Image Build Version, as determined -// by AWS Systems Manager Inventory at build time. +// by Amazon EC2 Systems Manager Inventory at build time. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5625,23 +5625,80 @@ func (c *Imagebuilder) UpdateInfrastructureConfigurationWithContext(ctx aws.Cont return out, req.Send() } -// Details of an EC2 AMI. +// In addition to your infrastruction configuration, these settings provide +// an extra layer of control over your build instances. For instances where +// Image Builder installs the SSM agent, you can choose whether to keep it for +// the AMI that you create. You can also specify commands to run on launch for +// all of your build instances. +type AdditionalInstanceConfiguration struct { + _ struct{} `type:"structure"` + + // Contains settings for the SSM agent on your build instance. + SystemsManagerAgent *SystemsManagerAgent `locationName:"systemsManagerAgent" type:"structure"` + + // Use this property to provide commands or a command script to run when you + // launch your build instance. + // + // The userDataOverride property replaces any commands that Image Builder might + // have added to ensure that SSM is installed on your Linux build instance. + // If you override the user data, make sure that you add commands to install + // SSM, if it is not pre-installed on your source image. + UserDataOverride *string `locationName:"userDataOverride" min:"1" type:"string"` +} + +// String returns the string representation +func (s AdditionalInstanceConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AdditionalInstanceConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AdditionalInstanceConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AdditionalInstanceConfiguration"} + if s.UserDataOverride != nil && len(*s.UserDataOverride) < 1 { + invalidParams.Add(request.NewErrParamMinLen("UserDataOverride", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetSystemsManagerAgent sets the SystemsManagerAgent field's value. +func (s *AdditionalInstanceConfiguration) SetSystemsManagerAgent(v *SystemsManagerAgent) *AdditionalInstanceConfiguration { + s.SystemsManagerAgent = v + return s +} + +// SetUserDataOverride sets the UserDataOverride field's value. +func (s *AdditionalInstanceConfiguration) SetUserDataOverride(v string) *AdditionalInstanceConfiguration { + s.UserDataOverride = &v + return s +} + +// Details of an Amazon EC2 AMI. type Ami struct { _ struct{} `type:"structure"` // The account ID of the owner of the AMI. AccountId *string `locationName:"accountId" min:"1" type:"string"` - // The description of the EC2 AMI. Minimum and maximum length are in characters. + // The description of the Amazon EC2 AMI. Minimum and maximum length are in + // characters. Description *string `locationName:"description" min:"1" type:"string"` - // The AMI ID of the EC2 AMI. + // The AMI ID of the Amazon EC2 AMI. Image *string `locationName:"image" min:"1" type:"string"` - // The name of the EC2 AMI. + // The name of the Amazon EC2 AMI. Name *string `locationName:"name" min:"1" type:"string"` - // The AWS Region of the EC2 AMI. + // The Region of the Amazon EC2 AMI. Region *string `locationName:"region" min:"1" type:"string"` // Image state shows the image status and the reason for that status. @@ -5708,8 +5765,8 @@ type AmiDistributionConfiguration struct { // The KMS key identifier used to encrypt the distributed image. KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"` - // Launch permissions can be used to configure which AWS accounts can use the - // AMI to launch instances. + // Launch permissions can be used to configure which accounts can use the AMI + // to launch instances. LaunchPermission *LaunchPermissionConfiguration `locationName:"launchPermission" type:"structure"` // The name of the distribution configuration. @@ -6031,6 +6088,10 @@ type Component struct { // The owner of the component. Owner *string `locationName:"owner" min:"1" type:"string"` + // Contains parameter details for each of the parameters that are defined for + // the component. + Parameters []*ComponentParameterDetail `locationName:"parameters" type:"list"` + // The platform of the component. Platform *string `locationName:"platform" type:"string" enum:"Platform"` @@ -6114,6 +6175,12 @@ func (s *Component) SetOwner(v string) *Component { return s } +// SetParameters sets the Parameters field's value. +func (s *Component) SetParameters(v []*ComponentParameterDetail) *Component { + s.Parameters = v + return s +} + // SetPlatform sets the Platform field's value. func (s *Component) SetPlatform(v string) *Component { s.Platform = &v @@ -6152,6 +6219,10 @@ type ComponentConfiguration struct { // // ComponentArn is a required field ComponentArn *string `locationName:"componentArn" type:"string" required:"true"` + + // A group of parameter settings that are used to configure the component for + // a specific recipe. + Parameters []*ComponentParameter `locationName:"parameters" min:"1" type:"list"` } // String returns the string representation @@ -6170,6 +6241,19 @@ func (s *ComponentConfiguration) Validate() error { if s.ComponentArn == nil { invalidParams.Add(request.NewErrParamRequired("ComponentArn")) } + if s.Parameters != nil && len(s.Parameters) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Parameters", 1)) + } + if s.Parameters != nil { + for i, v := range s.Parameters { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Parameters", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -6183,6 +6267,125 @@ func (s *ComponentConfiguration) SetComponentArn(v string) *ComponentConfigurati return s } +// SetParameters sets the Parameters field's value. +func (s *ComponentConfiguration) SetParameters(v []*ComponentParameter) *ComponentConfiguration { + s.Parameters = v + return s +} + +// Contains a key/value pair that sets the named component parameter. +type ComponentParameter struct { + _ struct{} `type:"structure"` + + // The name of the component parameter to set. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // Sets the value for the named component parameter. + // + // Value is a required field + Value []*string `locationName:"value" type:"list" required:"true"` +} + +// String returns the string representation +func (s ComponentParameter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ComponentParameter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ComponentParameter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ComponentParameter"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *ComponentParameter) SetName(v string) *ComponentParameter { + s.Name = &v + return s +} + +// SetValue sets the Value field's value. +func (s *ComponentParameter) SetValue(v []*string) *ComponentParameter { + s.Value = v + return s +} + +// Defines a parameter that is used to provide configuration details for the +// component. +type ComponentParameterDetail struct { + _ struct{} `type:"structure"` + + // The default value of this parameter if no input is provided. + DefaultValue []*string `locationName:"defaultValue" type:"list"` + + // Describes this parameter. + Description *string `locationName:"description" min:"1" type:"string"` + + // The name of this input parameter. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // The type of input this parameter provides. The currently supported value + // is "string". + // + // Type is a required field + Type *string `locationName:"type" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s ComponentParameterDetail) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ComponentParameterDetail) GoString() string { + return s.String() +} + +// SetDefaultValue sets the DefaultValue field's value. +func (s *ComponentParameterDetail) SetDefaultValue(v []*string) *ComponentParameterDetail { + s.DefaultValue = v + return s +} + +// SetDescription sets the Description field's value. +func (s *ComponentParameterDetail) SetDescription(v string) *ComponentParameterDetail { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *ComponentParameterDetail) SetName(v string) *ComponentParameterDetail { + s.Name = &v + return s +} + +// SetType sets the Type field's value. +func (s *ComponentParameterDetail) SetType(v string) *ComponentParameterDetail { + s.Type = &v + return s +} + // A high-level summary of a component. type ComponentSummary struct { _ struct{} `type:"structure"` @@ -6806,10 +7009,10 @@ type CreateComponentInput struct { // The tags of the component. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` - // The uri of the component. Must be an S3 URL and the requester must have permission - // to access the S3 bucket. If you use S3, you can specify component content - // up to your service quota. Either data or uri can be used to specify the data - // within the component. + // The uri of the component. Must be an Amazon S3 URL and the requester must + // have permission to access the Amazon S3 bucket. If you use Amazon S3, you + // can specify component content up to your service quota. Either data or uri + // can be used to specify the data within the component. Uri *string `locationName:"uri" type:"string"` } @@ -6993,7 +7196,8 @@ type CreateContainerRecipeInput struct { // The Dockerfile template used to build your image as an inline data blob. DockerfileTemplateData *string `locationName:"dockerfileTemplateData" min:"1" type:"string"` - // The S3 URI for the Dockerfile that will be used to build your container image. + // The Amazon S3 URI for the Dockerfile that will be used to build your container + // image. DockerfileTemplateUri *string `locationName:"dockerfileTemplateUri" type:"string"` // Specifies the operating system version for the source image. @@ -7772,6 +7976,9 @@ func (s *CreateImagePipelineOutput) SetRequestId(v string) *CreateImagePipelineO type CreateImageRecipeInput struct { _ struct{} `type:"structure"` + // Specify additional settings and launch scripts for your build instances. + AdditionalInstanceConfiguration *AdditionalInstanceConfiguration `locationName:"additionalInstanceConfiguration" type:"structure"` + // The block device mappings of the image recipe. BlockDeviceMappings []*InstanceBlockDeviceMapping `locationName:"blockDeviceMappings" type:"list"` @@ -7810,7 +8017,7 @@ type CreateImageRecipeInput struct { // The tags of the image recipe. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` - // The working directory to be used during build and test workflows. + // The working directory used during build and test workflows. WorkingDirectory *string `locationName:"workingDirectory" min:"1" type:"string"` } @@ -7857,6 +8064,11 @@ func (s *CreateImageRecipeInput) Validate() error { if s.WorkingDirectory != nil && len(*s.WorkingDirectory) < 1 { invalidParams.Add(request.NewErrParamMinLen("WorkingDirectory", 1)) } + if s.AdditionalInstanceConfiguration != nil { + if err := s.AdditionalInstanceConfiguration.Validate(); err != nil { + invalidParams.AddNested("AdditionalInstanceConfiguration", err.(request.ErrInvalidParams)) + } + } if s.BlockDeviceMappings != nil { for i, v := range s.BlockDeviceMappings { if v == nil { @@ -7884,6 +8096,12 @@ func (s *CreateImageRecipeInput) Validate() error { return nil } +// SetAdditionalInstanceConfiguration sets the AdditionalInstanceConfiguration field's value. +func (s *CreateImageRecipeInput) SetAdditionalInstanceConfiguration(v *AdditionalInstanceConfiguration) *CreateImageRecipeInput { + s.AdditionalInstanceConfiguration = v + return s +} + // SetBlockDeviceMappings sets the BlockDeviceMappings field's value. func (s *CreateImageRecipeInput) SetBlockDeviceMappings(v []*InstanceBlockDeviceMapping) *CreateImageRecipeInput { s.BlockDeviceMappings = v @@ -7990,7 +8208,7 @@ type CreateInfrastructureConfigurationInput struct { Description *string `locationName:"description" min:"1" type:"string"` // The instance profile to associate with the instance used to customize your - // EC2 AMI. + // Amazon EC2 AMI. // // InstanceProfileName is a required field InstanceProfileName *string `locationName:"instanceProfileName" min:"1" type:"string" required:"true"` @@ -8016,13 +8234,14 @@ type CreateInfrastructureConfigurationInput struct { ResourceTags map[string]*string `locationName:"resourceTags" min:"1" type:"map"` // The security group IDs to associate with the instance used to customize your - // EC2 AMI. + // Amazon EC2 AMI. SecurityGroupIds []*string `locationName:"securityGroupIds" type:"list"` // The SNS topic on which to send image build events. SnsTopicArn *string `locationName:"snsTopicArn" type:"string"` - // The subnet ID in which to place the instance used to customize your EC2 AMI. + // The subnet ID in which to place the instance used to customize your Amazon + // EC2 AMI. SubnetId *string `locationName:"subnetId" min:"1" type:"string"` // The tags of the infrastructure configuration. @@ -10405,6 +10624,12 @@ func (s *ImagePipeline) SetTags(v map[string]*string) *ImagePipeline { type ImageRecipe struct { _ struct{} `type:"structure"` + // Before you create a new AMI, Image Builder launches temporary Amazon EC2 + // instances to build and test your image configuration. Instance configuration + // adds a layer of control over those instances. You can define settings and + // add scripts to run when an instance is launched from your AMI. + AdditionalInstanceConfiguration *AdditionalInstanceConfiguration `locationName:"additionalInstanceConfiguration" type:"structure"` + // The Amazon Resource Name (ARN) of the image recipe. Arn *string `locationName:"arn" type:"string"` @@ -10456,6 +10681,12 @@ func (s ImageRecipe) GoString() string { return s.String() } +// SetAdditionalInstanceConfiguration sets the AdditionalInstanceConfiguration field's value. +func (s *ImageRecipe) SetAdditionalInstanceConfiguration(v *AdditionalInstanceConfiguration) *ImageRecipe { + s.AdditionalInstanceConfiguration = v + return s +} + // SetArn sets the Arn field's value. func (s *ImageRecipe) SetArn(v string) *ImageRecipe { s.Arn = &v @@ -10946,10 +11177,10 @@ type ImportComponentInput struct { // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"ComponentType"` - // The uri of the component. Must be an S3 URL and the requester must have permission - // to access the S3 bucket. If you use S3, you can specify component content - // up to your service quota. Either data or uri can be used to specify the data - // within the component. + // The uri of the component. Must be an Amazon S3 URL and the requester must + // have permission to access the Amazon S3 bucket. If you use Amazon S3, you + // can specify component content up to your service quota. Either data or uri + // can be used to specify the data within the component. Uri *string `locationName:"uri" type:"string"` } @@ -11141,7 +11372,7 @@ type InfrastructureConfiguration struct { // The instance types of the infrastructure configuration. InstanceTypes []*string `locationName:"instanceTypes" type:"list"` - // The EC2 key pair of the infrastructure configuration. + // The Amazon EC2 key pair of the infrastructure configuration. KeyPair *string `locationName:"keyPair" min:"1" type:"string"` // The logging configuration of the infrastructure configuration. @@ -11269,7 +11500,7 @@ func (s *InfrastructureConfiguration) SetTerminateInstanceOnFailure(v bool) *Inf return s } -// The infrastructure used when building EC2 AMIs. +// The infrastructure used when building Amazon EC2 AMIs. type InfrastructureConfigurationSummary struct { _ struct{} `type:"structure"` @@ -11836,10 +12067,10 @@ func (s *InvalidVersionNumberException) RequestID() string { } // Describes the configuration for a launch permission. The launch permission -// modification request is sent to the EC2 ModifyImageAttribute (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html) +// modification request is sent to the Amazon EC2 ModifyImageAttribute (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html) // API on behalf of the user for each Region they have selected to distribute // the AMI. To make an AMI public, set the launch permission authorized accounts -// to all. See the examples for making an AMI public at EC2 ModifyImageAttribute +// to all. See the examples for making an AMI public at Amazon EC2 ModifyImageAttribute // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html). type LaunchPermissionConfiguration struct { _ struct{} `type:"structure"` @@ -11847,7 +12078,7 @@ type LaunchPermissionConfiguration struct { // The name of the group. UserGroups []*string `locationName:"userGroups" type:"list"` - // The AWS account ID. + // The account ID. UserIds []*string `locationName:"userIds" min:"1" type:"list"` } @@ -11886,20 +12117,20 @@ func (s *LaunchPermissionConfiguration) SetUserIds(v []*string) *LaunchPermissio return s } -// Identifies an EC2 launch template to use for a specific account. +// Identifies an Amazon EC2 launch template to use for a specific account. type LaunchTemplateConfiguration struct { _ struct{} `type:"structure"` // The account ID that this configuration applies to. AccountId *string `locationName:"accountId" type:"string"` - // Identifies the EC2 launch template to use. + // Identifies the Amazon EC2 launch template to use. // // LaunchTemplateId is a required field LaunchTemplateId *string `locationName:"launchTemplateId" type:"string" required:"true"` - // Set the specified EC2 launch template as the default launch template for - // the specified account. + // Set the specified Amazon EC2 launch template as the default launch template + // for the specified account. SetDefaultVersion *bool `locationName:"setDefaultVersion" type:"boolean"` } @@ -13398,7 +13629,7 @@ func (s *Logging) SetS3Logs(v *S3Logs) *Logging { type OutputResources struct { _ struct{} `type:"structure"` - // The EC2 AMIs created by this image. + // The Amazon EC2 AMIs created by this image. Amis []*Ami `locationName:"amis" type:"list"` // Container images that the pipeline has generated and stored in the output @@ -14393,6 +14624,33 @@ func (s *StartImagePipelineExecutionOutput) SetRequestId(v string) *StartImagePi return s } +// Contains settings for the SSM agent on your build instance. +type SystemsManagerAgent struct { + _ struct{} `type:"structure"` + + // This property defaults to true. If Image Builder installs the SSM agent on + // a build instance, it removes the agent before creating a snapshot for the + // AMI. To ensure that the AMI you create includes the SSM agent, set this property + // to false. + UninstallAfterBuild *bool `locationName:"uninstallAfterBuild" type:"boolean"` +} + +// String returns the string representation +func (s SystemsManagerAgent) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s SystemsManagerAgent) GoString() string { + return s.String() +} + +// SetUninstallAfterBuild sets the UninstallAfterBuild field's value. +func (s *SystemsManagerAgent) SetUninstallAfterBuild(v bool) *SystemsManagerAgent { + s.UninstallAfterBuild = &v + return s +} + type TagResourceInput struct { _ struct{} `type:"structure"` @@ -14936,7 +15194,7 @@ type UpdateInfrastructureConfigurationInput struct { InfrastructureConfigurationArn *string `locationName:"infrastructureConfigurationArn" type:"string" required:"true"` // The instance profile to associate with the instance used to customize your - // EC2 AMI. + // Amazon EC2 AMI. // // InstanceProfileName is a required field InstanceProfileName *string `locationName:"instanceProfileName" min:"1" type:"string" required:"true"` @@ -14957,13 +15215,14 @@ type UpdateInfrastructureConfigurationInput struct { ResourceTags map[string]*string `locationName:"resourceTags" min:"1" type:"map"` // The security group IDs to associate with the instance used to customize your - // EC2 AMI. + // Amazon EC2 AMI. SecurityGroupIds []*string `locationName:"securityGroupIds" type:"list"` // The SNS topic on which to send image build events. SnsTopicArn *string `locationName:"snsTopicArn" type:"string"` - // The subnet ID to place the instance used to customize your EC2 AMI in. + // The subnet ID to place the instance used to customize your Amazon EC2 AMI + // in. SubnetId *string `locationName:"subnetId" min:"1" type:"string"` // The terminate instance on failure setting of the infrastructure configuration. diff --git a/service/imagebuilder/doc.go b/service/imagebuilder/doc.go index 9b3bd755260..e3a93071e75 100644 --- a/service/imagebuilder/doc.go +++ b/service/imagebuilder/doc.go @@ -3,10 +3,10 @@ // Package imagebuilder provides the client and types for making API // requests to EC2 Image Builder. // -// EC2 Image Builder is a fully managed AWS service that makes it easier to -// automate the creation, management, and deployment of customized, secure, -// and up-to-date "golden" server images that are pre-installed and pre-configured -// with software and settings to meet specific IT standards. +// EC2 Image Builder is a fully managed Amazon Web Services service that makes +// it easier to automate the creation, management, and deployment of customized, +// secure, and up-to-date "golden" server images that are pre-installed and +// pre-configured with software and settings to meet specific IT standards. // // See https://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02 for more information on this service. // diff --git a/service/lambda/api.go b/service/lambda/api.go index 47da9360816..398368ab62e 100644 --- a/service/lambda/api.go +++ b/service/lambda/api.go @@ -58,11 +58,11 @@ func (c *Lambda) AddLayerVersionPermissionRequest(input *AddLayerVersionPermissi // AddLayerVersionPermission API operation for AWS Lambda. // -// Adds permissions to the resource-based policy of a version of an AWS Lambda -// layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). +// Adds permissions to the resource-based policy of a version of an Lambda layer +// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). // Use this action to grant layer usage permission to other accounts. You can -// grant permission to a single account, all AWS accounts, or all accounts in -// an organization. +// grant permission to a single account, all accounts in an organization, or +// all Amazon Web Services accounts. // // To revoke permission, call RemoveLayerVersionPermission with the statement // ID that you specified when you added it. @@ -76,7 +76,7 @@ func (c *Lambda) AddLayerVersionPermissionRequest(input *AddLayerVersionPermissi // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -164,19 +164,19 @@ func (c *Lambda) AddPermissionRequest(input *AddPermissionInput) (req *request.R // AddPermission API operation for AWS Lambda. // -// Grants an AWS service or another account permission to use a function. You -// can apply the policy at the function level, or specify a qualifier to restrict -// access to a single version or alias. If you use a qualifier, the invoker -// must use the full Amazon Resource Name (ARN) of that version or alias to -// invoke the function. +// Grants an Amazon Web Services service or another account permission to use +// a function. You can apply the policy at the function level, or specify a +// qualifier to restrict access to a single version or alias. If you use a qualifier, +// the invoker must use the full Amazon Resource Name (ARN) of that version +// or alias to invoke the function. // // To grant permission to another account, specify the account ID as the Principal. -// For AWS services, the principal is a domain-style identifier defined by the -// service, like s3.amazonaws.com or sns.amazonaws.com. For AWS services, you -// can also specify the ARN of the associated resource as the SourceArn. If -// you grant permission to a service principal without specifying the source, -// other accounts could potentially configure resources in their account to -// invoke your Lambda function. +// For Amazon Web Services services, the principal is a domain-style identifier +// defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For Amazon +// Web Services services, you can also specify the ARN of the associated resource +// as the SourceArn. If you grant permission to a service principal without +// specifying the source, other accounts could potentially configure resources +// in their account to invoke your Lambda function. // // This action adds a statement to a resource-based permissions policy for the // function. For more information about function policies, see Lambda Function @@ -191,7 +191,7 @@ func (c *Lambda) AddPermissionRequest(input *AddPermissionInput) (req *request.R // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -296,7 +296,7 @@ func (c *Lambda) CreateAliasRequest(input *CreateAliasInput) (req *request.Reque // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -389,7 +389,7 @@ func (c *Lambda) CreateCodeSigningConfigRequest(input *CreateCodeSigningConfigIn // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * InvalidParameterValueException // One of the parameters in the request is invalid. @@ -460,22 +460,24 @@ func (c *Lambda) CreateEventSourceMappingRequest(input *CreateEventSourceMapping // CreateEventSourceMapping API operation for AWS Lambda. // -// Creates a mapping between an event source and an AWS Lambda function. Lambda +// Creates a mapping between an event source and an Lambda function. Lambda // reads items from the event source and triggers the function. // -// For details about each event source type, see the following topics. +// For details about each event source type, see the following topics. In particular, +// each of the topics describes the required and optional parameters for the +// specific event source. // -// * Using AWS Lambda with Amazon DynamoDB (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html) +// * Configuring a Dynamo DB stream as an event source (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping) // -// * Using AWS Lambda with Amazon Kinesis (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html) +// * Configuring a Kinesis stream as an event source (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping) // -// * Using AWS Lambda with Amazon SQS (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html) +// * Configuring an SQS queue as an event source (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource) // -// * Using AWS Lambda with Amazon MQ (https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html) +// * Configuring an MQ broker as an event source (https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping) // -// * Using AWS Lambda with Amazon MSK (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) +// * Configuring MSK as an event source (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) // -// * Using AWS Lambda with Self-Managed Apache Kafka (https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html) +// * Configuring Self-Managed Apache Kafka as an event source (https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html) // // The following error handling options are only available for stream sources // (DynamoDB and Kinesis): @@ -505,7 +507,7 @@ func (c *Lambda) CreateEventSourceMappingRequest(input *CreateEventSourceMapping // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * InvalidParameterValueException // One of the parameters in the request is invalid. @@ -590,8 +592,19 @@ func (c *Lambda) CreateFunctionRequest(input *CreateFunctionInput) (req *request // and an execution role (https://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html#lambda-intro-execution-role). // The deployment package is a .zip file archive or container image that contains // your function code. The execution role grants the function permission to -// use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS -// X-Ray for request tracing. +// use Amazon Web Services services, such as Amazon CloudWatch Logs for log +// streaming and X-Ray for request tracing. +// +// You set the package type to Image if the deployment package is a container +// image (https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html). +// For a container image, the code property must include the URI of a container +// image in the Amazon ECR registry. You do not need to specify the handler +// and runtime properties. +// +// You set the package type to Zip if the deployment package is a .zip file +// archive (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip). +// For a .zip file archive, the code property specifies the location of the +// .zip file. You must also specify the handler and runtime properties. // // When you create a function, Lambda provisions an instance of the function // and its supporting resources. If your function connects to a VPC, this process @@ -621,14 +634,14 @@ func (c *Lambda) CreateFunctionRequest(input *CreateFunctionInput) (req *request // publisher. The code-signing configuration includes set set of signing profiles, // which define the trusted publishers for this function. // -// If another account or an AWS service invokes your function, use AddPermission -// to grant permission by creating a resource-based IAM policy. You can grant -// permissions at the function level, on a version, or on an alias. +// If another account or an Amazon Web Services service invokes your function, +// use AddPermission to grant permission by creating a resource-based IAM policy. +// You can grant permissions at the function level, on a version, or on an alias. // // To invoke your function directly, use Invoke. To invoke your function in -// response to events in other AWS services, create an event source mapping -// (CreateEventSourceMapping), or configure a function trigger in the other -// service. For more information, see Invoking Functions (https://docs.aws.amazon.com/lambda/latest/dg/lambda-invocation.html). +// response to events in other Amazon Web Services services, create an event +// source mapping (CreateEventSourceMapping), or configure a function trigger +// in the other service. For more information, see Invoking Functions (https://docs.aws.amazon.com/lambda/latest/dg/lambda-invocation.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -639,7 +652,7 @@ func (c *Lambda) CreateFunctionRequest(input *CreateFunctionInput) (req *request // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * InvalidParameterValueException // One of the parameters in the request is invalid. @@ -746,7 +759,7 @@ func (c *Lambda) DeleteAliasRequest(input *DeleteAliasInput) (req *request.Reque // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * InvalidParameterValueException // One of the parameters in the request is invalid. @@ -836,7 +849,7 @@ func (c *Lambda) DeleteCodeSigningConfigRequest(input *DeleteCodeSigningConfigIn // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * InvalidParameterValueException // One of the parameters in the request is invalid. @@ -928,7 +941,7 @@ func (c *Lambda) DeleteEventSourceMappingRequest(input *DeleteEventSourceMapping // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -1015,8 +1028,9 @@ func (c *Lambda) DeleteFunctionRequest(input *DeleteFunctionInput) (req *request // Qualifier parameter. Otherwise, all versions and aliases are deleted. // // To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. -// For AWS services and resources that invoke your function directly, delete -// the trigger in the service where you originally configured it. +// For Amazon Web Services services and resources that invoke your function +// directly, delete the trigger in the service where you originally configured +// it. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1027,7 +1041,7 @@ func (c *Lambda) DeleteFunctionRequest(input *DeleteFunctionInput) (req *request // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -1128,7 +1142,7 @@ func (c *Lambda) DeleteFunctionCodeSigningConfigRequest(input *DeleteFunctionCod // The resource specified in the request does not exist. // // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * TooManyRequestsException // The request throughput limit was exceeded. @@ -1214,7 +1228,7 @@ func (c *Lambda) DeleteFunctionConcurrencyRequest(input *DeleteFunctionConcurren // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -1309,7 +1323,7 @@ func (c *Lambda) DeleteFunctionEventInvokeConfigRequest(input *DeleteFunctionEve // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -1387,7 +1401,7 @@ func (c *Lambda) DeleteLayerVersionRequest(input *DeleteLayerVersionInput) (req // DeleteLayerVersion API operation for AWS Lambda. // -// Deletes a version of an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). +// Deletes a version of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). // Deleted versions can no longer be viewed or added to functions. To avoid // breaking functions, a copy of the version remains in Lambda until no functions // refer to it. @@ -1401,7 +1415,7 @@ func (c *Lambda) DeleteLayerVersionRequest(input *DeleteLayerVersionInput) (req // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * TooManyRequestsException // The request throughput limit was exceeded. @@ -1496,7 +1510,7 @@ func (c *Lambda) DeleteProvisionedConcurrencyConfigRequest(input *DeleteProvisio // The request throughput limit was exceeded. // // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/lambda-2015-03-31/DeleteProvisionedConcurrencyConfig func (c *Lambda) DeleteProvisionedConcurrencyConfig(input *DeleteProvisionedConcurrencyConfigInput) (*DeleteProvisionedConcurrencyConfigOutput, error) { @@ -1565,7 +1579,7 @@ func (c *Lambda) GetAccountSettingsRequest(input *GetAccountSettingsInput) (req // GetAccountSettings API operation for AWS Lambda. // // Retrieves details about your account's limits (https://docs.aws.amazon.com/lambda/latest/dg/limits.html) -// and usage in an AWS Region. +// and usage in an Amazon Web Services Region. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1579,7 +1593,7 @@ func (c *Lambda) GetAccountSettingsRequest(input *GetAccountSettingsInput) (req // The request throughput limit was exceeded. // // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/lambda-2015-03-31/GetAccountSettings func (c *Lambda) GetAccountSettings(input *GetAccountSettingsInput) (*GetAccountSettingsOutput, error) { @@ -1658,7 +1672,7 @@ func (c *Lambda) GetAliasRequest(input *GetAliasInput) (req *request.Request, ou // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -1746,7 +1760,7 @@ func (c *Lambda) GetCodeSigningConfigRequest(input *GetCodeSigningConfigInput) ( // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * InvalidParameterValueException // One of the parameters in the request is invalid. @@ -1832,7 +1846,7 @@ func (c *Lambda) GetEventSourceMappingRequest(input *GetEventSourceMappingInput) // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -1922,7 +1936,7 @@ func (c *Lambda) GetFunctionRequest(input *GetFunctionInput) (req *request.Reque // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -2016,7 +2030,7 @@ func (c *Lambda) GetFunctionCodeSigningConfigRequest(input *GetFunctionCodeSigni // The resource specified in the request does not exist. // // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * TooManyRequestsException // The request throughput limit was exceeded. @@ -2108,7 +2122,7 @@ func (c *Lambda) GetFunctionConcurrencyRequest(input *GetFunctionConcurrencyInpu // The request throughput limit was exceeded. // // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/lambda-2015-03-31/GetFunctionConcurrency func (c *Lambda) GetFunctionConcurrency(input *GetFunctionConcurrencyInput) (*GetFunctionConcurrencyOutput, error) { @@ -2192,7 +2206,7 @@ func (c *Lambda) GetFunctionConfigurationRequest(input *GetFunctionConfiguration // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -2283,7 +2297,7 @@ func (c *Lambda) GetFunctionEventInvokeConfigRequest(input *GetFunctionEventInvo // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -2360,7 +2374,7 @@ func (c *Lambda) GetLayerVersionRequest(input *GetLayerVersionInput) (req *reque // GetLayerVersion API operation for AWS Lambda. // -// Returns information about a version of an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html), +// Returns information about a version of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html), // with a link to download the layer archive that's valid for 10 minutes. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2372,7 +2386,7 @@ func (c *Lambda) GetLayerVersionRequest(input *GetLayerVersionInput) (req *reque // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * InvalidParameterValueException // One of the parameters in the request is invalid. @@ -2449,7 +2463,7 @@ func (c *Lambda) GetLayerVersionByArnRequest(input *GetLayerVersionByArnInput) ( // GetLayerVersionByArn API operation for AWS Lambda. // -// Returns information about a version of an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html), +// Returns information about a version of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html), // with a link to download the layer archive that's valid for 10 minutes. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2461,7 +2475,7 @@ func (c *Lambda) GetLayerVersionByArnRequest(input *GetLayerVersionByArnInput) ( // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * InvalidParameterValueException // One of the parameters in the request is invalid. @@ -2538,7 +2552,7 @@ func (c *Lambda) GetLayerVersionPolicyRequest(input *GetLayerVersionPolicyInput) // GetLayerVersionPolicy API operation for AWS Lambda. // -// Returns the permission policy for a version of an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). +// Returns the permission policy for a version of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). // For more information, see AddLayerVersionPermission. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2550,7 +2564,7 @@ func (c *Lambda) GetLayerVersionPolicyRequest(input *GetLayerVersionPolicyInput) // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -2639,7 +2653,7 @@ func (c *Lambda) GetPolicyRequest(input *GetPolicyInput) (req *request.Request, // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -2737,7 +2751,7 @@ func (c *Lambda) GetProvisionedConcurrencyConfigRequest(input *GetProvisionedCon // The request throughput limit was exceeded. // // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ProvisionedConcurrencyConfigNotFoundException // The specified configuration does not exist. @@ -2856,7 +2870,7 @@ func (c *Lambda) InvokeRequest(input *InvokeInput) (req *request.Request, output // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -2878,17 +2892,17 @@ func (c *Lambda) InvokeRequest(input *InvokeInput) (req *request.Request, output // One of the parameters in the request is invalid. // // * EC2UnexpectedException -// AWS Lambda received an unexpected EC2 client exception while setting up for -// the Lambda function. +// Lambda received an unexpected EC2 client exception while setting up for the +// Lambda function. // // * SubnetIPAddressLimitReachedException -// AWS Lambda was not able to set up VPC access for the Lambda function because +// Lambda was not able to set up VPC access for the Lambda function because // one or more configured subnets has no available IP addresses. // // * ENILimitReachedException -// AWS Lambda was not able to create an elastic network interface in the VPC, -// specified as part of Lambda function configuration, because the limit for -// network interfaces has been reached. +// Lambda was not able to create an elastic network interface in the VPC, specified +// as part of Lambda function configuration, because the limit for network interfaces +// has been reached. // // * EFSMountConnectivityException // The function couldn't make a network connection to the configured file system. @@ -2905,7 +2919,7 @@ func (c *Lambda) InvokeRequest(input *InvokeInput) (req *request.Request, output // An error occured when reading from or writing to a connected file system. // // * EC2ThrottledException -// AWS Lambda was throttled by Amazon EC2 during Lambda function initialization +// Lambda was throttled by Amazon EC2 during Lambda function initialization // using the execution role provided for the Lambda function. // // * EC2AccessDeniedException @@ -2919,7 +2933,7 @@ func (c *Lambda) InvokeRequest(input *InvokeInput) (req *request.Request, output // invalid. // // * InvalidZipFileException -// AWS Lambda could not unzip the deployment package. +// Lambda could not unzip the deployment package. // // * KMSDisabledException // Lambda was unable to decrypt the environment variables because the KMS key @@ -3032,7 +3046,7 @@ func (c *Lambda) InvokeAsyncRequest(input *InvokeAsyncInput) (req *request.Reque // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -3134,7 +3148,7 @@ func (c *Lambda) ListAliasesRequest(input *ListAliasesInput) (req *request.Reque // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -3282,7 +3296,7 @@ func (c *Lambda) ListCodeSigningConfigsRequest(input *ListCodeSigningConfigsInpu // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * InvalidParameterValueException // One of the parameters in the request is invalid. @@ -3423,7 +3437,7 @@ func (c *Lambda) ListEventSourceMappingsRequest(input *ListEventSourceMappingsIn // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -3580,7 +3594,7 @@ func (c *Lambda) ListFunctionEventInvokeConfigsRequest(input *ListFunctionEventI // The request throughput limit was exceeded. // // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/lambda-2015-03-31/ListFunctionEventInvokeConfigs func (c *Lambda) ListFunctionEventInvokeConfigs(input *ListFunctionEventInvokeConfigsInput) (*ListFunctionEventInvokeConfigsOutput, error) { @@ -3726,7 +3740,7 @@ func (c *Lambda) ListFunctionsRequest(input *ListFunctionsInput) (req *request.R // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * TooManyRequestsException // The request throughput limit was exceeded. @@ -3871,7 +3885,7 @@ func (c *Lambda) ListFunctionsByCodeSigningConfigRequest(input *ListFunctionsByC // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * InvalidParameterValueException // One of the parameters in the request is invalid. @@ -4003,7 +4017,7 @@ func (c *Lambda) ListLayerVersionsRequest(input *ListLayerVersionsInput) (req *r // ListLayerVersions API operation for AWS Lambda. // -// Lists the versions of an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). +// Lists the versions of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). // Versions that have been deleted aren't listed. Specify a runtime identifier // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) to list // only versions that indicate that they're compatible with that runtime. @@ -4017,7 +4031,7 @@ func (c *Lambda) ListLayerVersionsRequest(input *ListLayerVersionsInput) (req *r // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * InvalidParameterValueException // One of the parameters in the request is invalid. @@ -4152,7 +4166,7 @@ func (c *Lambda) ListLayersRequest(input *ListLayersInput) (req *request.Request // ListLayers API operation for AWS Lambda. // -// Lists AWS Lambda layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) +// Lists Lambda layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) // and shows information about the latest version of each. Specify a runtime // identifier (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) // to list only layers that indicate that they're compatible with that runtime. @@ -4166,7 +4180,7 @@ func (c *Lambda) ListLayersRequest(input *ListLayersInput) (req *request.Request // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * InvalidParameterValueException // One of the parameters in the request is invalid. @@ -4318,7 +4332,7 @@ func (c *Lambda) ListProvisionedConcurrencyConfigsRequest(input *ListProvisioned // The request throughput limit was exceeded. // // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/lambda-2015-03-31/ListProvisionedConcurrencyConfigs func (c *Lambda) ListProvisionedConcurrencyConfigs(input *ListProvisionedConcurrencyConfigsInput) (*ListProvisionedConcurrencyConfigsOutput, error) { @@ -4450,7 +4464,7 @@ func (c *Lambda) ListTagsRequest(input *ListTagsInput) (req *request.Request, ou // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -4546,7 +4560,7 @@ func (c *Lambda) ListVersionsByFunctionRequest(input *ListVersionsByFunctionInpu // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -4675,7 +4689,7 @@ func (c *Lambda) PublishLayerVersionRequest(input *PublishLayerVersionInput) (re // PublishLayerVersion API operation for AWS Lambda. // -// Creates an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) +// Creates an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) // from a ZIP archive. Each time you call PublishLayerVersion with the same // layer name, a new version is created. // @@ -4690,7 +4704,7 @@ func (c *Lambda) PublishLayerVersionRequest(input *PublishLayerVersionInput) (re // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -4774,8 +4788,8 @@ func (c *Lambda) PublishVersionRequest(input *PublishVersionInput) (req *request // from the current code and configuration of a function. Use versions to create // a snapshot of your function code and configuration that doesn't change. // -// AWS Lambda doesn't publish a version if the function's configuration and -// code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration +// Lambda doesn't publish a version if the function's configuration and code +// haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration // to update the function before publishing a version. // // Clients can invoke versions directly or with an alias. To create an alias, @@ -4790,7 +4804,7 @@ func (c *Lambda) PublishVersionRequest(input *PublishVersionInput) (req *request // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -4891,7 +4905,7 @@ func (c *Lambda) PutFunctionCodeSigningConfigRequest(input *PutFunctionCodeSigni // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * InvalidParameterValueException // One of the parameters in the request is invalid. @@ -4998,7 +5012,7 @@ func (c *Lambda) PutFunctionConcurrencyRequest(input *PutFunctionConcurrencyInpu // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * InvalidParameterValueException // One of the parameters in the request is invalid. @@ -5105,7 +5119,7 @@ func (c *Lambda) PutFunctionEventInvokeConfigRequest(input *PutFunctionEventInvo // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -5205,7 +5219,7 @@ func (c *Lambda) PutProvisionedConcurrencyConfigRequest(input *PutProvisionedCon // The request throughput limit was exceeded. // // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/lambda-2015-03-31/PutProvisionedConcurrencyConfig func (c *Lambda) PutProvisionedConcurrencyConfig(input *PutProvisionedConcurrencyConfigInput) (*PutProvisionedConcurrencyConfigOutput, error) { @@ -5274,7 +5288,7 @@ func (c *Lambda) RemoveLayerVersionPermissionRequest(input *RemoveLayerVersionPe // RemoveLayerVersionPermission API operation for AWS Lambda. // -// Removes a statement from the permissions policy for a version of an AWS Lambda +// Removes a statement from the permissions policy for a version of an Lambda // layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). // For more information, see AddLayerVersionPermission. // @@ -5287,7 +5301,7 @@ func (c *Lambda) RemoveLayerVersionPermissionRequest(input *RemoveLayerVersionPe // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -5370,8 +5384,8 @@ func (c *Lambda) RemovePermissionRequest(input *RemovePermissionInput) (req *req // RemovePermission API operation for AWS Lambda. // -// Revokes function-use permission from an AWS service or another account. You -// can get the ID of the statement from the output of GetPolicy. +// Revokes function-use permission from an Amazon Web Services service or another +// account. You can get the ID of the statement from the output of GetPolicy. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5382,7 +5396,7 @@ func (c *Lambda) RemovePermissionRequest(input *RemovePermissionInput) (req *req // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -5477,7 +5491,7 @@ func (c *Lambda) TagResourceRequest(input *TagResourceInput) (req *request.Reque // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -5570,7 +5584,7 @@ func (c *Lambda) UntagResourceRequest(input *UntagResourceInput) (req *request.R // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -5661,7 +5675,7 @@ func (c *Lambda) UpdateAliasRequest(input *UpdateAliasInput) (req *request.Reque // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -5758,7 +5772,7 @@ func (c *Lambda) UpdateCodeSigningConfigRequest(input *UpdateCodeSigningConfigIn // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * InvalidParameterValueException // One of the parameters in the request is invalid. @@ -5832,7 +5846,7 @@ func (c *Lambda) UpdateEventSourceMappingRequest(input *UpdateEventSourceMapping // UpdateEventSourceMapping API operation for AWS Lambda. // -// Updates an event source mapping. You can change the function that AWS Lambda +// Updates an event source mapping. You can change the function that Lambda // invokes, or pause invocation and resume later from the same location. // // The following error handling options are only available for stream sources @@ -5863,7 +5877,7 @@ func (c *Lambda) UpdateEventSourceMappingRequest(input *UpdateEventSourceMapping // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -5968,7 +5982,7 @@ func (c *Lambda) UpdateFunctionCodeRequest(input *UpdateFunctionCodeInput) (req // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -6083,7 +6097,7 @@ func (c *Lambda) UpdateFunctionConfigurationRequest(input *UpdateFunctionConfigu // version, only the unpublished version. // // To configure function concurrency, use PutFunctionConcurrency. To grant invoke -// permissions to an account or AWS service, use AddPermission. +// permissions to an account or Amazon Web Services service, use AddPermission. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6094,7 +6108,7 @@ func (c *Lambda) UpdateFunctionConfigurationRequest(input *UpdateFunctionConfigu // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -6205,7 +6219,7 @@ func (c *Lambda) UpdateFunctionEventInvokeConfigRequest(input *UpdateFunctionEve // // Returned Error Types: // * ServiceException -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. // // * ResourceNotFoundException // The resource specified in the request does not exist. @@ -6247,8 +6261,8 @@ type AccountLimit struct { // extracted. CodeSizeUnzipped *int64 `type:"long"` - // The maximum size of a deployment package when it's uploaded directly to AWS - // Lambda. Use Amazon S3 for larger files. + // The maximum size of a deployment package when it's uploaded directly to Lambda. + // Use Amazon S3 for larger files. CodeSizeZipped *int64 `type:"long"` // The maximum number of simultaneous function executions. @@ -6354,7 +6368,10 @@ type AddLayerVersionPermissionInput struct { // organization. OrganizationId *string `type:"string"` - // An account ID, or * to grant permission to all AWS accounts. + // An account ID, or * to grant layer usage permission to all accounts in an + // organization, or all Amazon Web Services accounts (if organizationId is not + // specified). For the last case, make sure that you really do want all Amazon + // Web Services accounts to have usage permission to this layer. // // Principal is a required field Principal *string `type:"string" required:"true"` @@ -6519,9 +6536,9 @@ type AddPermissionInput struct { // FunctionName is a required field FunctionName *string `location:"uri" locationName:"FunctionName" min:"1" type:"string" required:"true"` - // The AWS service or account that invokes the function. If you specify a service, - // use SourceArn or SourceAccount to limit who can invoke the function through - // that service. + // The Amazon Web Services service or account that invokes the function. If + // you specify a service, use SourceArn or SourceAccount to limit who can invoke + // the function through that service. // // Principal is a required field Principal *string `type:"string" required:"true"` @@ -6541,8 +6558,9 @@ type AddPermissionInput struct { // by another account. SourceAccount *string `type:"string"` - // For AWS services, the ARN of the AWS resource that invokes the function. - // For example, an Amazon S3 bucket or Amazon SNS topic. + // For Amazon Web Services services, the ARN of the Amazon Web Services resource + // that invokes the function. For example, an Amazon S3 bucket or Amazon SNS + // topic. SourceArn *string `type:"string"` // A statement identifier that differentiates the statement from others in the @@ -6808,7 +6826,7 @@ func (s *AllowedPublishers) SetSigningProfileVersionArns(v []*string) *AllowedPu return s } -// Details about a Code signing configuration. +// Details about a Code signing configuration (https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html). type CodeSigningConfig struct { _ struct{} `type:"structure"` @@ -6947,8 +6965,8 @@ func (s *CodeSigningConfigNotFoundException) RequestID() string { return s.RespMetadata.RequestID } -// Code signing configuration policies specifies the validation failure action -// for signature mismatch or expiry. +// Code signing configuration policies (https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html#config-codesigning-policies) +// specify the validation failure action for signature mismatch or expiry. type CodeSigningPolicies struct { _ struct{} `type:"structure"` @@ -7305,10 +7323,11 @@ type CreateEventSourceMappingInput struct { // * Self-Managed Apache Kafka - Default 100. Max 10,000. BatchSize *int64 `min:"1" type:"integer"` - // (Streams) If the function returns an error, split the batch in two and retry. + // (Streams only) If the function returns an error, split the batch in two and + // retry. BisectBatchOnFunctionError *bool `type:"boolean"` - // (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded + // (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded // records. DestinationConfig *DestinationConfig `type:"structure"` @@ -7345,24 +7364,24 @@ type CreateEventSourceMappingInput struct { // FunctionName is a required field FunctionName *string `min:"1" type:"string" required:"true"` - // (Streams) A list of current response type enums applied to the event source - // mapping. + // (Streams only) A list of current response type enums applied to the event + // source mapping. FunctionResponseTypes []*string `type:"list"` // (Streams and SQS standard queues) The maximum amount of time to gather records // before invoking the function, in seconds. MaximumBatchingWindowInSeconds *int64 `type:"integer"` - // (Streams) Discard records older than the specified age. The default value - // is infinite (-1). + // (Streams only) Discard records older than the specified age. The default + // value is infinite (-1). MaximumRecordAgeInSeconds *int64 `type:"integer"` - // (Streams) Discard records after the specified number of retries. The default - // value is infinite (-1). When set to infinite (-1), failed records will be - // retried until the record expires. + // (Streams only) Discard records after the specified number of retries. The + // default value is infinite (-1). When set to infinite (-1), failed records + // will be retried until the record expires. MaximumRetryAttempts *int64 `type:"integer"` - // (Streams) The number of batches to process from each shard concurrently. + // (Streams only) The number of batches to process from each shard concurrently. ParallelizationFactor *int64 `min:"1" type:"integer"` // (MQ) The name of the Amazon MQ broker destination queue to consume. @@ -7386,8 +7405,8 @@ type CreateEventSourceMappingInput struct { // The name of the Kafka topic. Topics []*string `min:"1" type:"list"` - // (Streams) The duration in seconds of a processing window. The range is between - // 1 second up to 900 seconds. + // (Streams only) The duration in seconds of a processing window. The range + // is between 1 second up to 900 seconds. TumblingWindowInSeconds *int64 `type:"integer"` } @@ -7607,13 +7626,13 @@ type CreateFunctionInput struct { // Programming Model (https://docs.aws.amazon.com/lambda/latest/dg/programming-model-v2.html). Handler *string `type:"string"` - // Container image configuration values (https://docs.aws.amazon.com/lambda/latest/dg/images-parms.html) + // Container image configuration values (https://docs.aws.amazon.com/lambda/latest/dg/configuration-images.html#configuration-images-settings) // that override the values in the container image Dockerfile. ImageConfig *ImageConfig `type:"structure"` - // The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt - // your function's environment variables. If it's not provided, AWS Lambda uses - // a default service key. + // The ARN of the Amazon Web Services Key Management Service (KMS) key that's + // used to encrypt your function's environment variables. If it's not provided, + // Lambda uses a default service key. KMSKeyArn *string `type:"string"` // A list of function layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) @@ -7621,9 +7640,9 @@ type CreateFunctionInput struct { // ARN, including the version. Layers []*string `type:"list"` - // The amount of memory available to the function at runtime. Increasing the - // function's memory also increases its CPU allocation. The default value is - // 128 MB. The value can be any multiple of 1 MB. + // The amount of memory available to the function (https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html) + // at runtime. Increasing the function memory also increases its CPU allocation. + // The default value is 128 MB. The value can be any multiple of 1 MB. MemorySize *int64 `min:"128" type:"integer"` // The type of deployment package. Set to Image for container image and set @@ -7646,17 +7665,18 @@ type CreateFunctionInput struct { Tags map[string]*string `type:"map"` // The amount of time that Lambda allows a function to run before stopping it. - // The default is 3 seconds. The maximum allowed value is 900 seconds. + // The default is 3 seconds. The maximum allowed value is 900 seconds. For additional + // information, see Lambda execution environment (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html). Timeout *int64 `min:"1" type:"integer"` // Set Mode to Active to sample and trace a subset of incoming requests with - // AWS X-Ray. + // X-Ray (https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html). TracingConfig *TracingConfig `type:"structure"` - // For network connectivity to AWS resources in a VPC, specify a list of security - // groups and subnets in the VPC. When you connect a function to a VPC, it can - // only access resources and the internet through that VPC. For more information, - // see VPC Settings (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). + // For network connectivity to Amazon Web Services resources in a VPC, specify + // a list of security groups and subnets in the VPC. When you connect a function + // to a VPC, it can only access resources and the internet through that VPC. + // For more information, see VPC Settings (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). VpcConfig *VpcConfig `type:"structure"` } @@ -8572,7 +8592,7 @@ func (s *EC2AccessDeniedException) RequestID() string { return s.RespMetadata.RequestID } -// AWS Lambda was throttled by Amazon EC2 during Lambda function initialization +// Lambda was throttled by Amazon EC2 during Lambda function initialization // using the execution role provided for the Lambda function. type EC2ThrottledException struct { _ struct{} `type:"structure"` @@ -8631,8 +8651,8 @@ func (s *EC2ThrottledException) RequestID() string { return s.RespMetadata.RequestID } -// AWS Lambda received an unexpected EC2 client exception while setting up for -// the Lambda function. +// Lambda received an unexpected EC2 client exception while setting up for the +// Lambda function. type EC2UnexpectedException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -8926,9 +8946,9 @@ func (s *EFSMountTimeoutException) RequestID() string { return s.RespMetadata.RequestID } -// AWS Lambda was not able to create an elastic network interface in the VPC, -// specified as part of Lambda function configuration, because the limit for -// network interfaces has been reached. +// Lambda was not able to create an elastic network interface in the VPC, specified +// as part of Lambda function configuration, because the limit for network interfaces +// has been reached. type ENILimitReachedException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -8986,11 +9006,15 @@ func (s *ENILimitReachedException) RequestID() string { return s.RespMetadata.RequestID } -// A function's environment variable settings. +// A function's environment variable settings. You can use environment variables +// to adjust your function's behavior without updating code. An environment +// variable is a pair of strings that are stored in a function's version-specific +// configuration. type Environment struct { _ struct{} `type:"structure"` - // Environment variable key-value pairs. + // Environment variable key-value pairs. For more information, see Using Lambda + // environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html). Variables map[string]*string `type:"map" sensitive:"true"` } @@ -9078,19 +9102,19 @@ func (s *EnvironmentResponse) SetVariables(v map[string]*string) *EnvironmentRes return s } -// A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping -// for details. +// A mapping between an Amazon Web Services resource and an Lambda function. +// See CreateEventSourceMapping for details. type EventSourceMappingConfiguration struct { _ struct{} `type:"structure"` // The maximum number of items to retrieve in a single batch. BatchSize *int64 `min:"1" type:"integer"` - // (Streams) If the function returns an error, split the batch in two and retry. - // The default value is false. + // (Streams only) If the function returns an error, split the batch in two and + // retry. The default value is false. BisectBatchOnFunctionError *bool `type:"boolean"` - // (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded + // (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded // records. DestinationConfig *DestinationConfig `type:"structure"` @@ -9100,31 +9124,32 @@ type EventSourceMappingConfiguration struct { // The ARN of the Lambda function. FunctionArn *string `type:"string"` - // (Streams) A list of current response type enums applied to the event source - // mapping. + // (Streams only) A list of current response type enums applied to the event + // source mapping. FunctionResponseTypes []*string `type:"list"` // The date that the event source mapping was last updated, or its state changed. LastModified *time.Time `type:"timestamp"` - // The result of the last AWS Lambda invocation of your Lambda function. + // The result of the last Lambda invocation of your Lambda function. LastProcessingResult *string `type:"string"` // (Streams and SQS standard queues) The maximum amount of time to gather records // before invoking the function, in seconds. The default value is zero. MaximumBatchingWindowInSeconds *int64 `type:"integer"` - // (Streams) Discard records older than the specified age. The default value - // is infinite (-1). When set to infinite (-1), failed records are retried until - // the record expires. + // (Streams only) Discard records older than the specified age. The default + // value is -1, which sets the maximum age to infinite. When the value is set + // to infinite, Lambda never discards old records. MaximumRecordAgeInSeconds *int64 `type:"integer"` - // (Streams) Discard records after the specified number of retries. The default - // value is infinite (-1). When set to infinite (-1), failed records are retried - // until the record expires. + // (Streams only) Discard records after the specified number of retries. The + // default value is -1, which sets the maximum number of retries to infinite. + // When MaximumRetryAttempts is infinite, Lambda retries failed records until + // the record expires in the event source. MaximumRetryAttempts *int64 `type:"integer"` - // (Streams) The number of batches to process from each shard concurrently. + // (Streams only) The number of batches to process from each shard concurrently. // The default value is 1. ParallelizationFactor *int64 `min:"1" type:"integer"` @@ -9157,8 +9182,8 @@ type EventSourceMappingConfiguration struct { // The name of the Kafka topic. Topics []*string `min:"1" type:"list"` - // (Streams) The duration in seconds of a processing window. The range is between - // 1 second up to 900 seconds. + // (Streams only) The duration in seconds of a processing window. The range + // is between 1 second up to 900 seconds. TumblingWindowInSeconds *int64 `type:"integer"` // The identifier of the event source mapping. @@ -9308,7 +9333,7 @@ func (s *EventSourceMappingConfiguration) SetUUID(v string) *EventSourceMappingC } // Details about the connection between a Lambda function and an Amazon EFS -// file system. +// file system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html). type FileSystemConfig struct { _ struct{} `type:"structure"` @@ -9368,11 +9393,12 @@ func (s *FileSystemConfig) SetLocalMountPath(v string) *FileSystemConfig { type FunctionCode struct { _ struct{} `type:"structure"` - // URI of a container image in the Amazon ECR registry. + // URI of a container image (https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) + // in the Amazon ECR registry. ImageUri *string `type:"string"` - // An Amazon S3 bucket in the same AWS Region as your function. The bucket can - // be in a different AWS account. + // An Amazon S3 bucket in the same Amazon Web Services Region as your function. + // The bucket can be in a different Amazon Web Services account. S3Bucket *string `min:"3" type:"string"` // The Amazon S3 key of the deployment package. @@ -9381,8 +9407,8 @@ type FunctionCode struct { // For versioned objects, the version of the deployment package object to use. S3ObjectVersion *string `min:"1" type:"string"` - // The base64-encoded contents of the deployment package. AWS SDK and AWS CLI - // clients handle the encoding for you. + // The base64-encoded contents of the deployment package. Amazon Web Services + // SDK and Amazon Web Services CLI clients handle the encoding for you. // // ZipFile is automatically base64 encoded/decoded by the SDK. ZipFile []byte `type:"blob" sensitive:"true"` @@ -9514,10 +9540,10 @@ type FunctionConfiguration struct { // The function's description. Description *string `type:"string"` - // The function's environment variables. + // The function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html). Environment *EnvironmentResponse `type:"structure"` - // Connection settings for an Amazon EFS file system. + // Connection settings for an Amazon EFS file system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html). FileSystemConfigs []*FileSystemConfig `type:"list"` // The function's Amazon Resource Name (ARN). @@ -9593,7 +9619,7 @@ type FunctionConfiguration struct { // stopping it. Timeout *int64 `min:"1" type:"integer"` - // The function's AWS X-Ray tracing configuration. + // The function's X-Ray tracing configuration. TracingConfig *TracingConfigResponse `type:"structure"` // The version of the Lambda function. @@ -11637,7 +11663,7 @@ func (s *InvalidSubnetIDException) RequestID() string { return s.RespMetadata.RequestID } -// AWS Lambda could not unzip the deployment package. +// Lambda could not unzip the deployment package. type InvalidZipFileException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -12202,7 +12228,7 @@ func (s *KMSNotFoundException) RequestID() string { return s.RespMetadata.RequestID } -// An AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). +// An Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). type Layer struct { _ struct{} `type:"structure"` @@ -12253,7 +12279,7 @@ func (s *Layer) SetSigningProfileVersionArn(v string) *Layer { return s } -// A ZIP archive that contains the contents of an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). +// A ZIP archive that contains the contents of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). // You can specify either an Amazon S3 location, or upload a layer archive directly. type LayerVersionContentInput struct { _ struct{} `type:"structure"` @@ -12267,8 +12293,8 @@ type LayerVersionContentInput struct { // For versioned objects, the version of the layer archive object to use. S3ObjectVersion *string `min:"1" type:"string"` - // The base64-encoded contents of the layer archive. AWS SDK and AWS CLI clients - // handle the encoding for you. + // The base64-encoded contents of the layer archive. Amazon Web Services SDK + // and Amazon Web Services CLI clients handle the encoding for you. // // ZipFile is automatically base64 encoded/decoded by the SDK. ZipFile []byte `type:"blob" sensitive:"true"` @@ -12327,7 +12353,7 @@ func (s *LayerVersionContentInput) SetZipFile(v []byte) *LayerVersionContentInpu return s } -// Details about a version of an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). +// Details about a version of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). type LayerVersionContentOutput struct { _ struct{} `type:"structure"` @@ -12387,7 +12413,7 @@ func (s *LayerVersionContentOutput) SetSigningProfileVersionArn(v string) *Layer return s } -// Details about a version of an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). +// Details about a version of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). type LayerVersionsListItem struct { _ struct{} `type:"structure"` @@ -12456,7 +12482,7 @@ func (s *LayerVersionsListItem) SetVersion(v int64) *LayerVersionsListItem { return s } -// Details about an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). +// Details about an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). type LayersListItem struct { _ struct{} `type:"structure"` @@ -13025,7 +13051,7 @@ type ListFunctionsInput struct { // the next page of results. Marker *string `location:"querystring" locationName:"Marker" type:"string"` - // For Lambda@Edge functions, the AWS Region of the master function. For example, + // For Lambda@Edge functions, the Region of the master function. For example, // us-east-1 filters the list of functions to only include Lambda@Edge functions // replicated from a master function in US East (N. Virginia). If specified, // you must set FunctionVersion to ALL. @@ -13499,7 +13525,9 @@ type ListVersionsByFunctionInput struct { // the next page of results. Marker *string `location:"querystring" locationName:"Marker" type:"string"` - // The maximum number of versions to return. + // The maximum number of versions to return. Note that ListVersionsByFunction + // returns a maximum of 50 items in each response, even if you set the number + // higher. MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"` } @@ -15229,7 +15257,7 @@ func (s *SelfManagedEventSource) SetEndpoints(v map[string][]*string) *SelfManag return s } -// The AWS Lambda service encountered an internal error. +// The Lambda service encountered an internal error. type ServiceException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -15309,6 +15337,9 @@ type SourceAccessConfiguration struct { // // * SASL_SCRAM_512_AUTH - The Secrets Manager ARN of your secret key used // for SASL SCRAM-512 authentication of your Self-Managed Apache Kafka brokers. + // + // * VIRTUAL_HOST - The name of the virtual host in your RabbitMQ broker. + // Lambda will use this host as the event source. Type *string `type:"string" enum:"SourceAccessType"` // The value for your chosen configuration in Type. For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName". @@ -15350,7 +15381,7 @@ func (s *SourceAccessConfiguration) SetURI(v string) *SourceAccessConfiguration return s } -// AWS Lambda was not able to set up VPC access for the Lambda function because +// Lambda was not able to set up VPC access for the Lambda function because // one or more configured subnets has no available IP addresses. type SubnetIPAddressLimitReachedException struct { _ struct{} `type:"structure"` @@ -15541,8 +15572,9 @@ func (s *TooManyRequestsException) RequestID() string { return s.RespMetadata.RequestID } -// The function's AWS X-Ray tracing configuration. To sample and record incoming -// requests, set Mode to Active. +// The function's X-Ray (https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) +// tracing configuration. To sample and record incoming requests, set Mode to +// Active. type TracingConfig struct { _ struct{} `type:"structure"` @@ -15566,7 +15598,7 @@ func (s *TracingConfig) SetMode(v string) *TracingConfig { return s } -// The function's AWS X-Ray tracing configuration. +// The function's X-Ray tracing configuration. type TracingConfigResponse struct { _ struct{} `type:"structure"` @@ -15943,10 +15975,11 @@ type UpdateEventSourceMappingInput struct { // * Self-Managed Apache Kafka - Default 100. Max 10,000. BatchSize *int64 `min:"1" type:"integer"` - // (Streams) If the function returns an error, split the batch in two and retry. + // (Streams only) If the function returns an error, split the batch in two and + // retry. BisectBatchOnFunctionError *bool `type:"boolean"` - // (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded + // (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded // records. DestinationConfig *DestinationConfig `type:"structure"` @@ -15970,32 +16003,32 @@ type UpdateEventSourceMappingInput struct { // function name, it's limited to 64 characters in length. FunctionName *string `min:"1" type:"string"` - // (Streams) A list of current response type enums applied to the event source - // mapping. + // (Streams only) A list of current response type enums applied to the event + // source mapping. FunctionResponseTypes []*string `type:"list"` // (Streams and SQS standard queues) The maximum amount of time to gather records // before invoking the function, in seconds. MaximumBatchingWindowInSeconds *int64 `type:"integer"` - // (Streams) Discard records older than the specified age. The default value - // is infinite (-1). + // (Streams only) Discard records older than the specified age. The default + // value is infinite (-1). MaximumRecordAgeInSeconds *int64 `type:"integer"` - // (Streams) Discard records after the specified number of retries. The default - // value is infinite (-1). When set to infinite (-1), failed records will be - // retried until the record expires. + // (Streams only) Discard records after the specified number of retries. The + // default value is infinite (-1). When set to infinite (-1), failed records + // will be retried until the record expires. MaximumRetryAttempts *int64 `type:"integer"` - // (Streams) The number of batches to process from each shard concurrently. + // (Streams only) The number of batches to process from each shard concurrently. ParallelizationFactor *int64 `min:"1" type:"integer"` // An array of the authentication protocol, or the VPC components to secure // your event source. SourceAccessConfigurations []*SourceAccessConfiguration `type:"list"` - // (Streams) The duration in seconds of a processing window. The range is between - // 1 second up to 900 seconds. + // (Streams only) The duration in seconds of a processing window. The range + // is between 1 second up to 900 seconds. TumblingWindowInSeconds *int64 `type:"integer"` // The identifier of the event source mapping. @@ -16168,8 +16201,8 @@ type UpdateFunctionCodeInput struct { // last read it. RevisionId *string `type:"string"` - // An Amazon S3 bucket in the same AWS Region as your function. The bucket can - // be in a different AWS account. + // An Amazon S3 bucket in the same Amazon Web Services Region as your function. + // The bucket can be in a different Amazon Web Services account. S3Bucket *string `min:"3" type:"string"` // The Amazon S3 key of the deployment package. @@ -16178,8 +16211,8 @@ type UpdateFunctionCodeInput struct { // For versioned objects, the version of the deployment package object to use. S3ObjectVersion *string `min:"1" type:"string"` - // The base64-encoded contents of the deployment package. AWS SDK and AWS CLI - // clients handle the encoding for you. + // The base64-encoded contents of the deployment package. Amazon Web Services + // SDK and Amazon Web Services CLI clients handle the encoding for you. // // ZipFile is automatically base64 encoded/decoded by the SDK. ZipFile []byte `type:"blob" sensitive:"true"` @@ -16317,9 +16350,9 @@ type UpdateFunctionConfigurationInput struct { // that override the values in the container image Dockerfile. ImageConfig *ImageConfig `type:"structure"` - // The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt - // your function's environment variables. If it's not provided, AWS Lambda uses - // a default service key. + // The ARN of the Amazon Web Services Key Management Service (KMS) key that's + // used to encrypt your function's environment variables. If it's not provided, + // Lambda uses a default service key. KMSKeyArn *string `type:"string"` // A list of function layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) @@ -16327,9 +16360,9 @@ type UpdateFunctionConfigurationInput struct { // ARN, including the version. Layers []*string `type:"list"` - // The amount of memory available to the function at runtime. Increasing the - // function's memory also increases its CPU allocation. The default value is - // 128 MB. The value can be any multiple of 1 MB. + // The amount of memory available to the function (https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html) + // at runtime. Increasing the function memory also increases its CPU allocation. + // The default value is 128 MB. The value can be any multiple of 1 MB. MemorySize *int64 `min:"128" type:"integer"` // Only update the function if the revision ID matches the ID that's specified. @@ -16344,17 +16377,18 @@ type UpdateFunctionConfigurationInput struct { Runtime *string `type:"string" enum:"Runtime"` // The amount of time that Lambda allows a function to run before stopping it. - // The default is 3 seconds. The maximum allowed value is 900 seconds. + // The default is 3 seconds. The maximum allowed value is 900 seconds. For additional + // information, see Lambda execution environment (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html). Timeout *int64 `min:"1" type:"integer"` // Set Mode to Active to sample and trace a subset of incoming requests with - // AWS X-Ray. + // X-Ray (https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html). TracingConfig *TracingConfig `type:"structure"` - // For network connectivity to AWS resources in a VPC, specify a list of security - // groups and subnets in the VPC. When you connect a function to a VPC, it can - // only access resources and the internet through that VPC. For more information, - // see VPC Settings (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). + // For network connectivity to Amazon Web Services resources in a VPC, specify + // a list of security groups and subnets in the VPC. When you connect a function + // to a VPC, it can only access resources and the internet through that VPC. + // For more information, see VPC Settings (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). VpcConfig *VpcConfig `type:"structure"` } @@ -17077,6 +17111,9 @@ const ( // SourceAccessTypeSaslScram256Auth is a SourceAccessType enum value SourceAccessTypeSaslScram256Auth = "SASL_SCRAM_256_AUTH" + + // SourceAccessTypeVirtualHost is a SourceAccessType enum value + SourceAccessTypeVirtualHost = "VIRTUAL_HOST" ) // SourceAccessType_Values returns all elements of the SourceAccessType enum @@ -17087,6 +17124,7 @@ func SourceAccessType_Values() []string { SourceAccessTypeVpcSecurityGroup, SourceAccessTypeSaslScram512Auth, SourceAccessTypeSaslScram256Auth, + SourceAccessTypeVirtualHost, } } diff --git a/service/lambda/doc.go b/service/lambda/doc.go index 02825cc1f4d..33d944e4def 100644 --- a/service/lambda/doc.go +++ b/service/lambda/doc.go @@ -5,11 +5,11 @@ // // Overview // -// This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides -// additional information. For the service overview, see What is AWS Lambda -// (https://docs.aws.amazon.com/lambda/latest/dg/welcome.html), and for information -// about how the service works, see AWS Lambda: How it Works (https://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html) -// in the AWS Lambda Developer Guide. +// This is the Lambda API Reference. The Lambda Developer Guide provides additional +// information. For the service overview, see What is Lambda (https://docs.aws.amazon.com/lambda/latest/dg/welcome.html), +// and for information about how the service works, see Lambda: How it Works +// (https://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html) in +// the Lambda Developer Guide. // // See https://docs.aws.amazon.com/goto/WebAPI/lambda-2015-03-31 for more information on this service. // diff --git a/service/lambda/errors.go b/service/lambda/errors.go index c11d8ccd0b7..d7b36c492ed 100644 --- a/service/lambda/errors.go +++ b/service/lambda/errors.go @@ -37,15 +37,15 @@ const ( // ErrCodeEC2ThrottledException for service response error code // "EC2ThrottledException". // - // AWS Lambda was throttled by Amazon EC2 during Lambda function initialization + // Lambda was throttled by Amazon EC2 during Lambda function initialization // using the execution role provided for the Lambda function. ErrCodeEC2ThrottledException = "EC2ThrottledException" // ErrCodeEC2UnexpectedException for service response error code // "EC2UnexpectedException". // - // AWS Lambda received an unexpected EC2 client exception while setting up for - // the Lambda function. + // Lambda received an unexpected EC2 client exception while setting up for the + // Lambda function. ErrCodeEC2UnexpectedException = "EC2UnexpectedException" // ErrCodeEFSIOException for service response error code @@ -77,9 +77,9 @@ const ( // ErrCodeENILimitReachedException for service response error code // "ENILimitReachedException". // - // AWS Lambda was not able to create an elastic network interface in the VPC, - // specified as part of Lambda function configuration, because the limit for - // network interfaces has been reached. + // Lambda was not able to create an elastic network interface in the VPC, specified + // as part of Lambda function configuration, because the limit for network interfaces + // has been reached. ErrCodeENILimitReachedException = "ENILimitReachedException" // ErrCodeInvalidCodeSignatureException for service response error code @@ -123,7 +123,7 @@ const ( // ErrCodeInvalidZipFileException for service response error code // "InvalidZipFileException". // - // AWS Lambda could not unzip the deployment package. + // Lambda could not unzip the deployment package. ErrCodeInvalidZipFileException = "InvalidZipFileException" // ErrCodeKMSAccessDeniedException for service response error code @@ -211,13 +211,13 @@ const ( // ErrCodeServiceException for service response error code // "ServiceException". // - // The AWS Lambda service encountered an internal error. + // The Lambda service encountered an internal error. ErrCodeServiceException = "ServiceException" // ErrCodeSubnetIPAddressLimitReachedException for service response error code // "SubnetIPAddressLimitReachedException". // - // AWS Lambda was not able to set up VPC access for the Lambda function because + // Lambda was not able to set up VPC access for the Lambda function because // one or more configured subnets has no available IP addresses. ErrCodeSubnetIPAddressLimitReachedException = "SubnetIPAddressLimitReachedException" diff --git a/service/macie2/api.go b/service/macie2/api.go index df7cd017d1c..49a6a1261f6 100644 --- a/service/macie2/api.go +++ b/service/macie2/api.go @@ -1685,7 +1685,8 @@ func (c *Macie2) DescribeOrganizationConfigurationRequest(input *DescribeOrganiz // DescribeOrganizationConfiguration API operation for Amazon Macie 2. // -// Retrieves the Amazon Macie configuration settings for an AWS organization. +// Retrieves the Amazon Macie configuration settings for an Amazon Web Services +// organization. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1896,7 +1897,7 @@ func (c *Macie2) DisableOrganizationAdminAccountRequest(input *DisableOrganizati // DisableOrganizationAdminAccount API operation for Amazon Macie 2. // // Disables an account as the delegated Amazon Macie administrator account for -// an AWS organization. +// an Amazon Web Services organization. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2425,7 +2426,7 @@ func (c *Macie2) EnableOrganizationAdminAccountRequest(input *EnableOrganization // EnableOrganizationAdminAccount API operation for Amazon Macie 2. // // Designates an account as the delegated Amazon Macie administrator account -// for an AWS organization. +// for an Amazon Web Services organization. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3259,7 +3260,7 @@ func (c *Macie2) GetFindingsPublicationConfigurationRequest(input *GetFindingsPu // GetFindingsPublicationConfiguration API operation for Amazon Macie 2. // -// Retrieves the configuration settings for publishing findings to AWS Security +// Retrieves the configuration settings for publishing findings to Security // Hub. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -5033,7 +5034,7 @@ func (c *Macie2) ListOrganizationAdminAccountsRequest(input *ListOrganizationAdm // ListOrganizationAdminAccounts API operation for Amazon Macie 2. // // Retrieves information about the delegated Amazon Macie administrator account -// for an AWS organization. +// for an Amazon Web Services organization. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5370,8 +5371,7 @@ func (c *Macie2) PutFindingsPublicationConfigurationRequest(input *PutFindingsPu // PutFindingsPublicationConfiguration API operation for Amazon Macie 2. // -// Updates the configuration settings for publishing findings to AWS Security -// Hub. +// Updates the configuration settings for publishing findings to Security Hub. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5481,8 +5481,8 @@ func (c *Macie2) SearchResourcesRequest(input *SearchResourcesInput) (req *reque // SearchResources API operation for Amazon Macie 2. // -// Retrieves (queries) statistical data and other information about AWS resources -// that Amazon Macie monitors and analyzes. +// Retrieves (queries) statistical data and other information about Amazon Web +// Services resources that Amazon Macie monitors and analyzes. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6316,7 +6316,8 @@ func (c *Macie2) UpdateOrganizationConfigurationRequest(input *UpdateOrganizatio // UpdateOrganizationConfiguration API operation for Amazon Macie 2. // -// Updates the Amazon Macie configuration settings for an AWS organization. +// Updates the Amazon Macie configuration settings for an Amazon Web Services +// organization. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6377,11 +6378,11 @@ func (c *Macie2) UpdateOrganizationConfigurationWithContext(ctx aws.Context, inp } // Specifies an Amazon Macie membership invitation to accept. In the request, -// you have to specify the ID for the AWS account that sent the invitation. -// Otherwise, a validation error occurs. To specify this ID, we recommend that -// you use the administratorAccountId property instead of the masterAccount -// property. The masterAccount property has been deprecated and is retained -// only for backward compatibility. +// you have to specify the ID for the Amazon Web Services account that sent +// the invitation. Otherwise, a validation error occurs. To specify this ID, +// we recommend that you use the administratorAccountId property instead of +// the masterAccount property. The masterAccount property has been deprecated +// and is retained only for backward compatibility. type AcceptInvitationInput struct { _ struct{} `type:"structure"` @@ -6537,7 +6538,7 @@ func (s *AccessDeniedException) RequestID() string { return s.RespMetadata.RequestID } -// Specifies details for an account to associate with an Amazon Macie administrator +// Specifies the details of an account to associate with an Amazon Macie administrator // account. type AccountDetail struct { _ struct{} `type:"structure"` @@ -6617,14 +6618,14 @@ func (s *AccountLevelPermissions) SetBlockPublicAccess(v *BlockPublicAccess) *Ac } // Provides information about the delegated Amazon Macie administrator account -// for an AWS organization. +// for an Amazon Web Services organization. type AdminAccount struct { _ struct{} `type:"structure"` AccountId *string `locationName:"accountId" type:"string"` // The current status of an account as the delegated Amazon Macie administrator - // account for an AWS organization. Possible values are: + // account for an Amazon Web Services organization. Possible values are: Status *string `locationName:"status" type:"string" enum:"AdminStatus"` } @@ -6700,8 +6701,7 @@ func (s *ApiCallDetails) SetLastSeen(v time.Time) *ApiCallDetails { // Provides information about an identity that performed an action on an affected // resource by using temporary security credentials. The credentials were obtained -// using the AssumeRole operation of the AWS Security Token Service (AWS STS) -// API. +// using the AssumeRole operation of the Security Token Service (STS) API. type AssumedRole struct { _ struct{} `type:"structure"` @@ -6758,9 +6758,9 @@ func (s *AssumedRole) SetSessionContext(v *SessionContext) *AssumedRole { return s } -// Provides information about an AWS account and entity that performed an action -// on an affected resource. The action was performed using the credentials for -// an AWS account other than your own account. +// Provides information about an Amazon Web Services account and entity that +// performed an action on an affected resource. The action was performed using +// the credentials for an Amazon Web Services account other than your own account. type AwsAccount struct { _ struct{} `type:"structure"` @@ -6791,8 +6791,8 @@ func (s *AwsAccount) SetPrincipalId(v string) *AwsAccount { return s } -// Provides information about an AWS service that performed an action on an -// affected resource. +// Provides information about an Amazon Web Service that performed an action +// on an affected resource. type AwsService struct { _ struct{} `type:"structure"` @@ -7083,7 +7083,7 @@ func (s *BucketCountByEncryptionType) SetUnknown(v int64) *BucketCountByEncrypti } // Provides information about the number of S3 buckets that are or aren't shared -// with other AWS accounts. +// with other Amazon Web Services accounts. type BucketCountBySharedAccessType struct { _ struct{} `type:"structure"` @@ -7331,8 +7331,8 @@ type BucketMetadata struct { Region *string `locationName:"region" type:"string"` // Provides information about settings that define whether one or more objects - // in an S3 bucket are replicated to S3 buckets for other AWS accounts and, - // if so, which accounts. + // in an S3 bucket are replicated to S3 buckets for other Amazon Web Services + // accounts and, if so, which accounts. ReplicationDetails *ReplicationDetails `locationName:"replicationDetails" type:"structure"` // Provides information about the default server-side encryption settings for @@ -8467,12 +8467,12 @@ func (s *CreateInvitationsOutput) SetUnprocessedAccounts(v []*UnprocessedAccount return s } -// Specifies an AWS account to associate with an Amazon Macie administrator -// account. +// Specifies an Amazon Web Services account to associate with an Amazon Macie +// administrator account. type CreateMemberInput struct { _ struct{} `type:"structure"` - // Specifies details for an account to associate with an Amazon Macie administrator + // Specifies the details of an account to associate with an Amazon Macie administrator // account. // // Account is a required field @@ -9526,7 +9526,7 @@ func (s DescribeOrganizationConfigurationInput) GoString() string { } // Provides information about the Amazon Macie configuration settings for an -// AWS organization. +// Amazon Web Services organization. type DescribeOrganizationConfigurationOutput struct { _ struct{} `type:"structure"` @@ -9776,8 +9776,8 @@ type EnableMacieInput struct { ClientToken *string `locationName:"clientToken" type:"string" idempotencyToken:"true"` // The frequency with which Amazon Macie publishes updates to policy findings - // for an account. This includes publishing updates to AWS Security Hub and - // Amazon EventBridge (formerly called Amazon CloudWatch Events). For more information, + // for an account. This includes publishing updates to Security Hub and Amazon + // EventBridge (formerly called Amazon CloudWatch Events). For more information, // see Monitoring and processing findings (https://docs.aws.amazon.com/macie/latest/user/findings-monitor.html) // in the Amazon Macie User Guide. Valid values are: FindingPublishingFrequency *string `locationName:"findingPublishingFrequency" type:"string" enum:"FindingPublishingFrequency"` @@ -9829,8 +9829,9 @@ func (s EnableMacieOutput) GoString() string { } // Specifies an account to designate as a delegated Amazon Macie administrator -// account for an AWS organization. To submit this request, you must be a user -// of the management account for the AWS organization. +// account for an Amazon Web Services organization. To submit this request, +// you must be a user of the management account for the Amazon Web Services +// organization. type EnableOrganizationAdminAccountInput struct { _ struct{} `type:"structure"` @@ -9891,8 +9892,8 @@ func (s EnableOrganizationAdminAccountOutput) GoString() string { // Provides information about an identity that performed an action on an affected // resource by using temporary security credentials. The credentials were obtained -// using the GetFederationToken operation of the AWS Security Token Service -// (AWS STS) API. +// using the GetFederationToken operation of the Security Token Service (STS) +// API. type FederatedUser struct { _ struct{} `type:"structure"` @@ -10412,7 +10413,7 @@ type GetBucketStatisticsOutput struct { BucketCountByObjectEncryptionRequirement *BucketCountPolicyAllowsUnencryptedObjectUploads `locationName:"bucketCountByObjectEncryptionRequirement" type:"structure"` // Provides information about the number of S3 buckets that are or aren't shared - // with other AWS accounts. + // with other Amazon Web Services accounts. BucketCountBySharedAccessType *BucketCountBySharedAccessType `locationName:"bucketCountBySharedAccessType" type:"structure"` ClassifiableObjectCount *int64 `locationName:"classifiableObjectCount" type:"long"` @@ -11020,12 +11021,12 @@ func (s GetFindingsPublicationConfigurationInput) GoString() string { } // Provides information about the current configuration settings for publishing -// findings to AWS Security Hub automatically. +// findings to Security Hub automatically. type GetFindingsPublicationConfigurationOutput struct { _ struct{} `type:"structure"` // Specifies configuration settings that determine which findings are published - // to AWS Security Hub automatically. For information about how Macie publishes + // to Security Hub automatically. For information about how Macie publishes // findings to Security Hub, see Amazon Macie integration with Security Hub // (https://docs.aws.amazon.com/macie/latest/user/securityhub-integration.html) // in the Amazon Macie User Guide. @@ -11108,8 +11109,8 @@ type GetMacieSessionOutput struct { CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601"` // The frequency with which Amazon Macie publishes updates to policy findings - // for an account. This includes publishing updates to AWS Security Hub and - // Amazon EventBridge (formerly called Amazon CloudWatch Events). For more information, + // for an account. This includes publishing updates to Security Hub and Amazon + // EventBridge (formerly called Amazon CloudWatch Events). For more information, // see Monitoring and processing findings (https://docs.aws.amazon.com/macie/latest/user/findings-monitor.html) // in the Amazon Macie User Guide. Valid values are: FindingPublishingFrequency *string `locationName:"findingPublishingFrequency" type:"string" enum:"FindingPublishingFrequency"` @@ -11526,8 +11527,8 @@ func (s *GroupCount) SetGroupKey(v string) *GroupCount { return s } -// Provides information about an AWS Identity and Access Management (IAM) user -// who performed an action on an affected resource. +// Provides information about an Identity and Access Management (IAM) user who +// performed an action on an affected resource. type IamUser struct { _ struct{} `type:"structure"` @@ -12807,7 +12808,7 @@ func (s *ListOrganizationAdminAccountsInput) SetNextToken(v string) *ListOrganiz } // Provides information about the delegated Amazon Macie administrator accounts -// for an AWS organization. +// for an Amazon Web Services organization. type ListOrganizationAdminAccountsOutput struct { _ struct{} `type:"structure"` @@ -13027,8 +13028,8 @@ func (s *MatchingBucket) SetUnclassifiableObjectSizeInBytes(v *ObjectLevelStatis return s } -// Provides statistical data and other information about an AWS resource that -// Amazon Macie monitors and analyzes. +// Provides statistical data and other information about an Amazon Web Services +// resource that Amazon Macie monitors and analyzes. type MatchingResource struct { _ struct{} `type:"structure"` @@ -13280,22 +13281,14 @@ type Occurrences struct { // workbook, CSV file, or TSV file. Cells []*Cell `locationName:"cells" type:"list"` - // Provides details about the location of occurrences of sensitive data in an - // Adobe Portable Document Format file, Microsoft Word document, or non-binary - // text file. LineRanges []*Range `locationName:"lineRanges" type:"list"` - // Provides details about the location of occurrences of sensitive data in an - // Adobe Portable Document Format file, Microsoft Word document, or non-binary - // text file. OffsetRanges []*Range `locationName:"offsetRanges" type:"list"` // Specifies the location of occurrences of sensitive data in an Adobe Portable // Document Format file. Pages []*Page `locationName:"pages" type:"list"` - // Specifies the location of occurrences of sensitive data in an Apache Parquet - // file. Records []*Record `locationName:"records" type:"list"` } @@ -13344,12 +13337,12 @@ func (s *Occurrences) SetRecords(v []*Record) *Occurrences { type Page struct { _ struct{} `type:"structure"` - // Provides details about the location of an occurrence of sensitive data in - // a Microsoft Word document or non-binary text file. + // Specifies the location of an occurrence of sensitive data in a non-binary + // text file, such as an HTML, TXT, or XML file. LineRange *Range `locationName:"lineRange" type:"structure"` - // Provides details about the location of an occurrence of sensitive data in - // a Microsoft Word document or non-binary text file. + // Specifies the location of an occurrence of sensitive data in a non-binary + // text file, such as an HTML, TXT, or XML file. OffsetRange *Range `locationName:"offsetRange" type:"structure"` PageNumber *int64 `locationName:"pageNumber" type:"long"` @@ -13493,15 +13486,15 @@ func (s *PutClassificationExportConfigurationOutput) SetConfiguration(v *Classif return s } -// Specifies configuration settings for publishing findings to AWS Security -// Hub automatically. +// Specifies configuration settings for publishing findings to Security Hub +// automatically. type PutFindingsPublicationConfigurationInput struct { _ struct{} `type:"structure"` ClientToken *string `locationName:"clientToken" type:"string" idempotencyToken:"true"` // Specifies configuration settings that determine which findings are published - // to AWS Security Hub automatically. For information about how Macie publishes + // to Security Hub automatically. For information about how Macie publishes // findings to Security Hub, see Amazon Macie integration with Security Hub // (https://docs.aws.amazon.com/macie/latest/user/securityhub-integration.html) // in the Amazon Macie User Guide. @@ -13559,8 +13552,8 @@ func (s PutFindingsPublicationConfigurationOutput) GoString() string { return s.String() } -// Provides details about the location of an occurrence of sensitive data in -// a Microsoft Word document or non-binary text file. +// Specifies the location of an occurrence of sensitive data in a non-binary +// text file, such as an HTML, TXT, or XML file. type Range struct { _ struct{} `type:"structure"` @@ -13600,7 +13593,7 @@ func (s *Range) SetStartColumn(v int64) *Range { } // Specifies the location of an occurrence of sensitive data in an Apache Avro -// object container or Apache Parquet file. +// object container, Apache Parquet file, JSON file, or JSON Lines file. type Record struct { _ struct{} `type:"structure"` @@ -13632,8 +13625,8 @@ func (s *Record) SetRecordIndex(v int64) *Record { } // Provides information about settings that define whether one or more objects -// in an S3 bucket are replicated to S3 buckets for other AWS accounts and, -// if so, which accounts. +// in an S3 bucket are replicated to S3 buckets for other Amazon Web Services +// accounts and, if so, which accounts. type ReplicationDetails struct { _ struct{} `type:"structure"` @@ -13733,10 +13726,10 @@ func (s *ResourceNotFoundException) RequestID() string { type ResourcesAffected struct { _ struct{} `type:"structure"` - // Provides information about an S3 bucket that a finding applies to. + // Provides information about the S3 bucket that a finding applies to. S3Bucket *S3Bucket `locationName:"s3Bucket" type:"structure"` - // Provides information about an S3 object that a finding applies to. + // Provides information about the S3 object that a finding applies to. S3Object *S3Object `locationName:"s3Object" type:"structure"` } @@ -13762,7 +13755,7 @@ func (s *ResourcesAffected) SetS3Object(v *S3Object) *ResourcesAffected { return s } -// Provides information about an S3 bucket that a finding applies to. +// Provides information about the S3 bucket that a finding applies to. type S3Bucket struct { _ struct{} `type:"structure"` @@ -13886,8 +13879,8 @@ func (s *S3BucketCriteriaForJob) SetIncludes(v *CriteriaBlockForJob) *S3BucketCr return s } -// Specifies an AWS account that owns S3 buckets for a classification job to -// analyze, and one or more specific buckets to analyze for that account. +// Specifies an Amazon Web Services account that owns S3 buckets for a classification +// job to analyze, and one or more specific buckets to analyze for that account. type S3BucketDefinitionForJob struct { _ struct{} `type:"structure"` @@ -14095,7 +14088,7 @@ func (s *S3JobDefinition) SetScoping(v *Scoping) *S3JobDefinition { return s } -// Provides information about an S3 object that a finding applies to. +// Provides information about the S3 object that a finding applies to. type S3Object struct { _ struct{} `type:"structure"` @@ -14256,11 +14249,11 @@ type SearchResourcesBucketCriteria struct { _ struct{} `type:"structure"` // Specifies property- and tag-based conditions that define filter criteria - // for including or excluding AWS resources from the query results. + // for including or excluding Amazon Web Services resources from the query results. Excludes *SearchResourcesCriteriaBlock `locationName:"excludes" type:"structure"` // Specifies property- and tag-based conditions that define filter criteria - // for including or excluding AWS resources from the query results. + // for including or excluding Amazon Web Services resources from the query results. Includes *SearchResourcesCriteriaBlock `locationName:"includes" type:"structure"` } @@ -14287,16 +14280,16 @@ func (s *SearchResourcesBucketCriteria) SetIncludes(v *SearchResourcesCriteriaBl } // Specifies a property- or tag-based filter condition for including or excluding -// AWS resources from the query results. +// Amazon Web Services resources from the query results. type SearchResourcesCriteria struct { _ struct{} `type:"structure"` - // Specifies a property-based filter condition that determines which AWS resources - // are included or excluded from the query results. + // Specifies a property-based filter condition that determines which Amazon + // Web Services resources are included or excluded from the query results. SimpleCriterion *SearchResourcesSimpleCriterion `locationName:"simpleCriterion" type:"structure"` - // Specifies a tag-based filter condition that determines which AWS resources - // are included or excluded from the query results. + // Specifies a tag-based filter condition that determines which Amazon Web Services + // resources are included or excluded from the query results. TagCriterion *SearchResourcesTagCriterion `locationName:"tagCriterion" type:"structure"` } @@ -14323,7 +14316,7 @@ func (s *SearchResourcesCriteria) SetTagCriterion(v *SearchResourcesTagCriterion } // Specifies property- and tag-based conditions that define filter criteria -// for including or excluding AWS resources from the query results. +// for including or excluding Amazon Web Services resources from the query results. type SearchResourcesCriteriaBlock struct { _ struct{} `type:"structure"` @@ -14347,8 +14340,8 @@ func (s *SearchResourcesCriteriaBlock) SetAnd(v []*SearchResourcesCriteria) *Sea } // Specifies criteria for filtering, sorting, and paginating the results of -// a query for statistical data and other information about AWS resources that -// Amazon Macie monitors and analyzes. +// a query for statistical data and other information about Amazon Web Services +// resources that Amazon Macie monitors and analyzes. type SearchResourcesInput struct { _ struct{} `type:"structure"` @@ -14362,7 +14355,7 @@ type SearchResourcesInput struct { NextToken *string `locationName:"nextToken" type:"string"` // Specifies criteria for sorting the results of a query for information about - // AWS resources that Amazon Macie monitors and analyzes. + // Amazon Web Services resources that Amazon Macie monitors and analyzes. SortCriteria *SearchResourcesSortCriteria `locationName:"sortCriteria" type:"structure"` } @@ -14401,7 +14394,8 @@ func (s *SearchResourcesInput) SetSortCriteria(v *SearchResourcesSortCriteria) * } // Provides the results of a query that retrieved statistical data and other -// information about AWS resources that Amazon Macie monitors and analyzes. +// information about Amazon Web Services resources that Amazon Macie monitors +// and analyzes. type SearchResourcesOutput struct { _ struct{} `type:"structure"` @@ -14432,8 +14426,8 @@ func (s *SearchResourcesOutput) SetNextToken(v string) *SearchResourcesOutput { return s } -// Specifies a property-based filter condition that determines which AWS resources -// are included or excluded from the query results. +// Specifies a property-based filter condition that determines which Amazon +// Web Services resources are included or excluded from the query results. type SearchResourcesSimpleCriterion struct { _ struct{} `type:"structure"` @@ -14477,7 +14471,7 @@ func (s *SearchResourcesSimpleCriterion) SetValues(v []*string) *SearchResources } // Specifies criteria for sorting the results of a query for information about -// AWS resources that Amazon Macie monitors and analyzes. +// Amazon Web Services resources that Amazon Macie monitors and analyzes. type SearchResourcesSortCriteria struct { _ struct{} `type:"structure"` @@ -14509,8 +14503,8 @@ func (s *SearchResourcesSortCriteria) SetOrderBy(v string) *SearchResourcesSortC return s } -// Specifies a tag-based filter condition that determines which AWS resources -// are included or excluded from the query results. +// Specifies a tag-based filter condition that determines which Amazon Web Services +// resources are included or excluded from the query results. type SearchResourcesTagCriterion struct { _ struct{} `type:"structure"` @@ -14578,7 +14572,7 @@ func (s *SearchResourcesTagCriterionPair) SetValue(v string) *SearchResourcesTag } // Specifies configuration settings that determine which findings are published -// to AWS Security Hub automatically. For information about how Macie publishes +// to Security Hub automatically. For information about how Macie publishes // findings to Security Hub, see Amazon Macie integration with Security Hub // (https://docs.aws.amazon.com/macie/latest/user/securityhub-integration.html) // in the Amazon Macie User Guide. @@ -15794,8 +15788,8 @@ type UpdateMacieSessionInput struct { _ struct{} `type:"structure"` // The frequency with which Amazon Macie publishes updates to policy findings - // for an account. This includes publishing updates to AWS Security Hub and - // Amazon EventBridge (formerly called Amazon CloudWatch Events). For more information, + // for an account. This includes publishing updates to Security Hub and Amazon + // EventBridge (formerly called Amazon CloudWatch Events). For more information, // see Monitoring and processing findings (https://docs.aws.amazon.com/macie/latest/user/findings-monitor.html) // in the Amazon Macie User Guide. Valid values are: FindingPublishingFrequency *string `locationName:"findingPublishingFrequency" type:"string" enum:"FindingPublishingFrequency"` @@ -15909,7 +15903,7 @@ func (s UpdateMemberSessionOutput) GoString() string { } // Specifies whether to enable Amazon Macie automatically for accounts that -// are added to an AWS organization. +// are added to an Amazon Web Services organization. type UpdateOrganizationConfigurationInput struct { _ struct{} `type:"structure"` @@ -16183,32 +16177,31 @@ type UserIdentity struct { // Provides information about an identity that performed an action on an affected // resource by using temporary security credentials. The credentials were obtained - // using the AssumeRole operation of the AWS Security Token Service (AWS STS) - // API. + // using the AssumeRole operation of the Security Token Service (STS) API. AssumedRole *AssumedRole `locationName:"assumedRole" type:"structure"` - // Provides information about an AWS account and entity that performed an action - // on an affected resource. The action was performed using the credentials for - // an AWS account other than your own account. + // Provides information about an Amazon Web Services account and entity that + // performed an action on an affected resource. The action was performed using + // the credentials for an Amazon Web Services account other than your own account. AwsAccount *AwsAccount `locationName:"awsAccount" type:"structure"` - // Provides information about an AWS service that performed an action on an - // affected resource. + // Provides information about an Amazon Web Service that performed an action + // on an affected resource. AwsService *AwsService `locationName:"awsService" type:"structure"` // Provides information about an identity that performed an action on an affected // resource by using temporary security credentials. The credentials were obtained - // using the GetFederationToken operation of the AWS Security Token Service - // (AWS STS) API. + // using the GetFederationToken operation of the Security Token Service (STS) + // API. FederatedUser *FederatedUser `locationName:"federatedUser" type:"structure"` - // Provides information about an AWS Identity and Access Management (IAM) user - // who performed an action on an affected resource. + // Provides information about an Identity and Access Management (IAM) user who + // performed an action on an affected resource. IamUser *IamUser `locationName:"iamUser" type:"structure"` - // Provides information about an AWS account and entity that performed an action - // on an affected resource. The action was performed using the credentials for - // your AWS account. + // Provides information about an Amazon Web Services account and entity that + // performed an action on an affected resource. The action was performed using + // the credentials for your Amazon Web Services account. Root *UserIdentityRoot `locationName:"root" type:"structure"` // The type of entity that performed the action on the affected resource. Possible @@ -16268,9 +16261,9 @@ func (s *UserIdentity) SetType(v string) *UserIdentity { return s } -// Provides information about an AWS account and entity that performed an action -// on an affected resource. The action was performed using the credentials for -// your AWS account. +// Provides information about an Amazon Web Services account and entity that +// performed an action on an affected resource. The action was performed using +// the credentials for your Amazon Web Services account. type UserIdentityRoot struct { _ struct{} `type:"structure"` @@ -16435,7 +16428,7 @@ func (s *WeeklySchedule) SetDayOfWeek(v string) *WeeklySchedule { } // The current status of an account as the delegated Amazon Macie administrator -// account for an AWS organization. Possible values are: +// account for an Amazon Web Services organization. Possible values are: const ( // AdminStatusEnabled is a AdminStatus enum value AdminStatusEnabled = "ENABLED" @@ -16617,8 +16610,8 @@ func FindingCategory_Values() []string { } // The frequency with which Amazon Macie publishes updates to policy findings -// for an account. This includes publishing updates to AWS Security Hub and -// Amazon EventBridge (formerly called Amazon CloudWatch Events). For more information, +// for an account. This includes publishing updates to Security Hub and Amazon +// EventBridge (formerly called Amazon CloudWatch Events). For more information, // see Monitoring and processing findings (https://docs.aws.amazon.com/macie/latest/user/findings-monitor.html) // in the Amazon Macie User Guide. Valid values are: const ( diff --git a/service/macie2/doc.go b/service/macie2/doc.go index ccbd68e5485..42c29162434 100644 --- a/service/macie2/doc.go +++ b/service/macie2/doc.go @@ -8,7 +8,7 @@ // data in AWS. Macie automates the discovery of sensitive data, such as PII // and intellectual property, to provide you with insight into the data that // your organization stores in AWS. Macie also provides an inventory of your -// Amazon S3 buckets, which it continually monitors foryou. If Macie detects +// Amazon S3 buckets, which it continually monitors for you. If Macie detects // sensitive data or potential data access issues, it generates detailed findings // for you to review and act upon as necessary. // diff --git a/service/mgn/api.go b/service/mgn/api.go index 092ea4a2530..4afb07a84db 100644 --- a/service/mgn/api.go +++ b/service/mgn/api.go @@ -164,6 +164,9 @@ func (c *Mgn) CreateReplicationConfigurationTemplateRequest(input *CreateReplica // * ValidationException // Validate exception. // +// * AccessDeniedException +// Operating denied due to a file permission or access check error. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/mgn-2020-02-26/CreateReplicationConfigurationTemplate func (c *Mgn) CreateReplicationConfigurationTemplate(input *CreateReplicationConfigurationTemplateInput) (*CreateReplicationConfigurationTemplateOutput, error) { req, out := c.CreateReplicationConfigurationTemplateRequest(input) @@ -2332,6 +2335,9 @@ func (c *Mgn) UpdateReplicationConfigurationRequest(input *UpdateReplicationConf // * ValidationException // Validate exception. // +// * AccessDeniedException +// Operating denied due to a file permission or access check error. +// // * ConflictException // The request could not be completed due to a conflict with the current state // of the target resource. @@ -2421,6 +2427,9 @@ func (c *Mgn) UpdateReplicationConfigurationTemplateRequest(input *UpdateReplica // * ValidationException // Validate exception. // +// * AccessDeniedException +// Operating denied due to a file permission or access check error. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/mgn-2020-02-26/UpdateReplicationConfigurationTemplate func (c *Mgn) UpdateReplicationConfigurationTemplate(input *UpdateReplicationConfigurationTemplateInput) (*UpdateReplicationConfigurationTemplateOutput, error) { req, out := c.UpdateReplicationConfigurationTemplateRequest(input) @@ -8079,9 +8088,6 @@ func ReplicationConfigurationDefaultLargeStagingDiskType_Values() []string { } const ( - // ReplicationConfigurationEbsEncryptionNone is a ReplicationConfigurationEbsEncryption enum value - ReplicationConfigurationEbsEncryptionNone = "NONE" - // ReplicationConfigurationEbsEncryptionDefault is a ReplicationConfigurationEbsEncryption enum value ReplicationConfigurationEbsEncryptionDefault = "DEFAULT" @@ -8092,7 +8098,6 @@ const ( // ReplicationConfigurationEbsEncryption_Values returns all elements of the ReplicationConfigurationEbsEncryption enum func ReplicationConfigurationEbsEncryption_Values() []string { return []string{ - ReplicationConfigurationEbsEncryptionNone, ReplicationConfigurationEbsEncryptionDefault, ReplicationConfigurationEbsEncryptionCustom, } diff --git a/service/sns/api.go b/service/sns/api.go index 30204862b2a..a6540c21a71 100644 --- a/service/sns/api.go +++ b/service/sns/api.go @@ -59,7 +59,7 @@ func (c *SNS) AddPermissionRequest(input *AddPermissionInput) (req *request.Requ // AddPermission API operation for Amazon Simple Notification Service. // // Adds a statement to a topic's access control policy, granting access for -// the specified AWS accounts to the specified actions. +// the specified accounts to the specified actions. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -271,9 +271,9 @@ func (c *SNS) ConfirmSubscriptionRequest(input *ConfirmSubscriptionInput) (req * // Indicates that the user has been denied access to the requested resource. // // * ErrCodeFilterPolicyLimitExceededException "FilterPolicyLimitExceeded" -// Indicates that the number of filter polices in your AWS account exceeds the -// limit. To add more filter polices, submit an SNS Limit Increase case in the -// AWS Support Center. +// Indicates that the number of filter polices in your account exceeds the limit. +// To add more filter polices, submit an SNS Limit Increase case in the Amazon +// Web Services Support Center. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ConfirmSubscription func (c *SNS) ConfirmSubscription(input *ConfirmSubscriptionInput) (*ConfirmSubscriptionOutput, error) { @@ -554,16 +554,16 @@ func (c *SNS) CreateSMSSandboxPhoneNumberRequest(input *CreateSMSSandboxPhoneNum // CreateSMSSandboxPhoneNumber API operation for Amazon Simple Notification Service. // -// Adds a destination phone number to an AWS account in the SMS sandbox and -// sends a one-time password (OTP) to that phone number. +// Adds a destination phone number to an account in the SMS sandbox and sends +// a one-time password (OTP) to that phone number. // -// When you start using Amazon SNS to send SMS messages, your AWS account is -// in the SMS sandbox. The SMS sandbox provides a safe environment for you to -// try Amazon SNS features without risking your reputation as an SMS sender. -// While your account is in the SMS sandbox, you can use all of the features -// of Amazon SNS. However, you can send SMS messages only to verified destination -// phone numbers. For more information, including how to move out of the sandbox -// to send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// When you start using Amazon SNS to send SMS messages, your account is in +// the SMS sandbox. The SMS sandbox provides a safe environment for you to try +// Amazon SNS features without risking your reputation as an SMS sender. While +// your account is in the SMS sandbox, you can use all of the features of Amazon +// SNS. However, you can send SMS messages only to verified destination phone +// numbers. For more information, including how to move out of the sandbox to +// send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) // in the Amazon SNS Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -585,8 +585,8 @@ func (c *SNS) CreateSMSSandboxPhoneNumberRequest(input *CreateSMSSandboxPhoneNum // // * ErrCodeOptedOutException "OptedOut" // Indicates that the specified phone number opted out of receiving SMS messages -// from your AWS account. You can't send SMS messages to phone numbers that -// opt out. +// from your account. You can't send SMS messages to phone numbers that opt +// out. // // * ErrCodeUserErrorException "UserError" // Indicates that a request parameter does not comply with the associated constraints. @@ -663,9 +663,10 @@ func (c *SNS) CreateTopicRequest(input *CreateTopicInput) (req *request.Request, // // Creates a topic to which notifications can be published. Users can create // at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, -// see https://aws.amazon.com/sns (http://aws.amazon.com/sns/). This action -// is idempotent, so if the requester already owns a topic with the specified -// name, that topic's ARN is returned without creating a new topic. +// see Creating an Amazon SNS topic (https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html) +// in the Amazon SNS Developer Guide. This action is idempotent, so if the requester +// already owns a topic with the specified name, that topic's ARN is returned +// without creating a new topic. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -952,15 +953,15 @@ func (c *SNS) DeleteSMSSandboxPhoneNumberRequest(input *DeleteSMSSandboxPhoneNum // DeleteSMSSandboxPhoneNumber API operation for Amazon Simple Notification Service. // -// Deletes an AWS account's verified or pending phone number from the SMS sandbox. +// Deletes an account's verified or pending phone number from the SMS sandbox. // -// When you start using Amazon SNS to send SMS messages, your AWS account is -// in the SMS sandbox. The SMS sandbox provides a safe environment for you to -// try Amazon SNS features without risking your reputation as an SMS sender. -// While your account is in the SMS sandbox, you can use all of the features -// of Amazon SNS. However, you can send SMS messages only to verified destination -// phone numbers. For more information, including how to move out of the sandbox -// to send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// When you start using Amazon SNS to send SMS messages, your account is in +// the SMS sandbox. The SMS sandbox provides a safe environment for you to try +// Amazon SNS features without risking your reputation as an SMS sender. While +// your account is in the SMS sandbox, you can use all of the features of Amazon +// SNS. However, you can send SMS messages only to verified destination phone +// numbers. For more information, including how to move out of the sandbox to +// send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) // in the Amazon SNS Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -1432,16 +1433,15 @@ func (c *SNS) GetSMSSandboxAccountStatusRequest(input *GetSMSSandboxAccountStatu // GetSMSSandboxAccountStatus API operation for Amazon Simple Notification Service. // -// Retrieves the SMS sandbox status for the calling AWS account in the target -// AWS Region. +// Retrieves the SMS sandbox status for the calling account in the target Region. // -// When you start using Amazon SNS to send SMS messages, your AWS account is -// in the SMS sandbox. The SMS sandbox provides a safe environment for you to -// try Amazon SNS features without risking your reputation as an SMS sender. -// While your account is in the SMS sandbox, you can use all of the features -// of Amazon SNS. However, you can send SMS messages only to verified destination -// phone numbers. For more information, including how to move out of the sandbox -// to send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// When you start using Amazon SNS to send SMS messages, your account is in +// the SMS sandbox. The SMS sandbox provides a safe environment for you to try +// Amazon SNS features without risking your reputation as an SMS sender. While +// your account is in the SMS sandbox, you can use all of the features of Amazon +// SNS. However, you can send SMS messages only to verified destination phone +// numbers. For more information, including how to move out of the sandbox to +// send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) // in the Amazon SNS Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -1871,7 +1871,7 @@ func (c *SNS) ListOriginationNumbersRequest(input *ListOriginationNumbersInput) // ListOriginationNumbers API operation for Amazon Simple Notification Service. // -// Lists the calling AWS account's dedicated origination numbers and their metadata. +// Lists the calling account's dedicated origination numbers and their metadata. // For more information about origination numbers, see Origination numbers (https://docs.aws.amazon.com/sns/latest/dg/channels-sms-originating-identities-origination-numbers.html) // in the Amazon SNS Developer Guide. // @@ -2004,6 +2004,12 @@ func (c *SNS) ListPhoneNumbersOptedOutRequest(input *ListPhoneNumbersOptedOutInp Name: opListPhoneNumbersOptedOut, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "", + TruncationToken: "", + }, } if input == nil { @@ -2070,6 +2076,58 @@ func (c *SNS) ListPhoneNumbersOptedOutWithContext(ctx aws.Context, input *ListPh return out, req.Send() } +// ListPhoneNumbersOptedOutPages iterates over the pages of a ListPhoneNumbersOptedOut operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListPhoneNumbersOptedOut method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListPhoneNumbersOptedOut operation. +// pageNum := 0 +// err := client.ListPhoneNumbersOptedOutPages(params, +// func(page *sns.ListPhoneNumbersOptedOutOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *SNS) ListPhoneNumbersOptedOutPages(input *ListPhoneNumbersOptedOutInput, fn func(*ListPhoneNumbersOptedOutOutput, bool) bool) error { + return c.ListPhoneNumbersOptedOutPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListPhoneNumbersOptedOutPagesWithContext same as ListPhoneNumbersOptedOutPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SNS) ListPhoneNumbersOptedOutPagesWithContext(ctx aws.Context, input *ListPhoneNumbersOptedOutInput, fn func(*ListPhoneNumbersOptedOutOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListPhoneNumbersOptedOutInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListPhoneNumbersOptedOutRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListPhoneNumbersOptedOutOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListPlatformApplications = "ListPlatformApplications" // ListPlatformApplicationsRequest generates a "aws/request.Request" representing the @@ -2272,16 +2330,16 @@ func (c *SNS) ListSMSSandboxPhoneNumbersRequest(input *ListSMSSandboxPhoneNumber // ListSMSSandboxPhoneNumbers API operation for Amazon Simple Notification Service. // -// Lists the calling AWS account's current verified and pending destination -// phone numbers in the SMS sandbox. +// Lists the calling account's current verified and pending destination phone +// numbers in the SMS sandbox. // -// When you start using Amazon SNS to send SMS messages, your AWS account is -// in the SMS sandbox. The SMS sandbox provides a safe environment for you to -// try Amazon SNS features without risking your reputation as an SMS sender. -// While your account is in the SMS sandbox, you can use all of the features -// of Amazon SNS. However, you can send SMS messages only to verified destination -// phone numbers. For more information, including how to move out of the sandbox -// to send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// When you start using Amazon SNS to send SMS messages, your account is in +// the SMS sandbox. The SMS sandbox provides a safe environment for you to try +// Amazon SNS features without risking your reputation as an SMS sender. While +// your account is in the SMS sandbox, you can use all of the features of Amazon +// SNS. However, you can send SMS messages only to verified destination phone +// numbers. For more information, including how to move out of the sandbox to +// send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) // in the Amazon SNS Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -3081,7 +3139,7 @@ func (c *SNS) PublishRequest(input *PublishInput) (req *request.Request, output // For more information about formatting messages, see Send Custom Platform-Specific // Payloads in Messages to Mobile Devices (https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html). // -// You can publish messages only to topics and endpoints in the same AWS Region. +// You can publish messages only to topics and endpoints in the same Region. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3120,19 +3178,19 @@ func (c *SNS) PublishRequest(input *PublishInput) (req *request.Request, output // The request was rejected because the state of the specified resource isn't // valid for this request. For more information, see How Key State Affects Use // of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) -// in the AWS Key Management Service Developer Guide. +// in the Key Management Service Developer Guide. // // * ErrCodeKMSNotFoundException "KMSNotFound" // The request was rejected because the specified entity or resource can't be // found. // // * ErrCodeKMSOptInRequired "KMSOptInRequired" -// The AWS access key ID needs a subscription for the service. +// The Amazon Web Services access key ID needs a subscription for the service. // // * ErrCodeKMSThrottlingException "KMSThrottling" // The request was denied due to request throttling. For more information about // throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) -// in the AWS Key Management Service Developer Guide. +// in the Key Management Service Developer Guide. // // * ErrCodeKMSAccessDeniedException "KMSAccessDenied" // The ciphertext references a key that doesn't exist or that you don't have @@ -3596,9 +3654,9 @@ func (c *SNS) SetSubscriptionAttributesRequest(input *SetSubscriptionAttributesI // Indicates that a request parameter does not comply with the associated constraints. // // * ErrCodeFilterPolicyLimitExceededException "FilterPolicyLimitExceeded" -// Indicates that the number of filter polices in your AWS account exceeds the -// limit. To add more filter polices, submit an SNS Limit Increase case in the -// AWS Support Center. +// Indicates that the number of filter polices in your account exceeds the limit. +// To add more filter polices, submit an SNS Limit Increase case in the Amazon +// Web Services Support Center. // // * ErrCodeInternalErrorException "InternalError" // Indicates an internal service error. @@ -3769,9 +3827,8 @@ func (c *SNS) SubscribeRequest(input *SubscribeInput) (req *request.Request, out // Subscribe API operation for Amazon Simple Notification Service. // // Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S -// or email, or if the endpoint and the topic are not in the same AWS account, -// the endpoint owner must run the ConfirmSubscription action to confirm the -// subscription. +// or email, or if the endpoint and the topic are not in the same account, the +// endpoint owner must run the ConfirmSubscription action to confirm the subscription. // // You call the ConfirmSubscription action with the token from the subscription // response. Confirmation tokens are valid for three days. @@ -3790,9 +3847,9 @@ func (c *SNS) SubscribeRequest(input *SubscribeInput) (req *request.Request, out // Indicates that the customer already owns the maximum allowed number of subscriptions. // // * ErrCodeFilterPolicyLimitExceededException "FilterPolicyLimitExceeded" -// Indicates that the number of filter polices in your AWS account exceeds the -// limit. To add more filter polices, submit an SNS Limit Increase case in the -// AWS Support Center. +// Indicates that the number of filter polices in your account exceeds the limit. +// To add more filter polices, submit an SNS Limit Increase case in the Amazon +// Web Services Support Center. // // * ErrCodeInvalidParameterException "InvalidParameter" // Indicates that a request parameter does not comply with the associated constraints. @@ -3893,9 +3950,9 @@ func (c *SNS) TagResourceRequest(input *TagResourceInput) (req *request.Request, // * A new tag with a key identical to that of an existing tag overwrites // the existing tag. // -// * Tagging actions are limited to 10 TPS per AWS account, per AWS region. -// If your application requires a higher throughput, file a technical support -// request (https://console.aws.amazon.com/support/home#/case/create?issueType=technical). +// * Tagging actions are limited to 10 TPS per account, per Region. If your +// application requires a higher throughput, file a technical support request +// (https://console.aws.amazon.com/support/home#/case/create?issueType=technical). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3999,10 +4056,11 @@ func (c *SNS) UnsubscribeRequest(input *UnsubscribeInput) (req *request.Request, // // Deletes a subscription. If the subscription requires authentication for deletion, // only the owner of the subscription or the topic's owner can unsubscribe, -// and an AWS signature is required. If the Unsubscribe call does not require -// authentication and the requester is not the subscription owner, a final cancellation -// message is delivered to the endpoint, so that the endpoint owner can easily -// resubscribe to the topic if the Unsubscribe request was unintended. +// and an Amazon Web Services signature is required. If the Unsubscribe call +// does not require authentication and the requester is not the subscription +// owner, a final cancellation message is delivered to the endpoint, so that +// the endpoint owner can easily resubscribe to the topic if the Unsubscribe +// request was unintended. // // This action is throttled at 100 transactions per second (TPS). // @@ -4202,15 +4260,15 @@ func (c *SNS) VerifySMSSandboxPhoneNumberRequest(input *VerifySMSSandboxPhoneNum // VerifySMSSandboxPhoneNumber API operation for Amazon Simple Notification Service. // // Verifies a destination phone number with a one-time password (OTP) for the -// calling AWS account. -// -// When you start using Amazon SNS to send SMS messages, your AWS account is -// in the SMS sandbox. The SMS sandbox provides a safe environment for you to -// try Amazon SNS features without risking your reputation as an SMS sender. -// While your account is in the SMS sandbox, you can use all of the features -// of Amazon SNS. However, you can send SMS messages only to verified destination -// phone numbers. For more information, including how to move out of the sandbox -// to send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// calling account. +// +// When you start using Amazon SNS to send SMS messages, your account is in +// the SMS sandbox. The SMS sandbox provides a safe environment for you to try +// Amazon SNS features without risking your reputation as an SMS sender. While +// your account is in the SMS sandbox, you can use all of the features of Amazon +// SNS. However, you can send SMS messages only to verified destination phone +// numbers. For more information, including how to move out of the sandbox to +// send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) // in the Amazon SNS Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -4266,9 +4324,9 @@ func (c *SNS) VerifySMSSandboxPhoneNumberWithContext(ctx aws.Context, input *Ver type AddPermissionInput struct { _ struct{} `type:"structure"` - // The AWS account IDs of the users (principals) who will be given access to - // the specified actions. The users must have AWS accounts, but do not need - // to be signed up for this service. + // The account IDs of the users (principals) who will be given access to the + // specified actions. The users must have account, but do not need to be signed + // up for this service. // // AWSAccountId is a required field AWSAccountId []*string `type:"list" required:"true"` @@ -4435,9 +4493,9 @@ type ConfirmSubscriptionInput struct { _ struct{} `type:"structure"` // Disallows unauthenticated unsubscribes of the subscription. If the value - // of this parameter is true and the request has an AWS signature, then only - // the topic owner and the subscription owner can unsubscribe the endpoint. - // The unsubscribe action requires AWS authentication. + // of this parameter is true and the request has an Amazon Web Services signature, + // then only the topic owner and the subscription owner can unsubscribe the + // endpoint. The unsubscribe action requires Amazon Web Services authentication. AuthenticateOnUnsubscribe *string `type:"string"` // Short-lived token sent to an endpoint during the Subscribe action. @@ -4800,10 +4858,11 @@ type CreateTopicInput struct { // // The following attribute applies only to server-side encryption (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html): // - // * KmsMasterKeyId – The ID of an AWS managed customer master key (CMK) - // for Amazon SNS or a custom CMK. For more information, see Key Terms (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). + // * KmsMasterKeyId – The ID of an Amazon Web Services managed customer + // master key (CMK) for Amazon SNS or a custom CMK. For more information, + // see Key Terms (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). // For more examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) - // in the AWS Key Management Service API Reference. + // in the Key Management Service API Reference. // // The following attributes apply only to FIFO topics (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html): // @@ -5461,7 +5520,7 @@ type GetSubscriptionAttributesOutput struct { // For more information, see Amazon SNS Message Filtering (https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html) // in the Amazon SNS Developer Guide. // - // * Owner – The AWS account ID of the subscription's owner. + // * Owner – The account ID of the subscription's owner. // // * PendingConfirmation – true if the subscription hasn't been confirmed. // To confirm a pending subscription, call the ConfirmSubscription action @@ -5561,7 +5620,7 @@ type GetTopicAttributesOutput struct { // * DisplayName – The human-readable name used in the From field for notifications // to email and email-json endpoints. // - // * Owner – The AWS account ID of the topic's owner. + // * Owner – The account ID of the topic's owner. // // * Policy – The JSON serialization of the topic's access control policy. // @@ -5581,10 +5640,11 @@ type GetTopicAttributesOutput struct { // // The following attribute applies only to server-side-encryption (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html): // - // * KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) - // for Amazon SNS or a custom CMK. For more information, see Key Terms (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). + // * KmsMasterKeyId - The ID of an Amazon Web Services managed customer master + // key (CMK) for Amazon SNS or a custom CMK. For more information, see Key + // Terms (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). // For more examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) - // in the AWS Key Management Service API Reference. + // in the Key Management Service API Reference. // // The following attributes apply only to FIFO topics (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html): // @@ -6787,13 +6847,13 @@ func (s RemovePermissionOutput) GoString() string { // A verified or pending destination phone number in the SMS sandbox. // -// When you start using Amazon SNS to send SMS messages, your AWS account is -// in the SMS sandbox. The SMS sandbox provides a safe environment for you to -// try Amazon SNS features without risking your reputation as an SMS sender. -// While your account is in the SMS sandbox, you can use all of the features -// of Amazon SNS. However, you can send SMS messages only to verified destination -// phone numbers. For more information, including how to move out of the sandbox -// to send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// When you start using Amazon SNS to send SMS messages, your account is in +// the SMS sandbox. The SMS sandbox provides a safe environment for you to try +// Amazon SNS features without risking your reputation as an SMS sender. While +// your account is in the SMS sandbox, you can use all of the features of Amazon +// SNS. However, you can send SMS messages only to verified destination phone +// numbers. For more information, including how to move out of the sandbox to +// send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) // in the Amazon SNS Developer Guide. type SMSSandboxPhoneNumber struct { _ struct{} `type:"structure"` @@ -7079,7 +7139,7 @@ type SetSMSAttributesInput struct { // * Total number of parts // // To receive the report, the bucket must have a policy that allows the Amazon - // SNS service principle to perform the s3:PutObject and s3:GetBucketLocation + // SNS service principal to perform the s3:PutObject and s3:GetBucketLocation // actions. // // For an example bucket policy and usage report, see Monitoring SMS Activity @@ -7262,10 +7322,11 @@ type SetTopicAttributesInput struct { // // The following attribute applies only to server-side-encryption (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html): // - // * KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) - // for Amazon SNS or a custom CMK. For more information, see Key Terms (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). + // * KmsMasterKeyId – The ID of an Amazon Web Services managed customer + // master key (CMK) for Amazon SNS or a custom CMK. For more information, + // see Key Terms (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). // For more examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) - // in the AWS Key Management Service API Reference. + // in the Key Management Service API Reference. // // The following attribute applies only to FIFO topics (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html): // @@ -7356,7 +7417,7 @@ type SubscribeInput struct { // A map of attributes with their corresponding values. // // The following lists the names, descriptions, and values of the special request - // parameters that the SetTopicAttributes action uses: + // parameters that the Subscribe action uses: // // * DeliveryPolicy – The policy that defines how Amazon SNS retries failed // deliveries to HTTP/S endpoints. @@ -7409,7 +7470,7 @@ type SubscribeInput struct { // * For the application protocol, the endpoint is the EndpointArn of a mobile // app and device. // - // * For the lambda protocol, the endpoint is the ARN of an AWS Lambda function. + // * For the lambda protocol, the endpoint is the ARN of an Lambda function. // // * For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis // Data Firehose delivery stream. @@ -7432,7 +7493,7 @@ type SubscribeInput struct { // * application – delivery of JSON-encoded message to an EndpointArn for // a mobile app and device // - // * lambda – delivery of JSON-encoded message to an AWS Lambda function + // * lambda – delivery of JSON-encoded message to an Lambda function // // * firehose – delivery of JSON-encoded message to an Amazon Kinesis Data // Firehose delivery stream. diff --git a/service/sns/errors.go b/service/sns/errors.go index 8b416554ce5..5843f4d8d9c 100644 --- a/service/sns/errors.go +++ b/service/sns/errors.go @@ -26,9 +26,9 @@ const ( // ErrCodeFilterPolicyLimitExceededException for service response error code // "FilterPolicyLimitExceeded". // - // Indicates that the number of filter polices in your AWS account exceeds the - // limit. To add more filter polices, submit an SNS Limit Increase case in the - // AWS Support Center. + // Indicates that the number of filter polices in your account exceeds the limit. + // To add more filter polices, submit an SNS Limit Increase case in the Amazon + // Web Services Support Center. ErrCodeFilterPolicyLimitExceededException = "FilterPolicyLimitExceeded" // ErrCodeInternalErrorException for service response error code @@ -76,7 +76,7 @@ const ( // The request was rejected because the state of the specified resource isn't // valid for this request. For more information, see How Key State Affects Use // of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) - // in the AWS Key Management Service Developer Guide. + // in the Key Management Service Developer Guide. ErrCodeKMSInvalidStateException = "KMSInvalidState" // ErrCodeKMSNotFoundException for service response error code @@ -89,7 +89,7 @@ const ( // ErrCodeKMSOptInRequired for service response error code // "KMSOptInRequired". // - // The AWS access key ID needs a subscription for the service. + // The Amazon Web Services access key ID needs a subscription for the service. ErrCodeKMSOptInRequired = "KMSOptInRequired" // ErrCodeKMSThrottlingException for service response error code @@ -97,7 +97,7 @@ const ( // // The request was denied due to request throttling. For more information about // throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) - // in the AWS Key Management Service Developer Guide. + // in the Key Management Service Developer Guide. ErrCodeKMSThrottlingException = "KMSThrottling" // ErrCodeNotFoundException for service response error code @@ -110,8 +110,8 @@ const ( // "OptedOut". // // Indicates that the specified phone number opted out of receiving SMS messages - // from your AWS account. You can't send SMS messages to phone numbers that - // opt out. + // from your account. You can't send SMS messages to phone numbers that opt + // out. ErrCodeOptedOutException = "OptedOut" // ErrCodePlatformApplicationDisabledException for service response error code diff --git a/service/sns/snsiface/interface.go b/service/sns/snsiface/interface.go index 41952cd7827..4b6b4b7852a 100644 --- a/service/sns/snsiface/interface.go +++ b/service/sns/snsiface/interface.go @@ -146,6 +146,9 @@ type SNSAPI interface { ListPhoneNumbersOptedOutWithContext(aws.Context, *sns.ListPhoneNumbersOptedOutInput, ...request.Option) (*sns.ListPhoneNumbersOptedOutOutput, error) ListPhoneNumbersOptedOutRequest(*sns.ListPhoneNumbersOptedOutInput) (*request.Request, *sns.ListPhoneNumbersOptedOutOutput) + ListPhoneNumbersOptedOutPages(*sns.ListPhoneNumbersOptedOutInput, func(*sns.ListPhoneNumbersOptedOutOutput, bool) bool) error + ListPhoneNumbersOptedOutPagesWithContext(aws.Context, *sns.ListPhoneNumbersOptedOutInput, func(*sns.ListPhoneNumbersOptedOutOutput, bool) bool, ...request.Option) error + ListPlatformApplications(*sns.ListPlatformApplicationsInput) (*sns.ListPlatformApplicationsOutput, error) ListPlatformApplicationsWithContext(aws.Context, *sns.ListPlatformApplicationsInput, ...request.Option) (*sns.ListPlatformApplicationsOutput, error) ListPlatformApplicationsRequest(*sns.ListPlatformApplicationsInput) (*request.Request, *sns.ListPlatformApplicationsOutput)