Creates a connector using the specified properties.
", + "CreateCustomPlugin": "Creates a custom plugin using the specified properties.
", + "CreateWorkerConfiguration": "Creates a worker configuration using the specified properties.
", + "DeleteConnector": "Deletes the specified connector.
", + "DescribeConnector": "Returns summary information about the connector.
", + "DescribeCustomPlugin": "A summary description of the custom plugin.
", + "DescribeWorkerConfiguration": "Returns information about a worker configuration.
", + "ListConnectors": "Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors.
", + "ListCustomPlugins": "Returns a list of all of the custom plugins in this account and Region.
", + "ListWorkerConfigurations": "Returns a list of all of the worker configurations in this account and Region.
", + "UpdateConnector": "Updates the specified connector.
" + }, + "shapes": { + "ApacheKafkaCluster": { + "base": "The details of the Apache Kafka cluster to which the connector is connected.
", + "refs": { + "KafkaCluster$apacheKafkaCluster": "The Apache Kafka cluster to which the connector is connected.
" + } + }, + "ApacheKafkaClusterDescription": { + "base": "The description of the Apache Kafka cluster to which the connector is connected.
", + "refs": { + "KafkaClusterDescription$apacheKafkaCluster": "The Apache Kafka cluster to which the connector is connected.
" + } + }, + "AutoScaling": { + "base": "Specifies how the connector scales.
", + "refs": { + "Capacity$autoScaling": "Information about the auto scaling parameters for the connector.
" + } + }, + "AutoScalingDescription": { + "base": "Information about the auto scaling parameters for the connector.
", + "refs": { + "CapacityDescription$autoScaling": "Describes the connector's auto scaling capacity.
" + } + }, + "AutoScalingUpdate": { + "base": "The updates to the auto scaling parameters for the connector.
", + "refs": { + "CapacityUpdate$autoScaling": "The target auto scaling setting.
" + } + }, + "BadRequestException": { + "base": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
", + "refs": { + } + }, + "Capacity": { + "base": "Information about the capacity of the connector, whether it is auto scaled or provisioned.
", + "refs": { + "CreateConnectorRequest$capacity": "Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.
" + } + }, + "CapacityDescription": { + "base": "A description of the connector's capacity.
", + "refs": { + "ConnectorSummary$capacity": "The connector's compute capacity settings.
", + "DescribeConnectorResponse$capacity": "Information about the capacity of the connector, whether it is auto scaled or provisioned.
" + } + }, + "CapacityUpdate": { + "base": "The target capacity for the connector. The capacity can be auto scaled or provisioned.
", + "refs": { + "UpdateConnectorRequest$capacity": "The target capacity.
" + } + }, + "CloudWatchLogsLogDelivery": { + "base": "The settings for delivering connector logs to Amazon CloudWatch Logs.
", + "refs": { + "WorkerLogDelivery$cloudWatchLogs": "Details about delivering logs to Amazon CloudWatch Logs.
" + } + }, + "CloudWatchLogsLogDeliveryDescription": { + "base": "A description of the log delivery settings.
", + "refs": { + "WorkerLogDeliveryDescription$cloudWatchLogs": "Details about delivering logs to Amazon CloudWatch Logs.
" + } + }, + "ConflictException": { + "base": "HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another name.
", + "refs": { + } + }, + "ConnectorState": { + "base": null, + "refs": { + "ConnectorSummary$connectorState": "The state of the connector.
", + "CreateConnectorResponse$connectorState": "The state of the connector.
", + "DeleteConnectorResponse$connectorState": "The state of the connector that you requested to delete.
", + "DescribeConnectorResponse$connectorState": "The state of the connector.
", + "UpdateConnectorResponse$connectorState": "The state of the connector.
" + } + }, + "ConnectorSummary": { + "base": "Summary of a connector.
", + "refs": { + "__listOfConnectorSummary$member": null + } + }, + "CreateConnectorRequest": { + "base": null, + "refs": { + } + }, + "CreateConnectorResponse": { + "base": null, + "refs": { + } + }, + "CreateCustomPluginRequest": { + "base": null, + "refs": { + } + }, + "CreateCustomPluginResponse": { + "base": null, + "refs": { + } + }, + "CreateWorkerConfigurationRequest": { + "base": null, + "refs": { + } + }, + "CreateWorkerConfigurationResponse": { + "base": null, + "refs": { + } + }, + "CustomPlugin": { + "base": "A plugin is an AWS resource that contains the code that defines a connector's logic.
", + "refs": { + "Plugin$customPlugin": "Details about a custom plugin.
" + } + }, + "CustomPluginContentType": { + "base": null, + "refs": { + "CreateCustomPluginRequest$contentType": "The type of the plugin file.
", + "CustomPluginRevisionSummary$contentType": "The format of the plugin file.
" + } + }, + "CustomPluginDescription": { + "base": "Details about a custom plugin.
", + "refs": { + "PluginDescription$customPlugin": "Details about a custom plugin.
" + } + }, + "CustomPluginFileDescription": { + "base": "Details about a custom plugin file.
", + "refs": { + "CustomPluginRevisionSummary$fileDescription": "Details about the custom plugin file.
" + } + }, + "CustomPluginLocation": { + "base": "Information about the location of a custom plugin.
", + "refs": { + "CreateCustomPluginRequest$location": "Information about the location of a custom plugin.
" + } + }, + "CustomPluginLocationDescription": { + "base": "Information about the location of a custom plugin.
", + "refs": { + "CustomPluginRevisionSummary$location": "Information about the location of the custom plugin.
" + } + }, + "CustomPluginRevisionSummary": { + "base": "Details about the revision of a custom plugin.
", + "refs": { + "CustomPluginSummary$latestRevision": "The latest revision of the custom plugin.
", + "DescribeCustomPluginResponse$latestRevision": "The latest successfully created revision of the custom plugin. If there are no successfully created revisions, this field will be absent.
" + } + }, + "CustomPluginState": { + "base": null, + "refs": { + "CreateCustomPluginResponse$customPluginState": "The state of the custom plugin.
", + "CustomPluginSummary$customPluginState": "The state of the custom plugin.
", + "DescribeCustomPluginResponse$customPluginState": "The state of the custom plugin.
" + } + }, + "CustomPluginSummary": { + "base": "A summary of the custom plugin.
", + "refs": { + "__listOfCustomPluginSummary$member": null + } + }, + "DeleteConnectorRequest": { + "base": null, + "refs": { + } + }, + "DeleteConnectorResponse": { + "base": null, + "refs": { + } + }, + "DescribeConnectorRequest": { + "base": null, + "refs": { + } + }, + "DescribeConnectorResponse": { + "base": null, + "refs": { + } + }, + "DescribeCustomPluginRequest": { + "base": null, + "refs": { + } + }, + "DescribeCustomPluginResponse": { + "base": null, + "refs": { + } + }, + "DescribeWorkerConfigurationRequest": { + "base": null, + "refs": { + } + }, + "DescribeWorkerConfigurationResponse": { + "base": null, + "refs": { + } + }, + "FirehoseLogDelivery": { + "base": "The settings for delivering logs to Amazon Kinesis Data Firehose.
", + "refs": { + "WorkerLogDelivery$firehose": "Details about delivering logs to Amazon Kinesis Data Firehose.
" + } + }, + "FirehoseLogDeliveryDescription": { + "base": "A description of the settings for delivering logs to Amazon Kinesis Data Firehose.
", + "refs": { + "WorkerLogDeliveryDescription$firehose": "Details about delivering logs to Amazon Kinesis Data Firehose.
" + } + }, + "ForbiddenException": { + "base": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
", + "refs": { + } + }, + "InternalServerErrorException": { + "base": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
", + "refs": { + } + }, + "KafkaCluster": { + "base": "The details of the Apache Kafka cluster to which the connector is connected.
", + "refs": { + "CreateConnectorRequest$kafkaCluster": "Specifies which Apache Kafka cluster to connect to.
" + } + }, + "KafkaClusterClientAuthentication": { + "base": "The client authentication information used in order to authenticate with the Apache Kafka cluster.
", + "refs": { + "CreateConnectorRequest$kafkaClusterClientAuthentication": "Details of the client authentication used by the Apache Kafka cluster.
" + } + }, + "KafkaClusterClientAuthenticationDescription": { + "base": "The client authentication information used in order to authenticate with the Apache Kafka cluster.
", + "refs": { + "ConnectorSummary$kafkaClusterClientAuthentication": "The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.
", + "DescribeConnectorResponse$kafkaClusterClientAuthentication": "The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.
" + } + }, + "KafkaClusterClientAuthenticationType": { + "base": null, + "refs": { + "KafkaClusterClientAuthentication$authenticationType": "The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.
", + "KafkaClusterClientAuthenticationDescription$authenticationType": "The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.
" + } + }, + "KafkaClusterDescription": { + "base": "Details of how to connect to the Apache Kafka cluster.
", + "refs": { + "ConnectorSummary$kafkaCluster": "The details of the Apache Kafka cluster to which the connector is connected.
", + "DescribeConnectorResponse$kafkaCluster": "The Apache Kafka cluster that the connector is connected to.
" + } + }, + "KafkaClusterEncryptionInTransit": { + "base": "Details of encryption in transit to the Apache Kafka cluster.
", + "refs": { + "CreateConnectorRequest$kafkaClusterEncryptionInTransit": "Details of encryption in transit to the Apache Kafka cluster.
" + } + }, + "KafkaClusterEncryptionInTransitDescription": { + "base": "The description of the encryption in transit to the Apache Kafka cluster.
", + "refs": { + "ConnectorSummary$kafkaClusterEncryptionInTransit": "Details of encryption in transit to the Apache Kafka cluster.
", + "DescribeConnectorResponse$kafkaClusterEncryptionInTransit": "Details of encryption in transit to the Apache Kafka cluster.
" + } + }, + "KafkaClusterEncryptionInTransitType": { + "base": null, + "refs": { + "KafkaClusterEncryptionInTransit$encryptionType": "The type of encryption in transit to the Apache Kafka cluster.
", + "KafkaClusterEncryptionInTransitDescription$encryptionType": "The type of encryption in transit to the Apache Kafka cluster.
" + } + }, + "ListConnectorsRequest": { + "base": null, + "refs": { + } + }, + "ListConnectorsResponse": { + "base": null, + "refs": { + } + }, + "ListCustomPluginsRequest": { + "base": null, + "refs": { + } + }, + "ListCustomPluginsResponse": { + "base": null, + "refs": { + } + }, + "ListWorkerConfigurationsRequest": { + "base": null, + "refs": { + } + }, + "ListWorkerConfigurationsResponse": { + "base": null, + "refs": { + } + }, + "LogDelivery": { + "base": "Details about log delivery.
", + "refs": { + "CreateConnectorRequest$logDelivery": "Details about log delivery.
" + } + }, + "LogDeliveryDescription": { + "base": "The description of the log delivery settings.
", + "refs": { + "ConnectorSummary$logDelivery": "The settings for delivering connector logs to Amazon CloudWatch Logs.
", + "DescribeConnectorResponse$logDelivery": "Details about delivering logs to Amazon CloudWatch Logs.
" + } + }, + "MaxResults": { + "base": null, + "refs": { + "ListConnectorsRequest$maxResults": "The maximum number of connectors to list in one response.
", + "ListCustomPluginsRequest$maxResults": "The maximum number of custom plugins to list in one response.
", + "ListWorkerConfigurationsRequest$maxResults": "The maximum number of worker configurations to list in one response.
" + } + }, + "NotFoundException": { + "base": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
", + "refs": { + } + }, + "Plugin": { + "base": "A plugin is an AWS resource that contains the code that defines your connector logic.
", + "refs": { + "__listOfPlugin$member": null + } + }, + "PluginDescription": { + "base": "The description of the plugin.
", + "refs": { + "__listOfPluginDescription$member": null + } + }, + "ProvisionedCapacity": { + "base": "Details about a connector's provisioned capacity.
", + "refs": { + "Capacity$provisionedCapacity": "Details about a fixed capacity allocated to a connector.
" + } + }, + "ProvisionedCapacityDescription": { + "base": "The description of a connector's provisioned capacity.
", + "refs": { + "CapacityDescription$provisionedCapacity": "Describes a connector's provisioned capacity.
" + } + }, + "ProvisionedCapacityUpdate": { + "base": "An update to a connector's fixed capacity.
", + "refs": { + "CapacityUpdate$provisionedCapacity": "The target settings for provisioned capacity.
" + } + }, + "S3Location": { + "base": "The location of an object in Amazon S3.
", + "refs": { + "CustomPluginLocation$s3Location": "The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.
" + } + }, + "S3LocationDescription": { + "base": "The description of the location of an object in Amazon S3.
", + "refs": { + "CustomPluginLocationDescription$s3Location": "The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.
" + } + }, + "S3LogDelivery": { + "base": "Details about delivering logs to Amazon S3.
", + "refs": { + "WorkerLogDelivery$s3": "Details about delivering logs to Amazon S3.
" + } + }, + "S3LogDeliveryDescription": { + "base": "The description of the details about delivering logs to Amazon S3.
", + "refs": { + "WorkerLogDeliveryDescription$s3": "Details about delivering logs to Amazon S3.
" + } + }, + "ScaleInPolicy": { + "base": "The scale-in policy for the connector.
", + "refs": { + "AutoScaling$scaleInPolicy": "The sacle-in policy for the connector.
" + } + }, + "ScaleInPolicyDescription": { + "base": "The description of the scale-in policy for the connector.
", + "refs": { + "AutoScalingDescription$scaleInPolicy": "The sacle-in policy for the connector.
" + } + }, + "ScaleInPolicyUpdate": { + "base": "An update to the connector's scale-in policy.
", + "refs": { + "AutoScalingUpdate$scaleInPolicy": "The target sacle-in policy for the connector.
" + } + }, + "ScaleOutPolicy": { + "base": "The scale-out policy for the connector.
", + "refs": { + "AutoScaling$scaleOutPolicy": "The sacle-out policy for the connector.
" + } + }, + "ScaleOutPolicyDescription": { + "base": "The description of the scale-out policy for the connector.
", + "refs": { + "AutoScalingDescription$scaleOutPolicy": "The sacle-out policy for the connector.>
" + } + }, + "ScaleOutPolicyUpdate": { + "base": "An update to the connector's scale-out policy.
", + "refs": { + "AutoScalingUpdate$scaleOutPolicy": "The target sacle-out policy for the connector.
" + } + }, + "ServiceUnavailableException": { + "base": "HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.
", + "refs": { + } + }, + "TooManyRequestsException": { + "base": "HTTP Status Code 429: Limit exceeded. Resource limit reached.
", + "refs": { + } + }, + "UnauthorizedException": { + "base": "HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
", + "refs": { + } + }, + "UpdateConnectorRequest": { + "base": null, + "refs": { + } + }, + "UpdateConnectorResponse": { + "base": null, + "refs": { + } + }, + "Vpc": { + "base": "Information about the VPC in which the connector resides.
", + "refs": { + "ApacheKafkaCluster$vpc": "Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
" + } + }, + "VpcDescription": { + "base": "The description of the VPC in which the connector resides.
", + "refs": { + "ApacheKafkaClusterDescription$vpc": "Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
" + } + }, + "WorkerConfiguration": { + "base": "The configuration of the workers, which are the processes that run the connector logic.
", + "refs": { + "CreateConnectorRequest$workerConfiguration": "Specifies which worker configuration to use with the connector.
" + } + }, + "WorkerConfigurationDescription": { + "base": "The description of the worker configuration.
", + "refs": { + "ConnectorSummary$workerConfiguration": "The worker configurations that are in use with the connector.
", + "DescribeConnectorResponse$workerConfiguration": "Specifies which worker configuration was used for the connector.
" + } + }, + "WorkerConfigurationRevisionDescription": { + "base": "The description of the worker configuration revision.
", + "refs": { + "DescribeWorkerConfigurationResponse$latestRevision": "The latest revision of the custom configuration.
" + } + }, + "WorkerConfigurationRevisionSummary": { + "base": "The summary of a worker configuration revision.
", + "refs": { + "CreateWorkerConfigurationResponse$latestRevision": "The latest revision of the worker configuration.
", + "WorkerConfigurationSummary$latestRevision": "The latest revision of a worker configuration.
" + } + }, + "WorkerConfigurationSummary": { + "base": "The summary of a worker configuration.
", + "refs": { + "__listOfWorkerConfigurationSummary$member": null + } + }, + "WorkerLogDelivery": { + "base": "Workers can send worker logs to different destination types. This configuration specifies the details of these destinations.
", + "refs": { + "LogDelivery$workerLogDelivery": "The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.
" + } + }, + "WorkerLogDeliveryDescription": { + "base": "Workers can send worker logs to different destination types. This configuration specifies the details of these destinations.
", + "refs": { + "LogDeliveryDescription$workerLogDelivery": "The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.
" + } + }, + "__boolean": { + "base": null, + "refs": { + "CloudWatchLogsLogDelivery$enabled": "Whether log delivery to Amazon CloudWatch Logs is enabled.
", + "CloudWatchLogsLogDeliveryDescription$enabled": "Whether log delivery to Amazon CloudWatch Logs is enabled.
", + "FirehoseLogDelivery$enabled": "Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.
", + "FirehoseLogDeliveryDescription$enabled": "Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.
", + "S3LogDelivery$enabled": "Specifies whether connector logs get sent to the specified Amazon S3 destination.
", + "S3LogDeliveryDescription$enabled": "Specifies whether connector logs get sent to the specified Amazon S3 destination.
" + } + }, + "__integer": { + "base": null, + "refs": { + "AutoScalingDescription$maxWorkerCount": "The maximum number of workers allocated to the connector.
", + "AutoScalingDescription$mcuCount": "The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
", + "AutoScalingDescription$minWorkerCount": "The minimum number of workers allocated to the connector.
", + "ProvisionedCapacityDescription$mcuCount": "The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
", + "ProvisionedCapacityDescription$workerCount": "The number of workers that are allocated to the connector.
", + "ScaleInPolicyDescription$cpuUtilizationPercentage": "Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.
", + "ScaleOutPolicyDescription$cpuUtilizationPercentage": "The CPU utilization percentage threshold at which you want connector scale out to be triggered.
" + } + }, + "__integerMin1Max10": { + "base": null, + "refs": { + "AutoScaling$maxWorkerCount": "The maximum number of workers allocated to the connector.
", + "AutoScaling$minWorkerCount": "The minimum number of workers allocated to the connector.
", + "AutoScalingUpdate$maxWorkerCount": "The target maximum number of workers allocated to the connector.
", + "AutoScalingUpdate$minWorkerCount": "The target minimum number of workers allocated to the connector.
", + "ProvisionedCapacity$workerCount": "The number of workers that are allocated to the connector.
", + "ProvisionedCapacityUpdate$workerCount": "The number of workers that are allocated to the connector.
" + } + }, + "__integerMin1Max100": { + "base": null, + "refs": { + "ScaleInPolicy$cpuUtilizationPercentage": "Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.
", + "ScaleInPolicyUpdate$cpuUtilizationPercentage": "The target CPU utilization percentage threshold at which you want connector scale in to be triggered.
", + "ScaleOutPolicy$cpuUtilizationPercentage": "The CPU utilization percentage threshold at which you want connector scale out to be triggered.
", + "ScaleOutPolicyUpdate$cpuUtilizationPercentage": "The target CPU utilization percentage threshold at which you want connector scale out to be triggered.
" + } + }, + "__integerMin1Max8": { + "base": null, + "refs": { + "AutoScaling$mcuCount": "The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
", + "AutoScalingUpdate$mcuCount": "The target number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
", + "ProvisionedCapacity$mcuCount": "The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
", + "ProvisionedCapacityUpdate$mcuCount": "The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
" + } + }, + "__listOfConnectorSummary": { + "base": null, + "refs": { + "ListConnectorsResponse$connectors": "An array of connector descriptions.
" + } + }, + "__listOfCustomPluginSummary": { + "base": null, + "refs": { + "ListCustomPluginsResponse$customPlugins": "An array of custom plugin descriptions.
" + } + }, + "__listOfPlugin": { + "base": null, + "refs": { + "CreateConnectorRequest$plugins": "Specifies which plugins to use for the connector.
" + } + }, + "__listOfPluginDescription": { + "base": null, + "refs": { + "ConnectorSummary$plugins": "Specifies which plugins were used for this connector.
", + "DescribeConnectorResponse$plugins": "Specifies which plugins were used for this connector.
" + } + }, + "__listOfWorkerConfigurationSummary": { + "base": null, + "refs": { + "ListWorkerConfigurationsResponse$workerConfigurations": "An array of worker configuration descriptions.
" + } + }, + "__listOf__string": { + "base": null, + "refs": { + "Vpc$securityGroups": "The security groups for the connector.
", + "Vpc$subnets": "The subnets for the connector.
", + "VpcDescription$securityGroups": "The security groups for the connector.
", + "VpcDescription$subnets": "The subnets for the connector.
" + } + }, + "__long": { + "base": null, + "refs": { + "CreateCustomPluginResponse$revision": "The revision of the custom plugin.
", + "CustomPluginDescription$revision": "The revision of the custom plugin.
", + "CustomPluginFileDescription$fileSize": "The size in bytes of the custom plugin file. You can use it to validate the file.
", + "CustomPluginRevisionSummary$revision": "The revision of the custom plugin.
", + "WorkerConfigurationDescription$revision": "The revision of the worker configuration.
", + "WorkerConfigurationRevisionDescription$revision": "The description of a revision of the worker configuration.
", + "WorkerConfigurationRevisionSummary$revision": "The revision of a worker configuration.
" + } + }, + "__longMin1": { + "base": null, + "refs": { + "CustomPlugin$revision": "The revision of the custom plugin.
", + "WorkerConfiguration$revision": "The revision of the worker configuration.
" + } + }, + "__mapOf__string": { + "base": null, + "refs": { + "CreateConnectorRequest$connectorConfiguration": "A map of keys to values that represent the configuration for the connector.
", + "DescribeConnectorResponse$connectorConfiguration": "A map of keys to values that represent the configuration for the connector.
" + } + }, + "__string": { + "base": null, + "refs": { + "ApacheKafkaCluster$bootstrapServers": "The bootstrap servers of the cluster.
", + "ApacheKafkaClusterDescription$bootstrapServers": "The bootstrap servers of the cluster.
", + "BadRequestException$message": null, + "CloudWatchLogsLogDelivery$logGroup": "The name of the CloudWatch log group that is the destination for log delivery.
", + "CloudWatchLogsLogDeliveryDescription$logGroup": "The name of the CloudWatch log group that is the destination for log delivery.
", + "ConflictException$message": null, + "ConnectorSummary$connectorArn": "The Amazon Resource Name (ARN) of the connector.
", + "ConnectorSummary$connectorDescription": "The description of the connector.
", + "ConnectorSummary$connectorName": "The name of the connector.
", + "ConnectorSummary$currentVersion": "The current version of the connector.
", + "ConnectorSummary$kafkaConnectVersion": "The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.
", + "ConnectorSummary$serviceExecutionRoleArn": "The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
", + "CreateConnectorRequest$kafkaConnectVersion": "The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.
", + "CreateConnectorRequest$serviceExecutionRoleArn": "The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.
", + "CreateConnectorResponse$connectorArn": "The Amazon Resource Name (ARN) that Amazon assigned to the connector.
", + "CreateConnectorResponse$connectorName": "The name of the connector.
", + "CreateCustomPluginResponse$customPluginArn": "The Amazon Resource Name (ARN) that Amazon assigned to the custom plugin.
", + "CreateCustomPluginResponse$name": "The name of the custom plugin.
", + "CreateWorkerConfigurationRequest$propertiesFileContent": "Base64 encoded contents of connect-distributed.properties file.
", + "CreateWorkerConfigurationResponse$name": "The name of the worker configuration.
", + "CreateWorkerConfigurationResponse$workerConfigurationArn": "The Amazon Resource Name (ARN) that Amazon assigned to the worker configuration.
", + "CustomPlugin$customPluginArn": "The Amazon Resource Name (ARN) of the custom plugin.
", + "CustomPluginDescription$customPluginArn": "The Amazon Resource Name (ARN) of the custom plugin.
", + "CustomPluginFileDescription$fileMd5": "The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.
", + "CustomPluginRevisionSummary$description": "The description of the custom plugin.
", + "CustomPluginSummary$customPluginArn": "The Amazon Resource Name (ARN) of the custom plugin.
", + "CustomPluginSummary$description": "A description of the custom plugin.
", + "CustomPluginSummary$name": "The name of the custom plugin.
", + "DeleteConnectorRequest$connectorArn": "The Amazon Resource Name (ARN) of the connector that you want to delete.
", + "DeleteConnectorRequest$currentVersion": "The current version of the connector that you want to delete.
", + "DeleteConnectorResponse$connectorArn": "The Amazon Resource Name (ARN) of the connector that you requested to delete.
", + "DescribeConnectorRequest$connectorArn": "The Amazon Resource Name (ARN) of the connector that you want to describe.
", + "DescribeConnectorResponse$connectorArn": "The Amazon Resource Name (ARN) of the connector.
", + "DescribeConnectorResponse$connectorDescription": "A summary description of the connector.
", + "DescribeConnectorResponse$connectorName": "The name of the connector.
", + "DescribeConnectorResponse$currentVersion": "The current version of the connector.
", + "DescribeConnectorResponse$kafkaConnectVersion": "The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.
", + "DescribeConnectorResponse$serviceExecutionRoleArn": "The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
", + "DescribeCustomPluginRequest$customPluginArn": "Returns information about a custom plugin.
", + "DescribeCustomPluginResponse$customPluginArn": "The Amazon Resource Name (ARN) of the custom plugin.
", + "DescribeCustomPluginResponse$description": "The description of the custom plugin.
", + "DescribeCustomPluginResponse$name": "The name of the custom plugin.
", + "DescribeWorkerConfigurationRequest$workerConfigurationArn": "The Amazon Resource Name (ARN) of the worker configuration that you want to get information about.
", + "DescribeWorkerConfigurationResponse$description": "The description of the worker configuration.
", + "DescribeWorkerConfigurationResponse$name": "The name of the worker configuration.
", + "DescribeWorkerConfigurationResponse$workerConfigurationArn": "The Amazon Resource Name (ARN) of the custom configuration.
", + "FirehoseLogDelivery$deliveryStream": "The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.
", + "FirehoseLogDeliveryDescription$deliveryStream": "The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.
", + "ForbiddenException$message": null, + "InternalServerErrorException$message": null, + "ListConnectorsRequest$connectorNamePrefix": "The name prefix that you want to use to search for and list connectors.
", + "ListConnectorsRequest$nextToken": "If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.
", + "ListConnectorsResponse$nextToken": "If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where it left off.
", + "ListCustomPluginsRequest$nextToken": "If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.
", + "ListCustomPluginsResponse$nextToken": "If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.
", + "ListWorkerConfigurationsRequest$nextToken": "If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.
", + "ListWorkerConfigurationsResponse$nextToken": "If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.
", + "NotFoundException$message": null, + "S3Location$bucketArn": "The Amazon Resource Name (ARN) of an S3 bucket.
", + "S3Location$fileKey": "The file key for an object in an S3 bucket.
", + "S3Location$objectVersion": "The version of an object in an S3 bucket.
", + "S3LocationDescription$bucketArn": "The Amazon Resource Name (ARN) of an S3 bucket.
", + "S3LocationDescription$fileKey": "The file key for an object in an S3 bucket.
", + "S3LocationDescription$objectVersion": "The version of an object in an S3 bucket.
", + "S3LogDelivery$bucket": "The name of the S3 bucket that is the destination for log delivery.
", + "S3LogDelivery$prefix": "The S3 prefix that is the destination for log delivery.
", + "S3LogDeliveryDescription$bucket": "The name of the S3 bucket that is the destination for log delivery.
", + "S3LogDeliveryDescription$prefix": "The S3 prefix that is the destination for log delivery.
", + "ServiceUnavailableException$message": null, + "TooManyRequestsException$message": null, + "UnauthorizedException$message": null, + "UpdateConnectorRequest$connectorArn": "The Amazon Resource Name (ARN) of the connector that you want to update.
", + "UpdateConnectorRequest$currentVersion": "The current version of the connector that you want to update.
", + "UpdateConnectorResponse$connectorArn": "The Amazon Resource Name (ARN) of the connector.
", + "WorkerConfiguration$workerConfigurationArn": "The Amazon Resource Name (ARN) of the worker configuration.
", + "WorkerConfigurationDescription$workerConfigurationArn": "The Amazon Resource Name (ARN) of the worker configuration.
", + "WorkerConfigurationRevisionDescription$description": "The description of the worker configuration revision.
", + "WorkerConfigurationRevisionDescription$propertiesFileContent": "Base64 encoded contents of the connect-distributed.properties file.
", + "WorkerConfigurationRevisionSummary$description": "The description of a worker configuration revision.
", + "WorkerConfigurationSummary$description": "The description of a worker configuration.
", + "WorkerConfigurationSummary$name": "The name of the worker configuration.
", + "WorkerConfigurationSummary$workerConfigurationArn": "The Amazon Resource Name (ARN) of the worker configuration.
", + "__listOf__string$member": null, + "__mapOf__string$key": null, + "__mapOf__string$value": null + } + }, + "__stringMax1024": { + "base": null, + "refs": { + "CreateConnectorRequest$connectorDescription": "A summary description of the connector.
", + "CreateCustomPluginRequest$description": "A summary description of the custom plugin.
", + "CreateWorkerConfigurationRequest$description": "A summary description of the worker configuration.
" + } + }, + "__stringMin1Max128": { + "base": null, + "refs": { + "CreateConnectorRequest$connectorName": "The name of the connector.
", + "CreateCustomPluginRequest$name": "The name of the custom plugin.
", + "CreateWorkerConfigurationRequest$name": "The name of the worker configuration.
" + } + }, + "__timestampIso8601": { + "base": null, + "refs": { + "ConnectorSummary$creationTime": "The time that the connector was created.
", + "CreateWorkerConfigurationResponse$creationTime": "The time that the worker configuration was created.
", + "CustomPluginRevisionSummary$creationTime": "The time that the custom plugin was created.
", + "CustomPluginSummary$creationTime": "The time that the custom plugin was created.
", + "DescribeConnectorResponse$creationTime": "The time the connector was created.
", + "DescribeCustomPluginResponse$creationTime": "The time that the custom plugin was created.
", + "DescribeWorkerConfigurationResponse$creationTime": "The time that the worker configuration was created.
", + "WorkerConfigurationRevisionDescription$creationTime": "The time that the worker configuration was created.
", + "WorkerConfigurationRevisionSummary$creationTime": "The time that a worker configuration revision was created.
", + "WorkerConfigurationSummary$creationTime": "The time that a worker configuration was created.
" + } + } + } +} diff --git a/models/apis/kafkaconnect/2021-09-14/examples-1.json b/models/apis/kafkaconnect/2021-09-14/examples-1.json new file mode 100644 index 00000000000..0ea7e3b0bbe --- /dev/null +++ b/models/apis/kafkaconnect/2021-09-14/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/models/apis/kafkaconnect/2021-09-14/paginators-1.json b/models/apis/kafkaconnect/2021-09-14/paginators-1.json new file mode 100644 index 00000000000..489a00d61f3 --- /dev/null +++ b/models/apis/kafkaconnect/2021-09-14/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListConnectors": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "connectors" + }, + "ListCustomPlugins": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "customPlugins" + }, + "ListWorkerConfigurations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "workerConfigurations" + } + } +} diff --git a/models/apis/macie2/2020-01-01/api-2.json b/models/apis/macie2/2020-01-01/api-2.json index a9f901a7c61..6958e04607d 100644 --- a/models/apis/macie2/2020-01-01/api-2.json +++ b/models/apis/macie2/2020-01-01/api-2.json @@ -1565,6 +1565,21 @@ } ] }, + "ListManagedDataIdentifiers": { + "name": "ListManagedDataIdentifiers", + "http": { + "method": "POST", + "requestUri": "/managed-data-identifiers/list", + "responseCode": 200 + }, + "input": { + "shape": "ListManagedDataIdentifiersRequest" + }, + "output": { + "shape": "ListManagedDataIdentifiersResponse" + }, + "errors": [] + }, "ListMembers": { "name": "ListMembers", "http": { @@ -2696,6 +2711,14 @@ "shape": "JobType", "locationName": "jobType" }, + "managedDataIdentifierIds": { + "shape": "__listOf__string", + "locationName": "managedDataIdentifierIds" + }, + "managedDataIdentifierSelector": { + "shape": "ManagedDataIdentifierSelector", + "locationName": "managedDataIdentifierSelector" + }, "name": { "shape": "__string", "locationName": "name" @@ -3265,6 +3288,14 @@ "shape": "__timestampIso8601", "locationName": "lastRunTime" }, + "managedDataIdentifierIds": { + "shape": "__listOf__string", + "locationName": "managedDataIdentifierIds" + }, + "managedDataIdentifierSelector": { + "shape": "ManagedDataIdentifierSelector", + "locationName": "managedDataIdentifierSelector" + }, "name": { "shape": "__string", "locationName": "name" @@ -4680,6 +4711,28 @@ } } }, + "ListManagedDataIdentifiersRequest": { + "type": "structure", + "members": { + "nextToken": { + "shape": "__string", + "locationName": "nextToken" + } + } + }, + "ListManagedDataIdentifiersResponse": { + "type": "structure", + "members": { + "items": { + "shape": "__listOfManagedDataIdentifierSummary", + "locationName": "items" + }, + "nextToken": { + "shape": "__string", + "locationName": "nextToken" + } + } + }, "ListMembersRequest": { "type": "structure", "members": { @@ -4770,6 +4823,28 @@ "ENABLED" ] }, + "ManagedDataIdentifierSelector": { + "type": "string", + "enum": [ + "ALL", + "EXCLUDE", + "INCLUDE", + "NONE" + ] + }, + "ManagedDataIdentifierSummary": { + "type": "structure", + "members": { + "category": { + "shape": "SensitiveDataItemCategory", + "locationName": "category" + }, + "id": { + "shape": "__string", + "locationName": "id" + } + } + }, "MatchingBucket": { "type": "structure", "members": { @@ -6381,6 +6456,12 @@ "shape": "ListJobsFilterTerm" } }, + "__listOfManagedDataIdentifierSummary": { + "type": "list", + "member": { + "shape": "ManagedDataIdentifierSummary" + } + }, "__listOfMatchingResource": { "type": "list", "member": { diff --git a/models/apis/macie2/2020-01-01/docs-2.json b/models/apis/macie2/2020-01-01/docs-2.json index 906a96796f5..1a4ed39d569 100644 --- a/models/apis/macie2/2020-01-01/docs-2.json +++ b/models/apis/macie2/2020-01-01/docs-2.json @@ -43,7 +43,8 @@ "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.
", "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.
", + "ListInvitations" : "Retrieves information about the Amazon Macie membership invitations that were received by an account.
", + "ListManagedDataIdentifiers" : "Retrieves information about all the managed data identifiers that Amazon Macie currently provides.
", "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 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.
", @@ -280,7 +281,7 @@ "refs" : { } }, "CreateCustomDataIdentifierRequest" : { - "base" : "Specifies the criteria and other settings for a new custom data identifier. You can't change a custom data identifier after you create it. This helps ensure that you have an immutable history of sensitive data findings and discovery results for data privacy and protection audits or investigations.
", + "base" : "Specifies the criteria and other settings for a custom data identifier. You can't change a custom data identifier after you create it. This helps ensure that you have an immutable history of sensitive data findings and discovery results for data privacy and protection audits or investigations.
", "refs" : { } }, "CreateCustomDataIdentifierResponse" : { @@ -392,7 +393,7 @@ "refs" : { } }, "DefaultDetection" : { - "base" : "Provides information about a type of sensitive data that was detected by managed data identifiers and produced a sensitive data finding.
", + "base" : "Provides information about a type of sensitive data that was detected by a managed data identifier and produced a sensitive data finding.
", "refs" : { "DefaultDetections$member" : null } @@ -716,7 +717,7 @@ "base" : "Specifies the recurrence pattern for running a classification job.
", "refs" : { "CreateClassificationJobRequest$ScheduleFrequency" : "The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.
", - "DescribeClassificationJobResponse$ScheduleFrequency" : "The recurrence pattern for running the job. If the job is configured to run only once, this value is null.
" + "DescribeClassificationJobResponse$ScheduleFrequency" : "The recurrence pattern for running the job. This value is null if the job is configured to run only once.
" } }, "JobScopeTerm" : { @@ -735,8 +736,8 @@ "JobStatus" : { "base" : "The status of a classification job. Possible values are:
", "refs" : { - "DescribeClassificationJobResponse$JobStatus" : "The current status of the job. Possible values are:
CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.
COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
PAUSED - Amazon Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.
RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
The current status of the job. Possible values are:
CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.
COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
PAUSED - Amazon Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.
RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
The current status of the job. Possible values are:
CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.
COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.
RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
The current status of the job. Possible values are:
CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.
COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.
RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
The new status for the job. Valid values are:
CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.
If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.
RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.
If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.
USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.
If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
The criteria to use to sort the results.
" } }, + "ListManagedDataIdentifiersRequest" : { + "base" : "Specifies criteria for paginating the results of a request for information about managed data identifiers.
", + "refs" : { } + }, + "ListManagedDataIdentifiersResponse" : { + "base" : "Provides information about the managed data identifiers that Amazon Macie currently provides.
", + "refs" : { } + }, "ListMembersResponse" : { "base" : "Provides information about the accounts that are associated with an Amazon Macie administrator account.
", "refs" : { } @@ -864,6 +873,19 @@ "UpdateMemberSessionRequest$Status" : "Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.
" } }, + "ManagedDataIdentifierSelector" : { + "base" : "The selection type that determines which managed data identifiers a classification job uses to analyze data. Valid values are:
", + "refs" : { + "CreateClassificationJobRequest$ManagedDataIdentifierSelector" : "The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:
ALL - Use all the managed data identifiers that Amazon Macie provides. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers specified by the managedDataIdentifierIds property.
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
NONE - Don't use any managed data identifiers. If you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.
If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.
", + "DescribeClassificationJobResponse$ManagedDataIdentifierSelector" : "The selection type that determines which managed data identifiers the job uses to analyze data. Possible values are:
ALL - Use all the managed data identifiers that Amazon Macie provides.
EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers specified by the managedDataIdentifierIds property.
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
NONE - Don't use any managed data identifiers.
If this value is null, the job uses all managed data identifiers. If this value is null, ALL, or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.
" + } + }, + "ManagedDataIdentifierSummary" : { + "base" : "Provides information about a managed data identifier. For additional information, see Using managed data identifiers in the Amazon Macie User Guide.
", + "refs" : { + "__listOfManagedDataIdentifierSummary$member" : null + } + }, "MatchingBucket" : { "base" : "Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes.
", "refs" : { @@ -907,7 +929,7 @@ } }, "Occurrences" : { - "base" : "Specifies the location of 1-15 occurrences of sensitive data that was detected by managed data identifiers or a custom data identifier and produced a sensitive data finding.
", + "base" : "Specifies the location of 1-15 occurrences of sensitive data that was detected by a managed data identifier or a custom data identifier and produced a sensitive data finding.
", "refs" : { "CustomDetection$Occurrences" : "The location of 1-15 occurrences of the sensitive data that the custom data identifier detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.
", "DefaultDetection$Occurrences" : "The location of 1-15 occurrences of the sensitive data that was detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.
" @@ -1025,9 +1047,9 @@ } }, "S3BucketOwner" : { - "base" : "Provides information about the user who owns an S3 bucket.
", + "base" : "Provides information about the Amazon Web Services account that owns an S3 bucket.
", "refs" : { - "S3Bucket$Owner" : "The display name and Amazon Web Services account ID for the user who owns the bucket.
" + "S3Bucket$Owner" : "The display name and canonical user ID for the Amazon Web Services account that owns the bucket.
" } }, "S3Destination" : { @@ -1151,9 +1173,10 @@ } }, "SensitiveDataItemCategory" : { - "base" : "The category of sensitive data that was detected and produced the finding. Possible values are:
", + "base" : "For a finding, the category of sensitive data that was detected and produced the finding. For a managed data identifier, the category of sensitive data that the managed data identifier detects. 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 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.
" + "ManagedDataIdentifierSummary$Category" : "The category of sensitive data that the managed data identifier detects: 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 passport 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 passport numbers.
" } }, "ServerSideEncryption" : { @@ -1472,9 +1495,9 @@ "BucketPolicy$AllowsPublicReadAccess" : "Specifies whether the bucket policy allows the general public to have read access to the bucket.
", "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.
", + "CreateClassificationJobRequest$InitialRun" : "For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.
If you configure the job to run only once, don't specify a value for this property.
", "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.
", + "DescribeClassificationJobResponse$InitialRun" : "For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects immediately after the job was created (true). If you configured the job to analyze only those objects that were created or changed after the job was created and before the job's first scheduled run, this value is false. This value is also false for a one-time job.
", "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).
", @@ -1502,12 +1525,12 @@ "__integer" : { "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.
", + "CreateClassificationJobRequest$SamplingPercentage" : "The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at 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. Amazon 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.
", - "GetCustomDataIdentifierResponse$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.
", + "GetCustomDataIdentifierResponse$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. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern.
", "GetFindingStatisticsRequest$Size" : "The maximum number of items to include in each page of the response.
", "GetFindingsFilterResponse$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.
", "GetUsageStatisticsRequest$MaxResults" : "The maximum number of items to include in each page of the response.
", @@ -1516,7 +1539,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. Amazon 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.
" } @@ -1606,6 +1629,12 @@ "ListJobsFilterCriteria$Includes" : "An array of objects, one for each condition that determines which jobs to include in the results.
" } }, + "__listOfManagedDataIdentifierSummary" : { + "base" : null, + "refs" : { + "ListManagedDataIdentifiersResponse$Items" : "An array of objects, one for each managed data identifier.
" + } + }, "__listOfMatchingResource" : { "base" : null, "refs" : { @@ -1684,20 +1713,22 @@ "__listOf__string" : { "base" : null, "refs" : { - "BatchGetCustomDataIdentifiersRequest$Ids" : "An array of strings that lists the unique identifiers for the custom data identifiers to retrieve information about.
", - "BatchGetCustomDataIdentifiersResponse$NotFoundIdentifierIds" : "An array of identifiers, one for each identifier that was specified in the request, but doesn't correlate to an existing custom data identifier.
", + "BatchGetCustomDataIdentifiersRequest$Ids" : "An array of custom data identifier IDs, one for each custom data identifier to retrieve information about.
", + "BatchGetCustomDataIdentifiersResponse$NotFoundIdentifierIds" : "An array of custom data identifier IDs, one for each custom data identifier that was specified in the request but doesn't correlate to an existing custom data identifier.
", "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.
", + "CreateClassificationJobRequest$CustomDataIdentifierIds" : "An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.
", + "CreateClassificationJobRequest$ManagedDataIdentifierIds" : "An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).
To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.
", + "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 UTF-8 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 UTF-8 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 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.
", + "DescribeClassificationJobResponse$CustomDataIdentifierIds" : "An array of unique identifiers, one for each custom data identifier that the job uses to analyze data. This value is null if the job uses only managed data identifiers to analyze data.
", + "DescribeClassificationJobResponse$ManagedDataIdentifierIds" : "An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector). This value is null if the job's managed data identifier selection type is ALL or the job uses only custom data identifiers (customDataIdentifierIds) 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.
", @@ -1708,8 +1739,8 @@ "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.
", + "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 UTF-8 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 UTF-8 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 nextToken string that specifies which page of results to return in a paginated response.
", "ListFindingsResponse$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.
", "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.
", + "ListManagedDataIdentifiersRequest$NextToken" : "The nextToken string that specifies which page of results to return in a paginated response.
", + "ListManagedDataIdentifiersResponse$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.
", + "ManagedDataIdentifierSummary$Id" : "The unique identifier for the managed data identifier. This is a string that describes the type of sensitive data that the managed data identifier detects. For example: OPENSSH_PRIVATE_KEY for OpenSSH private keys, CREDIT_CARD_NUMBER for credit card numbers, or USA_PASSPORT_NUMBER for US passport numbers.
", "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 Amazon Web Services account ID for the account.
", @@ -1933,8 +1967,8 @@ "S3Bucket$Arn" : "The Amazon Resource Name (ARN) of the bucket.
", "S3Bucket$Name" : "The name of the bucket.
", "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 Amazon Web Services account ID for the user who owns the bucket.
", + "S3BucketOwner$DisplayName" : "The display name of the account that owns the bucket.
", + "S3BucketOwner$Id" : "The canonical user ID for the account that 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 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.
", diff --git a/models/apis/pinpoint/2016-12-01/api-2.json b/models/apis/pinpoint/2016-12-01/api-2.json index 42773e620e4..f604f8e008b 100644 --- a/models/apis/pinpoint/2016-12-01/api-2.json +++ b/models/apis/pinpoint/2016-12-01/api-2.json @@ -190,6 +190,37 @@ } ] }, + "CreateInAppTemplate": { + "name": "CreateInAppTemplate", + "http": { + "method": "POST", + "requestUri": "/v1/templates/{template-name}/inapp", + "responseCode": 201 + }, + "input": { + "shape": "CreateInAppTemplateRequest" + }, + "output": { + "shape": "CreateInAppTemplateResponse" + }, + "errors": [ + { + "shape": "MethodNotAllowedException" + }, + { + "shape": "TooManyRequestsException" + }, + { + "shape": "BadRequestException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + } + ] + }, "CreateJourney": { "name": "CreateJourney", "http": { @@ -875,6 +906,43 @@ } ] }, + "DeleteInAppTemplate": { + "name": "DeleteInAppTemplate", + "http": { + "method": "DELETE", + "requestUri": "/v1/templates/{template-name}/inapp", + "responseCode": 202 + }, + "input": { + "shape": "DeleteInAppTemplateRequest" + }, + "output": { + "shape": "DeleteInAppTemplateResponse" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "PayloadTooLargeException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "MethodNotAllowedException" + }, + { + "shape": "TooManyRequestsException" + } + ] + }, "DeleteJourney": { "name": "DeleteJourney", "http": { @@ -2170,6 +2238,80 @@ } ] }, + "GetInAppMessages": { + "name": "GetInAppMessages", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/endpoints/{endpoint-id}/inappmessages", + "responseCode": 200 + }, + "input": { + "shape": "GetInAppMessagesRequest" + }, + "output": { + "shape": "GetInAppMessagesResponse" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "PayloadTooLargeException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "MethodNotAllowedException" + }, + { + "shape": "TooManyRequestsException" + } + ] + }, + "GetInAppTemplate": { + "name": "GetInAppTemplate", + "http": { + "method": "GET", + "requestUri": "/v1/templates/{template-name}/inapp", + "responseCode": 200 + }, + "input": { + "shape": "GetInAppTemplateRequest" + }, + "output": { + "shape": "GetInAppTemplateResponse" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "PayloadTooLargeException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "MethodNotAllowedException" + }, + { + "shape": "TooManyRequestsException" + } + ] + }, "GetJourney": { "name": "GetJourney", "http": { @@ -3683,6 +3825,43 @@ } ] }, + "UpdateInAppTemplate": { + "name": "UpdateInAppTemplate", + "http": { + "method": "PUT", + "requestUri": "/v1/templates/{template-name}/inapp", + "responseCode": 202 + }, + "input": { + "shape": "UpdateInAppTemplateRequest" + }, + "output": { + "shape": "UpdateInAppTemplateResponse" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "PayloadTooLargeException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "MethodNotAllowedException" + }, + { + "shape": "TooManyRequestsException" + } + ] + }, "UpdateJourney": { "name": "UpdateJourney", "http": { @@ -4673,6 +4852,14 @@ } } }, + "Alignment": { + "type": "string", + "enum": [ + "LEFT", + "CENTER", + "RIGHT" + ] + }, "AndroidPushNotificationTemplate": { "type": "structure", "members": { @@ -4969,6 +5156,14 @@ "Rows" ] }, + "ButtonAction": { + "type": "string", + "enum": [ + "LINK", + "DEEP_LINK", + "CLOSE" + ] + }, "CampaignCustomMessage": { "type": "structure", "members": { @@ -5057,6 +5252,23 @@ } } }, + "CampaignInAppMessage": { + "type": "structure", + "members": { + "Body": { + "shape": "__string" + }, + "Content": { + "shape": "ListOfInAppMessageContent" + }, + "CustomConfig": { + "shape": "MapOf__string" + }, + "Layout": { + "shape": "Layout" + } + } + }, "CampaignLimits": { "type": "structure", "members": { @@ -5071,6 +5283,9 @@ }, "Total": { "shape": "__integer" + }, + "Session": { + "shape": "__integer" } } }, @@ -5149,6 +5364,9 @@ }, "Version": { "shape": "__integer" + }, + "Priority": { + "shape": "__integer" } }, "required": [ @@ -5264,7 +5482,8 @@ "VOICE", "EMAIL", "BAIDU", - "CUSTOM" + "CUSTOM", + "IN_APP" ] }, "ChannelsResponse": { @@ -5480,6 +5699,36 @@ ], "payload": "ImportJobResponse" }, + "CreateInAppTemplateRequest": { + "type": "structure", + "members": { + "InAppTemplateRequest": { + "shape": "InAppTemplateRequest" + }, + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name" + } + }, + "required": [ + "TemplateName", + "InAppTemplateRequest" + ], + "payload": "InAppTemplateRequest" + }, + "CreateInAppTemplateResponse": { + "type": "structure", + "members": { + "TemplateCreateMessageBody": { + "shape": "TemplateCreateMessageBody" + } + }, + "required": [ + "TemplateCreateMessageBody" + ], + "payload": "TemplateCreateMessageBody" + }, "CreateJourneyRequest": { "type": "structure", "members": { @@ -5741,6 +5990,33 @@ } } }, + "DefaultButtonConfiguration": { + "type": "structure", + "members": { + "BackgroundColor": { + "shape": "__string" + }, + "BorderRadius": { + "shape": "__integer" + }, + "ButtonAction": { + "shape": "ButtonAction" + }, + "Link": { + "shape": "__string" + }, + "Text": { + "shape": "__string" + }, + "TextColor": { + "shape": "__string" + } + }, + "required": [ + "ButtonAction", + "Text" + ] + }, "DefaultMessage": { "type": "structure", "members": { @@ -6140,6 +6416,36 @@ ], "payload": "GCMChannelResponse" }, + "DeleteInAppTemplateRequest": { + "type": "structure", + "members": { + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name" + }, + "Version": { + "shape": "__string", + "location": "querystring", + "locationName": "version" + } + }, + "required": [ + "TemplateName" + ] + }, + "DeleteInAppTemplateResponse": { + "type": "structure", + "members": { + "MessageBody": { + "shape": "MessageBody" + } + }, + "required": [ + "MessageBody" + ], + "payload": "MessageBody" + }, "DeleteJourneyRequest": { "type": "structure", "members": { @@ -7236,7 +7542,8 @@ "DAILY", "WEEKLY", "MONTHLY", - "EVENT" + "EVENT", + "IN_APP_EVENT" ] }, "GCMChannelRequest": { @@ -8193,7 +8500,7 @@ ], "payload": "ImportJobsResponse" }, - "GetJourneyDateRangeKpiRequest": { + "GetInAppMessagesRequest": { "type": "structure", "members": { "ApplicationId": { @@ -8201,17 +8508,78 @@ "location": "uri", "locationName": "application-id" }, - "EndTime": { - "shape": "__timestampIso8601", - "location": "querystring", - "locationName": "end-time" - }, - "JourneyId": { + "EndpointId": { "shape": "__string", "location": "uri", - "locationName": "journey-id" - }, - "KpiName": { + "locationName": "endpoint-id" + } + }, + "required": [ + "ApplicationId", + "EndpointId" + ] + }, + "GetInAppMessagesResponse": { + "type": "structure", + "members": { + "InAppMessagesResponse": { + "shape": "InAppMessagesResponse" + } + }, + "required": [ + "InAppMessagesResponse" + ], + "payload": "InAppMessagesResponse" + }, + "GetInAppTemplateRequest": { + "type": "structure", + "members": { + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name" + }, + "Version": { + "shape": "__string", + "location": "querystring", + "locationName": "version" + } + }, + "required": [ + "TemplateName" + ] + }, + "GetInAppTemplateResponse": { + "type": "structure", + "members": { + "InAppTemplateResponse": { + "shape": "InAppTemplateResponse" + } + }, + "required": [ + "InAppTemplateResponse" + ], + "payload": "InAppTemplateResponse" + }, + "GetJourneyDateRangeKpiRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id" + }, + "EndTime": { + "shape": "__timestampIso8601", + "location": "querystring", + "locationName": "end-time" + }, + "JourneyId": { + "shape": "__string", + "location": "uri", + "locationName": "journey-id" + }, + "KpiName": { "shape": "__string", "location": "uri", "locationName": "kpi-name" @@ -8966,6 +9334,215 @@ "Item" ] }, + "InAppCampaignSchedule": { + "type": "structure", + "members": { + "EndDate": { + "shape": "__string" + }, + "EventFilter": { + "shape": "CampaignEventFilter" + }, + "QuietTime": { + "shape": "QuietTime" + } + } + }, + "InAppMessage": { + "type": "structure", + "members": { + "Content": { + "shape": "ListOfInAppMessageContent" + }, + "CustomConfig": { + "shape": "MapOf__string" + }, + "Layout": { + "shape": "Layout" + } + } + }, + "InAppMessageBodyConfig": { + "type": "structure", + "members": { + "Alignment": { + "shape": "Alignment" + }, + "Body": { + "shape": "__string" + }, + "TextColor": { + "shape": "__string" + } + }, + "required": [ + "Alignment", + "TextColor", + "Body" + ] + }, + "InAppMessageButton": { + "type": "structure", + "members": { + "Android": { + "shape": "OverrideButtonConfiguration" + }, + "DefaultConfig": { + "shape": "DefaultButtonConfiguration" + }, + "IOS": { + "shape": "OverrideButtonConfiguration" + }, + "Web": { + "shape": "OverrideButtonConfiguration" + } + } + }, + "InAppMessageCampaign": { + "type": "structure", + "members": { + "CampaignId": { + "shape": "__string" + }, + "DailyCap": { + "shape": "__integer" + }, + "InAppMessage": { + "shape": "InAppMessage" + }, + "Priority": { + "shape": "__integer" + }, + "Schedule": { + "shape": "InAppCampaignSchedule" + }, + "SessionCap": { + "shape": "__integer" + }, + "TotalCap": { + "shape": "__integer" + }, + "TreatmentId": { + "shape": "__string" + } + } + }, + "InAppMessageContent": { + "type": "structure", + "members": { + "BackgroundColor": { + "shape": "__string" + }, + "BodyConfig": { + "shape": "InAppMessageBodyConfig" + }, + "HeaderConfig": { + "shape": "InAppMessageHeaderConfig" + }, + "ImageUrl": { + "shape": "__string" + }, + "PrimaryBtn": { + "shape": "InAppMessageButton" + }, + "SecondaryBtn": { + "shape": "InAppMessageButton" + } + } + }, + "InAppMessageHeaderConfig": { + "type": "structure", + "members": { + "Alignment": { + "shape": "Alignment" + }, + "Header": { + "shape": "__string" + }, + "TextColor": { + "shape": "__string" + } + }, + "required": [ + "Alignment", + "Header", + "TextColor" + ] + }, + "InAppMessagesResponse": { + "type": "structure", + "members": { + "InAppMessageCampaigns": { + "shape": "ListOfInAppMessageCampaign" + } + } + }, + "InAppTemplateRequest": { + "type": "structure", + "members": { + "Content": { + "shape": "ListOfInAppMessageContent" + }, + "CustomConfig": { + "shape": "MapOf__string" + }, + "Layout": { + "shape": "Layout" + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags" + }, + "TemplateDescription": { + "shape": "__string" + } + } + }, + "InAppTemplateResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string" + }, + "Content": { + "shape": "ListOfInAppMessageContent" + }, + "CreationDate": { + "shape": "__string" + }, + "CustomConfig": { + "shape": "MapOf__string" + }, + "LastModifiedDate": { + "shape": "__string" + }, + "Layout": { + "shape": "Layout" + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags" + }, + "TemplateDescription": { + "shape": "__string" + }, + "TemplateName": { + "shape": "__string" + }, + "TemplateType": { + "shape": "TemplateType" + }, + "Version": { + "shape": "__string" + } + }, + "required": [ + "LastModifiedDate", + "CreationDate", + "TemplateName", + "TemplateType" + ] + }, "Include": { "type": "string", "enum": [ @@ -9255,6 +9832,17 @@ "Item" ] }, + "Layout": { + "type": "string", + "enum": [ + "BOTTOM_BANNER", + "TOP_BANNER", + "OVERLAYS", + "MOBILE_FEED", + "MIDDLE_BANNER", + "CAROUSEL" + ] + }, "ListJourneysRequest": { "type": "structure", "members": { @@ -9485,6 +10073,9 @@ }, "SMSMessage": { "shape": "CampaignSmsMessage" + }, + "InAppMessage": { + "shape": "CampaignInAppMessage" } } }, @@ -9707,6 +10298,20 @@ "ANY" ] }, + "OverrideButtonConfiguration": { + "type": "structure", + "members": { + "ButtonAction": { + "shape": "ButtonAction" + }, + "Link": { + "shape": "__string" + } + }, + "required": [ + "ButtonAction" + ] + }, "PayloadTooLargeException": { "type": "structure", "members": { @@ -10833,6 +11438,20 @@ } } }, + "TemplateCreateMessageBody": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string" + }, + "Message": { + "shape": "__string" + }, + "RequestID": { + "shape": "__string" + } + } + }, "TemplateResponse": { "type": "structure", "members": { @@ -10878,7 +11497,8 @@ "EMAIL", "SMS", "VOICE", - "PUSH" + "PUSH", + "INAPP" ] }, "TemplateVersionResponse": { @@ -11445,6 +12065,46 @@ ], "payload": "GCMChannelResponse" }, + "UpdateInAppTemplateRequest": { + "type": "structure", + "members": { + "CreateNewVersion": { + "shape": "__boolean", + "location": "querystring", + "locationName": "create-new-version" + }, + "InAppTemplateRequest": { + "shape": "InAppTemplateRequest" + }, + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name" + }, + "Version": { + "shape": "__string", + "location": "querystring", + "locationName": "version" + } + }, + "required": [ + "TemplateName", + "InAppTemplateRequest" + ], + "payload": "InAppTemplateRequest" + }, + "UpdateInAppTemplateResponse": { + "type": "structure", + "members": { + "MessageBody": { + "shape": "MessageBody" + } + }, + "required": [ + "MessageBody" + ], + "payload": "MessageBody" + }, "UpdateJourneyRequest": { "type": "structure", "members": { @@ -12063,6 +12723,9 @@ }, "TreatmentName": { "shape": "__string" + }, + "Priority": { + "shape": "__integer" } } }, @@ -12192,7 +12855,8 @@ "VOICE", "EMAIL", "BAIDU", - "CUSTOM" + "CUSTOM", + "IN_APP" ] }, "__boolean": { @@ -12246,6 +12910,18 @@ "shape": "ImportJobResponse" } }, + "ListOfInAppMessageCampaign": { + "type": "list", + "member": { + "shape": "InAppMessageCampaign" + } + }, + "ListOfInAppMessageContent": { + "type": "list", + "member": { + "shape": "InAppMessageContent" + } + }, "ListOfJourneyResponse": { "type": "list", "member": { diff --git a/models/apis/pinpoint/2016-12-01/docs-2.json b/models/apis/pinpoint/2016-12-01/docs-2.json index 9c18f2eb1b1..41abfa94d80 100644 --- a/models/apis/pinpoint/2016-12-01/docs-2.json +++ b/models/apis/pinpoint/2016-12-01/docs-2.json @@ -7,6 +7,7 @@ "CreateEmailTemplate" : "Creates a message template for messages that are sent through the email channel.
", "CreateExportJob" : "Creates an export job for an application.
", "CreateImportJob" : "Creates an import job for an application.
", + "CreateInAppTemplate" : "Creates a new message template for messages using the in-app message channel.
", "CreateJourney" : "Creates a journey for an application.
", "CreatePushTemplate" : "Creates a message template for messages that are sent through a push notification channel.
", "CreateRecommenderConfiguration" : "Creates an Amazon Pinpoint configuration for a recommender model.
", @@ -26,6 +27,7 @@ "DeleteEndpoint" : "Deletes an endpoint from an application.
", "DeleteEventStream" : "Deletes the event stream for an application.
", "DeleteGcmChannel" : "Disables the GCM channel for an application and deletes any existing settings for the channel.
", + "DeleteInAppTemplate" : "Deletes a message template for messages sent using the in-app message channel.
", "DeleteJourney" : "Deletes a journey from an application.
", "DeletePushTemplate" : "Deletes a message template for messages that were sent through a push notification channel.
", "DeleteRecommenderConfiguration" : "Deletes an Amazon Pinpoint configuration for a recommender model.
", @@ -61,6 +63,8 @@ "GetGcmChannel" : "Retrieves information about the status and settings of the GCM channel for an application.
", "GetImportJob" : "Retrieves information about the status and settings of a specific import job for an application.
", "GetImportJobs" : "Retrieves information about the status and settings of all the import jobs for an application.
", + "GetInAppMessages" : "Retrieves the in-app messages targeted for the provided endpoint ID.
", + "GetInAppTemplate" : "Retrieves the content and settings of a message template for messages sent through the in-app channel.
", "GetJourney" : "Retrieves information about the status, configuration, and other settings for a journey.
", "GetJourneyDateRangeKpi" : "Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
", "GetJourneyExecutionActivityMetrics" : "Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
", @@ -104,6 +108,7 @@ "UpdateEndpoint" : "Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
", "UpdateEndpointsBatch" : "Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
", "UpdateGcmChannel" : "Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
", + "UpdateInAppTemplate" : "Updates an existing message template for messages sent through the in-app message channel.
", "UpdateJourney" : "Updates the configuration and other settings for a journey.
", "UpdateJourneyState" : "Pause, resume or cancels (stops) a journey.
", "UpdatePushTemplate" : "Updates an existing message template for messages that are sent through a push notification channel.
", @@ -211,6 +216,13 @@ "MapOfAddressConfiguration$member" : null } }, + "Alignment" : { + "base" : null, + "refs" : { + "InAppMessageBodyConfig$Alignment" : "The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
", + "InAppMessageHeaderConfig$Alignment" : "The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
" + } + }, "AndroidPushNotificationTemplate" : { "base" : "Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.
", "refs" : { @@ -282,6 +294,13 @@ "JourneyDateRangeKpiResponse$KpiResult" : "An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
" } }, + "ButtonAction" : { + "base" : null, + "refs" : { + "DefaultButtonConfiguration$ButtonAction" : "Action triggered by the button.
", + "OverrideButtonConfiguration$ButtonAction" : "Action triggered by the button.
" + } + }, "CampaignCustomMessage" : { "base" : "Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.
", "refs" : { @@ -301,6 +320,7 @@ "CampaignEventFilter" : { "base" : "Specifies the settings for events that cause a campaign to be sent.
", "refs" : { + "InAppCampaignSchedule$EventFilter" : "The event filter the SDK has to use to show the in-app message in the application.
", "Schedule$EventFilter" : "The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
" } }, @@ -313,6 +333,12 @@ "WriteCampaignRequest$Hook" : "The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
" } }, + "CampaignInAppMessage" : { + "base" : "In-app message configuration.
", + "refs" : { + "MessageConfiguration$InAppMessage" : "The in-app message configuration.
" + } + }, "CampaignLimits" : { "base" : "For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns in the application can send.
", "refs" : { @@ -415,6 +441,12 @@ "Activity$CUSTOM" : "The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
" } }, + "DefaultButtonConfiguration" : { + "base" : "Default button configuration.
", + "refs" : { + "InAppMessageButton$DefaultConfig" : "Default button content.
" + } + }, "DefaultMessage" : { "base" : "Specifies the default message for all channels.
", "refs" : { @@ -710,6 +742,61 @@ "base" : "Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.
", "refs" : { } }, + "InAppCampaignSchedule" : { + "base" : null, + "refs" : { + "InAppMessageCampaign$Schedule" : "Schedule of the campaign.
" + } + }, + "InAppMessage" : { + "base" : "Provides all fields required for building an in-app message.
", + "refs" : { + "InAppMessageCampaign$InAppMessage" : "In-app message content with all fields required for rendering an in-app message.
" + } + }, + "InAppMessageBodyConfig" : { + "base" : "Text config for Message Body.
", + "refs" : { + "InAppMessageContent$BodyConfig" : "The configuration for the message body.
" + } + }, + "InAppMessageButton" : { + "base" : "Button Config for an in-app message.
", + "refs" : { + "InAppMessageContent$PrimaryBtn" : "The first button inside the message.
", + "InAppMessageContent$SecondaryBtn" : "The second button inside message.
" + } + }, + "InAppMessageCampaign" : { + "base" : null, + "refs" : { + "ListOfInAppMessageCampaign$member" : null + } + }, + "InAppMessageContent" : { + "base" : "The configuration for the message content.
", + "refs" : { + "ListOfInAppMessageContent$member" : null + } + }, + "InAppMessageHeaderConfig" : { + "base" : "Text config for Message Header.
", + "refs" : { + "InAppMessageContent$HeaderConfig" : "The configuration for the message header.
" + } + }, + "InAppMessagesResponse" : { + "base" : "Get in-app messages response object.
", + "refs" : { } + }, + "InAppTemplateRequest" : { + "base" : "In-App Template Request.
", + "refs" : { } + }, + "InAppTemplateResponse" : { + "base" : "In-App Template Response.
", + "refs" : { } + }, "Include" : { "base" : null, "refs" : { @@ -797,6 +884,15 @@ "base" : "Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.
", "refs" : { } }, + "Layout" : { + "base" : null, + "refs" : { + "CampaignInAppMessage$Layout" : "In-app message layout.
", + "InAppMessage$Layout" : "The layout of the message.
", + "InAppTemplateRequest$Layout" : "The layout of the message.
", + "InAppTemplateResponse$Layout" : "The layout of the message.
" + } + }, "ListRecommenderConfigurationsResponse" : { "base" : "Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
", "refs" : { } @@ -892,6 +988,14 @@ "Condition$Operator" : "Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
" } }, + "OverrideButtonConfiguration" : { + "base" : "Override button configuration.
", + "refs" : { + "InAppMessageButton$Android" : "Default button content.
", + "InAppMessageButton$IOS" : "Default button content.
", + "InAppMessageButton$Web" : "Default button content.
" + } + }, "PayloadTooLargeException" : { "base" : "Provides information about an API request or response.
", "refs" : { } @@ -920,6 +1024,7 @@ "base" : "Specifies the start and end times that define a time range when messages aren't sent to endpoints.
", "refs" : { "ApplicationSettingsResource$QuietTime" : "The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
", + "InAppCampaignSchedule$QuietTime" : "Time during which the in-app message should not be shown to the user.
", "JourneyResponse$QuietTime" : "The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
", "Schedule$QuietTime" : "The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
", "WriteApplicationSettingsRequest$QuietTime" : "The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.
", @@ -1183,6 +1288,10 @@ "WriteTreatmentResource$TemplateConfiguration" : "The message template to use for the treatment.
" } }, + "TemplateCreateMessageBody" : { + "base" : "Provides information about a request to create a message template.
", + "refs" : { } + }, "TemplateResponse" : { "base" : "Provides information about a message template that's associated with your Amazon Pinpoint account.
", "refs" : { @@ -1193,6 +1302,7 @@ "base" : null, "refs" : { "EmailTemplateResponse$TemplateType" : "The type of channel that the message template is designed for. For an email template, this value is EMAIL.
", + "InAppTemplateResponse$TemplateType" : "The type of the template.
", "PushNotificationTemplateResponse$TemplateType" : "The type of channel that the message template is designed for. For a push notification template, this value is PUSH.
", "SMSTemplateResponse$TemplateType" : "The type of channel that the message template is designed for. For an SMS template, this value is SMS.
", "TemplateResponse$TemplateType" : "The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.
", @@ -1405,12 +1515,15 @@ "CampaignLimits$Daily" : "The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
", "CampaignLimits$MaximumDuration" : "The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
", "CampaignLimits$MessagesPerSecond" : "The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
", + "CampaignLimits$Session" : "The maximum total number of messages that the campaign can send per user session.
", "CampaignLimits$Total" : "The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
", "CampaignResponse$HoldoutPercent" : "The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
", + "CampaignResponse$Priority" : "Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment
", "CampaignResponse$SegmentVersion" : "The version number of the segment that's associated with the campaign.
", "CampaignResponse$Version" : "The version number of the campaign.
", "ChannelResponse$Version" : "The current version of the channel.
", "CreateRecommenderConfiguration$RecommendationsPerMessage" : "The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.
To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
", + "DefaultButtonConfiguration$BorderRadius" : "The border radius of the button.
", "EmailChannelResponse$MessagesPerSecond" : "The maximum number of emails that can be sent through the channel each second.
", "EmailChannelResponse$Version" : "The current version of the email channel.
", "EndpointItemResponse$StatusCode" : "The status code that's returned in the response as a result of processing the endpoint data.
", @@ -1431,6 +1544,10 @@ "ImportJobResponse$TotalFailures" : "The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.
", "ImportJobResponse$TotalPieces" : "The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.
", "ImportJobResponse$TotalProcessed" : "The total number of endpoint definitions that were processed by the import job.
", + "InAppMessageCampaign$DailyCap" : "Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
", + "InAppMessageCampaign$Priority" : "Priority of the in-app message.
", + "InAppMessageCampaign$SessionCap" : "Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
", + "InAppMessageCampaign$TotalCap" : "Total cap which controls the number of times an in-app message can be shown to the endpoint.
", "JourneyLimits$DailyCap" : "The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
", "JourneyLimits$EndpointReentryCap" : "The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
", "JourneyLimits$MessagesPerSecond" : "The maximum number of messages that the journey can send each second.
", @@ -1450,6 +1567,7 @@ "UpdateRecommenderConfiguration$RecommendationsPerMessage" : "The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.
To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
", "VoiceChannelResponse$Version" : "The current version of the voice channel.
", "WriteCampaignRequest$HoldoutPercent" : "The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
", + "WriteCampaignRequest$Priority" : "Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
", "WriteCampaignRequest$SegmentVersion" : "The version of the segment to associate with the campaign.
", "WriteTreatmentResource$SizePercent" : "The allocated percentage of users (segment members) to send the treatment to.
", "MapOf__integer$member" : null @@ -1497,6 +1615,21 @@ "ImportJobsResponse$Item" : "An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).
" } }, + "ListOfInAppMessageCampaign" : { + "base" : null, + "refs" : { + "InAppMessagesResponse$InAppMessageCampaigns" : "List of targeted in-app message campaigns.
" + } + }, + "ListOfInAppMessageContent" : { + "base" : null, + "refs" : { + "CampaignInAppMessage$Content" : "In-app message content.
", + "InAppMessage$Content" : "In-app message content.
", + "InAppTemplateRequest$Content" : "The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
", + "InAppTemplateResponse$Content" : "The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
" + } + }, "ListOfJourneyResponse" : { "base" : null, "refs" : { @@ -1737,6 +1870,7 @@ "AddressConfiguration$Context" : "An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.
For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
", "ApplicationResponse$tags" : "A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.
", "BaiduMessage$Data" : "The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
", + "CampaignInAppMessage$CustomConfig" : "Custom config to be sent to client.
", "CampaignResponse$tags" : "A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
", "CreateApplicationRequest$tags" : "A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.
", "CreateRecommenderConfiguration$Attributes" : "A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:
An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.
", @@ -1746,6 +1880,11 @@ "EndpointSendConfiguration$Context" : "A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.
For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
", "Event$Attributes" : "One or more custom attributes that are associated with the event.
", "GCMMessage$Data" : "The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
", + "InAppMessage$CustomConfig" : "Custom config to be sent to SDK.
", + "InAppTemplateRequest$CustomConfig" : "Custom config to be sent to client.
", + "InAppTemplateRequest$tags" : "A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
", + "InAppTemplateResponse$CustomConfig" : "Custom config to be sent to client.
", + "InAppTemplateResponse$tags" : "Tags map that contains arn and InternalId for API GW.
", "JourneyExecutionActivityMetricsResponse$Metrics" : "A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
", "JourneyExecutionMetricsResponse$Metrics" : "A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
", "JourneyResponse$tags" : "This object is not used or supported.
", @@ -1929,6 +2068,7 @@ "CampaignEmailMessage$Title" : "The subject line, or title, of the email.
", "CampaignHook$LambdaFunctionName" : "The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
", "CampaignHook$WebUrl" : "The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
", + "CampaignInAppMessage$Body" : "The message body of the notification, the email body or the text message.
", "CampaignResponse$ApplicationId" : "The unique identifier for the application that the campaign applies to.
", "CampaignResponse$Arn" : "The Amazon Resource Name (ARN) of the campaign.
", "CampaignResponse$CreationDate" : "The date, in ISO 8601 format, when the campaign was created.
", @@ -1968,6 +2108,10 @@ "CustomMessageActivity$NextActivity" : "The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
", "CustomMessageActivity$TemplateName" : "The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
", "CustomMessageActivity$TemplateVersion" : "The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
", + "DefaultButtonConfiguration$BackgroundColor" : "The background color of the button.
", + "DefaultButtonConfiguration$Link" : "Button destination.
", + "DefaultButtonConfiguration$Text" : "Button text.
", + "DefaultButtonConfiguration$TextColor" : "The text color of the button.
", "DefaultMessage$Body" : "The default body of the message.
", "DefaultPushNotificationMessage$Body" : "The default body of the notification message.
", "DefaultPushNotificationMessage$Title" : "The default title to display above the notification message on a recipient's device.
", @@ -2119,7 +2263,22 @@ "ImportJobResponse$Id" : "The unique identifier for the import job.
", "ImportJobResponse$Type" : "The job type. This value is IMPORT for import jobs.
", "ImportJobsResponse$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.
", - "JourneyCustomMessage$Data" : "The message content that's passed to an AWS Lambda function or to a web hook.
", + "InAppCampaignSchedule$EndDate" : "The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.
", + "InAppMessageBodyConfig$Body" : "Message Body.
", + "InAppMessageBodyConfig$TextColor" : "The text color.
", + "InAppMessageCampaign$CampaignId" : "Campaign id of the corresponding campaign.
", + "InAppMessageCampaign$TreatmentId" : "Treatment id of the campaign.
", + "InAppMessageContent$BackgroundColor" : "The background color for the message.
", + "InAppMessageContent$ImageUrl" : "The image url for the background of message.
", + "InAppMessageHeaderConfig$Header" : "Message Header.
", + "InAppMessageHeaderConfig$TextColor" : "The text color.
", + "InAppTemplateRequest$TemplateDescription" : "The description of the template.
", + "InAppTemplateResponse$Arn" : "The resource arn of the template.
", + "InAppTemplateResponse$CreationDate" : "The creation date of the template.
", + "InAppTemplateResponse$LastModifiedDate" : "The last modified date of the template.
", + "InAppTemplateResponse$TemplateDescription" : "The description of the template.
", + "InAppTemplateResponse$TemplateName" : "The name of the template.
", + "InAppTemplateResponse$Version" : "The version id of the template.
", "JourneyDateRangeKpiResponse$ApplicationId" : "The unique identifier for the application that the metric applies to.
", "JourneyDateRangeKpiResponse$EndTime" : "The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
", "JourneyDateRangeKpiResponse$JourneyId" : "The unique identifier for the journey that the metric applies to.
", @@ -2187,6 +2346,7 @@ "NumberValidateResponse$PhoneType" : "The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP,\n INVALID, PREPAID, and OTHER.
", "NumberValidateResponse$Timezone" : "The time zone for the location where the phone number was originally registered.
", "NumberValidateResponse$ZipCode" : "The postal or ZIP code for the location where the phone number was originally registered.
", + "OverrideButtonConfiguration$Link" : "Button destination.
", "PublicEndpoint$Address" : "The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
", "PublicEndpoint$EffectiveDate" : "The date and time, in ISO 8601 format, when the endpoint was last updated.
", "PublicEndpoint$EndpointStatus" : "Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
", @@ -2283,6 +2443,9 @@ "Template$Name" : "The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
", "Template$Version" : "The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
", "TemplateActiveVersionRequest$Version" : "The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
", + "TemplateCreateMessageBody$Arn" : "The Amazon Resource Name (ARN) of the message template that was created.
", + "TemplateCreateMessageBody$Message" : "The message that's returned from the API for the request to create the message template.
", + "TemplateCreateMessageBody$RequestID" : "The unique identifier for the request to create the message template.
", "TemplateResponse$Arn" : "The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.
", "TemplateResponse$CreationDate" : "The date, in ISO 8601 format, when the message template was created.
", "TemplateResponse$DefaultSubstitutions" : "The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
", diff --git a/models/apis/robomaker/2018-06-29/api-2.json b/models/apis/robomaker/2018-06-29/api-2.json index 6a37c2d98fd..d1b865b965b 100644 --- a/models/apis/robomaker/2018-06-29/api-2.json +++ b/models/apis/robomaker/2018-06-29/api-2.json @@ -1085,14 +1085,14 @@ "type":"structure", "required":[ "name", - "sources", "robotSoftwareSuite" ], "members":{ "name":{"shape":"Name"}, "sources":{"shape":"SourceConfigs"}, "robotSoftwareSuite":{"shape":"RobotSoftwareSuite"}, - "tags":{"shape":"TagMap"} + "tags":{"shape":"TagMap"}, + "environment":{"shape":"Environment"} } }, "CreateRobotApplicationResponse":{ @@ -1105,7 +1105,8 @@ "robotSoftwareSuite":{"shape":"RobotSoftwareSuite"}, "lastUpdatedAt":{"shape":"LastUpdatedAt"}, "revisionId":{"shape":"RevisionId"}, - "tags":{"shape":"TagMap"} + "tags":{"shape":"TagMap"}, + "environment":{"shape":"Environment"} } }, "CreateRobotApplicationVersionRequest":{ @@ -1113,7 +1114,9 @@ "required":["application"], "members":{ "application":{"shape":"Arn"}, - "currentRevisionId":{"shape":"RevisionId"} + "currentRevisionId":{"shape":"RevisionId"}, + "s3Etags":{"shape":"S3Etags"}, + "imageDigest":{"shape":"ImageDigest"} } }, "CreateRobotApplicationVersionResponse":{ @@ -1125,7 +1128,8 @@ "sources":{"shape":"Sources"}, "robotSoftwareSuite":{"shape":"RobotSoftwareSuite"}, "lastUpdatedAt":{"shape":"LastUpdatedAt"}, - "revisionId":{"shape":"RevisionId"} + "revisionId":{"shape":"RevisionId"}, + "environment":{"shape":"Environment"} } }, "CreateRobotRequest":{ @@ -1157,7 +1161,6 @@ "type":"structure", "required":[ "name", - "sources", "simulationSoftwareSuite", "robotSoftwareSuite" ], @@ -1167,7 +1170,8 @@ "simulationSoftwareSuite":{"shape":"SimulationSoftwareSuite"}, "robotSoftwareSuite":{"shape":"RobotSoftwareSuite"}, "renderingEngine":{"shape":"RenderingEngine"}, - "tags":{"shape":"TagMap"} + "tags":{"shape":"TagMap"}, + "environment":{"shape":"Environment"} } }, "CreateSimulationApplicationResponse":{ @@ -1182,7 +1186,8 @@ "renderingEngine":{"shape":"RenderingEngine"}, "lastUpdatedAt":{"shape":"LastUpdatedAt"}, "revisionId":{"shape":"RevisionId"}, - "tags":{"shape":"TagMap"} + "tags":{"shape":"TagMap"}, + "environment":{"shape":"Environment"} } }, "CreateSimulationApplicationVersionRequest":{ @@ -1190,7 +1195,9 @@ "required":["application"], "members":{ "application":{"shape":"Arn"}, - "currentRevisionId":{"shape":"RevisionId"} + "currentRevisionId":{"shape":"RevisionId"}, + "s3Etags":{"shape":"S3Etags"}, + "imageDigest":{"shape":"ImageDigest"} } }, "CreateSimulationApplicationVersionResponse":{ @@ -1204,7 +1211,8 @@ "robotSoftwareSuite":{"shape":"RobotSoftwareSuite"}, "renderingEngine":{"shape":"RenderingEngine"}, "lastUpdatedAt":{"shape":"LastUpdatedAt"}, - "revisionId":{"shape":"RevisionId"} + "revisionId":{"shape":"RevisionId"}, + "environment":{"shape":"Environment"} } }, "CreateSimulationJobRequest":{ @@ -1626,7 +1634,9 @@ "robotSoftwareSuite":{"shape":"RobotSoftwareSuite"}, "revisionId":{"shape":"RevisionId"}, "lastUpdatedAt":{"shape":"LastUpdatedAt"}, - "tags":{"shape":"TagMap"} + "tags":{"shape":"TagMap"}, + "environment":{"shape":"Environment"}, + "imageDigest":{"shape":"ImageDigest"} } }, "DescribeRobotRequest":{ @@ -1671,7 +1681,9 @@ "renderingEngine":{"shape":"RenderingEngine"}, "revisionId":{"shape":"RevisionId"}, "lastUpdatedAt":{"shape":"LastUpdatedAt"}, - "tags":{"shape":"TagMap"} + "tags":{"shape":"TagMap"}, + "environment":{"shape":"Environment"}, + "imageDigest":{"shape":"ImageDigest"} } }, "DescribeSimulationJobBatchRequest":{ @@ -1813,6 +1825,12 @@ "version":{"shape":"GenericString"} } }, + "Environment":{ + "type":"structure", + "members":{ + "uri":{"shape":"RepositoryUrl"} + } + }, "EnvironmentVariableKey":{ "type":"string", "max":1024, @@ -1952,6 +1970,12 @@ "error":{"httpStatusCode":400}, "exception":true }, + "ImageDigest":{ + "type":"string", + "max":72, + "min":0, + "pattern":"[Ss][Hh][Aa]256:[0-9a-fA-F]{64}" + }, "Integer":{"type":"integer"}, "InteriorCountPerFloorplan":{"type":"integer"}, "InternalServerException":{ @@ -2323,6 +2347,12 @@ "min":1, "pattern":"1.x" }, + "RepositoryUrl":{ + "type":"string", + "max":1024, + "min":1, + "pattern":".+" + }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ @@ -2489,6 +2519,10 @@ "pattern":"[a-z0-9][a-z0-9.\\-]*[a-z0-9]" }, "S3Etag":{"type":"string"}, + "S3Etags":{ + "type":"list", + "member":{"shape":"S3Etag"} + }, "S3Key":{ "type":"string", "max":1024, @@ -2982,14 +3016,14 @@ "type":"structure", "required":[ "application", - "sources", "robotSoftwareSuite" ], "members":{ "application":{"shape":"Arn"}, "sources":{"shape":"SourceConfigs"}, "robotSoftwareSuite":{"shape":"RobotSoftwareSuite"}, - "currentRevisionId":{"shape":"RevisionId"} + "currentRevisionId":{"shape":"RevisionId"}, + "environment":{"shape":"Environment"} } }, "UpdateRobotApplicationResponse":{ @@ -3001,14 +3035,14 @@ "sources":{"shape":"Sources"}, "robotSoftwareSuite":{"shape":"RobotSoftwareSuite"}, "lastUpdatedAt":{"shape":"LastUpdatedAt"}, - "revisionId":{"shape":"RevisionId"} + "revisionId":{"shape":"RevisionId"}, + "environment":{"shape":"Environment"} } }, "UpdateSimulationApplicationRequest":{ "type":"structure", "required":[ "application", - "sources", "simulationSoftwareSuite", "robotSoftwareSuite" ], @@ -3018,7 +3052,8 @@ "simulationSoftwareSuite":{"shape":"SimulationSoftwareSuite"}, "robotSoftwareSuite":{"shape":"RobotSoftwareSuite"}, "renderingEngine":{"shape":"RenderingEngine"}, - "currentRevisionId":{"shape":"RevisionId"} + "currentRevisionId":{"shape":"RevisionId"}, + "environment":{"shape":"Environment"} } }, "UpdateSimulationApplicationResponse":{ @@ -3032,7 +3067,8 @@ "robotSoftwareSuite":{"shape":"RobotSoftwareSuite"}, "renderingEngine":{"shape":"RenderingEngine"}, "lastUpdatedAt":{"shape":"LastUpdatedAt"}, - "revisionId":{"shape":"RevisionId"} + "revisionId":{"shape":"RevisionId"}, + "environment":{"shape":"Environment"} } }, "UpdateWorldTemplateRequest":{ diff --git a/models/apis/robomaker/2018-06-29/docs-2.json b/models/apis/robomaker/2018-06-29/docs-2.json index d433b8bde8b..74424f29a0f 100644 --- a/models/apis/robomaker/2018-06-29/docs-2.json +++ b/models/apis/robomaker/2018-06-29/docs-2.json @@ -787,6 +787,23 @@ "refs": { } }, + "Environment": { + "base": "The object that contains the Docker image URI for either your robot or simulation applications.
", + "refs": { + "CreateRobotApplicationRequest$environment": "The object that contains that URI of the Docker image that you use for your robot application.
", + "CreateRobotApplicationResponse$environment": "An object that contains the Docker image URI used to a create your robot application.
", + "CreateRobotApplicationVersionResponse$environment": "The object that contains the Docker image URI used to create your robot application.
", + "CreateSimulationApplicationRequest$environment": "The object that contains the Docker image URI used to create your simulation application.
", + "CreateSimulationApplicationResponse$environment": "The object that contains the Docker image URI that you used to create your simulation application.
", + "CreateSimulationApplicationVersionResponse$environment": "The object that contains the Docker image URI used to create the simulation application.
", + "DescribeRobotApplicationResponse$environment": "The object that contains the Docker image URI used to create the robot application.
", + "DescribeSimulationApplicationResponse$environment": "The object that contains the Docker image URI used to create the simulation application.
", + "UpdateRobotApplicationRequest$environment": "The object that contains the Docker image URI for your robot application.
", + "UpdateRobotApplicationResponse$environment": "The object that contains the Docker image URI for your robot application.
", + "UpdateSimulationApplicationRequest$environment": "The object that contains the Docker image URI for your simulation application.
", + "UpdateSimulationApplicationResponse$environment": "The object that contains the Docker image URI used for your simulation application.
" + } + }, "EnvironmentVariableKey": { "base": null, "refs": { @@ -966,6 +983,15 @@ "refs": { } }, + "ImageDigest": { + "base": null, + "refs": { + "CreateRobotApplicationVersionRequest$imageDigest": "A SHA256 identifier for the Docker image that you use for your robot application.
", + "CreateSimulationApplicationVersionRequest$imageDigest": "The SHA256 digest used to identify the Docker image URI used to created the simulation application.
", + "DescribeRobotApplicationResponse$imageDigest": "A SHA256 identifier for the Docker image that you use for your robot application.
", + "DescribeSimulationApplicationResponse$imageDigest": "A SHA256 identifier for the Docker image that you use for your simulation application.
" + } + }, "Integer": { "base": null, "refs": { @@ -1391,6 +1417,12 @@ "RenderingEngine$version": "The version of the rendering engine.
" } }, + "RepositoryUrl": { + "base": null, + "refs": { + "Environment$uri": "The Docker image URI for either your robot or simulation applications.
" + } + }, "ResourceAlreadyExistsException": { "base": "The specified resource already exists.
", "refs": { @@ -1547,11 +1579,19 @@ "S3Etag": { "base": null, "refs": { + "S3Etags$member": null, "S3KeyOutput$etag": "The etag for the object.
", "S3Object$etag": "The etag of the object.
", "Source$etag": "A hash of the object specified by s3Bucket and s3Key.
The Amazon S3 identifier for the zip file bundle that you use for your robot application.
", + "CreateSimulationApplicationVersionRequest$s3Etags": "The Amazon S3 eTag identifier for the zip file bundle that you use to create the simulation application.
" + } + }, "S3Key": { "base": null, "refs": { diff --git a/models/apis/s3/2006-03-01/api-2.json b/models/apis/s3/2006-03-01/api-2.json index dec58b13fe4..5c6529ee263 100644 --- a/models/apis/s3/2006-03-01/api-2.json +++ b/models/apis/s3/2006-03-01/api-2.json @@ -1060,6 +1060,7 @@ "Owner":{"shape":"OwnerOverride"} } }, + "AccessPointArn":{"type":"string"}, "AccountId":{"type":"string"}, "AllowQuotedRecordDelimiter":{"type":"boolean"}, "AllowedHeader":{"type":"string"}, @@ -4938,7 +4939,8 @@ "shape":"TagSet", "flattened":true, "locationName":"Tag" - } + }, + "AccessPointArn":{"shape":"AccessPointArn"} } }, "MetricsConfiguration":{ @@ -4959,6 +4961,7 @@ "members":{ "Prefix":{"shape":"Prefix"}, "Tag":{"shape":"Tag"}, + "AccessPointArn":{"shape":"AccessPointArn"}, "And":{"shape":"MetricsAndOperator"} } }, diff --git a/models/apis/s3/2006-03-01/docs-2.json b/models/apis/s3/2006-03-01/docs-2.json index 71497e7fd64..942882e597f 100644 --- a/models/apis/s3/2006-03-01/docs-2.json +++ b/models/apis/s3/2006-03-01/docs-2.json @@ -6,12 +6,12 @@ "CompleteMultipartUpload": "Completes a multipart upload by assembling previously uploaded parts.
You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This action concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the ETag value, returned after that part was uploaded.
Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.
Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.
For more information about multipart uploads, see Uploading Objects Using Multipart Upload.
For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions.
CompleteMultipartUpload has the following special errors:
Error code: EntityTooSmall
Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.
400 Bad Request
Error code: InvalidPart
Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.
400 Bad Request
Error code: InvalidPartOrder
Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.
400 Bad Request
Error code: NoSuchUpload
Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
404 Not Found
The following operations are related to CompleteMultipartUpload:
Creates a copy of an object that is already stored in Amazon S3.
You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API.
All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.
A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.
If the copy is successful, you receive a response with information about the copied object.
If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.
The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing.
Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration.
Metadata
When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs.
To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the x-amz-metadata-directive header. When you grant permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3.
x-amz-copy-source-if Headers
To only copy an object under certain conditions, such as whether the Etag matches or whether the object was modified before or after a specified date, use the following request parameters:
x-amz-copy-source-if-match
x-amz-copy-source-if-none-match
x-amz-copy-source-if-unmodified-since
x-amz-copy-source-if-modified-since
If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data:
x-amz-copy-source-if-match condition evaluates to true
x-amz-copy-source-if-unmodified-since condition evaluates to false
If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed response code:
x-amz-copy-source-if-none-match condition evaluates to false
x-amz-copy-source-if-modified-since condition evaluates to true
All headers with the x-amz- prefix, including x-amz-copy-source, must be signed.
Server-side encryption
When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see Using Server-Side Encryption.
If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
Access Control List (ACL)-Specific Request Headers
When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.
Storage Class Options
You can use the CopyObject action to change the storage class of an object that is already stored in Amazon S3 using the StorageClass parameter. For more information, see Storage Classes in the Amazon S3 User Guide.
Versioning
By default, x-amz-copy-source identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the versionId subresource.
If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id response header in the response.
If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.
If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject.
The following operations are related to CopyObject:
For more information, see Copying Objects.
", "CreateBucket": "Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.
Not every string is an acceptable bucket name. For information about bucket naming restrictions, see Bucket naming rules.
If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see Accessing a bucket.
If you send your create bucket request to the s3.amazonaws.com endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual hosting of buckets.
When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.
Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see Access control list (ACL) overview.
You specify each grantee as a type=value pair, where the type is one of the following:
id – if the value specified is the canonical user ID of an Amazon Web Services account
uri – if you are granting permissions to a predefined group
emailAddress – if the value specified is the email address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
Permissions
If your CreateBucket request specifies ACL permissions and the ACL is public-read, public-read-write, authenticated-read, or if you specify access permissions explicitly through any other ACL, both s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the CreateBucket request is private, only s3:CreateBucket permission is needed.
If ObjectLockEnabledForBucket is set to true in your CreateBucket request, s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.
The following operations are related to CreateBucket:
This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.
For more information about multipart uploads, see Multipart Upload Overview.
If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
For information about the permissions required to use the multipart upload API, see Multipart Upload and Permissions.
For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4).
After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.
You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use Amazon Web Services Key Management Service (Amazon Web Services KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload.
To perform a multipart upload with encryption using an Amazon Web Services KMS CMK, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions in the Amazon S3 User Guide.
If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the Amazon Web Services KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.
For more information, see Protecting Data Using Server-Side Encryption.
When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:
Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use Amazon Web Services managed encryption keys or provide your own encryption key.
Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.
x-amz-server-side-encryption
x-amz-server-side-encryption-aws-kms-key-id
x-amz-server-side-encryption-context
If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed CMK in Amazon Web Services KMS to protect the data.
All GET and PUT requests for an object protected by Amazon Web Services KMS fail if you don't make them with SSL or by using SigV4.
For more information about server-side encryption with CMKs stored in Amazon Web Services KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon Web Services KMS.
Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about server-side encryption with CMKs stored in Amazon Web Services KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon Web Services KMS.
You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:
Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly — To explicitly grant access permissions to specific Amazon Web Services accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:
x-amz-grant-read
x-amz-grant-write
x-amz-grant-read-acp
x-amz-grant-write-acp
x-amz-grant-full-control
You specify each grantee as a type=value pair, where the type is one of the following:
id – if the value specified is the canonical user ID of an Amazon Web Services account
uri – if you are granting permissions to a predefined group
emailAddress – if the value specified is the email address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"
The following operations are related to CreateMultipartUpload:
This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.
For more information about multipart uploads, see Multipart Upload Overview.
If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
For information about the permissions required to use the multipart upload API, see Multipart Upload and Permissions.
For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4).
After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.
You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload.
To perform a multipart upload with encryption using an Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions in the Amazon S3 User Guide.
If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.
For more information, see Protecting Data Using Server-Side Encryption.
When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:
Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use Amazon Web Services managed encryption keys or provide your own encryption key.
Use encryption keys managed by Amazon S3 or customer managed key stored in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.
x-amz-server-side-encryption
x-amz-server-side-encryption-aws-kms-key-id
x-amz-server-side-encryption-context
If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key in Amazon Web Services KMS to protect the data.
All GET and PUT requests for an object protected by Amazon Web Services KMS fail if you don't make them with SSL or by using SigV4.
For more information about server-side encryption with KMS key (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys.
Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys.
You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:
Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly — To explicitly grant access permissions to specific Amazon Web Services accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:
x-amz-grant-read
x-amz-grant-write
x-amz-grant-read-acp
x-amz-grant-write-acp
x-amz-grant-full-control
You specify each grantee as a type=value pair, where the type is one of the following:
id – if the value specified is the canonical user ID of an Amazon Web Services account
uri – if you are granting permissions to a predefined group
emailAddress – if the value specified is the email address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"
The following operations are related to CreateMultipartUpload:
Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.
Related Resources
", "DeleteBucketAnalyticsConfiguration": "Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to DeleteBucketAnalyticsConfiguration:
Deletes the cors configuration information set for the bucket.
To use this operation, you must have permission to perform the s3:PutBucketCORS action. The bucket owner has this permission by default and can grant this permission to others.
For information about cors, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.
Related Resources:
", "DeleteBucketEncryption": "This implementation of the DELETE action removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon S3 User Guide.
To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.
Related Resources
", - "DeleteBucketIntelligentTieringConfiguration": "Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to DeleteBucketIntelligentTieringConfiguration include:
Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in two low latency and high throughput access tiers. For data that can be accessed asynchronously, you can choose to activate automatic archiving capabilities within the S3 Intelligent-Tiering storage class.
The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to DeleteBucketIntelligentTieringConfiguration include:
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
Operations related to DeleteBucketInventoryConfiguration include:
Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.
To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others.
There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.
For more information about the object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
", "DeleteBucketMetricsConfiguration": "Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.
To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to DeleteBucketMetricsConfiguration:
This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.
To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon S3 User Guide.
Related Resources
Returns the cors configuration information set for the bucket.
To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.
For more information about cors, see Enabling Cross-Origin Resource Sharing.
The following operations are related to GetBucketCors:
Returns the default encryption configuration for an Amazon S3 bucket. If the bucket does not have a default encryption configuration, GetBucketEncryption returns ServerSideEncryptionConfigurationNotFoundError.
For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.
To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
The following operations are related to GetBucketEncryption:
Gets the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to GetBucketIntelligentTieringConfiguration include:
Gets the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in two low latency and high throughput access tiers. For data that can be accessed asynchronously, you can choose to activate automatic archiving capabilities within the S3 Intelligent-Tiering storage class.
The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to GetBucketIntelligentTieringConfiguration include:
Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
The following operations are related to GetBucketInventoryConfiguration:
For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the filter element, you should see the updated version of this topic. This topic is provided for backward compatibility.
Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.
To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
GetBucketLifecycle has the following special error:
Error code: NoSuchLifecycleConfiguration
Description: The lifecycle configuration does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
The following operations are related to GetBucketLifecycle:
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier action, see GetBucketLifecycle.
Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.
To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
GetBucketLifecycleConfiguration has the following special error:
Error code: NoSuchLifecycleConfiguration
Description: The lifecycle configuration does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
The following operations are related to GetBucketLifecycleConfiguration:
Returns the tag set associated with the bucket.
To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.
GetBucketTagging has the following special error:
Error code: NoSuchTagSetError
Description: There is no tag set associated with the bucket.
The following operations are related to GetBucketTagging:
Returns the versioning state of a bucket.
To retrieve the versioning state of a bucket, you must be the bucket owner.
This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket.
The following operations are related to GetBucketVersioning:
Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.
This GET action requires the S3:GetBucketWebsite permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite permission.
The following operations are related to DeleteBucketWebsite:
Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg.
To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification.
To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.
If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this action returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects.
Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in Amazon Web Services KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Assuming you have the relevant permission to read object tags, the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object.
Permissions
You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket permission, Amazon S3 will return an HTTP status code 403 (\"access denied\") error.
Versioning
By default, the GET action returns the current version of an object. To return a different version, use the versionId subresource.
You need the s3:GetObjectVersion permission to access a specific version of an object.
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.
For more information about versioning, see PutBucketVersioning.
Overriding Response Header Values
There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.
You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these header values in the GET response, you use the following request parameters.
You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.
response-content-type
response-content-language
response-expires
response-cache-control
response-content-disposition
response-content-encoding
Additional Considerations about Request Headers
If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
The following operations are related to GetObject:
Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg.
To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification.
To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.
If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this action returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects.
Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Assuming you have the relevant permission to read object tags, the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object.
Permissions
You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket permission, Amazon S3 will return an HTTP status code 403 (\"access denied\") error.
Versioning
By default, the GET action returns the current version of an object. To return a different version, use the versionId subresource.
You need the s3:GetObjectVersion permission to access a specific version of an object.
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.
For more information about versioning, see PutBucketVersioning.
Overriding Response Header Values
There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.
You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these header values in the GET response, you use the following request parameters.
You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.
response-content-type
response-content-language
response-expires
response-cache-control
response-content-disposition
response-content-encoding
Additional Considerations about Request Headers
If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
The following operations are related to GetObject:
Returns the access control list (ACL) of an object. To use this operation, you must have READ_ACP access to the object.
This action is not supported by Amazon S3 on Outposts.
Versioning
By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.
The following operations are related to GetObjectAcl:
Gets an object's current Legal Hold status. For more information, see Locking Objects.
This action is not supported by Amazon S3 on Outposts.
", "GetObjectLockConfiguration": "Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
", @@ -55,9 +55,9 @@ "GetObjectTorrent": "Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.
You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.
To use GET, you must have READ access to the object.
This action is not supported by Amazon S3 on Outposts.
The following action is related to GetObjectTorrent:
Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.
When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
The following operations are related to GetPublicAccessBlock:
This action is useful to determine if a bucket exists and you have permission to access it. The action returns a 200 OK if the bucket exists and you have permission to access it.
If the bucket does not exist or you do not have permission to access it, the HEAD request returns a generic 404 Not Found or 403 Forbidden code. A message body is not included, so you cannot determine the exception beyond these error codes.
To use this operation, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
To use this API against an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more information see, Using access points.
", - "HeadObject": "The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.
A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic 404 Not Found or 403 Forbidden code. It is not possible to retrieve the exact exception beyond these error codes.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in Amazon Web Services KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
The last modified property in this case is the creation date of the object.
Request headers are limited to 8 KB in size. For more information, see Common Request Headers.
Consider the following when using request headers:
Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:
If-Match condition evaluates to true, and;
If-Unmodified-Since condition evaluates to false;
Then Amazon S3 returns 200 OK and the data requested.
Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:
If-None-Match condition evaluates to false, and;
If-Modified-Since condition evaluates to true;
Then Amazon S3 returns the 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
Permissions
You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 (\"access denied\") error.
The following action is related to HeadObject:
The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.
A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic 404 Not Found or 403 Forbidden code. It is not possible to retrieve the exact exception beyond these error codes.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
The last modified property in this case is the creation date of the object.
Request headers are limited to 8 KB in size. For more information, see Common Request Headers.
Consider the following when using request headers:
Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:
If-Match condition evaluates to true, and;
If-Unmodified-Since condition evaluates to false;
Then Amazon S3 returns 200 OK and the data requested.
Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:
If-None-Match condition evaluates to false, and;
If-Modified-Since condition evaluates to true;
Then Amazon S3 returns the 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
Permissions
You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 (\"access denied\") error.
The following action is related to HeadObject:
Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This action supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.
To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to ListBucketAnalyticsConfigurations:
Lists the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to ListBucketIntelligentTieringConfigurations include:
Lists the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in two low latency and high throughput access tiers. For data that can be accessed asynchronously, you can choose to activate automatic archiving capabilities within the S3 Intelligent-Tiering storage class.
The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to ListBucketIntelligentTieringConfigurations include:
Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.
To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory
The following operations are related to ListBucketInventoryConfigurations:
Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.
This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.
To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to ListBucketMetricsConfigurations:
Returns a list of all buckets owned by the authenticated sender of the request.
", @@ -70,18 +70,18 @@ "PutBucketAcl": "Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have WRITE_ACP permission.
You can use one of the following two ways to set a bucket's permissions:
Specify the ACL in the request body
Specify permissions using request headers
You cannot specify access permission using both the body and the request headers.
Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.
Access Permissions
You can set access permissions using one of the following methods:
Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
id – if the value specified is the canonical user ID of an Amazon Web Services account
uri – if you are granting permissions to a predefined group
emailAddress – if the value specified is the email address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
For example, the following x-amz-grant-write header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses.
x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\", id=\"111122223333\", id=\"555566667777\"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By the person's ID:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request
By URI:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
By Email address:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
Related Resources
", "PutBucketAnalyticsConfiguration": "Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.
You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis.
You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
Special Errors
HTTP Error: HTTP 400 Bad Request
Code: InvalidArgument
Cause: Invalid argument.
HTTP Error: HTTP 400 Bad Request
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP Error: HTTP 403 Forbidden
Code: AccessDenied
Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.
Related Resources
Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.
To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others.
You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability.
To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. The cors subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.
When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:
The request's Origin header must match AllowedOrigin elements.
The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method header in case of a pre-flight OPTIONS request must be one of the AllowedMethod elements.
Every header specified in the Access-Control-Request-Headers request header of a pre-flight request must match an AllowedHeader element.
For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.
Related Resources
", - "PutBucketEncryption": "This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket.
Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or Amazon Web Services KMS customer master keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default encryption, see Amazon S3 default bucket encryption in the Amazon S3 User Guide. For more information about S3 Bucket Keys, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4).
To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
Related Resources
", - "PutBucketIntelligentTieringConfiguration": "Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to PutBucketIntelligentTieringConfiguration include:
You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.
Special Errors
HTTP 400 Bad Request Error
Code: InvalidArgument
Cause: Invalid Argument
HTTP 400 Bad Request Error
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP 403 Forbidden Error
Code: AccessDenied
Cause: You are not the owner of the specified bucket, or you do not have the s3:PutIntelligentTieringConfiguration bucket permission to set the configuration on the bucket.
This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket.
Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default encryption, see Amazon S3 default bucket encryption in the Amazon S3 User Guide. For more information about S3 Bucket Keys, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4).
To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
Related Resources
", + "PutBucketIntelligentTieringConfiguration": "Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in two low latency and high throughput access tiers. For data that can be accessed asynchronously, you can choose to activate automatic archiving capabilities within the S3 Intelligent-Tiering storage class.
The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to PutBucketIntelligentTieringConfiguration include:
You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.
Special Errors
HTTP 400 Bad Request Error
Code: InvalidArgument
Cause: Invalid Argument
HTTP 400 Bad Request Error
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP 403 Forbidden Error
Code: AccessDenied
Cause: You are not the owner of the specified bucket, or you do not have the s3:PutIntelligentTieringConfiguration bucket permission to set the configuration on the bucket.
This implementation of the PUT action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.
Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket.
When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide.
You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
Special Errors
HTTP 400 Bad Request Error
Code: InvalidArgument
Cause: Invalid Argument
HTTP 400 Bad Request Error
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP 403 Forbidden Error
Code: AccessDenied
Cause: You are not the owner of the specified bucket, or you do not have the s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket.
Related Resources
For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon S3 User Guide.
By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission.
You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration
For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.
For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration.
Related Resources
GetBucketLifecycle(Deprecated)
By default, a resource owner—in this case, a bucket owner, which is the Amazon Web Services account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon S3 User Guide:
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle.
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.
Rules
You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:
Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.
Status whether the rule is in effect.
One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.
For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.
Permissions
By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.
You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration
For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.
The following are related to PutBucketLifecycleConfiguration:
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.
The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By the person's ID:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request.
By Email address:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
By URI:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:
<BucketLoggingStatus xmlns=\"http://doc.s3.amazonaws.com/2006-03-01\" />
For more information about server access logging, see Server Access Logging.
For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.
The following operations are related to PutBucketLogging:
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.
To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to PutBucketMetricsConfiguration:
GetBucketLifecycle has the following special error:
Error code: TooManyConfigurations
Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP Status Code: HTTP 400 Bad Request
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.
To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to PutBucketMetricsConfiguration:
GetBucketLifecycle has the following special error:
Error code: TooManyConfigurations
Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP Status Code: HTTP 400 Bad Request
No longer used, see the PutBucketNotificationConfiguration operation.
", "PutBucketNotificationConfiguration": "Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.
Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.
By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration.
<NotificationConfiguration>
</NotificationConfiguration>
This action replaces the existing notification configuration with the configuration you include in the request body.
After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.
You can disable notifications by adding the empty NotificationConfiguration element.
By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission.
The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket.
Responses
If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic.
The following action is related to PutBucketNotificationConfiguration:
Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to PutBucketOwnershipControls:
Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information, see Bucket policy examples.
The following operations are related to PutBucketPolicy:
Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User Guide.
Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.
A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset.
To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, Status, and Priority.
If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.
For information about enabling versioning on a bucket, see Using Versioning.
Handling Replication of Encrypted Objects
By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with CMKs stored in Amazon Web Services KMS. To replicate Amazon Web Services KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using CMKs stored in Amazon Web Services KMS.
For information on PutBucketReplication errors, see List of replication-related error codes
Permissions
To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration permissions for the bucket.
By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.
To perform this operation, the user or role performing the action must have the iam:PassRole permission.
The following operations are related to PutBucketReplication:
Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User Guide.
Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.
A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset.
To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, Status, and Priority.
If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.
For information about enabling versioning on a bucket, see Using Versioning.
Handling Replication of Encrypted Objects
By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using KMS keys.
For information on PutBucketReplication errors, see List of replication-related error codes
Permissions
To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration permissions for the bucket.
By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.
To perform this operation, the user or role performing the action must have the iam:PassRole permission.
The following operations are related to PutBucketReplication:
Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.
The following operations are related to PutBucketRequestPayment:
Sets the tags for a bucket.
Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging and Using Cost Allocation in Amazon S3 Bucket Tags.
When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags.
To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
PutBucketTagging has the following special errors:
Error code: InvalidTagError
Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and Amazon Web Services-Generated Cost Allocation Tag Restrictions.
Error code: MalformedXMLError
Description: The XML provided does not match the schema.
Error code: OperationAbortedError
Description: A conflicting conditional action is currently in progress against this resource. Please try again.
Error code: InternalError
Description: The service was unable to apply the provided tag to the bucket.
The following operations are related to PutBucketTagging:
Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.
You can set the versioning state with one of the following values:
Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.
Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.
If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.
If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the x-amz-mfa request header and the Status and the MfaDelete request elements in a request to set the versioning state of the bucket.
If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.
Related Resources
", @@ -94,10 +94,10 @@ "PutObjectTagging": "Sets the supplied tag-set to an object that already exists in a bucket.
A tag is a key-value pair. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging.
For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.
To use this operation, you must have permission to perform the s3:PutObjectTagging action. By default, the bucket owner has this permission and can grant this permission to others.
To put tags of any other version, use the versionId query parameter. You also need permission for the s3:PutObjectVersionTagging action.
For information about the Amazon S3 object tagging feature, see Object Tagging.
Special Errors
Code: InvalidTagError
Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging.
Code: MalformedXMLError
Cause: The XML provided does not match the schema.
Code: OperationAbortedError
Cause: A conflicting conditional action is currently in progress against this resource. Please try again.
Code: InternalError
Cause: The service was unable to apply the provided tag to the object.
Related Resources
", "PutPublicAccessBlock": "Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.
When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
Related Resources
Restores an archived copy of an object back into Amazon S3
This action is not supported by Amazon S3 on Outposts.
This action performs the following types of requests:
select - Perform a select query on an archived object
restore an archive - Restore an archived object
To use this operation, you must have permissions to perform the s3:RestoreObject action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
Querying Archives with Select Requests
You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see Querying Archived Objects in the Amazon S3 User Guide.
When making a select request, do the following:
Define an output location for the select query's output. This must be an Amazon S3 bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is being queried. The Amazon Web Services account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see Querying Archived Objects in the Amazon S3 User Guide.
For more information about the S3 structure in the request body, see the following:
Managing Access with ACLs in the Amazon S3 User Guide
Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide
Define the SQL expression for the SELECT type of restoration for your query in the request body's SelectParameters structure. You can use expressions like the following examples.
The following expression returns all records from the specified object.
SELECT * FROM Object
Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.
SELECT s._1, s._2 FROM Object s WHERE s._3 > 100
If you have headers and you set the fileHeaderInfo in the CSV structure in the request body to USE, you can specify headers in the query. (If you set the fileHeaderInfo field to IGNORE, the first row is skipped for the query.) You cannot mix ordinal positions with header column names.
SELECT s.Id, s.FirstName, s.SSN FROM S3Object s
For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide.
When making a select request, you can also do the following:
To expedite your queries, specify the Expedited tier. For more information about tiers, see \"Restoring Archives,\" later in this topic.
Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.
The following are additional important facts about the select feature:
The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy.
You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests.
Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409.
Restoring objects
Objects that you archive to the S3 Glacier or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in Archive Access or Deep Archive Access tiers you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier. For objects in S3 Glacier or S3 Glacier Deep Archive storage classes you must first initiate a restore request, and then wait until a temporary copy of the object is available. To access an archived object, you must restore the object for the duration (number of days) that you specify.
To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.
When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the Tier element of the request body:
Expedited - Expedited retrievals allow you to quickly access your data stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.
Standard - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.
Bulk - Bulk retrievals are the lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts, even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.
For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide.
You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the Amazon S3 User Guide.
To get the status of object restoration, you can send a HEAD request. Operations return the x-amz-restore header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in the Amazon S3 User Guide.
After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.
If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon S3 User Guide.
Responses
A successful action returns either the 200 OK or 202 Accepted status code.
If the object is not previously restored, then Amazon S3 returns 202 Accepted in the response.
If the object is previously restored, Amazon S3 returns 200 OK in the response.
Special Errors
Code: RestoreAlreadyInProgress
Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: GlacierExpeditedRetrievalNotAvailable
Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)
HTTP Status Code: 503
SOAP Fault Code Prefix: N/A
Related Resources
SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide
This action filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.
This action is not supported by Amazon S3 on Outposts.
For more information about Amazon S3 Select, see Selecting Content from Objects in the Amazon S3 User Guide.
For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide.
Permissions
You must have s3:GetObject permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy in the Amazon S3 User Guide.
Object Data Formats
You can use Amazon S3 Select to query objects that have the following format properties:
CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format.
UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports.
GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects.
Server-side encryption - Amazon S3 Select supports querying objects that are protected with server-side encryption.
For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and customer master keys (CMKs) stored in Amazon Web Services Key Management Service (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide.
Working with the Response Body
Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a Transfer-Encoding header with chunked as its value in the response. For more information, see Appendix: SelectObjectContent Response.
GetObject Support
The SelectObjectContent action does not support the following GetObject functionality. For more information, see GetObject.
Range: Although you can specify a scan range for an Amazon S3 Select request (see SelectObjectContentRequest - ScanRange in the request parameters), you cannot specify the range of bytes of an object to return.
GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For more information, about storage classes see Storage Classes in the Amazon S3 User Guide.
Special Errors
For a list of special errors for this operation, see List of SELECT Object Content Error Codes
Related Resources
", + "SelectObjectContent": "This action filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.
This action is not supported by Amazon S3 on Outposts.
For more information about Amazon S3 Select, see Selecting Content from Objects in the Amazon S3 User Guide.
For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide.
Permissions
You must have s3:GetObject permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy in the Amazon S3 User Guide.
Object Data Formats
You can use Amazon S3 Select to query objects that have the following format properties:
CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format.
UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports.
GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects.
Server-side encryption - Amazon S3 Select supports querying objects that are protected with server-side encryption.
For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide.
Working with the Response Body
Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a Transfer-Encoding header with chunked as its value in the response. For more information, see Appendix: SelectObjectContent Response.
GetObject Support
The SelectObjectContent action does not support the following GetObject functionality. For more information, see GetObject.
Range: Although you can specify a scan range for an Amazon S3 Select request (see SelectObjectContentRequest - ScanRange in the request parameters), you cannot specify the range of bytes of an object to return.
GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For more information, about storage classes see Storage Classes in the Amazon S3 User Guide.
Special Errors
For a list of special errors for this operation, see List of SELECT Object Content Error Codes
Related Resources
", "UploadPart": "Uploads a part in a multipart upload.
In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation.
You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request.
Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload.
To ensure that data is not corrupted when traversing the network, specify the Content-MD5 header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error.
If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the x-amz-content-sha256 header as a checksum instead of Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4).
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
For more information on multipart uploads, go to Multipart Upload Overview in the Amazon S3 User Guide .
For information on the permissions required to use the multipart upload API, go to Multipart Upload and Permissions in the Amazon S3 User Guide.
You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the Amazon Web Services managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. For more information, go to Using Server-Side Encryption in the Amazon S3 User Guide.
Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload.
If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers.
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
Special Errors
Code: NoSuchUpload
Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Related Resources
", "UploadPartCopy": "Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header x-amz-copy-source in your request and a byte range by adding the request header x-amz-copy-source-range in your request.
The minimum allowable part size for a multipart upload is 5 MB. For more information about multipart upload limits, go to Quick Facts in the Amazon S3 User Guide.
Instead of using an existing object as part data, you might use the UploadPart action and provide data in your request.
You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request.
For more information about using the UploadPartCopy operation, see the following:
For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.
For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.
For information about copying objects using a single atomic action vs. the multipart upload, see Operations on Objects in the Amazon S3 User Guide.
For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.
Note the following additional considerations about the request headers x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since, and x-amz-copy-source-if-modified-since:
Consideration 1 - If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows:
x-amz-copy-source-if-match condition evaluates to true, and;
x-amz-copy-source-if-unmodified-since condition evaluates to false;
Amazon S3 returns 200 OK and copies the data.
Consideration 2 - If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows:
x-amz-copy-source-if-none-match condition evaluates to false, and;
x-amz-copy-source-if-modified-since condition evaluates to true;
Amazon S3 returns 412 Precondition Failed response code.
Versioning
If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source.
You can optionally specify a specific version of the source object to copy by adding the versionId subresource as shown in the following example:
x-amz-copy-source: /bucket/object?versionId=version id
Special Errors
Code: NoSuchUpload
Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
HTTP Status Code: 404 Not Found
Code: InvalidRequest
Cause: The specified copy source is not supported as a byte-range copy source.
HTTP Status Code: 400 Bad Request
Related Resources
Passes transformed objects to a GetObject operation when using Object Lambda Access Points. For information about Object Lambda Access Points, see Transforming objects with Object Lambda Access Points in the Amazon S3 User Guide.
This operation supports metadata that can be returned by GetObject, in addition to RequestRoute, RequestToken, StatusCode, ErrorCode, and ErrorMessage. The GetObject response metadata is supported so that the WriteGetObjectResponse caller, typically an Lambda function, can provide the same metadata when it internally invokes GetObject. When WriteGetObjectResponse is called by a customer-owned Lambda function, the metadata returned to the end user GetObject call might differ from what Amazon S3 would normally return.
You can include any number of metadata headers. When including a metadata header, it should be prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this is to forward GetObject metadata.
Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact personally identifiable information (PII) and decompress S3 objects. These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your Object Lambda Access Point.
Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.
Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.
Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.
For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.
" + "WriteGetObjectResponse": "Passes transformed objects to a GetObject operation when using Object Lambda access points. For information about Object Lambda access points, see Transforming objects with Object Lambda access points in the Amazon S3 User Guide.
This operation supports metadata that can be returned by GetObject, in addition to RequestRoute, RequestToken, StatusCode, ErrorCode, and ErrorMessage. The GetObject response metadata is supported so that the WriteGetObjectResponse caller, typically an Lambda function, can provide the same metadata when it internally invokes GetObject. When WriteGetObjectResponse is called by a customer-owned Lambda function, the metadata returned to the end user GetObject call might differ from what Amazon S3 would normally return.
You can include any number of metadata headers. When including a metadata header, it should be prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this is to forward GetObject metadata.
Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact personally identifiable information (PII) and decompress S3 objects. These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.
Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.
Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.
Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.
For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.
" }, "shapes": { "AbortDate": { @@ -158,6 +158,13 @@ "Destination$AccessControlTranslation": "Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the Amazon Web Services account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same Amazon Web Services account that owns the source object.
" } }, + "AccessPointArn": { + "base": null, + "refs": { + "MetricsAndOperator$AccessPointArn": "The access point ARN used when evaluating an AND predicate.
", + "MetricsFilter$AccessPointArn": "The access point ARN used when evaluating a metrics filter.
" + } + }, "AccountId": { "base": null, "refs": { @@ -495,7 +502,7 @@ "GetObjectAclRequest$Bucket": "The bucket name that contains the object for which to get the ACL information.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
", "GetObjectLegalHoldRequest$Bucket": "The bucket name containing the object whose Legal Hold status you want to retrieve.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
", "GetObjectLockConfigurationRequest$Bucket": "The bucket whose Object Lock configuration you want to retrieve.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
", - "GetObjectRequest$Bucket": "The bucket name containing the object.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.
", + "GetObjectRequest$Bucket": "The bucket name containing the object.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.
", "GetObjectRetentionRequest$Bucket": "The bucket name containing the object whose retention settings you want to retrieve.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
", "GetObjectTaggingRequest$Bucket": "The bucket name containing the object for which to get the tagging information.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.
", "GetObjectTorrentRequest$Bucket": "The name of the bucket containing the object for which to get the torrent files.
", @@ -521,7 +528,7 @@ "PutBucketAclRequest$Bucket": "The bucket to which to apply the ACL.
", "PutBucketAnalyticsConfigurationRequest$Bucket": "The name of the bucket to which an analytics configuration is stored.
", "PutBucketCorsRequest$Bucket": "Specifies the bucket impacted by the corsconfiguration.
Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or customer master keys stored in Amazon Web Services KMS (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon S3 User Guide.
", + "PutBucketEncryptionRequest$Bucket": "Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon S3 User Guide.
", "PutBucketIntelligentTieringConfigurationRequest$Bucket": "The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
", "PutBucketInventoryConfigurationRequest$Bucket": "The name of the bucket where the inventory configuration will be stored.
", "PutBucketLifecycleConfigurationRequest$Bucket": "The name of the bucket for which to set the configuration.
", @@ -2388,7 +2395,7 @@ } }, "MetricsConfiguration": { - "base": "Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PUT Bucket metrics in the Amazon S3 API Reference.
", + "base": "Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PutBucketMetricsConfiguration.
", "refs": { "GetBucketMetricsConfigurationOutput$MetricsConfiguration": "Specifies the metrics configuration.
", "MetricsConfigurationList$member": null, @@ -2402,9 +2409,9 @@ } }, "MetricsFilter": { - "base": "Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator).
", + "base": "Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). For more information, see PutBucketMetricsConfiguration.
", "refs": { - "MetricsConfiguration$Filter": "Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator).
" + "MetricsConfiguration$Filter": "Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator).
" } }, "MetricsId": { @@ -3601,21 +3608,21 @@ "SSEKMSKeyId": { "base": null, "refs": { - "CompleteMultipartUploadOutput$SSEKMSKeyId": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed customer master key (CMK) that was used for the object.
", - "CopyObjectOutput$SSEKMSKeyId": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed customer master key (CMK) that was used for the object.
", + "CompleteMultipartUploadOutput$SSEKMSKeyId": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
", + "CopyObjectOutput$SSEKMSKeyId": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
", "CopyObjectRequest$SSEKMSKeyId": "Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.
", - "CreateMultipartUploadOutput$SSEKMSKeyId": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed customer master key (CMK) that was used for the object.
", - "CreateMultipartUploadRequest$SSEKMSKeyId": "Specifies the ID of the symmetric customer managed Amazon Web Services KMS CMK to use for object encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.
", - "Encryption$KMSKeyId": "If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed Amazon Web Services KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed customer master key (CMK) that was used for the object.
", - "HeadObjectOutput$SSEKMSKeyId": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed customer master key (CMK) that was used for the object.
", - "PutObjectOutput$SSEKMSKeyId": "If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed customer master key (CMK) that was used for the object.
If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetrical customer managed customer master key (CMK) that was used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed CMK in Amazon Web Services to protect the data. If the KMS key does not exist in the same account issuing the command, you must use the full ARN and not just the ID.
Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed customer master key (CMK) to use for encrypting inventory reports.
", + "CreateMultipartUploadOutput$SSEKMSKeyId": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
", + "CreateMultipartUploadRequest$SSEKMSKeyId": "Specifies the ID of the symmetric customer managed key to use for object encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.
", + "Encryption$KMSKeyId": "If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed key to use for encryption of job results. Amazon S3 only supports symmetric keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
", + "HeadObjectOutput$SSEKMSKeyId": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
", + "PutObjectOutput$SSEKMSKeyId": "If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetrical customer managed key that was used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key to protect the data. If the KMS key does not exist in the same account issuing the command, you must use the full ARN and not just the ID.
Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key to use for encrypting inventory reports.
", "ServerSideEncryptionByDefault$KMSMasterKeyID": "Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.
You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account operations, you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed customer master key (CMK) that was used for the object.
", - "UploadPartOutput$SSEKMSKeyId": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed customer master key (CMK) was used for the object.
", - "WriteGetObjectResponseRequest$SSEKMSKeyId": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed customer master key (CMK) that was used for stored in Amazon S3 object.
" + "UploadPartCopyOutput$SSEKMSKeyId": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
", + "UploadPartOutput$SSEKMSKeyId": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key was used for the object.
", + "WriteGetObjectResponseRequest$SSEKMSKeyId": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for stored in Amazon S3 object.
" } }, "SSES3": { @@ -3655,15 +3662,15 @@ "ServerSideEncryption": { "base": null, "refs": { - "CompleteMultipartUploadOutput$ServerSideEncryption": "If you specified server-side encryption either with an Amazon S3-managed encryption key or an Amazon Web Services KMS customer master key (CMK) in your initiate multipart upload request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.
", + "CompleteMultipartUploadOutput$ServerSideEncryption": "If you specified server-side encryption either with an Amazon S3-managed encryption key or an Amazon Web Services KMS key in your initiate multipart upload request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.
", "CopyObjectOutput$ServerSideEncryption": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", "CopyObjectRequest$ServerSideEncryption": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", "CreateMultipartUploadOutput$ServerSideEncryption": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", "CreateMultipartUploadRequest$ServerSideEncryption": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", "Encryption$EncryptionType": "The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).
", "GetObjectOutput$ServerSideEncryption": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", - "HeadObjectOutput$ServerSideEncryption": "If the object is stored using server-side encryption either with an Amazon Web Services KMS customer master key (CMK) or an Amazon S3-managed encryption key, the response includes this header with the value of the server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", - "PutObjectOutput$ServerSideEncryption": "If you specified server-side encryption either with an Amazon Web Services KMS customer master key (CMK) or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.
", + "HeadObjectOutput$ServerSideEncryption": "If the object is stored using server-side encryption either with an Amazon Web Services KMS key or an Amazon S3-managed encryption key, the response includes this header with the value of the server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", + "PutObjectOutput$ServerSideEncryption": "If you specified server-side encryption either with an Amazon Web Services KMS key or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.
", "PutObjectRequest$ServerSideEncryption": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", "ServerSideEncryptionByDefault$SSEAlgorithm": "Server-side encryption algorithm to use for the default encryption.
", "UploadPartCopyOutput$ServerSideEncryption": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", @@ -3714,9 +3721,9 @@ } }, "SourceSelectionCriteria": { - "base": "A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer master key (CMK) stored in Amazon Web Services Key Management Service (SSE-KMS).
", + "base": "A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).
", "refs": { - "ReplicationRule$SourceSelectionCriteria": "A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer master key (CMK) stored in Amazon Web Services Key Management Service (SSE-KMS).
" + "ReplicationRule$SourceSelectionCriteria": "A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).
" } }, "SseKmsEncryptedObjects": { diff --git a/models/apis/s3/2006-03-01/examples-1.json b/models/apis/s3/2006-03-01/examples-1.json index 5f8e6731e3f..6cababa94fa 100644 --- a/models/apis/s3/2006-03-01/examples-1.json +++ b/models/apis/s3/2006-03-01/examples-1.json @@ -84,13 +84,10 @@ "CreateBucket": [ { "input": { - "Bucket": "examplebucket", - "CreateBucketConfiguration": { - "LocationConstraint": "eu-west-1" - } + "Bucket": "examplebucket" }, "output": { - "Location": "http://examplebucket.Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..
", "RegisterDevices": "Register devices.
", "RenderUiTemplate": "Renders the UI template so that you can preview the worker's experience.
", + "RetryPipelineExecution": "Retry the execution of the pipeline.
", "Search": "Finds Amazon SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.
You can query against the following value types: numeric, text, Boolean, and timestamp.
", "SendPipelineExecutionStepFailure": "Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
", "SendPipelineExecutionStepSuccess": "Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
", @@ -4584,10 +4585,11 @@ "refs": { "CreatePipelineRequest$ClientRequestToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
", "DeletePipelineRequest$ClientRequestToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
", + "RetryPipelineExecutionRequest$ClientRequestToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
", "SendPipelineExecutionStepFailureRequest$ClientRequestToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
", "SendPipelineExecutionStepSuccessRequest$ClientRequestToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
", - "StartPipelineExecutionRequest$ClientRequestToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
", - "StopPipelineExecutionRequest$ClientRequestToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
" + "StartPipelineExecutionRequest$ClientRequestToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
", + "StopPipelineExecutionRequest$ClientRequestToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
" } }, "Image": { @@ -7514,6 +7516,8 @@ "ListPipelineParametersForExecutionRequest$PipelineExecutionArn": "The Amazon Resource Name (ARN) of the pipeline execution.
", "PipelineExecution$PipelineExecutionArn": "The Amazon Resource Name (ARN) of the pipeline execution.
", "PipelineExecutionSummary$PipelineExecutionArn": "The Amazon Resource Name (ARN) of the pipeline execution.
", + "RetryPipelineExecutionRequest$PipelineExecutionArn": "The Amazon Resource Name (ARN) of the pipeline execution.
", + "RetryPipelineExecutionResponse$PipelineExecutionArn": "The Amazon Resource Name (ARN) of the pipeline execution.
", "SendPipelineExecutionStepFailureResponse$PipelineExecutionArn": "The Amazon Resource Name (ARN) of the pipeline execution.
", "SendPipelineExecutionStepSuccessResponse$PipelineExecutionArn": "The Amazon Resource Name (ARN) of the pipeline execution.
", "StartPipelineExecutionResponse$PipelineExecutionArn": "The Amazon Resource Name (ARN) of the pipeline execution.
", @@ -8373,6 +8377,16 @@ "RetentionPolicy$HomeEfsFileSystem": "The default is Retain, which specifies to keep the data stored on the EFS volume.
Specify Delete to delete the data stored on the EFS volume.
The retry strategy to use when a training job fails due to an InternalServerError. RetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob requests. You can add the StoppingCondition parameter to the request to limit the training time for the complete job.
Details that you specify to provision a service catalog product. For information about service catalog, see .What is Amazon Web Services Service Catalog.
", + "base": "Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.
", "refs": { "CreateProjectInput$ServiceCatalogProvisioningDetails": "The product ID and provisioning artifact ID to provision a service catalog. For information, see What is Amazon Web Services Service Catalog.
", "DescribeProjectOutput$ServiceCatalogProvisioningDetails": "Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.
", @@ -10554,7 +10568,7 @@ } }, "UserContext": { - "base": "Information about the user who created or modified an experiment, trial, or trial component.
", + "base": "Information about the user who created or modified an experiment, trial, trial component, or project.
", "refs": { "AssociationSummary$CreatedBy": null, "DescribeActionResponse$CreatedBy": null, @@ -10573,11 +10587,11 @@ "DescribePipelineResponse$CreatedBy": null, "DescribePipelineResponse$LastModifiedBy": null, "DescribeProjectOutput$CreatedBy": null, - "DescribeTrialComponentResponse$CreatedBy": "Who created the component.
", + "DescribeTrialComponentResponse$CreatedBy": "Who created the trial component.
", "DescribeTrialComponentResponse$LastModifiedBy": "Who last modified the component.
", "DescribeTrialResponse$CreatedBy": "Who created the trial.
", "DescribeTrialResponse$LastModifiedBy": "Who last modified the trial.
", - "Experiment$CreatedBy": null, + "Experiment$CreatedBy": "Who created the experiment.
", "Experiment$LastModifiedBy": null, "ModelPackage$CreatedBy": null, "ModelPackage$LastModifiedBy": null, @@ -10586,13 +10600,13 @@ "Pipeline$LastModifiedBy": null, "PipelineExecution$CreatedBy": null, "PipelineExecution$LastModifiedBy": null, - "Project$CreatedBy": null, - "Trial$CreatedBy": null, + "Project$CreatedBy": "Who created the project.
", + "Trial$CreatedBy": "Who created the trial.
", "Trial$LastModifiedBy": null, - "TrialComponent$CreatedBy": null, + "TrialComponent$CreatedBy": "Who created the trial component.
", "TrialComponent$LastModifiedBy": null, "TrialComponentSimpleSummary$CreatedBy": null, - "TrialComponentSummary$CreatedBy": "Who created the component.
", + "TrialComponentSummary$CreatedBy": "Who created the trial component.
", "TrialComponentSummary$LastModifiedBy": "Who last modified the component.
" } }, diff --git a/models/apis/transcribe/2017-10-26/api-2.json b/models/apis/transcribe/2017-10-26/api-2.json index 6818295aef1..2c608dedbbf 100644 --- a/models/apis/transcribe/2017-10-26/api-2.json +++ b/models/apis/transcribe/2017-10-26/api-2.json @@ -1656,6 +1656,7 @@ "ContentRedaction":{"shape":"ContentRedaction"}, "IdentifyLanguage":{"shape":"Boolean"}, "LanguageOptions":{"shape":"LanguageOptions"}, + "Subtitles":{"shape":"Subtitles"}, "Tags":{"shape":"TagList"} } }, @@ -1671,6 +1672,34 @@ "member":{"shape":"NonEmptyString"}, "min":1 }, + "SubtitleFileUris":{ + "type":"list", + "member":{"shape":"Uri"} + }, + "SubtitleFormat":{ + "type":"string", + "enum":[ + "vtt", + "srt" + ] + }, + "SubtitleFormats":{ + "type":"list", + "member":{"shape":"SubtitleFormat"} + }, + "Subtitles":{ + "type":"structure", + "members":{ + "Formats":{"shape":"SubtitleFormats"} + } + }, + "SubtitlesOutput":{ + "type":"structure", + "members":{ + "Formats":{"shape":"SubtitleFormats"}, + "SubtitleFileUris":{"shape":"SubtitleFileUris"} + } + }, "Tag":{ "type":"structure", "required":[ @@ -1778,7 +1807,8 @@ "IdentifyLanguage":{"shape":"Boolean"}, "LanguageOptions":{"shape":"LanguageOptions"}, "IdentifiedLanguageScore":{"shape":"IdentifiedLanguageScore"}, - "Tags":{"shape":"TagList"} + "Tags":{"shape":"TagList"}, + "Subtitles":{"shape":"SubtitlesOutput"} } }, "TranscriptionJobName":{ diff --git a/models/apis/transcribe/2017-10-26/docs-2.json b/models/apis/transcribe/2017-10-26/docs-2.json index ed57d69ce47..3540ab17422 100644 --- a/models/apis/transcribe/2017-10-26/docs-2.json +++ b/models/apis/transcribe/2017-10-26/docs-2.json @@ -968,6 +968,37 @@ "TranscriptFilter$Targets": "The phrases that you're specifying for the transcript filter to match.
" } }, + "SubtitleFileUris": { + "base": null, + "refs": { + "SubtitlesOutput$SubtitleFileUris": "Choose the output location for your subtitle file. This location must be an S3 bucket.
" + } + }, + "SubtitleFormat": { + "base": null, + "refs": { + "SubtitleFormats$member": null + } + }, + "SubtitleFormats": { + "base": null, + "refs": { + "Subtitles$Formats": "Specify the output format for your subtitle file.
", + "SubtitlesOutput$Formats": "Specify the output format for your subtitle file; if you select both SRT and VTT formats, two output files are genereated.
" + } + }, + "Subtitles": { + "base": "Generate subtitles for your batch transcription job.
", + "refs": { + "StartTranscriptionJobRequest$Subtitles": "Add subtitles to your batch transcription job.
" + } + }, + "SubtitlesOutput": { + "base": "Specify the output format for your subtitle file.
", + "refs": { + "TranscriptionJob$Subtitles": "Generate subtitles for your batch transcription job.
" + } + }, "Tag": { "base": "A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
", "refs": { @@ -1179,6 +1210,7 @@ "Media$RedactedMediaFileUri": "The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
", "MedicalTranscript$TranscriptFileUri": "The S3 object location of the medical transcript.
Use this URI to access the medical transcript. This URI points to the S3 bucket you created to store the medical transcript.
", "StartCallAnalyticsJobRequest$OutputLocation": "The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:
s3://DOC-EXAMPLE-BUCKET1
If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.
s3://DOC-EXAMPLE-BUCKET1/folder/
f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json
If you specify a folder, you must provide a trailing slash.
s3://DOC-EXAMPLE-BUCKET1/folder/filename.json
If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.
The S3 object location of the transcript.
Use this URI to access the transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
The S3 object location of the redacted transcript.
Use this URI to access the redacted transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you are calling. The following is the format for a URI:
https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
For example:
https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.
", diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index e92d3eac99c..f8e122bf07a 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -7240,6 +7240,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "sa-east-1" : { }, + "transcribestreaming-fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "transcribestreaming-fips.ca-central-1.amazonaws.com" + }, + "transcribestreaming-fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "transcribestreaming-fips.us-east-1.amazonaws.com" + }, + "transcribestreaming-fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "transcribestreaming-fips.us-east-2.amazonaws.com" + }, + "transcribestreaming-fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "transcribestreaming-fips.us-west-2.amazonaws.com" + }, "us-east-1" : { }, "us-east-2" : { }, "us-west-2" : { } @@ -9804,6 +9828,16 @@ "us-gov-west-1" : { } } }, + "oidc" : { + "endpoints" : { + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "oidc.us-gov-west-1.amazonaws.com" + } + } + }, "organizations" : { "endpoints" : { "aws-us-gov-global" : { diff --git a/service/kafkaconnect/api.go b/service/kafkaconnect/api.go new file mode 100644 index 00000000000..87ff2a6a9c3 --- /dev/null +++ b/service/kafkaconnect/api.go @@ -0,0 +1,6438 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package kafkaconnect + +import ( + "fmt" + "time" + + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/awsutil" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/private/protocol" +) + +const opCreateConnector = "CreateConnector" + +// CreateConnectorRequest generates a "aws/request.Request" representing the +// client's request for the CreateConnector operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateConnector for more information on using the CreateConnector +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateConnectorRequest method. +// req, resp := client.CreateConnectorRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/CreateConnector +func (c *KafkaConnect) CreateConnectorRequest(input *CreateConnectorInput) (req *request.Request, output *CreateConnectorOutput) { + op := &request.Operation{ + Name: opCreateConnector, + HTTPMethod: "POST", + HTTPPath: "/v1/connectors", + } + + if input == nil { + input = &CreateConnectorInput{} + } + + output = &CreateConnectorOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateConnector API operation for Managed Streaming for Kafka Connect. +// +// Creates a connector using the specified properties. +// +// 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 +// the error. +// +// See the AWS API reference guide for Managed Streaming for Kafka Connect's +// API operation CreateConnector for usage and error information. +// +// Returned Error Types: +// * NotFoundException +// HTTP Status Code 404: Resource not found due to incorrect input. Correct +// your request and then retry it. +// +// * ConflictException +// HTTP Status Code 409: Conflict. A resource with this name already exists. +// Retry your request with another name. +// +// * BadRequestException +// HTTP Status Code 400: Bad request due to incorrect input. Correct your request +// and then retry it. +// +// * ForbiddenException +// HTTP Status Code 403: Access forbidden. Correct your credentials and then +// retry your request. +// +// * ServiceUnavailableException +// HTTP Status Code 503: Service Unavailable. Retrying your request in some +// time might resolve the issue. +// +// * TooManyRequestsException +// HTTP Status Code 429: Limit exceeded. Resource limit reached. +// +// * UnauthorizedException +// HTTP Status Code 401: Unauthorized request. The provided credentials couldn't +// be validated. +// +// * InternalServerErrorException +// HTTP Status Code 500: Unexpected internal server error. Retrying your request +// might resolve the issue. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/CreateConnector +func (c *KafkaConnect) CreateConnector(input *CreateConnectorInput) (*CreateConnectorOutput, error) { + req, out := c.CreateConnectorRequest(input) + return out, req.Send() +} + +// CreateConnectorWithContext is the same as CreateConnector with the addition of +// the ability to pass a context and additional request options. +// +// See CreateConnector for details on how to use this API operation. +// +// 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 *KafkaConnect) CreateConnectorWithContext(ctx aws.Context, input *CreateConnectorInput, opts ...request.Option) (*CreateConnectorOutput, error) { + req, out := c.CreateConnectorRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateCustomPlugin = "CreateCustomPlugin" + +// CreateCustomPluginRequest generates a "aws/request.Request" representing the +// client's request for the CreateCustomPlugin operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateCustomPlugin for more information on using the CreateCustomPlugin +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateCustomPluginRequest method. +// req, resp := client.CreateCustomPluginRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/CreateCustomPlugin +func (c *KafkaConnect) CreateCustomPluginRequest(input *CreateCustomPluginInput) (req *request.Request, output *CreateCustomPluginOutput) { + op := &request.Operation{ + Name: opCreateCustomPlugin, + HTTPMethod: "POST", + HTTPPath: "/v1/custom-plugins", + } + + if input == nil { + input = &CreateCustomPluginInput{} + } + + output = &CreateCustomPluginOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateCustomPlugin API operation for Managed Streaming for Kafka Connect. +// +// Creates a custom plugin using the specified properties. +// +// 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 +// the error. +// +// See the AWS API reference guide for Managed Streaming for Kafka Connect's +// API operation CreateCustomPlugin for usage and error information. +// +// Returned Error Types: +// * NotFoundException +// HTTP Status Code 404: Resource not found due to incorrect input. Correct +// your request and then retry it. +// +// * ConflictException +// HTTP Status Code 409: Conflict. A resource with this name already exists. +// Retry your request with another name. +// +// * BadRequestException +// HTTP Status Code 400: Bad request due to incorrect input. Correct your request +// and then retry it. +// +// * ForbiddenException +// HTTP Status Code 403: Access forbidden. Correct your credentials and then +// retry your request. +// +// * ServiceUnavailableException +// HTTP Status Code 503: Service Unavailable. Retrying your request in some +// time might resolve the issue. +// +// * TooManyRequestsException +// HTTP Status Code 429: Limit exceeded. Resource limit reached. +// +// * UnauthorizedException +// HTTP Status Code 401: Unauthorized request. The provided credentials couldn't +// be validated. +// +// * InternalServerErrorException +// HTTP Status Code 500: Unexpected internal server error. Retrying your request +// might resolve the issue. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/CreateCustomPlugin +func (c *KafkaConnect) CreateCustomPlugin(input *CreateCustomPluginInput) (*CreateCustomPluginOutput, error) { + req, out := c.CreateCustomPluginRequest(input) + return out, req.Send() +} + +// CreateCustomPluginWithContext is the same as CreateCustomPlugin with the addition of +// the ability to pass a context and additional request options. +// +// See CreateCustomPlugin for details on how to use this API operation. +// +// 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 *KafkaConnect) CreateCustomPluginWithContext(ctx aws.Context, input *CreateCustomPluginInput, opts ...request.Option) (*CreateCustomPluginOutput, error) { + req, out := c.CreateCustomPluginRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateWorkerConfiguration = "CreateWorkerConfiguration" + +// CreateWorkerConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the CreateWorkerConfiguration operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateWorkerConfiguration for more information on using the CreateWorkerConfiguration +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateWorkerConfigurationRequest method. +// req, resp := client.CreateWorkerConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/CreateWorkerConfiguration +func (c *KafkaConnect) CreateWorkerConfigurationRequest(input *CreateWorkerConfigurationInput) (req *request.Request, output *CreateWorkerConfigurationOutput) { + op := &request.Operation{ + Name: opCreateWorkerConfiguration, + HTTPMethod: "POST", + HTTPPath: "/v1/worker-configurations", + } + + if input == nil { + input = &CreateWorkerConfigurationInput{} + } + + output = &CreateWorkerConfigurationOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateWorkerConfiguration API operation for Managed Streaming for Kafka Connect. +// +// Creates a worker configuration using the specified properties. +// +// 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 +// the error. +// +// See the AWS API reference guide for Managed Streaming for Kafka Connect's +// API operation CreateWorkerConfiguration for usage and error information. +// +// Returned Error Types: +// * NotFoundException +// HTTP Status Code 404: Resource not found due to incorrect input. Correct +// your request and then retry it. +// +// * ConflictException +// HTTP Status Code 409: Conflict. A resource with this name already exists. +// Retry your request with another name. +// +// * BadRequestException +// HTTP Status Code 400: Bad request due to incorrect input. Correct your request +// and then retry it. +// +// * ForbiddenException +// HTTP Status Code 403: Access forbidden. Correct your credentials and then +// retry your request. +// +// * ServiceUnavailableException +// HTTP Status Code 503: Service Unavailable. Retrying your request in some +// time might resolve the issue. +// +// * TooManyRequestsException +// HTTP Status Code 429: Limit exceeded. Resource limit reached. +// +// * UnauthorizedException +// HTTP Status Code 401: Unauthorized request. The provided credentials couldn't +// be validated. +// +// * InternalServerErrorException +// HTTP Status Code 500: Unexpected internal server error. Retrying your request +// might resolve the issue. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/CreateWorkerConfiguration +func (c *KafkaConnect) CreateWorkerConfiguration(input *CreateWorkerConfigurationInput) (*CreateWorkerConfigurationOutput, error) { + req, out := c.CreateWorkerConfigurationRequest(input) + return out, req.Send() +} + +// CreateWorkerConfigurationWithContext is the same as CreateWorkerConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See CreateWorkerConfiguration for details on how to use this API operation. +// +// 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 *KafkaConnect) CreateWorkerConfigurationWithContext(ctx aws.Context, input *CreateWorkerConfigurationInput, opts ...request.Option) (*CreateWorkerConfigurationOutput, error) { + req, out := c.CreateWorkerConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteConnector = "DeleteConnector" + +// DeleteConnectorRequest generates a "aws/request.Request" representing the +// client's request for the DeleteConnector operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteConnector for more information on using the DeleteConnector +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteConnectorRequest method. +// req, resp := client.DeleteConnectorRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/DeleteConnector +func (c *KafkaConnect) DeleteConnectorRequest(input *DeleteConnectorInput) (req *request.Request, output *DeleteConnectorOutput) { + op := &request.Operation{ + Name: opDeleteConnector, + HTTPMethod: "DELETE", + HTTPPath: "/v1/connectors/{connectorArn}", + } + + if input == nil { + input = &DeleteConnectorInput{} + } + + output = &DeleteConnectorOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteConnector API operation for Managed Streaming for Kafka Connect. +// +// Deletes the specified connector. +// +// 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 +// the error. +// +// See the AWS API reference guide for Managed Streaming for Kafka Connect's +// API operation DeleteConnector for usage and error information. +// +// Returned Error Types: +// * NotFoundException +// HTTP Status Code 404: Resource not found due to incorrect input. Correct +// your request and then retry it. +// +// * BadRequestException +// HTTP Status Code 400: Bad request due to incorrect input. Correct your request +// and then retry it. +// +// * ForbiddenException +// HTTP Status Code 403: Access forbidden. Correct your credentials and then +// retry your request. +// +// * ServiceUnavailableException +// HTTP Status Code 503: Service Unavailable. Retrying your request in some +// time might resolve the issue. +// +// * TooManyRequestsException +// HTTP Status Code 429: Limit exceeded. Resource limit reached. +// +// * UnauthorizedException +// HTTP Status Code 401: Unauthorized request. The provided credentials couldn't +// be validated. +// +// * InternalServerErrorException +// HTTP Status Code 500: Unexpected internal server error. Retrying your request +// might resolve the issue. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/DeleteConnector +func (c *KafkaConnect) DeleteConnector(input *DeleteConnectorInput) (*DeleteConnectorOutput, error) { + req, out := c.DeleteConnectorRequest(input) + return out, req.Send() +} + +// DeleteConnectorWithContext is the same as DeleteConnector with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteConnector for details on how to use this API operation. +// +// 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 *KafkaConnect) DeleteConnectorWithContext(ctx aws.Context, input *DeleteConnectorInput, opts ...request.Option) (*DeleteConnectorOutput, error) { + req, out := c.DeleteConnectorRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeConnector = "DescribeConnector" + +// DescribeConnectorRequest generates a "aws/request.Request" representing the +// client's request for the DescribeConnector operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeConnector for more information on using the DescribeConnector +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeConnectorRequest method. +// req, resp := client.DescribeConnectorRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/DescribeConnector +func (c *KafkaConnect) DescribeConnectorRequest(input *DescribeConnectorInput) (req *request.Request, output *DescribeConnectorOutput) { + op := &request.Operation{ + Name: opDescribeConnector, + HTTPMethod: "GET", + HTTPPath: "/v1/connectors/{connectorArn}", + } + + if input == nil { + input = &DescribeConnectorInput{} + } + + output = &DescribeConnectorOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeConnector API operation for Managed Streaming for Kafka Connect. +// +// Returns summary information about the connector. +// +// 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 +// the error. +// +// See the AWS API reference guide for Managed Streaming for Kafka Connect's +// API operation DescribeConnector for usage and error information. +// +// Returned Error Types: +// * NotFoundException +// HTTP Status Code 404: Resource not found due to incorrect input. Correct +// your request and then retry it. +// +// * BadRequestException +// HTTP Status Code 400: Bad request due to incorrect input. Correct your request +// and then retry it. +// +// * ForbiddenException +// HTTP Status Code 403: Access forbidden. Correct your credentials and then +// retry your request. +// +// * ServiceUnavailableException +// HTTP Status Code 503: Service Unavailable. Retrying your request in some +// time might resolve the issue. +// +// * TooManyRequestsException +// HTTP Status Code 429: Limit exceeded. Resource limit reached. +// +// * UnauthorizedException +// HTTP Status Code 401: Unauthorized request. The provided credentials couldn't +// be validated. +// +// * InternalServerErrorException +// HTTP Status Code 500: Unexpected internal server error. Retrying your request +// might resolve the issue. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/DescribeConnector +func (c *KafkaConnect) DescribeConnector(input *DescribeConnectorInput) (*DescribeConnectorOutput, error) { + req, out := c.DescribeConnectorRequest(input) + return out, req.Send() +} + +// DescribeConnectorWithContext is the same as DescribeConnector with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeConnector for details on how to use this API operation. +// +// 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 *KafkaConnect) DescribeConnectorWithContext(ctx aws.Context, input *DescribeConnectorInput, opts ...request.Option) (*DescribeConnectorOutput, error) { + req, out := c.DescribeConnectorRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeCustomPlugin = "DescribeCustomPlugin" + +// DescribeCustomPluginRequest generates a "aws/request.Request" representing the +// client's request for the DescribeCustomPlugin operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeCustomPlugin for more information on using the DescribeCustomPlugin +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeCustomPluginRequest method. +// req, resp := client.DescribeCustomPluginRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/DescribeCustomPlugin +func (c *KafkaConnect) DescribeCustomPluginRequest(input *DescribeCustomPluginInput) (req *request.Request, output *DescribeCustomPluginOutput) { + op := &request.Operation{ + Name: opDescribeCustomPlugin, + HTTPMethod: "GET", + HTTPPath: "/v1/custom-plugins/{customPluginArn}", + } + + if input == nil { + input = &DescribeCustomPluginInput{} + } + + output = &DescribeCustomPluginOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeCustomPlugin API operation for Managed Streaming for Kafka Connect. +// +// A summary description of the custom plugin. +// +// 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 +// the error. +// +// See the AWS API reference guide for Managed Streaming for Kafka Connect's +// API operation DescribeCustomPlugin for usage and error information. +// +// Returned Error Types: +// * NotFoundException +// HTTP Status Code 404: Resource not found due to incorrect input. Correct +// your request and then retry it. +// +// * BadRequestException +// HTTP Status Code 400: Bad request due to incorrect input. Correct your request +// and then retry it. +// +// * ForbiddenException +// HTTP Status Code 403: Access forbidden. Correct your credentials and then +// retry your request. +// +// * ServiceUnavailableException +// HTTP Status Code 503: Service Unavailable. Retrying your request in some +// time might resolve the issue. +// +// * TooManyRequestsException +// HTTP Status Code 429: Limit exceeded. Resource limit reached. +// +// * UnauthorizedException +// HTTP Status Code 401: Unauthorized request. The provided credentials couldn't +// be validated. +// +// * InternalServerErrorException +// HTTP Status Code 500: Unexpected internal server error. Retrying your request +// might resolve the issue. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/DescribeCustomPlugin +func (c *KafkaConnect) DescribeCustomPlugin(input *DescribeCustomPluginInput) (*DescribeCustomPluginOutput, error) { + req, out := c.DescribeCustomPluginRequest(input) + return out, req.Send() +} + +// DescribeCustomPluginWithContext is the same as DescribeCustomPlugin with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeCustomPlugin for details on how to use this API operation. +// +// 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 *KafkaConnect) DescribeCustomPluginWithContext(ctx aws.Context, input *DescribeCustomPluginInput, opts ...request.Option) (*DescribeCustomPluginOutput, error) { + req, out := c.DescribeCustomPluginRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeWorkerConfiguration = "DescribeWorkerConfiguration" + +// DescribeWorkerConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWorkerConfiguration operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeWorkerConfiguration for more information on using the DescribeWorkerConfiguration +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeWorkerConfigurationRequest method. +// req, resp := client.DescribeWorkerConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/DescribeWorkerConfiguration +func (c *KafkaConnect) DescribeWorkerConfigurationRequest(input *DescribeWorkerConfigurationInput) (req *request.Request, output *DescribeWorkerConfigurationOutput) { + op := &request.Operation{ + Name: opDescribeWorkerConfiguration, + HTTPMethod: "GET", + HTTPPath: "/v1/worker-configurations/{workerConfigurationArn}", + } + + if input == nil { + input = &DescribeWorkerConfigurationInput{} + } + + output = &DescribeWorkerConfigurationOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeWorkerConfiguration API operation for Managed Streaming for Kafka Connect. +// +// Returns information about a worker configuration. +// +// 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 +// the error. +// +// See the AWS API reference guide for Managed Streaming for Kafka Connect's +// API operation DescribeWorkerConfiguration for usage and error information. +// +// Returned Error Types: +// * NotFoundException +// HTTP Status Code 404: Resource not found due to incorrect input. Correct +// your request and then retry it. +// +// * BadRequestException +// HTTP Status Code 400: Bad request due to incorrect input. Correct your request +// and then retry it. +// +// * ForbiddenException +// HTTP Status Code 403: Access forbidden. Correct your credentials and then +// retry your request. +// +// * ServiceUnavailableException +// HTTP Status Code 503: Service Unavailable. Retrying your request in some +// time might resolve the issue. +// +// * TooManyRequestsException +// HTTP Status Code 429: Limit exceeded. Resource limit reached. +// +// * UnauthorizedException +// HTTP Status Code 401: Unauthorized request. The provided credentials couldn't +// be validated. +// +// * InternalServerErrorException +// HTTP Status Code 500: Unexpected internal server error. Retrying your request +// might resolve the issue. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/DescribeWorkerConfiguration +func (c *KafkaConnect) DescribeWorkerConfiguration(input *DescribeWorkerConfigurationInput) (*DescribeWorkerConfigurationOutput, error) { + req, out := c.DescribeWorkerConfigurationRequest(input) + return out, req.Send() +} + +// DescribeWorkerConfigurationWithContext is the same as DescribeWorkerConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeWorkerConfiguration for details on how to use this API operation. +// +// 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 *KafkaConnect) DescribeWorkerConfigurationWithContext(ctx aws.Context, input *DescribeWorkerConfigurationInput, opts ...request.Option) (*DescribeWorkerConfigurationOutput, error) { + req, out := c.DescribeWorkerConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListConnectors = "ListConnectors" + +// ListConnectorsRequest generates a "aws/request.Request" representing the +// client's request for the ListConnectors operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListConnectors for more information on using the ListConnectors +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListConnectorsRequest method. +// req, resp := client.ListConnectorsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/ListConnectors +func (c *KafkaConnect) ListConnectorsRequest(input *ListConnectorsInput) (req *request.Request, output *ListConnectorsOutput) { + op := &request.Operation{ + Name: opListConnectors, + HTTPMethod: "GET", + HTTPPath: "/v1/connectors", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListConnectorsInput{} + } + + output = &ListConnectorsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListConnectors API operation for Managed Streaming for Kafka Connect. +// +// Returns a list of all the connectors in this account and Region. The list +// is limited to connectors whose name starts with the specified prefix. The +// response also includes a description of each of the listed connectors. +// +// 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 +// the error. +// +// See the AWS API reference guide for Managed Streaming for Kafka Connect's +// API operation ListConnectors for usage and error information. +// +// Returned Error Types: +// * NotFoundException +// HTTP Status Code 404: Resource not found due to incorrect input. Correct +// your request and then retry it. +// +// * BadRequestException +// HTTP Status Code 400: Bad request due to incorrect input. Correct your request +// and then retry it. +// +// * ForbiddenException +// HTTP Status Code 403: Access forbidden. Correct your credentials and then +// retry your request. +// +// * ServiceUnavailableException +// HTTP Status Code 503: Service Unavailable. Retrying your request in some +// time might resolve the issue. +// +// * TooManyRequestsException +// HTTP Status Code 429: Limit exceeded. Resource limit reached. +// +// * UnauthorizedException +// HTTP Status Code 401: Unauthorized request. The provided credentials couldn't +// be validated. +// +// * InternalServerErrorException +// HTTP Status Code 500: Unexpected internal server error. Retrying your request +// might resolve the issue. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/ListConnectors +func (c *KafkaConnect) ListConnectors(input *ListConnectorsInput) (*ListConnectorsOutput, error) { + req, out := c.ListConnectorsRequest(input) + return out, req.Send() +} + +// ListConnectorsWithContext is the same as ListConnectors with the addition of +// the ability to pass a context and additional request options. +// +// See ListConnectors for details on how to use this API operation. +// +// 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 *KafkaConnect) ListConnectorsWithContext(ctx aws.Context, input *ListConnectorsInput, opts ...request.Option) (*ListConnectorsOutput, error) { + req, out := c.ListConnectorsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListConnectorsPages iterates over the pages of a ListConnectors operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListConnectors 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 ListConnectors operation. +// pageNum := 0 +// err := client.ListConnectorsPages(params, +// func(page *kafkaconnect.ListConnectorsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *KafkaConnect) ListConnectorsPages(input *ListConnectorsInput, fn func(*ListConnectorsOutput, bool) bool) error { + return c.ListConnectorsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListConnectorsPagesWithContext same as ListConnectorsPages 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 *KafkaConnect) ListConnectorsPagesWithContext(ctx aws.Context, input *ListConnectorsInput, fn func(*ListConnectorsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListConnectorsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListConnectorsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListConnectorsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListCustomPlugins = "ListCustomPlugins" + +// ListCustomPluginsRequest generates a "aws/request.Request" representing the +// client's request for the ListCustomPlugins operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListCustomPlugins for more information on using the ListCustomPlugins +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListCustomPluginsRequest method. +// req, resp := client.ListCustomPluginsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/ListCustomPlugins +func (c *KafkaConnect) ListCustomPluginsRequest(input *ListCustomPluginsInput) (req *request.Request, output *ListCustomPluginsOutput) { + op := &request.Operation{ + Name: opListCustomPlugins, + HTTPMethod: "GET", + HTTPPath: "/v1/custom-plugins", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListCustomPluginsInput{} + } + + output = &ListCustomPluginsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListCustomPlugins API operation for Managed Streaming for Kafka Connect. +// +// Returns a list of all of the custom plugins in this account and 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 +// the error. +// +// See the AWS API reference guide for Managed Streaming for Kafka Connect's +// API operation ListCustomPlugins for usage and error information. +// +// Returned Error Types: +// * NotFoundException +// HTTP Status Code 404: Resource not found due to incorrect input. Correct +// your request and then retry it. +// +// * BadRequestException +// HTTP Status Code 400: Bad request due to incorrect input. Correct your request +// and then retry it. +// +// * ForbiddenException +// HTTP Status Code 403: Access forbidden. Correct your credentials and then +// retry your request. +// +// * ServiceUnavailableException +// HTTP Status Code 503: Service Unavailable. Retrying your request in some +// time might resolve the issue. +// +// * TooManyRequestsException +// HTTP Status Code 429: Limit exceeded. Resource limit reached. +// +// * UnauthorizedException +// HTTP Status Code 401: Unauthorized request. The provided credentials couldn't +// be validated. +// +// * InternalServerErrorException +// HTTP Status Code 500: Unexpected internal server error. Retrying your request +// might resolve the issue. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/ListCustomPlugins +func (c *KafkaConnect) ListCustomPlugins(input *ListCustomPluginsInput) (*ListCustomPluginsOutput, error) { + req, out := c.ListCustomPluginsRequest(input) + return out, req.Send() +} + +// ListCustomPluginsWithContext is the same as ListCustomPlugins with the addition of +// the ability to pass a context and additional request options. +// +// See ListCustomPlugins for details on how to use this API operation. +// +// 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 *KafkaConnect) ListCustomPluginsWithContext(ctx aws.Context, input *ListCustomPluginsInput, opts ...request.Option) (*ListCustomPluginsOutput, error) { + req, out := c.ListCustomPluginsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListCustomPluginsPages iterates over the pages of a ListCustomPlugins operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListCustomPlugins 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 ListCustomPlugins operation. +// pageNum := 0 +// err := client.ListCustomPluginsPages(params, +// func(page *kafkaconnect.ListCustomPluginsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *KafkaConnect) ListCustomPluginsPages(input *ListCustomPluginsInput, fn func(*ListCustomPluginsOutput, bool) bool) error { + return c.ListCustomPluginsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListCustomPluginsPagesWithContext same as ListCustomPluginsPages 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 *KafkaConnect) ListCustomPluginsPagesWithContext(ctx aws.Context, input *ListCustomPluginsInput, fn func(*ListCustomPluginsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListCustomPluginsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListCustomPluginsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListCustomPluginsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListWorkerConfigurations = "ListWorkerConfigurations" + +// ListWorkerConfigurationsRequest generates a "aws/request.Request" representing the +// client's request for the ListWorkerConfigurations operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListWorkerConfigurations for more information on using the ListWorkerConfigurations +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListWorkerConfigurationsRequest method. +// req, resp := client.ListWorkerConfigurationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/ListWorkerConfigurations +func (c *KafkaConnect) ListWorkerConfigurationsRequest(input *ListWorkerConfigurationsInput) (req *request.Request, output *ListWorkerConfigurationsOutput) { + op := &request.Operation{ + Name: opListWorkerConfigurations, + HTTPMethod: "GET", + HTTPPath: "/v1/worker-configurations", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListWorkerConfigurationsInput{} + } + + output = &ListWorkerConfigurationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListWorkerConfigurations API operation for Managed Streaming for Kafka Connect. +// +// Returns a list of all of the worker configurations in this account and 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 +// the error. +// +// See the AWS API reference guide for Managed Streaming for Kafka Connect's +// API operation ListWorkerConfigurations for usage and error information. +// +// Returned Error Types: +// * NotFoundException +// HTTP Status Code 404: Resource not found due to incorrect input. Correct +// your request and then retry it. +// +// * BadRequestException +// HTTP Status Code 400: Bad request due to incorrect input. Correct your request +// and then retry it. +// +// * ForbiddenException +// HTTP Status Code 403: Access forbidden. Correct your credentials and then +// retry your request. +// +// * ServiceUnavailableException +// HTTP Status Code 503: Service Unavailable. Retrying your request in some +// time might resolve the issue. +// +// * TooManyRequestsException +// HTTP Status Code 429: Limit exceeded. Resource limit reached. +// +// * UnauthorizedException +// HTTP Status Code 401: Unauthorized request. The provided credentials couldn't +// be validated. +// +// * InternalServerErrorException +// HTTP Status Code 500: Unexpected internal server error. Retrying your request +// might resolve the issue. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/ListWorkerConfigurations +func (c *KafkaConnect) ListWorkerConfigurations(input *ListWorkerConfigurationsInput) (*ListWorkerConfigurationsOutput, error) { + req, out := c.ListWorkerConfigurationsRequest(input) + return out, req.Send() +} + +// ListWorkerConfigurationsWithContext is the same as ListWorkerConfigurations with the addition of +// the ability to pass a context and additional request options. +// +// See ListWorkerConfigurations for details on how to use this API operation. +// +// 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 *KafkaConnect) ListWorkerConfigurationsWithContext(ctx aws.Context, input *ListWorkerConfigurationsInput, opts ...request.Option) (*ListWorkerConfigurationsOutput, error) { + req, out := c.ListWorkerConfigurationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListWorkerConfigurationsPages iterates over the pages of a ListWorkerConfigurations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListWorkerConfigurations 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 ListWorkerConfigurations operation. +// pageNum := 0 +// err := client.ListWorkerConfigurationsPages(params, +// func(page *kafkaconnect.ListWorkerConfigurationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *KafkaConnect) ListWorkerConfigurationsPages(input *ListWorkerConfigurationsInput, fn func(*ListWorkerConfigurationsOutput, bool) bool) error { + return c.ListWorkerConfigurationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListWorkerConfigurationsPagesWithContext same as ListWorkerConfigurationsPages 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 *KafkaConnect) ListWorkerConfigurationsPagesWithContext(ctx aws.Context, input *ListWorkerConfigurationsInput, fn func(*ListWorkerConfigurationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListWorkerConfigurationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListWorkerConfigurationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListWorkerConfigurationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opUpdateConnector = "UpdateConnector" + +// UpdateConnectorRequest generates a "aws/request.Request" representing the +// client's request for the UpdateConnector operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateConnector for more information on using the UpdateConnector +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateConnectorRequest method. +// req, resp := client.UpdateConnectorRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/UpdateConnector +func (c *KafkaConnect) UpdateConnectorRequest(input *UpdateConnectorInput) (req *request.Request, output *UpdateConnectorOutput) { + op := &request.Operation{ + Name: opUpdateConnector, + HTTPMethod: "PUT", + HTTPPath: "/v1/connectors/{connectorArn}", + } + + if input == nil { + input = &UpdateConnectorInput{} + } + + output = &UpdateConnectorOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateConnector API operation for Managed Streaming for Kafka Connect. +// +// Updates the specified connector. +// +// 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 +// the error. +// +// See the AWS API reference guide for Managed Streaming for Kafka Connect's +// API operation UpdateConnector for usage and error information. +// +// Returned Error Types: +// * NotFoundException +// HTTP Status Code 404: Resource not found due to incorrect input. Correct +// your request and then retry it. +// +// * BadRequestException +// HTTP Status Code 400: Bad request due to incorrect input. Correct your request +// and then retry it. +// +// * ForbiddenException +// HTTP Status Code 403: Access forbidden. Correct your credentials and then +// retry your request. +// +// * ServiceUnavailableException +// HTTP Status Code 503: Service Unavailable. Retrying your request in some +// time might resolve the issue. +// +// * TooManyRequestsException +// HTTP Status Code 429: Limit exceeded. Resource limit reached. +// +// * UnauthorizedException +// HTTP Status Code 401: Unauthorized request. The provided credentials couldn't +// be validated. +// +// * InternalServerErrorException +// HTTP Status Code 500: Unexpected internal server error. Retrying your request +// might resolve the issue. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/UpdateConnector +func (c *KafkaConnect) UpdateConnector(input *UpdateConnectorInput) (*UpdateConnectorOutput, error) { + req, out := c.UpdateConnectorRequest(input) + return out, req.Send() +} + +// UpdateConnectorWithContext is the same as UpdateConnector with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateConnector for details on how to use this API operation. +// +// 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 *KafkaConnect) UpdateConnectorWithContext(ctx aws.Context, input *UpdateConnectorInput, opts ...request.Option) (*UpdateConnectorOutput, error) { + req, out := c.UpdateConnectorRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// The details of the Apache Kafka cluster to which the connector is connected. +type ApacheKafkaCluster struct { + _ struct{} `type:"structure"` + + // The bootstrap servers of the cluster. + // + // BootstrapServers is a required field + BootstrapServers *string `locationName:"bootstrapServers" type:"string" required:"true"` + + // Details of an Amazon VPC which has network connectivity to the Apache Kafka + // cluster. + // + // Vpc is a required field + Vpc *Vpc `locationName:"vpc" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApacheKafkaCluster) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApacheKafkaCluster) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ApacheKafkaCluster) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ApacheKafkaCluster"} + if s.BootstrapServers == nil { + invalidParams.Add(request.NewErrParamRequired("BootstrapServers")) + } + if s.Vpc == nil { + invalidParams.Add(request.NewErrParamRequired("Vpc")) + } + if s.Vpc != nil { + if err := s.Vpc.Validate(); err != nil { + invalidParams.AddNested("Vpc", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBootstrapServers sets the BootstrapServers field's value. +func (s *ApacheKafkaCluster) SetBootstrapServers(v string) *ApacheKafkaCluster { + s.BootstrapServers = &v + return s +} + +// SetVpc sets the Vpc field's value. +func (s *ApacheKafkaCluster) SetVpc(v *Vpc) *ApacheKafkaCluster { + s.Vpc = v + return s +} + +// The description of the Apache Kafka cluster to which the connector is connected. +type ApacheKafkaClusterDescription struct { + _ struct{} `type:"structure"` + + // The bootstrap servers of the cluster. + BootstrapServers *string `locationName:"bootstrapServers" type:"string"` + + // Details of an Amazon VPC which has network connectivity to the Apache Kafka + // cluster. + Vpc *VpcDescription `locationName:"vpc" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApacheKafkaClusterDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApacheKafkaClusterDescription) GoString() string { + return s.String() +} + +// SetBootstrapServers sets the BootstrapServers field's value. +func (s *ApacheKafkaClusterDescription) SetBootstrapServers(v string) *ApacheKafkaClusterDescription { + s.BootstrapServers = &v + return s +} + +// SetVpc sets the Vpc field's value. +func (s *ApacheKafkaClusterDescription) SetVpc(v *VpcDescription) *ApacheKafkaClusterDescription { + s.Vpc = v + return s +} + +// Specifies how the connector scales. +type AutoScaling struct { + _ struct{} `type:"structure"` + + // The maximum number of workers allocated to the connector. + // + // MaxWorkerCount is a required field + MaxWorkerCount *int64 `locationName:"maxWorkerCount" min:"1" type:"integer" required:"true"` + + // The number of microcontroller units (MCUs) allocated to each connector worker. + // The valid values are 1,2,4,8. + // + // McuCount is a required field + McuCount *int64 `locationName:"mcuCount" min:"1" type:"integer" required:"true"` + + // The minimum number of workers allocated to the connector. + // + // MinWorkerCount is a required field + MinWorkerCount *int64 `locationName:"minWorkerCount" min:"1" type:"integer" required:"true"` + + // The sacle-in policy for the connector. + ScaleInPolicy *ScaleInPolicy `locationName:"scaleInPolicy" type:"structure"` + + // The sacle-out policy for the connector. + ScaleOutPolicy *ScaleOutPolicy `locationName:"scaleOutPolicy" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AutoScaling) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AutoScaling) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AutoScaling) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AutoScaling"} + if s.MaxWorkerCount == nil { + invalidParams.Add(request.NewErrParamRequired("MaxWorkerCount")) + } + if s.MaxWorkerCount != nil && *s.MaxWorkerCount < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxWorkerCount", 1)) + } + if s.McuCount == nil { + invalidParams.Add(request.NewErrParamRequired("McuCount")) + } + if s.McuCount != nil && *s.McuCount < 1 { + invalidParams.Add(request.NewErrParamMinValue("McuCount", 1)) + } + if s.MinWorkerCount == nil { + invalidParams.Add(request.NewErrParamRequired("MinWorkerCount")) + } + if s.MinWorkerCount != nil && *s.MinWorkerCount < 1 { + invalidParams.Add(request.NewErrParamMinValue("MinWorkerCount", 1)) + } + if s.ScaleInPolicy != nil { + if err := s.ScaleInPolicy.Validate(); err != nil { + invalidParams.AddNested("ScaleInPolicy", err.(request.ErrInvalidParams)) + } + } + if s.ScaleOutPolicy != nil { + if err := s.ScaleOutPolicy.Validate(); err != nil { + invalidParams.AddNested("ScaleOutPolicy", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxWorkerCount sets the MaxWorkerCount field's value. +func (s *AutoScaling) SetMaxWorkerCount(v int64) *AutoScaling { + s.MaxWorkerCount = &v + return s +} + +// SetMcuCount sets the McuCount field's value. +func (s *AutoScaling) SetMcuCount(v int64) *AutoScaling { + s.McuCount = &v + return s +} + +// SetMinWorkerCount sets the MinWorkerCount field's value. +func (s *AutoScaling) SetMinWorkerCount(v int64) *AutoScaling { + s.MinWorkerCount = &v + return s +} + +// SetScaleInPolicy sets the ScaleInPolicy field's value. +func (s *AutoScaling) SetScaleInPolicy(v *ScaleInPolicy) *AutoScaling { + s.ScaleInPolicy = v + return s +} + +// SetScaleOutPolicy sets the ScaleOutPolicy field's value. +func (s *AutoScaling) SetScaleOutPolicy(v *ScaleOutPolicy) *AutoScaling { + s.ScaleOutPolicy = v + return s +} + +// Information about the auto scaling parameters for the connector. +type AutoScalingDescription struct { + _ struct{} `type:"structure"` + + // The maximum number of workers allocated to the connector. + MaxWorkerCount *int64 `locationName:"maxWorkerCount" type:"integer"` + + // The number of microcontroller units (MCUs) allocated to each connector worker. + // The valid values are 1,2,4,8. + McuCount *int64 `locationName:"mcuCount" type:"integer"` + + // The minimum number of workers allocated to the connector. + MinWorkerCount *int64 `locationName:"minWorkerCount" type:"integer"` + + // The sacle-in policy for the connector. + ScaleInPolicy *ScaleInPolicyDescription `locationName:"scaleInPolicy" type:"structure"` + + // The sacle-out policy for the connector.> + ScaleOutPolicy *ScaleOutPolicyDescription `locationName:"scaleOutPolicy" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AutoScalingDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AutoScalingDescription) GoString() string { + return s.String() +} + +// SetMaxWorkerCount sets the MaxWorkerCount field's value. +func (s *AutoScalingDescription) SetMaxWorkerCount(v int64) *AutoScalingDescription { + s.MaxWorkerCount = &v + return s +} + +// SetMcuCount sets the McuCount field's value. +func (s *AutoScalingDescription) SetMcuCount(v int64) *AutoScalingDescription { + s.McuCount = &v + return s +} + +// SetMinWorkerCount sets the MinWorkerCount field's value. +func (s *AutoScalingDescription) SetMinWorkerCount(v int64) *AutoScalingDescription { + s.MinWorkerCount = &v + return s +} + +// SetScaleInPolicy sets the ScaleInPolicy field's value. +func (s *AutoScalingDescription) SetScaleInPolicy(v *ScaleInPolicyDescription) *AutoScalingDescription { + s.ScaleInPolicy = v + return s +} + +// SetScaleOutPolicy sets the ScaleOutPolicy field's value. +func (s *AutoScalingDescription) SetScaleOutPolicy(v *ScaleOutPolicyDescription) *AutoScalingDescription { + s.ScaleOutPolicy = v + return s +} + +// The updates to the auto scaling parameters for the connector. +type AutoScalingUpdate struct { + _ struct{} `type:"structure"` + + // The target maximum number of workers allocated to the connector. + // + // MaxWorkerCount is a required field + MaxWorkerCount *int64 `locationName:"maxWorkerCount" min:"1" type:"integer" required:"true"` + + // The target number of microcontroller units (MCUs) allocated to each connector + // worker. The valid values are 1,2,4,8. + // + // McuCount is a required field + McuCount *int64 `locationName:"mcuCount" min:"1" type:"integer" required:"true"` + + // The target minimum number of workers allocated to the connector. + // + // MinWorkerCount is a required field + MinWorkerCount *int64 `locationName:"minWorkerCount" min:"1" type:"integer" required:"true"` + + // The target sacle-in policy for the connector. + // + // ScaleInPolicy is a required field + ScaleInPolicy *ScaleInPolicyUpdate `locationName:"scaleInPolicy" type:"structure" required:"true"` + + // The target sacle-out policy for the connector. + // + // ScaleOutPolicy is a required field + ScaleOutPolicy *ScaleOutPolicyUpdate `locationName:"scaleOutPolicy" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AutoScalingUpdate) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AutoScalingUpdate) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AutoScalingUpdate) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AutoScalingUpdate"} + if s.MaxWorkerCount == nil { + invalidParams.Add(request.NewErrParamRequired("MaxWorkerCount")) + } + if s.MaxWorkerCount != nil && *s.MaxWorkerCount < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxWorkerCount", 1)) + } + if s.McuCount == nil { + invalidParams.Add(request.NewErrParamRequired("McuCount")) + } + if s.McuCount != nil && *s.McuCount < 1 { + invalidParams.Add(request.NewErrParamMinValue("McuCount", 1)) + } + if s.MinWorkerCount == nil { + invalidParams.Add(request.NewErrParamRequired("MinWorkerCount")) + } + if s.MinWorkerCount != nil && *s.MinWorkerCount < 1 { + invalidParams.Add(request.NewErrParamMinValue("MinWorkerCount", 1)) + } + if s.ScaleInPolicy == nil { + invalidParams.Add(request.NewErrParamRequired("ScaleInPolicy")) + } + if s.ScaleOutPolicy == nil { + invalidParams.Add(request.NewErrParamRequired("ScaleOutPolicy")) + } + if s.ScaleInPolicy != nil { + if err := s.ScaleInPolicy.Validate(); err != nil { + invalidParams.AddNested("ScaleInPolicy", err.(request.ErrInvalidParams)) + } + } + if s.ScaleOutPolicy != nil { + if err := s.ScaleOutPolicy.Validate(); err != nil { + invalidParams.AddNested("ScaleOutPolicy", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxWorkerCount sets the MaxWorkerCount field's value. +func (s *AutoScalingUpdate) SetMaxWorkerCount(v int64) *AutoScalingUpdate { + s.MaxWorkerCount = &v + return s +} + +// SetMcuCount sets the McuCount field's value. +func (s *AutoScalingUpdate) SetMcuCount(v int64) *AutoScalingUpdate { + s.McuCount = &v + return s +} + +// SetMinWorkerCount sets the MinWorkerCount field's value. +func (s *AutoScalingUpdate) SetMinWorkerCount(v int64) *AutoScalingUpdate { + s.MinWorkerCount = &v + return s +} + +// SetScaleInPolicy sets the ScaleInPolicy field's value. +func (s *AutoScalingUpdate) SetScaleInPolicy(v *ScaleInPolicyUpdate) *AutoScalingUpdate { + s.ScaleInPolicy = v + return s +} + +// SetScaleOutPolicy sets the ScaleOutPolicy field's value. +func (s *AutoScalingUpdate) SetScaleOutPolicy(v *ScaleOutPolicyUpdate) *AutoScalingUpdate { + s.ScaleOutPolicy = v + return s +} + +// HTTP Status Code 400: Bad request due to incorrect input. Correct your request +// and then retry it. +type BadRequestException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BadRequestException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BadRequestException) GoString() string { + return s.String() +} + +func newErrorBadRequestException(v protocol.ResponseMetadata) error { + return &BadRequestException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *BadRequestException) Code() string { + return "BadRequestException" +} + +// Message returns the exception's message. +func (s *BadRequestException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *BadRequestException) OrigErr() error { + return nil +} + +func (s *BadRequestException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *BadRequestException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *BadRequestException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Information about the capacity of the connector, whether it is auto scaled +// or provisioned. +type Capacity struct { + _ struct{} `type:"structure"` + + // Information about the auto scaling parameters for the connector. + AutoScaling *AutoScaling `locationName:"autoScaling" type:"structure"` + + // Details about a fixed capacity allocated to a connector. + ProvisionedCapacity *ProvisionedCapacity `locationName:"provisionedCapacity" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Capacity) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Capacity) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Capacity) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Capacity"} + if s.AutoScaling != nil { + if err := s.AutoScaling.Validate(); err != nil { + invalidParams.AddNested("AutoScaling", err.(request.ErrInvalidParams)) + } + } + if s.ProvisionedCapacity != nil { + if err := s.ProvisionedCapacity.Validate(); err != nil { + invalidParams.AddNested("ProvisionedCapacity", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAutoScaling sets the AutoScaling field's value. +func (s *Capacity) SetAutoScaling(v *AutoScaling) *Capacity { + s.AutoScaling = v + return s +} + +// SetProvisionedCapacity sets the ProvisionedCapacity field's value. +func (s *Capacity) SetProvisionedCapacity(v *ProvisionedCapacity) *Capacity { + s.ProvisionedCapacity = v + return s +} + +// A description of the connector's capacity. +type CapacityDescription struct { + _ struct{} `type:"structure"` + + // Describes the connector's auto scaling capacity. + AutoScaling *AutoScalingDescription `locationName:"autoScaling" type:"structure"` + + // Describes a connector's provisioned capacity. + ProvisionedCapacity *ProvisionedCapacityDescription `locationName:"provisionedCapacity" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CapacityDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CapacityDescription) GoString() string { + return s.String() +} + +// SetAutoScaling sets the AutoScaling field's value. +func (s *CapacityDescription) SetAutoScaling(v *AutoScalingDescription) *CapacityDescription { + s.AutoScaling = v + return s +} + +// SetProvisionedCapacity sets the ProvisionedCapacity field's value. +func (s *CapacityDescription) SetProvisionedCapacity(v *ProvisionedCapacityDescription) *CapacityDescription { + s.ProvisionedCapacity = v + return s +} + +// The target capacity for the connector. The capacity can be auto scaled or +// provisioned. +type CapacityUpdate struct { + _ struct{} `type:"structure"` + + // The target auto scaling setting. + AutoScaling *AutoScalingUpdate `locationName:"autoScaling" type:"structure"` + + // The target settings for provisioned capacity. + ProvisionedCapacity *ProvisionedCapacityUpdate `locationName:"provisionedCapacity" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CapacityUpdate) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CapacityUpdate) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CapacityUpdate) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CapacityUpdate"} + if s.AutoScaling != nil { + if err := s.AutoScaling.Validate(); err != nil { + invalidParams.AddNested("AutoScaling", err.(request.ErrInvalidParams)) + } + } + if s.ProvisionedCapacity != nil { + if err := s.ProvisionedCapacity.Validate(); err != nil { + invalidParams.AddNested("ProvisionedCapacity", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAutoScaling sets the AutoScaling field's value. +func (s *CapacityUpdate) SetAutoScaling(v *AutoScalingUpdate) *CapacityUpdate { + s.AutoScaling = v + return s +} + +// SetProvisionedCapacity sets the ProvisionedCapacity field's value. +func (s *CapacityUpdate) SetProvisionedCapacity(v *ProvisionedCapacityUpdate) *CapacityUpdate { + s.ProvisionedCapacity = v + return s +} + +// The settings for delivering connector logs to Amazon CloudWatch Logs. +type CloudWatchLogsLogDelivery struct { + _ struct{} `type:"structure"` + + // Whether log delivery to Amazon CloudWatch Logs is enabled. + // + // Enabled is a required field + Enabled *bool `locationName:"enabled" type:"boolean" required:"true"` + + // The name of the CloudWatch log group that is the destination for log delivery. + LogGroup *string `locationName:"logGroup" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CloudWatchLogsLogDelivery) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CloudWatchLogsLogDelivery) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CloudWatchLogsLogDelivery) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CloudWatchLogsLogDelivery"} + if s.Enabled == nil { + invalidParams.Add(request.NewErrParamRequired("Enabled")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEnabled sets the Enabled field's value. +func (s *CloudWatchLogsLogDelivery) SetEnabled(v bool) *CloudWatchLogsLogDelivery { + s.Enabled = &v + return s +} + +// SetLogGroup sets the LogGroup field's value. +func (s *CloudWatchLogsLogDelivery) SetLogGroup(v string) *CloudWatchLogsLogDelivery { + s.LogGroup = &v + return s +} + +// A description of the log delivery settings. +type CloudWatchLogsLogDeliveryDescription struct { + _ struct{} `type:"structure"` + + // Whether log delivery to Amazon CloudWatch Logs is enabled. + Enabled *bool `locationName:"enabled" type:"boolean"` + + // The name of the CloudWatch log group that is the destination for log delivery. + LogGroup *string `locationName:"logGroup" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CloudWatchLogsLogDeliveryDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CloudWatchLogsLogDeliveryDescription) GoString() string { + return s.String() +} + +// SetEnabled sets the Enabled field's value. +func (s *CloudWatchLogsLogDeliveryDescription) SetEnabled(v bool) *CloudWatchLogsLogDeliveryDescription { + s.Enabled = &v + return s +} + +// SetLogGroup sets the LogGroup field's value. +func (s *CloudWatchLogsLogDeliveryDescription) SetLogGroup(v string) *CloudWatchLogsLogDeliveryDescription { + s.LogGroup = &v + return s +} + +// HTTP Status Code 409: Conflict. A resource with this name already exists. +// Retry your request with another name. +type ConflictException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConflictException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConflictException) GoString() string { + return s.String() +} + +func newErrorConflictException(v protocol.ResponseMetadata) error { + return &ConflictException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ConflictException) Code() string { + return "ConflictException" +} + +// Message returns the exception's message. +func (s *ConflictException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ConflictException) OrigErr() error { + return nil +} + +func (s *ConflictException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ConflictException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ConflictException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Summary of a connector. +type ConnectorSummary struct { + _ struct{} `type:"structure"` + + // The connector's compute capacity settings. + Capacity *CapacityDescription `locationName:"capacity" type:"structure"` + + // The Amazon Resource Name (ARN) of the connector. + ConnectorArn *string `locationName:"connectorArn" type:"string"` + + // The description of the connector. + ConnectorDescription *string `locationName:"connectorDescription" type:"string"` + + // The name of the connector. + ConnectorName *string `locationName:"connectorName" type:"string"` + + // The state of the connector. + ConnectorState *string `locationName:"connectorState" type:"string" enum:"ConnectorState"` + + // The time that the connector was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"` + + // The current version of the connector. + CurrentVersion *string `locationName:"currentVersion" type:"string"` + + // The details of the Apache Kafka cluster to which the connector is connected. + KafkaCluster *KafkaClusterDescription `locationName:"kafkaCluster" type:"structure"` + + // The type of client authentication used to connect to the Apache Kafka cluster. + // The value is NONE when no client authentication is used. + KafkaClusterClientAuthentication *KafkaClusterClientAuthenticationDescription `locationName:"kafkaClusterClientAuthentication" type:"structure"` + + // Details of encryption in transit to the Apache Kafka cluster. + KafkaClusterEncryptionInTransit *KafkaClusterEncryptionInTransitDescription `locationName:"kafkaClusterEncryptionInTransit" type:"structure"` + + // The version of Kafka Connect. It has to be compatible with both the Apache + // Kafka cluster's version and the plugins. + KafkaConnectVersion *string `locationName:"kafkaConnectVersion" type:"string"` + + // The settings for delivering connector logs to Amazon CloudWatch Logs. + LogDelivery *LogDeliveryDescription `locationName:"logDelivery" type:"structure"` + + // Specifies which plugins were used for this connector. + Plugins []*PluginDescription `locationName:"plugins" type:"list"` + + // The Amazon Resource Name (ARN) of the IAM role used by the connector to access + // Amazon Web Services resources. + ServiceExecutionRoleArn *string `locationName:"serviceExecutionRoleArn" type:"string"` + + // The worker configurations that are in use with the connector. + WorkerConfiguration *WorkerConfigurationDescription `locationName:"workerConfiguration" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConnectorSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConnectorSummary) GoString() string { + return s.String() +} + +// SetCapacity sets the Capacity field's value. +func (s *ConnectorSummary) SetCapacity(v *CapacityDescription) *ConnectorSummary { + s.Capacity = v + return s +} + +// SetConnectorArn sets the ConnectorArn field's value. +func (s *ConnectorSummary) SetConnectorArn(v string) *ConnectorSummary { + s.ConnectorArn = &v + return s +} + +// SetConnectorDescription sets the ConnectorDescription field's value. +func (s *ConnectorSummary) SetConnectorDescription(v string) *ConnectorSummary { + s.ConnectorDescription = &v + return s +} + +// SetConnectorName sets the ConnectorName field's value. +func (s *ConnectorSummary) SetConnectorName(v string) *ConnectorSummary { + s.ConnectorName = &v + return s +} + +// SetConnectorState sets the ConnectorState field's value. +func (s *ConnectorSummary) SetConnectorState(v string) *ConnectorSummary { + s.ConnectorState = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *ConnectorSummary) SetCreationTime(v time.Time) *ConnectorSummary { + s.CreationTime = &v + return s +} + +// SetCurrentVersion sets the CurrentVersion field's value. +func (s *ConnectorSummary) SetCurrentVersion(v string) *ConnectorSummary { + s.CurrentVersion = &v + return s +} + +// SetKafkaCluster sets the KafkaCluster field's value. +func (s *ConnectorSummary) SetKafkaCluster(v *KafkaClusterDescription) *ConnectorSummary { + s.KafkaCluster = v + return s +} + +// SetKafkaClusterClientAuthentication sets the KafkaClusterClientAuthentication field's value. +func (s *ConnectorSummary) SetKafkaClusterClientAuthentication(v *KafkaClusterClientAuthenticationDescription) *ConnectorSummary { + s.KafkaClusterClientAuthentication = v + return s +} + +// SetKafkaClusterEncryptionInTransit sets the KafkaClusterEncryptionInTransit field's value. +func (s *ConnectorSummary) SetKafkaClusterEncryptionInTransit(v *KafkaClusterEncryptionInTransitDescription) *ConnectorSummary { + s.KafkaClusterEncryptionInTransit = v + return s +} + +// SetKafkaConnectVersion sets the KafkaConnectVersion field's value. +func (s *ConnectorSummary) SetKafkaConnectVersion(v string) *ConnectorSummary { + s.KafkaConnectVersion = &v + return s +} + +// SetLogDelivery sets the LogDelivery field's value. +func (s *ConnectorSummary) SetLogDelivery(v *LogDeliveryDescription) *ConnectorSummary { + s.LogDelivery = v + return s +} + +// SetPlugins sets the Plugins field's value. +func (s *ConnectorSummary) SetPlugins(v []*PluginDescription) *ConnectorSummary { + s.Plugins = v + return s +} + +// SetServiceExecutionRoleArn sets the ServiceExecutionRoleArn field's value. +func (s *ConnectorSummary) SetServiceExecutionRoleArn(v string) *ConnectorSummary { + s.ServiceExecutionRoleArn = &v + return s +} + +// SetWorkerConfiguration sets the WorkerConfiguration field's value. +func (s *ConnectorSummary) SetWorkerConfiguration(v *WorkerConfigurationDescription) *ConnectorSummary { + s.WorkerConfiguration = v + return s +} + +type CreateConnectorInput struct { + _ struct{} `type:"structure"` + + // Information about the capacity allocated to the connector. Exactly one of + // the two properties must be specified. + // + // Capacity is a required field + Capacity *Capacity `locationName:"capacity" type:"structure" required:"true"` + + // A map of keys to values that represent the configuration for the connector. + // + // ConnectorConfiguration is a required field + ConnectorConfiguration map[string]*string `locationName:"connectorConfiguration" type:"map" required:"true"` + + // A summary description of the connector. + ConnectorDescription *string `locationName:"connectorDescription" type:"string"` + + // The name of the connector. + // + // ConnectorName is a required field + ConnectorName *string `locationName:"connectorName" min:"1" type:"string" required:"true"` + + // Specifies which Apache Kafka cluster to connect to. + // + // KafkaCluster is a required field + KafkaCluster *KafkaCluster `locationName:"kafkaCluster" type:"structure" required:"true"` + + // Details of the client authentication used by the Apache Kafka cluster. + // + // KafkaClusterClientAuthentication is a required field + KafkaClusterClientAuthentication *KafkaClusterClientAuthentication `locationName:"kafkaClusterClientAuthentication" type:"structure" required:"true"` + + // Details of encryption in transit to the Apache Kafka cluster. + // + // KafkaClusterEncryptionInTransit is a required field + KafkaClusterEncryptionInTransit *KafkaClusterEncryptionInTransit `locationName:"kafkaClusterEncryptionInTransit" type:"structure" required:"true"` + + // The version of Kafka Connect. It has to be compatible with both the Apache + // Kafka cluster's version and the plugins. + // + // KafkaConnectVersion is a required field + KafkaConnectVersion *string `locationName:"kafkaConnectVersion" type:"string" required:"true"` + + // Details about log delivery. + LogDelivery *LogDelivery `locationName:"logDelivery" type:"structure"` + + // Specifies which plugins to use for the connector. + // + // Plugins is a required field + Plugins []*Plugin `locationName:"plugins" type:"list" required:"true"` + + // The Amazon Resource Name (ARN) of the IAM role used by the connector to access + // the Amazon Web Services resources that it needs. The types of resources depends + // on the logic of the connector. For example, a connector that has Amazon S3 + // as a destination must have permissions that allow it to write to the S3 destination + // bucket. + // + // ServiceExecutionRoleArn is a required field + ServiceExecutionRoleArn *string `locationName:"serviceExecutionRoleArn" type:"string" required:"true"` + + // Specifies which worker configuration to use with the connector. + WorkerConfiguration *WorkerConfiguration `locationName:"workerConfiguration" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateConnectorInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateConnectorInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateConnectorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateConnectorInput"} + if s.Capacity == nil { + invalidParams.Add(request.NewErrParamRequired("Capacity")) + } + if s.ConnectorConfiguration == nil { + invalidParams.Add(request.NewErrParamRequired("ConnectorConfiguration")) + } + if s.ConnectorName == nil { + invalidParams.Add(request.NewErrParamRequired("ConnectorName")) + } + if s.ConnectorName != nil && len(*s.ConnectorName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ConnectorName", 1)) + } + if s.KafkaCluster == nil { + invalidParams.Add(request.NewErrParamRequired("KafkaCluster")) + } + if s.KafkaClusterClientAuthentication == nil { + invalidParams.Add(request.NewErrParamRequired("KafkaClusterClientAuthentication")) + } + if s.KafkaClusterEncryptionInTransit == nil { + invalidParams.Add(request.NewErrParamRequired("KafkaClusterEncryptionInTransit")) + } + if s.KafkaConnectVersion == nil { + invalidParams.Add(request.NewErrParamRequired("KafkaConnectVersion")) + } + if s.Plugins == nil { + invalidParams.Add(request.NewErrParamRequired("Plugins")) + } + if s.ServiceExecutionRoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("ServiceExecutionRoleArn")) + } + if s.Capacity != nil { + if err := s.Capacity.Validate(); err != nil { + invalidParams.AddNested("Capacity", err.(request.ErrInvalidParams)) + } + } + if s.KafkaCluster != nil { + if err := s.KafkaCluster.Validate(); err != nil { + invalidParams.AddNested("KafkaCluster", err.(request.ErrInvalidParams)) + } + } + if s.KafkaClusterClientAuthentication != nil { + if err := s.KafkaClusterClientAuthentication.Validate(); err != nil { + invalidParams.AddNested("KafkaClusterClientAuthentication", err.(request.ErrInvalidParams)) + } + } + if s.KafkaClusterEncryptionInTransit != nil { + if err := s.KafkaClusterEncryptionInTransit.Validate(); err != nil { + invalidParams.AddNested("KafkaClusterEncryptionInTransit", err.(request.ErrInvalidParams)) + } + } + if s.LogDelivery != nil { + if err := s.LogDelivery.Validate(); err != nil { + invalidParams.AddNested("LogDelivery", err.(request.ErrInvalidParams)) + } + } + if s.Plugins != nil { + for i, v := range s.Plugins { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Plugins", i), err.(request.ErrInvalidParams)) + } + } + } + if s.WorkerConfiguration != nil { + if err := s.WorkerConfiguration.Validate(); err != nil { + invalidParams.AddNested("WorkerConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCapacity sets the Capacity field's value. +func (s *CreateConnectorInput) SetCapacity(v *Capacity) *CreateConnectorInput { + s.Capacity = v + return s +} + +// SetConnectorConfiguration sets the ConnectorConfiguration field's value. +func (s *CreateConnectorInput) SetConnectorConfiguration(v map[string]*string) *CreateConnectorInput { + s.ConnectorConfiguration = v + return s +} + +// SetConnectorDescription sets the ConnectorDescription field's value. +func (s *CreateConnectorInput) SetConnectorDescription(v string) *CreateConnectorInput { + s.ConnectorDescription = &v + return s +} + +// SetConnectorName sets the ConnectorName field's value. +func (s *CreateConnectorInput) SetConnectorName(v string) *CreateConnectorInput { + s.ConnectorName = &v + return s +} + +// SetKafkaCluster sets the KafkaCluster field's value. +func (s *CreateConnectorInput) SetKafkaCluster(v *KafkaCluster) *CreateConnectorInput { + s.KafkaCluster = v + return s +} + +// SetKafkaClusterClientAuthentication sets the KafkaClusterClientAuthentication field's value. +func (s *CreateConnectorInput) SetKafkaClusterClientAuthentication(v *KafkaClusterClientAuthentication) *CreateConnectorInput { + s.KafkaClusterClientAuthentication = v + return s +} + +// SetKafkaClusterEncryptionInTransit sets the KafkaClusterEncryptionInTransit field's value. +func (s *CreateConnectorInput) SetKafkaClusterEncryptionInTransit(v *KafkaClusterEncryptionInTransit) *CreateConnectorInput { + s.KafkaClusterEncryptionInTransit = v + return s +} + +// SetKafkaConnectVersion sets the KafkaConnectVersion field's value. +func (s *CreateConnectorInput) SetKafkaConnectVersion(v string) *CreateConnectorInput { + s.KafkaConnectVersion = &v + return s +} + +// SetLogDelivery sets the LogDelivery field's value. +func (s *CreateConnectorInput) SetLogDelivery(v *LogDelivery) *CreateConnectorInput { + s.LogDelivery = v + return s +} + +// SetPlugins sets the Plugins field's value. +func (s *CreateConnectorInput) SetPlugins(v []*Plugin) *CreateConnectorInput { + s.Plugins = v + return s +} + +// SetServiceExecutionRoleArn sets the ServiceExecutionRoleArn field's value. +func (s *CreateConnectorInput) SetServiceExecutionRoleArn(v string) *CreateConnectorInput { + s.ServiceExecutionRoleArn = &v + return s +} + +// SetWorkerConfiguration sets the WorkerConfiguration field's value. +func (s *CreateConnectorInput) SetWorkerConfiguration(v *WorkerConfiguration) *CreateConnectorInput { + s.WorkerConfiguration = v + return s +} + +type CreateConnectorOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) that Amazon assigned to the connector. + ConnectorArn *string `locationName:"connectorArn" type:"string"` + + // The name of the connector. + ConnectorName *string `locationName:"connectorName" type:"string"` + + // The state of the connector. + ConnectorState *string `locationName:"connectorState" type:"string" enum:"ConnectorState"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateConnectorOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateConnectorOutput) GoString() string { + return s.String() +} + +// SetConnectorArn sets the ConnectorArn field's value. +func (s *CreateConnectorOutput) SetConnectorArn(v string) *CreateConnectorOutput { + s.ConnectorArn = &v + return s +} + +// SetConnectorName sets the ConnectorName field's value. +func (s *CreateConnectorOutput) SetConnectorName(v string) *CreateConnectorOutput { + s.ConnectorName = &v + return s +} + +// SetConnectorState sets the ConnectorState field's value. +func (s *CreateConnectorOutput) SetConnectorState(v string) *CreateConnectorOutput { + s.ConnectorState = &v + return s +} + +type CreateCustomPluginInput struct { + _ struct{} `type:"structure"` + + // The type of the plugin file. + // + // ContentType is a required field + ContentType *string `locationName:"contentType" type:"string" required:"true" enum:"CustomPluginContentType"` + + // A summary description of the custom plugin. + Description *string `locationName:"description" type:"string"` + + // Information about the location of a custom plugin. + // + // Location is a required field + Location *CustomPluginLocation `locationName:"location" type:"structure" required:"true"` + + // The name of the custom plugin. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateCustomPluginInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateCustomPluginInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateCustomPluginInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateCustomPluginInput"} + if s.ContentType == nil { + invalidParams.Add(request.NewErrParamRequired("ContentType")) + } + if s.Location == nil { + invalidParams.Add(request.NewErrParamRequired("Location")) + } + 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.Location != nil { + if err := s.Location.Validate(); err != nil { + invalidParams.AddNested("Location", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetContentType sets the ContentType field's value. +func (s *CreateCustomPluginInput) SetContentType(v string) *CreateCustomPluginInput { + s.ContentType = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateCustomPluginInput) SetDescription(v string) *CreateCustomPluginInput { + s.Description = &v + return s +} + +// SetLocation sets the Location field's value. +func (s *CreateCustomPluginInput) SetLocation(v *CustomPluginLocation) *CreateCustomPluginInput { + s.Location = v + return s +} + +// SetName sets the Name field's value. +func (s *CreateCustomPluginInput) SetName(v string) *CreateCustomPluginInput { + s.Name = &v + return s +} + +type CreateCustomPluginOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) that Amazon assigned to the custom plugin. + CustomPluginArn *string `locationName:"customPluginArn" type:"string"` + + // The state of the custom plugin. + CustomPluginState *string `locationName:"customPluginState" type:"string" enum:"CustomPluginState"` + + // The name of the custom plugin. + Name *string `locationName:"name" type:"string"` + + // The revision of the custom plugin. + Revision *int64 `locationName:"revision" type:"long"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateCustomPluginOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateCustomPluginOutput) GoString() string { + return s.String() +} + +// SetCustomPluginArn sets the CustomPluginArn field's value. +func (s *CreateCustomPluginOutput) SetCustomPluginArn(v string) *CreateCustomPluginOutput { + s.CustomPluginArn = &v + return s +} + +// SetCustomPluginState sets the CustomPluginState field's value. +func (s *CreateCustomPluginOutput) SetCustomPluginState(v string) *CreateCustomPluginOutput { + s.CustomPluginState = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateCustomPluginOutput) SetName(v string) *CreateCustomPluginOutput { + s.Name = &v + return s +} + +// SetRevision sets the Revision field's value. +func (s *CreateCustomPluginOutput) SetRevision(v int64) *CreateCustomPluginOutput { + s.Revision = &v + return s +} + +type CreateWorkerConfigurationInput struct { + _ struct{} `type:"structure"` + + // A summary description of the worker configuration. + Description *string `locationName:"description" type:"string"` + + // The name of the worker configuration. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // Base64 encoded contents of connect-distributed.properties file. + // + // PropertiesFileContent is a required field + PropertiesFileContent *string `locationName:"propertiesFileContent" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateWorkerConfigurationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateWorkerConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateWorkerConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateWorkerConfigurationInput"} + 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.PropertiesFileContent == nil { + invalidParams.Add(request.NewErrParamRequired("PropertiesFileContent")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDescription sets the Description field's value. +func (s *CreateWorkerConfigurationInput) SetDescription(v string) *CreateWorkerConfigurationInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateWorkerConfigurationInput) SetName(v string) *CreateWorkerConfigurationInput { + s.Name = &v + return s +} + +// SetPropertiesFileContent sets the PropertiesFileContent field's value. +func (s *CreateWorkerConfigurationInput) SetPropertiesFileContent(v string) *CreateWorkerConfigurationInput { + s.PropertiesFileContent = &v + return s +} + +type CreateWorkerConfigurationOutput struct { + _ struct{} `type:"structure"` + + // The time that the worker configuration was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"` + + // The latest revision of the worker configuration. + LatestRevision *WorkerConfigurationRevisionSummary `locationName:"latestRevision" type:"structure"` + + // The name of the worker configuration. + Name *string `locationName:"name" type:"string"` + + // The Amazon Resource Name (ARN) that Amazon assigned to the worker configuration. + WorkerConfigurationArn *string `locationName:"workerConfigurationArn" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateWorkerConfigurationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateWorkerConfigurationOutput) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *CreateWorkerConfigurationOutput) SetCreationTime(v time.Time) *CreateWorkerConfigurationOutput { + s.CreationTime = &v + return s +} + +// SetLatestRevision sets the LatestRevision field's value. +func (s *CreateWorkerConfigurationOutput) SetLatestRevision(v *WorkerConfigurationRevisionSummary) *CreateWorkerConfigurationOutput { + s.LatestRevision = v + return s +} + +// SetName sets the Name field's value. +func (s *CreateWorkerConfigurationOutput) SetName(v string) *CreateWorkerConfigurationOutput { + s.Name = &v + return s +} + +// SetWorkerConfigurationArn sets the WorkerConfigurationArn field's value. +func (s *CreateWorkerConfigurationOutput) SetWorkerConfigurationArn(v string) *CreateWorkerConfigurationOutput { + s.WorkerConfigurationArn = &v + return s +} + +// A plugin is an AWS resource that contains the code that defines a connector's +// logic. +type CustomPlugin struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the custom plugin. + // + // CustomPluginArn is a required field + CustomPluginArn *string `locationName:"customPluginArn" type:"string" required:"true"` + + // The revision of the custom plugin. + // + // Revision is a required field + Revision *int64 `locationName:"revision" min:"1" type:"long" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomPlugin) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomPlugin) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CustomPlugin) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CustomPlugin"} + if s.CustomPluginArn == nil { + invalidParams.Add(request.NewErrParamRequired("CustomPluginArn")) + } + if s.Revision == nil { + invalidParams.Add(request.NewErrParamRequired("Revision")) + } + if s.Revision != nil && *s.Revision < 1 { + invalidParams.Add(request.NewErrParamMinValue("Revision", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCustomPluginArn sets the CustomPluginArn field's value. +func (s *CustomPlugin) SetCustomPluginArn(v string) *CustomPlugin { + s.CustomPluginArn = &v + return s +} + +// SetRevision sets the Revision field's value. +func (s *CustomPlugin) SetRevision(v int64) *CustomPlugin { + s.Revision = &v + return s +} + +// Details about a custom plugin. +type CustomPluginDescription struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the custom plugin. + CustomPluginArn *string `locationName:"customPluginArn" type:"string"` + + // The revision of the custom plugin. + Revision *int64 `locationName:"revision" type:"long"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomPluginDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomPluginDescription) GoString() string { + return s.String() +} + +// SetCustomPluginArn sets the CustomPluginArn field's value. +func (s *CustomPluginDescription) SetCustomPluginArn(v string) *CustomPluginDescription { + s.CustomPluginArn = &v + return s +} + +// SetRevision sets the Revision field's value. +func (s *CustomPluginDescription) SetRevision(v int64) *CustomPluginDescription { + s.Revision = &v + return s +} + +// Details about a custom plugin file. +type CustomPluginFileDescription struct { + _ struct{} `type:"structure"` + + // The hex-encoded MD5 checksum of the custom plugin file. You can use it to + // validate the file. + FileMd5 *string `locationName:"fileMd5" type:"string"` + + // The size in bytes of the custom plugin file. You can use it to validate the + // file. + FileSize *int64 `locationName:"fileSize" type:"long"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomPluginFileDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomPluginFileDescription) GoString() string { + return s.String() +} + +// SetFileMd5 sets the FileMd5 field's value. +func (s *CustomPluginFileDescription) SetFileMd5(v string) *CustomPluginFileDescription { + s.FileMd5 = &v + return s +} + +// SetFileSize sets the FileSize field's value. +func (s *CustomPluginFileDescription) SetFileSize(v int64) *CustomPluginFileDescription { + s.FileSize = &v + return s +} + +// Information about the location of a custom plugin. +type CustomPluginLocation struct { + _ struct{} `type:"structure"` + + // The S3 bucket Amazon Resource Name (ARN), file key, and object version of + // the plugin file stored in Amazon S3. + // + // S3Location is a required field + S3Location *S3Location `locationName:"s3Location" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomPluginLocation) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomPluginLocation) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CustomPluginLocation) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CustomPluginLocation"} + if s.S3Location == nil { + invalidParams.Add(request.NewErrParamRequired("S3Location")) + } + if s.S3Location != nil { + if err := s.S3Location.Validate(); err != nil { + invalidParams.AddNested("S3Location", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetS3Location sets the S3Location field's value. +func (s *CustomPluginLocation) SetS3Location(v *S3Location) *CustomPluginLocation { + s.S3Location = v + return s +} + +// Information about the location of a custom plugin. +type CustomPluginLocationDescription struct { + _ struct{} `type:"structure"` + + // The S3 bucket Amazon Resource Name (ARN), file key, and object version of + // the plugin file stored in Amazon S3. + S3Location *S3LocationDescription `locationName:"s3Location" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomPluginLocationDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomPluginLocationDescription) GoString() string { + return s.String() +} + +// SetS3Location sets the S3Location field's value. +func (s *CustomPluginLocationDescription) SetS3Location(v *S3LocationDescription) *CustomPluginLocationDescription { + s.S3Location = v + return s +} + +// Details about the revision of a custom plugin. +type CustomPluginRevisionSummary struct { + _ struct{} `type:"structure"` + + // The format of the plugin file. + ContentType *string `locationName:"contentType" type:"string" enum:"CustomPluginContentType"` + + // The time that the custom plugin was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"` + + // The description of the custom plugin. + Description *string `locationName:"description" type:"string"` + + // Details about the custom plugin file. + FileDescription *CustomPluginFileDescription `locationName:"fileDescription" type:"structure"` + + // Information about the location of the custom plugin. + Location *CustomPluginLocationDescription `locationName:"location" type:"structure"` + + // The revision of the custom plugin. + Revision *int64 `locationName:"revision" type:"long"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomPluginRevisionSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomPluginRevisionSummary) GoString() string { + return s.String() +} + +// SetContentType sets the ContentType field's value. +func (s *CustomPluginRevisionSummary) SetContentType(v string) *CustomPluginRevisionSummary { + s.ContentType = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *CustomPluginRevisionSummary) SetCreationTime(v time.Time) *CustomPluginRevisionSummary { + s.CreationTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CustomPluginRevisionSummary) SetDescription(v string) *CustomPluginRevisionSummary { + s.Description = &v + return s +} + +// SetFileDescription sets the FileDescription field's value. +func (s *CustomPluginRevisionSummary) SetFileDescription(v *CustomPluginFileDescription) *CustomPluginRevisionSummary { + s.FileDescription = v + return s +} + +// SetLocation sets the Location field's value. +func (s *CustomPluginRevisionSummary) SetLocation(v *CustomPluginLocationDescription) *CustomPluginRevisionSummary { + s.Location = v + return s +} + +// SetRevision sets the Revision field's value. +func (s *CustomPluginRevisionSummary) SetRevision(v int64) *CustomPluginRevisionSummary { + s.Revision = &v + return s +} + +// A summary of the custom plugin. +type CustomPluginSummary struct { + _ struct{} `type:"structure"` + + // The time that the custom plugin was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"` + + // The Amazon Resource Name (ARN) of the custom plugin. + CustomPluginArn *string `locationName:"customPluginArn" type:"string"` + + // The state of the custom plugin. + CustomPluginState *string `locationName:"customPluginState" type:"string" enum:"CustomPluginState"` + + // A description of the custom plugin. + Description *string `locationName:"description" type:"string"` + + // The latest revision of the custom plugin. + LatestRevision *CustomPluginRevisionSummary `locationName:"latestRevision" type:"structure"` + + // The name of the custom plugin. + Name *string `locationName:"name" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomPluginSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomPluginSummary) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *CustomPluginSummary) SetCreationTime(v time.Time) *CustomPluginSummary { + s.CreationTime = &v + return s +} + +// SetCustomPluginArn sets the CustomPluginArn field's value. +func (s *CustomPluginSummary) SetCustomPluginArn(v string) *CustomPluginSummary { + s.CustomPluginArn = &v + return s +} + +// SetCustomPluginState sets the CustomPluginState field's value. +func (s *CustomPluginSummary) SetCustomPluginState(v string) *CustomPluginSummary { + s.CustomPluginState = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CustomPluginSummary) SetDescription(v string) *CustomPluginSummary { + s.Description = &v + return s +} + +// SetLatestRevision sets the LatestRevision field's value. +func (s *CustomPluginSummary) SetLatestRevision(v *CustomPluginRevisionSummary) *CustomPluginSummary { + s.LatestRevision = v + return s +} + +// SetName sets the Name field's value. +func (s *CustomPluginSummary) SetName(v string) *CustomPluginSummary { + s.Name = &v + return s +} + +type DeleteConnectorInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the connector that you want to delete. + // + // ConnectorArn is a required field + ConnectorArn *string `location:"uri" locationName:"connectorArn" type:"string" required:"true"` + + // The current version of the connector that you want to delete. + CurrentVersion *string `location:"querystring" locationName:"currentVersion" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteConnectorInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteConnectorInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteConnectorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteConnectorInput"} + if s.ConnectorArn == nil { + invalidParams.Add(request.NewErrParamRequired("ConnectorArn")) + } + if s.ConnectorArn != nil && len(*s.ConnectorArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ConnectorArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetConnectorArn sets the ConnectorArn field's value. +func (s *DeleteConnectorInput) SetConnectorArn(v string) *DeleteConnectorInput { + s.ConnectorArn = &v + return s +} + +// SetCurrentVersion sets the CurrentVersion field's value. +func (s *DeleteConnectorInput) SetCurrentVersion(v string) *DeleteConnectorInput { + s.CurrentVersion = &v + return s +} + +type DeleteConnectorOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the connector that you requested to delete. + ConnectorArn *string `locationName:"connectorArn" type:"string"` + + // The state of the connector that you requested to delete. + ConnectorState *string `locationName:"connectorState" type:"string" enum:"ConnectorState"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteConnectorOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteConnectorOutput) GoString() string { + return s.String() +} + +// SetConnectorArn sets the ConnectorArn field's value. +func (s *DeleteConnectorOutput) SetConnectorArn(v string) *DeleteConnectorOutput { + s.ConnectorArn = &v + return s +} + +// SetConnectorState sets the ConnectorState field's value. +func (s *DeleteConnectorOutput) SetConnectorState(v string) *DeleteConnectorOutput { + s.ConnectorState = &v + return s +} + +type DescribeConnectorInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the connector that you want to describe. + // + // ConnectorArn is a required field + ConnectorArn *string `location:"uri" locationName:"connectorArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeConnectorInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeConnectorInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeConnectorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeConnectorInput"} + if s.ConnectorArn == nil { + invalidParams.Add(request.NewErrParamRequired("ConnectorArn")) + } + if s.ConnectorArn != nil && len(*s.ConnectorArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ConnectorArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetConnectorArn sets the ConnectorArn field's value. +func (s *DescribeConnectorInput) SetConnectorArn(v string) *DescribeConnectorInput { + s.ConnectorArn = &v + return s +} + +type DescribeConnectorOutput struct { + _ struct{} `type:"structure"` + + // Information about the capacity of the connector, whether it is auto scaled + // or provisioned. + Capacity *CapacityDescription `locationName:"capacity" type:"structure"` + + // The Amazon Resource Name (ARN) of the connector. + ConnectorArn *string `locationName:"connectorArn" type:"string"` + + // A map of keys to values that represent the configuration for the connector. + ConnectorConfiguration map[string]*string `locationName:"connectorConfiguration" type:"map"` + + // A summary description of the connector. + ConnectorDescription *string `locationName:"connectorDescription" type:"string"` + + // The name of the connector. + ConnectorName *string `locationName:"connectorName" type:"string"` + + // The state of the connector. + ConnectorState *string `locationName:"connectorState" type:"string" enum:"ConnectorState"` + + // The time the connector was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"` + + // The current version of the connector. + CurrentVersion *string `locationName:"currentVersion" type:"string"` + + // The Apache Kafka cluster that the connector is connected to. + KafkaCluster *KafkaClusterDescription `locationName:"kafkaCluster" type:"structure"` + + // The type of client authentication used to connect to the Apache Kafka cluster. + // The value is NONE when no client authentication is used. + KafkaClusterClientAuthentication *KafkaClusterClientAuthenticationDescription `locationName:"kafkaClusterClientAuthentication" type:"structure"` + + // Details of encryption in transit to the Apache Kafka cluster. + KafkaClusterEncryptionInTransit *KafkaClusterEncryptionInTransitDescription `locationName:"kafkaClusterEncryptionInTransit" type:"structure"` + + // The version of Kafka Connect. It has to be compatible with both the Apache + // Kafka cluster's version and the plugins. + KafkaConnectVersion *string `locationName:"kafkaConnectVersion" type:"string"` + + // Details about delivering logs to Amazon CloudWatch Logs. + LogDelivery *LogDeliveryDescription `locationName:"logDelivery" type:"structure"` + + // Specifies which plugins were used for this connector. + Plugins []*PluginDescription `locationName:"plugins" type:"list"` + + // The Amazon Resource Name (ARN) of the IAM role used by the connector to access + // Amazon Web Services resources. + ServiceExecutionRoleArn *string `locationName:"serviceExecutionRoleArn" type:"string"` + + // Specifies which worker configuration was used for the connector. + WorkerConfiguration *WorkerConfigurationDescription `locationName:"workerConfiguration" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeConnectorOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeConnectorOutput) GoString() string { + return s.String() +} + +// SetCapacity sets the Capacity field's value. +func (s *DescribeConnectorOutput) SetCapacity(v *CapacityDescription) *DescribeConnectorOutput { + s.Capacity = v + return s +} + +// SetConnectorArn sets the ConnectorArn field's value. +func (s *DescribeConnectorOutput) SetConnectorArn(v string) *DescribeConnectorOutput { + s.ConnectorArn = &v + return s +} + +// SetConnectorConfiguration sets the ConnectorConfiguration field's value. +func (s *DescribeConnectorOutput) SetConnectorConfiguration(v map[string]*string) *DescribeConnectorOutput { + s.ConnectorConfiguration = v + return s +} + +// SetConnectorDescription sets the ConnectorDescription field's value. +func (s *DescribeConnectorOutput) SetConnectorDescription(v string) *DescribeConnectorOutput { + s.ConnectorDescription = &v + return s +} + +// SetConnectorName sets the ConnectorName field's value. +func (s *DescribeConnectorOutput) SetConnectorName(v string) *DescribeConnectorOutput { + s.ConnectorName = &v + return s +} + +// SetConnectorState sets the ConnectorState field's value. +func (s *DescribeConnectorOutput) SetConnectorState(v string) *DescribeConnectorOutput { + s.ConnectorState = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *DescribeConnectorOutput) SetCreationTime(v time.Time) *DescribeConnectorOutput { + s.CreationTime = &v + return s +} + +// SetCurrentVersion sets the CurrentVersion field's value. +func (s *DescribeConnectorOutput) SetCurrentVersion(v string) *DescribeConnectorOutput { + s.CurrentVersion = &v + return s +} + +// SetKafkaCluster sets the KafkaCluster field's value. +func (s *DescribeConnectorOutput) SetKafkaCluster(v *KafkaClusterDescription) *DescribeConnectorOutput { + s.KafkaCluster = v + return s +} + +// SetKafkaClusterClientAuthentication sets the KafkaClusterClientAuthentication field's value. +func (s *DescribeConnectorOutput) SetKafkaClusterClientAuthentication(v *KafkaClusterClientAuthenticationDescription) *DescribeConnectorOutput { + s.KafkaClusterClientAuthentication = v + return s +} + +// SetKafkaClusterEncryptionInTransit sets the KafkaClusterEncryptionInTransit field's value. +func (s *DescribeConnectorOutput) SetKafkaClusterEncryptionInTransit(v *KafkaClusterEncryptionInTransitDescription) *DescribeConnectorOutput { + s.KafkaClusterEncryptionInTransit = v + return s +} + +// SetKafkaConnectVersion sets the KafkaConnectVersion field's value. +func (s *DescribeConnectorOutput) SetKafkaConnectVersion(v string) *DescribeConnectorOutput { + s.KafkaConnectVersion = &v + return s +} + +// SetLogDelivery sets the LogDelivery field's value. +func (s *DescribeConnectorOutput) SetLogDelivery(v *LogDeliveryDescription) *DescribeConnectorOutput { + s.LogDelivery = v + return s +} + +// SetPlugins sets the Plugins field's value. +func (s *DescribeConnectorOutput) SetPlugins(v []*PluginDescription) *DescribeConnectorOutput { + s.Plugins = v + return s +} + +// SetServiceExecutionRoleArn sets the ServiceExecutionRoleArn field's value. +func (s *DescribeConnectorOutput) SetServiceExecutionRoleArn(v string) *DescribeConnectorOutput { + s.ServiceExecutionRoleArn = &v + return s +} + +// SetWorkerConfiguration sets the WorkerConfiguration field's value. +func (s *DescribeConnectorOutput) SetWorkerConfiguration(v *WorkerConfigurationDescription) *DescribeConnectorOutput { + s.WorkerConfiguration = v + return s +} + +type DescribeCustomPluginInput struct { + _ struct{} `type:"structure"` + + // Returns information about a custom plugin. + // + // CustomPluginArn is a required field + CustomPluginArn *string `location:"uri" locationName:"customPluginArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeCustomPluginInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeCustomPluginInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeCustomPluginInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeCustomPluginInput"} + if s.CustomPluginArn == nil { + invalidParams.Add(request.NewErrParamRequired("CustomPluginArn")) + } + if s.CustomPluginArn != nil && len(*s.CustomPluginArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CustomPluginArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCustomPluginArn sets the CustomPluginArn field's value. +func (s *DescribeCustomPluginInput) SetCustomPluginArn(v string) *DescribeCustomPluginInput { + s.CustomPluginArn = &v + return s +} + +type DescribeCustomPluginOutput struct { + _ struct{} `type:"structure"` + + // The time that the custom plugin was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"` + + // The Amazon Resource Name (ARN) of the custom plugin. + CustomPluginArn *string `locationName:"customPluginArn" type:"string"` + + // The state of the custom plugin. + CustomPluginState *string `locationName:"customPluginState" type:"string" enum:"CustomPluginState"` + + // The description of the custom plugin. + Description *string `locationName:"description" type:"string"` + + // The latest successfully created revision of the custom plugin. If there are + // no successfully created revisions, this field will be absent. + LatestRevision *CustomPluginRevisionSummary `locationName:"latestRevision" type:"structure"` + + // The name of the custom plugin. + Name *string `locationName:"name" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeCustomPluginOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeCustomPluginOutput) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *DescribeCustomPluginOutput) SetCreationTime(v time.Time) *DescribeCustomPluginOutput { + s.CreationTime = &v + return s +} + +// SetCustomPluginArn sets the CustomPluginArn field's value. +func (s *DescribeCustomPluginOutput) SetCustomPluginArn(v string) *DescribeCustomPluginOutput { + s.CustomPluginArn = &v + return s +} + +// SetCustomPluginState sets the CustomPluginState field's value. +func (s *DescribeCustomPluginOutput) SetCustomPluginState(v string) *DescribeCustomPluginOutput { + s.CustomPluginState = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *DescribeCustomPluginOutput) SetDescription(v string) *DescribeCustomPluginOutput { + s.Description = &v + return s +} + +// SetLatestRevision sets the LatestRevision field's value. +func (s *DescribeCustomPluginOutput) SetLatestRevision(v *CustomPluginRevisionSummary) *DescribeCustomPluginOutput { + s.LatestRevision = v + return s +} + +// SetName sets the Name field's value. +func (s *DescribeCustomPluginOutput) SetName(v string) *DescribeCustomPluginOutput { + s.Name = &v + return s +} + +type DescribeWorkerConfigurationInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the worker configuration that you want + // to get information about. + // + // WorkerConfigurationArn is a required field + WorkerConfigurationArn *string `location:"uri" locationName:"workerConfigurationArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeWorkerConfigurationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeWorkerConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeWorkerConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeWorkerConfigurationInput"} + if s.WorkerConfigurationArn == nil { + invalidParams.Add(request.NewErrParamRequired("WorkerConfigurationArn")) + } + if s.WorkerConfigurationArn != nil && len(*s.WorkerConfigurationArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("WorkerConfigurationArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetWorkerConfigurationArn sets the WorkerConfigurationArn field's value. +func (s *DescribeWorkerConfigurationInput) SetWorkerConfigurationArn(v string) *DescribeWorkerConfigurationInput { + s.WorkerConfigurationArn = &v + return s +} + +type DescribeWorkerConfigurationOutput struct { + _ struct{} `type:"structure"` + + // The time that the worker configuration was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"` + + // The description of the worker configuration. + Description *string `locationName:"description" type:"string"` + + // The latest revision of the custom configuration. + LatestRevision *WorkerConfigurationRevisionDescription `locationName:"latestRevision" type:"structure"` + + // The name of the worker configuration. + Name *string `locationName:"name" type:"string"` + + // The Amazon Resource Name (ARN) of the custom configuration. + WorkerConfigurationArn *string `locationName:"workerConfigurationArn" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeWorkerConfigurationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeWorkerConfigurationOutput) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *DescribeWorkerConfigurationOutput) SetCreationTime(v time.Time) *DescribeWorkerConfigurationOutput { + s.CreationTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *DescribeWorkerConfigurationOutput) SetDescription(v string) *DescribeWorkerConfigurationOutput { + s.Description = &v + return s +} + +// SetLatestRevision sets the LatestRevision field's value. +func (s *DescribeWorkerConfigurationOutput) SetLatestRevision(v *WorkerConfigurationRevisionDescription) *DescribeWorkerConfigurationOutput { + s.LatestRevision = v + return s +} + +// SetName sets the Name field's value. +func (s *DescribeWorkerConfigurationOutput) SetName(v string) *DescribeWorkerConfigurationOutput { + s.Name = &v + return s +} + +// SetWorkerConfigurationArn sets the WorkerConfigurationArn field's value. +func (s *DescribeWorkerConfigurationOutput) SetWorkerConfigurationArn(v string) *DescribeWorkerConfigurationOutput { + s.WorkerConfigurationArn = &v + return s +} + +// The settings for delivering logs to Amazon Kinesis Data Firehose. +type FirehoseLogDelivery struct { + _ struct{} `type:"structure"` + + // The name of the Kinesis Data Firehose delivery stream that is the destination + // for log delivery. + DeliveryStream *string `locationName:"deliveryStream" type:"string"` + + // Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose. + // + // Enabled is a required field + Enabled *bool `locationName:"enabled" type:"boolean" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FirehoseLogDelivery) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FirehoseLogDelivery) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *FirehoseLogDelivery) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "FirehoseLogDelivery"} + if s.Enabled == nil { + invalidParams.Add(request.NewErrParamRequired("Enabled")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDeliveryStream sets the DeliveryStream field's value. +func (s *FirehoseLogDelivery) SetDeliveryStream(v string) *FirehoseLogDelivery { + s.DeliveryStream = &v + return s +} + +// SetEnabled sets the Enabled field's value. +func (s *FirehoseLogDelivery) SetEnabled(v bool) *FirehoseLogDelivery { + s.Enabled = &v + return s +} + +// A description of the settings for delivering logs to Amazon Kinesis Data +// Firehose. +type FirehoseLogDeliveryDescription struct { + _ struct{} `type:"structure"` + + // The name of the Kinesis Data Firehose delivery stream that is the destination + // for log delivery. + DeliveryStream *string `locationName:"deliveryStream" type:"string"` + + // Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose. + Enabled *bool `locationName:"enabled" type:"boolean"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FirehoseLogDeliveryDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FirehoseLogDeliveryDescription) GoString() string { + return s.String() +} + +// SetDeliveryStream sets the DeliveryStream field's value. +func (s *FirehoseLogDeliveryDescription) SetDeliveryStream(v string) *FirehoseLogDeliveryDescription { + s.DeliveryStream = &v + return s +} + +// SetEnabled sets the Enabled field's value. +func (s *FirehoseLogDeliveryDescription) SetEnabled(v bool) *FirehoseLogDeliveryDescription { + s.Enabled = &v + return s +} + +// HTTP Status Code 403: Access forbidden. Correct your credentials and then +// retry your request. +type ForbiddenException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ForbiddenException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ForbiddenException) GoString() string { + return s.String() +} + +func newErrorForbiddenException(v protocol.ResponseMetadata) error { + return &ForbiddenException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ForbiddenException) Code() string { + return "ForbiddenException" +} + +// Message returns the exception's message. +func (s *ForbiddenException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ForbiddenException) OrigErr() error { + return nil +} + +func (s *ForbiddenException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ForbiddenException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ForbiddenException) RequestID() string { + return s.RespMetadata.RequestID +} + +// HTTP Status Code 500: Unexpected internal server error. Retrying your request +// might resolve the issue. +type InternalServerErrorException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InternalServerErrorException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InternalServerErrorException) GoString() string { + return s.String() +} + +func newErrorInternalServerErrorException(v protocol.ResponseMetadata) error { + return &InternalServerErrorException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *InternalServerErrorException) Code() string { + return "InternalServerErrorException" +} + +// Message returns the exception's message. +func (s *InternalServerErrorException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InternalServerErrorException) OrigErr() error { + return nil +} + +func (s *InternalServerErrorException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *InternalServerErrorException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *InternalServerErrorException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The details of the Apache Kafka cluster to which the connector is connected. +type KafkaCluster struct { + _ struct{} `type:"structure"` + + // The Apache Kafka cluster to which the connector is connected. + // + // ApacheKafkaCluster is a required field + ApacheKafkaCluster *ApacheKafkaCluster `locationName:"apacheKafkaCluster" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KafkaCluster) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KafkaCluster) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *KafkaCluster) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "KafkaCluster"} + if s.ApacheKafkaCluster == nil { + invalidParams.Add(request.NewErrParamRequired("ApacheKafkaCluster")) + } + if s.ApacheKafkaCluster != nil { + if err := s.ApacheKafkaCluster.Validate(); err != nil { + invalidParams.AddNested("ApacheKafkaCluster", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApacheKafkaCluster sets the ApacheKafkaCluster field's value. +func (s *KafkaCluster) SetApacheKafkaCluster(v *ApacheKafkaCluster) *KafkaCluster { + s.ApacheKafkaCluster = v + return s +} + +// The client authentication information used in order to authenticate with +// the Apache Kafka cluster. +type KafkaClusterClientAuthentication struct { + _ struct{} `type:"structure"` + + // The type of client authentication used to connect to the Apache Kafka cluster. + // Value NONE means that no client authentication is used. + // + // AuthenticationType is a required field + AuthenticationType *string `locationName:"authenticationType" type:"string" required:"true" enum:"KafkaClusterClientAuthenticationType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KafkaClusterClientAuthentication) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KafkaClusterClientAuthentication) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *KafkaClusterClientAuthentication) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "KafkaClusterClientAuthentication"} + if s.AuthenticationType == nil { + invalidParams.Add(request.NewErrParamRequired("AuthenticationType")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAuthenticationType sets the AuthenticationType field's value. +func (s *KafkaClusterClientAuthentication) SetAuthenticationType(v string) *KafkaClusterClientAuthentication { + s.AuthenticationType = &v + return s +} + +// The client authentication information used in order to authenticate with +// the Apache Kafka cluster. +type KafkaClusterClientAuthenticationDescription struct { + _ struct{} `type:"structure"` + + // The type of client authentication used to connect to the Apache Kafka cluster. + // Value NONE means that no client authentication is used. + AuthenticationType *string `locationName:"authenticationType" type:"string" enum:"KafkaClusterClientAuthenticationType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KafkaClusterClientAuthenticationDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KafkaClusterClientAuthenticationDescription) GoString() string { + return s.String() +} + +// SetAuthenticationType sets the AuthenticationType field's value. +func (s *KafkaClusterClientAuthenticationDescription) SetAuthenticationType(v string) *KafkaClusterClientAuthenticationDescription { + s.AuthenticationType = &v + return s +} + +// Details of how to connect to the Apache Kafka cluster. +type KafkaClusterDescription struct { + _ struct{} `type:"structure"` + + // The Apache Kafka cluster to which the connector is connected. + ApacheKafkaCluster *ApacheKafkaClusterDescription `locationName:"apacheKafkaCluster" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KafkaClusterDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KafkaClusterDescription) GoString() string { + return s.String() +} + +// SetApacheKafkaCluster sets the ApacheKafkaCluster field's value. +func (s *KafkaClusterDescription) SetApacheKafkaCluster(v *ApacheKafkaClusterDescription) *KafkaClusterDescription { + s.ApacheKafkaCluster = v + return s +} + +// Details of encryption in transit to the Apache Kafka cluster. +type KafkaClusterEncryptionInTransit struct { + _ struct{} `type:"structure"` + + // The type of encryption in transit to the Apache Kafka cluster. + // + // EncryptionType is a required field + EncryptionType *string `locationName:"encryptionType" type:"string" required:"true" enum:"KafkaClusterEncryptionInTransitType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KafkaClusterEncryptionInTransit) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KafkaClusterEncryptionInTransit) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *KafkaClusterEncryptionInTransit) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "KafkaClusterEncryptionInTransit"} + if s.EncryptionType == nil { + invalidParams.Add(request.NewErrParamRequired("EncryptionType")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEncryptionType sets the EncryptionType field's value. +func (s *KafkaClusterEncryptionInTransit) SetEncryptionType(v string) *KafkaClusterEncryptionInTransit { + s.EncryptionType = &v + return s +} + +// The description of the encryption in transit to the Apache Kafka cluster. +type KafkaClusterEncryptionInTransitDescription struct { + _ struct{} `type:"structure"` + + // The type of encryption in transit to the Apache Kafka cluster. + EncryptionType *string `locationName:"encryptionType" type:"string" enum:"KafkaClusterEncryptionInTransitType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KafkaClusterEncryptionInTransitDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KafkaClusterEncryptionInTransitDescription) GoString() string { + return s.String() +} + +// SetEncryptionType sets the EncryptionType field's value. +func (s *KafkaClusterEncryptionInTransitDescription) SetEncryptionType(v string) *KafkaClusterEncryptionInTransitDescription { + s.EncryptionType = &v + return s +} + +type ListConnectorsInput struct { + _ struct{} `type:"structure"` + + // The name prefix that you want to use to search for and list connectors. + ConnectorNamePrefix *string `location:"querystring" locationName:"connectorNamePrefix" type:"string"` + + // The maximum number of connectors to list in one response. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // If the response of a ListConnectors operation is truncated, it will include + // a NextToken. Send this NextToken in a subsequent request to continue listing + // from where the previous operation left off. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListConnectorsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListConnectorsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListConnectorsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListConnectorsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetConnectorNamePrefix sets the ConnectorNamePrefix field's value. +func (s *ListConnectorsInput) SetConnectorNamePrefix(v string) *ListConnectorsInput { + s.ConnectorNamePrefix = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListConnectorsInput) SetMaxResults(v int64) *ListConnectorsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListConnectorsInput) SetNextToken(v string) *ListConnectorsInput { + s.NextToken = &v + return s +} + +type ListConnectorsOutput struct { + _ struct{} `type:"structure"` + + // An array of connector descriptions. + Connectors []*ConnectorSummary `locationName:"connectors" type:"list"` + + // If the response of a ListConnectors operation is truncated, it will include + // a NextToken. Send this NextToken in a subsequent request to continue listing + // from where it left off. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListConnectorsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListConnectorsOutput) GoString() string { + return s.String() +} + +// SetConnectors sets the Connectors field's value. +func (s *ListConnectorsOutput) SetConnectors(v []*ConnectorSummary) *ListConnectorsOutput { + s.Connectors = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListConnectorsOutput) SetNextToken(v string) *ListConnectorsOutput { + s.NextToken = &v + return s +} + +type ListCustomPluginsInput struct { + _ struct{} `type:"structure"` + + // The maximum number of custom plugins to list in one response. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // If the response of a ListCustomPlugins operation is truncated, it will include + // a NextToken. Send this NextToken in a subsequent request to continue listing + // from where the previous operation left off. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListCustomPluginsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListCustomPluginsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListCustomPluginsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListCustomPluginsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListCustomPluginsInput) SetMaxResults(v int64) *ListCustomPluginsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListCustomPluginsInput) SetNextToken(v string) *ListCustomPluginsInput { + s.NextToken = &v + return s +} + +type ListCustomPluginsOutput struct { + _ struct{} `type:"structure"` + + // An array of custom plugin descriptions. + CustomPlugins []*CustomPluginSummary `locationName:"customPlugins" type:"list"` + + // If the response of a ListCustomPlugins operation is truncated, it will include + // a NextToken. Send this NextToken in a subsequent request to continue listing + // from where the previous operation left off. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListCustomPluginsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListCustomPluginsOutput) GoString() string { + return s.String() +} + +// SetCustomPlugins sets the CustomPlugins field's value. +func (s *ListCustomPluginsOutput) SetCustomPlugins(v []*CustomPluginSummary) *ListCustomPluginsOutput { + s.CustomPlugins = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListCustomPluginsOutput) SetNextToken(v string) *ListCustomPluginsOutput { + s.NextToken = &v + return s +} + +type ListWorkerConfigurationsInput struct { + _ struct{} `type:"structure"` + + // The maximum number of worker configurations to list in one response. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // If the response of a ListWorkerConfigurations operation is truncated, it + // will include a NextToken. Send this NextToken in a subsequent request to + // continue listing from where the previous operation left off. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListWorkerConfigurationsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListWorkerConfigurationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListWorkerConfigurationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListWorkerConfigurationsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListWorkerConfigurationsInput) SetMaxResults(v int64) *ListWorkerConfigurationsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListWorkerConfigurationsInput) SetNextToken(v string) *ListWorkerConfigurationsInput { + s.NextToken = &v + return s +} + +type ListWorkerConfigurationsOutput struct { + _ struct{} `type:"structure"` + + // If the response of a ListWorkerConfigurations operation is truncated, it + // will include a NextToken. Send this NextToken in a subsequent request to + // continue listing from where the previous operation left off. + NextToken *string `locationName:"nextToken" type:"string"` + + // An array of worker configuration descriptions. + WorkerConfigurations []*WorkerConfigurationSummary `locationName:"workerConfigurations" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListWorkerConfigurationsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListWorkerConfigurationsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListWorkerConfigurationsOutput) SetNextToken(v string) *ListWorkerConfigurationsOutput { + s.NextToken = &v + return s +} + +// SetWorkerConfigurations sets the WorkerConfigurations field's value. +func (s *ListWorkerConfigurationsOutput) SetWorkerConfigurations(v []*WorkerConfigurationSummary) *ListWorkerConfigurationsOutput { + s.WorkerConfigurations = v + return s +} + +// Details about log delivery. +type LogDelivery struct { + _ struct{} `type:"structure"` + + // The workers can send worker logs to different destination types. This configuration + // specifies the details of these destinations. + // + // WorkerLogDelivery is a required field + WorkerLogDelivery *WorkerLogDelivery `locationName:"workerLogDelivery" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LogDelivery) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LogDelivery) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *LogDelivery) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "LogDelivery"} + if s.WorkerLogDelivery == nil { + invalidParams.Add(request.NewErrParamRequired("WorkerLogDelivery")) + } + if s.WorkerLogDelivery != nil { + if err := s.WorkerLogDelivery.Validate(); err != nil { + invalidParams.AddNested("WorkerLogDelivery", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetWorkerLogDelivery sets the WorkerLogDelivery field's value. +func (s *LogDelivery) SetWorkerLogDelivery(v *WorkerLogDelivery) *LogDelivery { + s.WorkerLogDelivery = v + return s +} + +// The description of the log delivery settings. +type LogDeliveryDescription struct { + _ struct{} `type:"structure"` + + // The workers can send worker logs to different destination types. This configuration + // specifies the details of these destinations. + WorkerLogDelivery *WorkerLogDeliveryDescription `locationName:"workerLogDelivery" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LogDeliveryDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LogDeliveryDescription) GoString() string { + return s.String() +} + +// SetWorkerLogDelivery sets the WorkerLogDelivery field's value. +func (s *LogDeliveryDescription) SetWorkerLogDelivery(v *WorkerLogDeliveryDescription) *LogDeliveryDescription { + s.WorkerLogDelivery = v + return s +} + +// HTTP Status Code 404: Resource not found due to incorrect input. Correct +// your request and then retry it. +type NotFoundException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NotFoundException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NotFoundException) GoString() string { + return s.String() +} + +func newErrorNotFoundException(v protocol.ResponseMetadata) error { + return &NotFoundException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *NotFoundException) Code() string { + return "NotFoundException" +} + +// Message returns the exception's message. +func (s *NotFoundException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *NotFoundException) OrigErr() error { + return nil +} + +func (s *NotFoundException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *NotFoundException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *NotFoundException) RequestID() string { + return s.RespMetadata.RequestID +} + +// A plugin is an AWS resource that contains the code that defines your connector +// logic. +type Plugin struct { + _ struct{} `type:"structure"` + + // Details about a custom plugin. + // + // CustomPlugin is a required field + CustomPlugin *CustomPlugin `locationName:"customPlugin" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Plugin) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Plugin) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Plugin) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Plugin"} + if s.CustomPlugin == nil { + invalidParams.Add(request.NewErrParamRequired("CustomPlugin")) + } + if s.CustomPlugin != nil { + if err := s.CustomPlugin.Validate(); err != nil { + invalidParams.AddNested("CustomPlugin", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCustomPlugin sets the CustomPlugin field's value. +func (s *Plugin) SetCustomPlugin(v *CustomPlugin) *Plugin { + s.CustomPlugin = v + return s +} + +// The description of the plugin. +type PluginDescription struct { + _ struct{} `type:"structure"` + + // Details about a custom plugin. + CustomPlugin *CustomPluginDescription `locationName:"customPlugin" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PluginDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PluginDescription) GoString() string { + return s.String() +} + +// SetCustomPlugin sets the CustomPlugin field's value. +func (s *PluginDescription) SetCustomPlugin(v *CustomPluginDescription) *PluginDescription { + s.CustomPlugin = v + return s +} + +// Details about a connector's provisioned capacity. +type ProvisionedCapacity struct { + _ struct{} `type:"structure"` + + // The number of microcontroller units (MCUs) allocated to each connector worker. + // The valid values are 1,2,4,8. + // + // McuCount is a required field + McuCount *int64 `locationName:"mcuCount" min:"1" type:"integer" required:"true"` + + // The number of workers that are allocated to the connector. + // + // WorkerCount is a required field + WorkerCount *int64 `locationName:"workerCount" min:"1" type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ProvisionedCapacity) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ProvisionedCapacity) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ProvisionedCapacity) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ProvisionedCapacity"} + if s.McuCount == nil { + invalidParams.Add(request.NewErrParamRequired("McuCount")) + } + if s.McuCount != nil && *s.McuCount < 1 { + invalidParams.Add(request.NewErrParamMinValue("McuCount", 1)) + } + if s.WorkerCount == nil { + invalidParams.Add(request.NewErrParamRequired("WorkerCount")) + } + if s.WorkerCount != nil && *s.WorkerCount < 1 { + invalidParams.Add(request.NewErrParamMinValue("WorkerCount", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMcuCount sets the McuCount field's value. +func (s *ProvisionedCapacity) SetMcuCount(v int64) *ProvisionedCapacity { + s.McuCount = &v + return s +} + +// SetWorkerCount sets the WorkerCount field's value. +func (s *ProvisionedCapacity) SetWorkerCount(v int64) *ProvisionedCapacity { + s.WorkerCount = &v + return s +} + +// The description of a connector's provisioned capacity. +type ProvisionedCapacityDescription struct { + _ struct{} `type:"structure"` + + // The number of microcontroller units (MCUs) allocated to each connector worker. + // The valid values are 1,2,4,8. + McuCount *int64 `locationName:"mcuCount" type:"integer"` + + // The number of workers that are allocated to the connector. + WorkerCount *int64 `locationName:"workerCount" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ProvisionedCapacityDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ProvisionedCapacityDescription) GoString() string { + return s.String() +} + +// SetMcuCount sets the McuCount field's value. +func (s *ProvisionedCapacityDescription) SetMcuCount(v int64) *ProvisionedCapacityDescription { + s.McuCount = &v + return s +} + +// SetWorkerCount sets the WorkerCount field's value. +func (s *ProvisionedCapacityDescription) SetWorkerCount(v int64) *ProvisionedCapacityDescription { + s.WorkerCount = &v + return s +} + +// An update to a connector's fixed capacity. +type ProvisionedCapacityUpdate struct { + _ struct{} `type:"structure"` + + // The number of microcontroller units (MCUs) allocated to each connector worker. + // The valid values are 1,2,4,8. + // + // McuCount is a required field + McuCount *int64 `locationName:"mcuCount" min:"1" type:"integer" required:"true"` + + // The number of workers that are allocated to the connector. + // + // WorkerCount is a required field + WorkerCount *int64 `locationName:"workerCount" min:"1" type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ProvisionedCapacityUpdate) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ProvisionedCapacityUpdate) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ProvisionedCapacityUpdate) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ProvisionedCapacityUpdate"} + if s.McuCount == nil { + invalidParams.Add(request.NewErrParamRequired("McuCount")) + } + if s.McuCount != nil && *s.McuCount < 1 { + invalidParams.Add(request.NewErrParamMinValue("McuCount", 1)) + } + if s.WorkerCount == nil { + invalidParams.Add(request.NewErrParamRequired("WorkerCount")) + } + if s.WorkerCount != nil && *s.WorkerCount < 1 { + invalidParams.Add(request.NewErrParamMinValue("WorkerCount", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMcuCount sets the McuCount field's value. +func (s *ProvisionedCapacityUpdate) SetMcuCount(v int64) *ProvisionedCapacityUpdate { + s.McuCount = &v + return s +} + +// SetWorkerCount sets the WorkerCount field's value. +func (s *ProvisionedCapacityUpdate) SetWorkerCount(v int64) *ProvisionedCapacityUpdate { + s.WorkerCount = &v + return s +} + +// The location of an object in Amazon S3. +type S3Location struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of an S3 bucket. + // + // BucketArn is a required field + BucketArn *string `locationName:"bucketArn" type:"string" required:"true"` + + // The file key for an object in an S3 bucket. + // + // FileKey is a required field + FileKey *string `locationName:"fileKey" type:"string" required:"true"` + + // The version of an object in an S3 bucket. + ObjectVersion *string `locationName:"objectVersion" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3Location) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3Location) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *S3Location) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "S3Location"} + if s.BucketArn == nil { + invalidParams.Add(request.NewErrParamRequired("BucketArn")) + } + if s.FileKey == nil { + invalidParams.Add(request.NewErrParamRequired("FileKey")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBucketArn sets the BucketArn field's value. +func (s *S3Location) SetBucketArn(v string) *S3Location { + s.BucketArn = &v + return s +} + +// SetFileKey sets the FileKey field's value. +func (s *S3Location) SetFileKey(v string) *S3Location { + s.FileKey = &v + return s +} + +// SetObjectVersion sets the ObjectVersion field's value. +func (s *S3Location) SetObjectVersion(v string) *S3Location { + s.ObjectVersion = &v + return s +} + +// The description of the location of an object in Amazon S3. +type S3LocationDescription struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of an S3 bucket. + BucketArn *string `locationName:"bucketArn" type:"string"` + + // The file key for an object in an S3 bucket. + FileKey *string `locationName:"fileKey" type:"string"` + + // The version of an object in an S3 bucket. + ObjectVersion *string `locationName:"objectVersion" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3LocationDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3LocationDescription) GoString() string { + return s.String() +} + +// SetBucketArn sets the BucketArn field's value. +func (s *S3LocationDescription) SetBucketArn(v string) *S3LocationDescription { + s.BucketArn = &v + return s +} + +// SetFileKey sets the FileKey field's value. +func (s *S3LocationDescription) SetFileKey(v string) *S3LocationDescription { + s.FileKey = &v + return s +} + +// SetObjectVersion sets the ObjectVersion field's value. +func (s *S3LocationDescription) SetObjectVersion(v string) *S3LocationDescription { + s.ObjectVersion = &v + return s +} + +// Details about delivering logs to Amazon S3. +type S3LogDelivery struct { + _ struct{} `type:"structure"` + + // The name of the S3 bucket that is the destination for log delivery. + Bucket *string `locationName:"bucket" type:"string"` + + // Specifies whether connector logs get sent to the specified Amazon S3 destination. + // + // Enabled is a required field + Enabled *bool `locationName:"enabled" type:"boolean" required:"true"` + + // The S3 prefix that is the destination for log delivery. + Prefix *string `locationName:"prefix" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3LogDelivery) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3LogDelivery) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *S3LogDelivery) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "S3LogDelivery"} + if s.Enabled == nil { + invalidParams.Add(request.NewErrParamRequired("Enabled")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBucket sets the Bucket field's value. +func (s *S3LogDelivery) SetBucket(v string) *S3LogDelivery { + s.Bucket = &v + return s +} + +// SetEnabled sets the Enabled field's value. +func (s *S3LogDelivery) SetEnabled(v bool) *S3LogDelivery { + s.Enabled = &v + return s +} + +// SetPrefix sets the Prefix field's value. +func (s *S3LogDelivery) SetPrefix(v string) *S3LogDelivery { + s.Prefix = &v + return s +} + +// The description of the details about delivering logs to Amazon S3. +type S3LogDeliveryDescription struct { + _ struct{} `type:"structure"` + + // The name of the S3 bucket that is the destination for log delivery. + Bucket *string `locationName:"bucket" type:"string"` + + // Specifies whether connector logs get sent to the specified Amazon S3 destination. + Enabled *bool `locationName:"enabled" type:"boolean"` + + // The S3 prefix that is the destination for log delivery. + Prefix *string `locationName:"prefix" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3LogDeliveryDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3LogDeliveryDescription) GoString() string { + return s.String() +} + +// SetBucket sets the Bucket field's value. +func (s *S3LogDeliveryDescription) SetBucket(v string) *S3LogDeliveryDescription { + s.Bucket = &v + return s +} + +// SetEnabled sets the Enabled field's value. +func (s *S3LogDeliveryDescription) SetEnabled(v bool) *S3LogDeliveryDescription { + s.Enabled = &v + return s +} + +// SetPrefix sets the Prefix field's value. +func (s *S3LogDeliveryDescription) SetPrefix(v string) *S3LogDeliveryDescription { + s.Prefix = &v + return s +} + +// The scale-in policy for the connector. +type ScaleInPolicy struct { + _ struct{} `type:"structure"` + + // Specifies the CPU utilization percentage threshold at which you want connector + // scale in to be triggered. + // + // CpuUtilizationPercentage is a required field + CpuUtilizationPercentage *int64 `locationName:"cpuUtilizationPercentage" min:"1" type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ScaleInPolicy) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ScaleInPolicy) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ScaleInPolicy) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ScaleInPolicy"} + if s.CpuUtilizationPercentage == nil { + invalidParams.Add(request.NewErrParamRequired("CpuUtilizationPercentage")) + } + if s.CpuUtilizationPercentage != nil && *s.CpuUtilizationPercentage < 1 { + invalidParams.Add(request.NewErrParamMinValue("CpuUtilizationPercentage", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCpuUtilizationPercentage sets the CpuUtilizationPercentage field's value. +func (s *ScaleInPolicy) SetCpuUtilizationPercentage(v int64) *ScaleInPolicy { + s.CpuUtilizationPercentage = &v + return s +} + +// The description of the scale-in policy for the connector. +type ScaleInPolicyDescription struct { + _ struct{} `type:"structure"` + + // Specifies the CPU utilization percentage threshold at which you want connector + // scale in to be triggered. + CpuUtilizationPercentage *int64 `locationName:"cpuUtilizationPercentage" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ScaleInPolicyDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ScaleInPolicyDescription) GoString() string { + return s.String() +} + +// SetCpuUtilizationPercentage sets the CpuUtilizationPercentage field's value. +func (s *ScaleInPolicyDescription) SetCpuUtilizationPercentage(v int64) *ScaleInPolicyDescription { + s.CpuUtilizationPercentage = &v + return s +} + +// An update to the connector's scale-in policy. +type ScaleInPolicyUpdate struct { + _ struct{} `type:"structure"` + + // The target CPU utilization percentage threshold at which you want connector + // scale in to be triggered. + // + // CpuUtilizationPercentage is a required field + CpuUtilizationPercentage *int64 `locationName:"cpuUtilizationPercentage" min:"1" type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ScaleInPolicyUpdate) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ScaleInPolicyUpdate) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ScaleInPolicyUpdate) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ScaleInPolicyUpdate"} + if s.CpuUtilizationPercentage == nil { + invalidParams.Add(request.NewErrParamRequired("CpuUtilizationPercentage")) + } + if s.CpuUtilizationPercentage != nil && *s.CpuUtilizationPercentage < 1 { + invalidParams.Add(request.NewErrParamMinValue("CpuUtilizationPercentage", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCpuUtilizationPercentage sets the CpuUtilizationPercentage field's value. +func (s *ScaleInPolicyUpdate) SetCpuUtilizationPercentage(v int64) *ScaleInPolicyUpdate { + s.CpuUtilizationPercentage = &v + return s +} + +// The scale-out policy for the connector. +type ScaleOutPolicy struct { + _ struct{} `type:"structure"` + + // The CPU utilization percentage threshold at which you want connector scale + // out to be triggered. + // + // CpuUtilizationPercentage is a required field + CpuUtilizationPercentage *int64 `locationName:"cpuUtilizationPercentage" min:"1" type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ScaleOutPolicy) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ScaleOutPolicy) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ScaleOutPolicy) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ScaleOutPolicy"} + if s.CpuUtilizationPercentage == nil { + invalidParams.Add(request.NewErrParamRequired("CpuUtilizationPercentage")) + } + if s.CpuUtilizationPercentage != nil && *s.CpuUtilizationPercentage < 1 { + invalidParams.Add(request.NewErrParamMinValue("CpuUtilizationPercentage", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCpuUtilizationPercentage sets the CpuUtilizationPercentage field's value. +func (s *ScaleOutPolicy) SetCpuUtilizationPercentage(v int64) *ScaleOutPolicy { + s.CpuUtilizationPercentage = &v + return s +} + +// The description of the scale-out policy for the connector. +type ScaleOutPolicyDescription struct { + _ struct{} `type:"structure"` + + // The CPU utilization percentage threshold at which you want connector scale + // out to be triggered. + CpuUtilizationPercentage *int64 `locationName:"cpuUtilizationPercentage" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ScaleOutPolicyDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ScaleOutPolicyDescription) GoString() string { + return s.String() +} + +// SetCpuUtilizationPercentage sets the CpuUtilizationPercentage field's value. +func (s *ScaleOutPolicyDescription) SetCpuUtilizationPercentage(v int64) *ScaleOutPolicyDescription { + s.CpuUtilizationPercentage = &v + return s +} + +// An update to the connector's scale-out policy. +type ScaleOutPolicyUpdate struct { + _ struct{} `type:"structure"` + + // The target CPU utilization percentage threshold at which you want connector + // scale out to be triggered. + // + // CpuUtilizationPercentage is a required field + CpuUtilizationPercentage *int64 `locationName:"cpuUtilizationPercentage" min:"1" type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ScaleOutPolicyUpdate) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ScaleOutPolicyUpdate) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ScaleOutPolicyUpdate) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ScaleOutPolicyUpdate"} + if s.CpuUtilizationPercentage == nil { + invalidParams.Add(request.NewErrParamRequired("CpuUtilizationPercentage")) + } + if s.CpuUtilizationPercentage != nil && *s.CpuUtilizationPercentage < 1 { + invalidParams.Add(request.NewErrParamMinValue("CpuUtilizationPercentage", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCpuUtilizationPercentage sets the CpuUtilizationPercentage field's value. +func (s *ScaleOutPolicyUpdate) SetCpuUtilizationPercentage(v int64) *ScaleOutPolicyUpdate { + s.CpuUtilizationPercentage = &v + return s +} + +// HTTP Status Code 503: Service Unavailable. Retrying your request in some +// time might resolve the issue. +type ServiceUnavailableException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceUnavailableException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceUnavailableException) GoString() string { + return s.String() +} + +func newErrorServiceUnavailableException(v protocol.ResponseMetadata) error { + return &ServiceUnavailableException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ServiceUnavailableException) Code() string { + return "ServiceUnavailableException" +} + +// Message returns the exception's message. +func (s *ServiceUnavailableException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ServiceUnavailableException) OrigErr() error { + return nil +} + +func (s *ServiceUnavailableException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ServiceUnavailableException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ServiceUnavailableException) RequestID() string { + return s.RespMetadata.RequestID +} + +// HTTP Status Code 429: Limit exceeded. Resource limit reached. +type TooManyRequestsException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TooManyRequestsException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TooManyRequestsException) GoString() string { + return s.String() +} + +func newErrorTooManyRequestsException(v protocol.ResponseMetadata) error { + return &TooManyRequestsException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *TooManyRequestsException) Code() string { + return "TooManyRequestsException" +} + +// Message returns the exception's message. +func (s *TooManyRequestsException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *TooManyRequestsException) OrigErr() error { + return nil +} + +func (s *TooManyRequestsException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *TooManyRequestsException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *TooManyRequestsException) RequestID() string { + return s.RespMetadata.RequestID +} + +// HTTP Status Code 401: Unauthorized request. The provided credentials couldn't +// be validated. +type UnauthorizedException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UnauthorizedException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UnauthorizedException) GoString() string { + return s.String() +} + +func newErrorUnauthorizedException(v protocol.ResponseMetadata) error { + return &UnauthorizedException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *UnauthorizedException) Code() string { + return "UnauthorizedException" +} + +// Message returns the exception's message. +func (s *UnauthorizedException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *UnauthorizedException) OrigErr() error { + return nil +} + +func (s *UnauthorizedException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *UnauthorizedException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *UnauthorizedException) RequestID() string { + return s.RespMetadata.RequestID +} + +type UpdateConnectorInput struct { + _ struct{} `type:"structure"` + + // The target capacity. + // + // Capacity is a required field + Capacity *CapacityUpdate `locationName:"capacity" type:"structure" required:"true"` + + // The Amazon Resource Name (ARN) of the connector that you want to update. + // + // ConnectorArn is a required field + ConnectorArn *string `location:"uri" locationName:"connectorArn" type:"string" required:"true"` + + // The current version of the connector that you want to update. + // + // CurrentVersion is a required field + CurrentVersion *string `location:"querystring" locationName:"currentVersion" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateConnectorInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateConnectorInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateConnectorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateConnectorInput"} + if s.Capacity == nil { + invalidParams.Add(request.NewErrParamRequired("Capacity")) + } + if s.ConnectorArn == nil { + invalidParams.Add(request.NewErrParamRequired("ConnectorArn")) + } + if s.ConnectorArn != nil && len(*s.ConnectorArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ConnectorArn", 1)) + } + if s.CurrentVersion == nil { + invalidParams.Add(request.NewErrParamRequired("CurrentVersion")) + } + if s.Capacity != nil { + if err := s.Capacity.Validate(); err != nil { + invalidParams.AddNested("Capacity", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCapacity sets the Capacity field's value. +func (s *UpdateConnectorInput) SetCapacity(v *CapacityUpdate) *UpdateConnectorInput { + s.Capacity = v + return s +} + +// SetConnectorArn sets the ConnectorArn field's value. +func (s *UpdateConnectorInput) SetConnectorArn(v string) *UpdateConnectorInput { + s.ConnectorArn = &v + return s +} + +// SetCurrentVersion sets the CurrentVersion field's value. +func (s *UpdateConnectorInput) SetCurrentVersion(v string) *UpdateConnectorInput { + s.CurrentVersion = &v + return s +} + +type UpdateConnectorOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the connector. + ConnectorArn *string `locationName:"connectorArn" type:"string"` + + // The state of the connector. + ConnectorState *string `locationName:"connectorState" type:"string" enum:"ConnectorState"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateConnectorOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateConnectorOutput) GoString() string { + return s.String() +} + +// SetConnectorArn sets the ConnectorArn field's value. +func (s *UpdateConnectorOutput) SetConnectorArn(v string) *UpdateConnectorOutput { + s.ConnectorArn = &v + return s +} + +// SetConnectorState sets the ConnectorState field's value. +func (s *UpdateConnectorOutput) SetConnectorState(v string) *UpdateConnectorOutput { + s.ConnectorState = &v + return s +} + +// Information about the VPC in which the connector resides. +type Vpc struct { + _ struct{} `type:"structure"` + + // The security groups for the connector. + SecurityGroups []*string `locationName:"securityGroups" type:"list"` + + // The subnets for the connector. + // + // Subnets is a required field + Subnets []*string `locationName:"subnets" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Vpc) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Vpc) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Vpc) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Vpc"} + if s.Subnets == nil { + invalidParams.Add(request.NewErrParamRequired("Subnets")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetSecurityGroups sets the SecurityGroups field's value. +func (s *Vpc) SetSecurityGroups(v []*string) *Vpc { + s.SecurityGroups = v + return s +} + +// SetSubnets sets the Subnets field's value. +func (s *Vpc) SetSubnets(v []*string) *Vpc { + s.Subnets = v + return s +} + +// The description of the VPC in which the connector resides. +type VpcDescription struct { + _ struct{} `type:"structure"` + + // The security groups for the connector. + SecurityGroups []*string `locationName:"securityGroups" type:"list"` + + // The subnets for the connector. + Subnets []*string `locationName:"subnets" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VpcDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VpcDescription) GoString() string { + return s.String() +} + +// SetSecurityGroups sets the SecurityGroups field's value. +func (s *VpcDescription) SetSecurityGroups(v []*string) *VpcDescription { + s.SecurityGroups = v + return s +} + +// SetSubnets sets the Subnets field's value. +func (s *VpcDescription) SetSubnets(v []*string) *VpcDescription { + s.Subnets = v + return s +} + +// The configuration of the workers, which are the processes that run the connector +// logic. +type WorkerConfiguration struct { + _ struct{} `type:"structure"` + + // The revision of the worker configuration. + // + // Revision is a required field + Revision *int64 `locationName:"revision" min:"1" type:"long" required:"true"` + + // The Amazon Resource Name (ARN) of the worker configuration. + // + // WorkerConfigurationArn is a required field + WorkerConfigurationArn *string `locationName:"workerConfigurationArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WorkerConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WorkerConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *WorkerConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "WorkerConfiguration"} + if s.Revision == nil { + invalidParams.Add(request.NewErrParamRequired("Revision")) + } + if s.Revision != nil && *s.Revision < 1 { + invalidParams.Add(request.NewErrParamMinValue("Revision", 1)) + } + if s.WorkerConfigurationArn == nil { + invalidParams.Add(request.NewErrParamRequired("WorkerConfigurationArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetRevision sets the Revision field's value. +func (s *WorkerConfiguration) SetRevision(v int64) *WorkerConfiguration { + s.Revision = &v + return s +} + +// SetWorkerConfigurationArn sets the WorkerConfigurationArn field's value. +func (s *WorkerConfiguration) SetWorkerConfigurationArn(v string) *WorkerConfiguration { + s.WorkerConfigurationArn = &v + return s +} + +// The description of the worker configuration. +type WorkerConfigurationDescription struct { + _ struct{} `type:"structure"` + + // The revision of the worker configuration. + Revision *int64 `locationName:"revision" type:"long"` + + // The Amazon Resource Name (ARN) of the worker configuration. + WorkerConfigurationArn *string `locationName:"workerConfigurationArn" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WorkerConfigurationDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WorkerConfigurationDescription) GoString() string { + return s.String() +} + +// SetRevision sets the Revision field's value. +func (s *WorkerConfigurationDescription) SetRevision(v int64) *WorkerConfigurationDescription { + s.Revision = &v + return s +} + +// SetWorkerConfigurationArn sets the WorkerConfigurationArn field's value. +func (s *WorkerConfigurationDescription) SetWorkerConfigurationArn(v string) *WorkerConfigurationDescription { + s.WorkerConfigurationArn = &v + return s +} + +// The description of the worker configuration revision. +type WorkerConfigurationRevisionDescription struct { + _ struct{} `type:"structure"` + + // The time that the worker configuration was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"` + + // The description of the worker configuration revision. + Description *string `locationName:"description" type:"string"` + + // Base64 encoded contents of the connect-distributed.properties file. + PropertiesFileContent *string `locationName:"propertiesFileContent" type:"string"` + + // The description of a revision of the worker configuration. + Revision *int64 `locationName:"revision" type:"long"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WorkerConfigurationRevisionDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WorkerConfigurationRevisionDescription) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *WorkerConfigurationRevisionDescription) SetCreationTime(v time.Time) *WorkerConfigurationRevisionDescription { + s.CreationTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *WorkerConfigurationRevisionDescription) SetDescription(v string) *WorkerConfigurationRevisionDescription { + s.Description = &v + return s +} + +// SetPropertiesFileContent sets the PropertiesFileContent field's value. +func (s *WorkerConfigurationRevisionDescription) SetPropertiesFileContent(v string) *WorkerConfigurationRevisionDescription { + s.PropertiesFileContent = &v + return s +} + +// SetRevision sets the Revision field's value. +func (s *WorkerConfigurationRevisionDescription) SetRevision(v int64) *WorkerConfigurationRevisionDescription { + s.Revision = &v + return s +} + +// The summary of a worker configuration revision. +type WorkerConfigurationRevisionSummary struct { + _ struct{} `type:"structure"` + + // The time that a worker configuration revision was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"` + + // The description of a worker configuration revision. + Description *string `locationName:"description" type:"string"` + + // The revision of a worker configuration. + Revision *int64 `locationName:"revision" type:"long"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WorkerConfigurationRevisionSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WorkerConfigurationRevisionSummary) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *WorkerConfigurationRevisionSummary) SetCreationTime(v time.Time) *WorkerConfigurationRevisionSummary { + s.CreationTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *WorkerConfigurationRevisionSummary) SetDescription(v string) *WorkerConfigurationRevisionSummary { + s.Description = &v + return s +} + +// SetRevision sets the Revision field's value. +func (s *WorkerConfigurationRevisionSummary) SetRevision(v int64) *WorkerConfigurationRevisionSummary { + s.Revision = &v + return s +} + +// The summary of a worker configuration. +type WorkerConfigurationSummary struct { + _ struct{} `type:"structure"` + + // The time that a worker configuration was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"` + + // The description of a worker configuration. + Description *string `locationName:"description" type:"string"` + + // The latest revision of a worker configuration. + LatestRevision *WorkerConfigurationRevisionSummary `locationName:"latestRevision" type:"structure"` + + // The name of the worker configuration. + Name *string `locationName:"name" type:"string"` + + // The Amazon Resource Name (ARN) of the worker configuration. + WorkerConfigurationArn *string `locationName:"workerConfigurationArn" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WorkerConfigurationSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WorkerConfigurationSummary) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *WorkerConfigurationSummary) SetCreationTime(v time.Time) *WorkerConfigurationSummary { + s.CreationTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *WorkerConfigurationSummary) SetDescription(v string) *WorkerConfigurationSummary { + s.Description = &v + return s +} + +// SetLatestRevision sets the LatestRevision field's value. +func (s *WorkerConfigurationSummary) SetLatestRevision(v *WorkerConfigurationRevisionSummary) *WorkerConfigurationSummary { + s.LatestRevision = v + return s +} + +// SetName sets the Name field's value. +func (s *WorkerConfigurationSummary) SetName(v string) *WorkerConfigurationSummary { + s.Name = &v + return s +} + +// SetWorkerConfigurationArn sets the WorkerConfigurationArn field's value. +func (s *WorkerConfigurationSummary) SetWorkerConfigurationArn(v string) *WorkerConfigurationSummary { + s.WorkerConfigurationArn = &v + return s +} + +// Workers can send worker logs to different destination types. This configuration +// specifies the details of these destinations. +type WorkerLogDelivery struct { + _ struct{} `type:"structure"` + + // Details about delivering logs to Amazon CloudWatch Logs. + CloudWatchLogs *CloudWatchLogsLogDelivery `locationName:"cloudWatchLogs" type:"structure"` + + // Details about delivering logs to Amazon Kinesis Data Firehose. + Firehose *FirehoseLogDelivery `locationName:"firehose" type:"structure"` + + // Details about delivering logs to Amazon S3. + S3 *S3LogDelivery `locationName:"s3" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WorkerLogDelivery) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WorkerLogDelivery) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *WorkerLogDelivery) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "WorkerLogDelivery"} + if s.CloudWatchLogs != nil { + if err := s.CloudWatchLogs.Validate(); err != nil { + invalidParams.AddNested("CloudWatchLogs", err.(request.ErrInvalidParams)) + } + } + if s.Firehose != nil { + if err := s.Firehose.Validate(); err != nil { + invalidParams.AddNested("Firehose", err.(request.ErrInvalidParams)) + } + } + if s.S3 != nil { + if err := s.S3.Validate(); err != nil { + invalidParams.AddNested("S3", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCloudWatchLogs sets the CloudWatchLogs field's value. +func (s *WorkerLogDelivery) SetCloudWatchLogs(v *CloudWatchLogsLogDelivery) *WorkerLogDelivery { + s.CloudWatchLogs = v + return s +} + +// SetFirehose sets the Firehose field's value. +func (s *WorkerLogDelivery) SetFirehose(v *FirehoseLogDelivery) *WorkerLogDelivery { + s.Firehose = v + return s +} + +// SetS3 sets the S3 field's value. +func (s *WorkerLogDelivery) SetS3(v *S3LogDelivery) *WorkerLogDelivery { + s.S3 = v + return s +} + +// Workers can send worker logs to different destination types. This configuration +// specifies the details of these destinations. +type WorkerLogDeliveryDescription struct { + _ struct{} `type:"structure"` + + // Details about delivering logs to Amazon CloudWatch Logs. + CloudWatchLogs *CloudWatchLogsLogDeliveryDescription `locationName:"cloudWatchLogs" type:"structure"` + + // Details about delivering logs to Amazon Kinesis Data Firehose. + Firehose *FirehoseLogDeliveryDescription `locationName:"firehose" type:"structure"` + + // Details about delivering logs to Amazon S3. + S3 *S3LogDeliveryDescription `locationName:"s3" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WorkerLogDeliveryDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WorkerLogDeliveryDescription) GoString() string { + return s.String() +} + +// SetCloudWatchLogs sets the CloudWatchLogs field's value. +func (s *WorkerLogDeliveryDescription) SetCloudWatchLogs(v *CloudWatchLogsLogDeliveryDescription) *WorkerLogDeliveryDescription { + s.CloudWatchLogs = v + return s +} + +// SetFirehose sets the Firehose field's value. +func (s *WorkerLogDeliveryDescription) SetFirehose(v *FirehoseLogDeliveryDescription) *WorkerLogDeliveryDescription { + s.Firehose = v + return s +} + +// SetS3 sets the S3 field's value. +func (s *WorkerLogDeliveryDescription) SetS3(v *S3LogDeliveryDescription) *WorkerLogDeliveryDescription { + s.S3 = v + return s +} + +const ( + // ConnectorStateRunning is a ConnectorState enum value + ConnectorStateRunning = "RUNNING" + + // ConnectorStateCreating is a ConnectorState enum value + ConnectorStateCreating = "CREATING" + + // ConnectorStateUpdating is a ConnectorState enum value + ConnectorStateUpdating = "UPDATING" + + // ConnectorStateDeleting is a ConnectorState enum value + ConnectorStateDeleting = "DELETING" + + // ConnectorStateFailed is a ConnectorState enum value + ConnectorStateFailed = "FAILED" +) + +// ConnectorState_Values returns all elements of the ConnectorState enum +func ConnectorState_Values() []string { + return []string{ + ConnectorStateRunning, + ConnectorStateCreating, + ConnectorStateUpdating, + ConnectorStateDeleting, + ConnectorStateFailed, + } +} + +const ( + // CustomPluginContentTypeJar is a CustomPluginContentType enum value + CustomPluginContentTypeJar = "JAR" + + // CustomPluginContentTypeZip is a CustomPluginContentType enum value + CustomPluginContentTypeZip = "ZIP" +) + +// CustomPluginContentType_Values returns all elements of the CustomPluginContentType enum +func CustomPluginContentType_Values() []string { + return []string{ + CustomPluginContentTypeJar, + CustomPluginContentTypeZip, + } +} + +const ( + // CustomPluginStateCreating is a CustomPluginState enum value + CustomPluginStateCreating = "CREATING" + + // CustomPluginStateCreateFailed is a CustomPluginState enum value + CustomPluginStateCreateFailed = "CREATE_FAILED" + + // CustomPluginStateActive is a CustomPluginState enum value + CustomPluginStateActive = "ACTIVE" + + // CustomPluginStateUpdating is a CustomPluginState enum value + CustomPluginStateUpdating = "UPDATING" + + // CustomPluginStateUpdateFailed is a CustomPluginState enum value + CustomPluginStateUpdateFailed = "UPDATE_FAILED" + + // CustomPluginStateDeleting is a CustomPluginState enum value + CustomPluginStateDeleting = "DELETING" +) + +// CustomPluginState_Values returns all elements of the CustomPluginState enum +func CustomPluginState_Values() []string { + return []string{ + CustomPluginStateCreating, + CustomPluginStateCreateFailed, + CustomPluginStateActive, + CustomPluginStateUpdating, + CustomPluginStateUpdateFailed, + CustomPluginStateDeleting, + } +} + +const ( + // KafkaClusterClientAuthenticationTypeNone is a KafkaClusterClientAuthenticationType enum value + KafkaClusterClientAuthenticationTypeNone = "NONE" + + // KafkaClusterClientAuthenticationTypeIam is a KafkaClusterClientAuthenticationType enum value + KafkaClusterClientAuthenticationTypeIam = "IAM" +) + +// KafkaClusterClientAuthenticationType_Values returns all elements of the KafkaClusterClientAuthenticationType enum +func KafkaClusterClientAuthenticationType_Values() []string { + return []string{ + KafkaClusterClientAuthenticationTypeNone, + KafkaClusterClientAuthenticationTypeIam, + } +} + +const ( + // KafkaClusterEncryptionInTransitTypePlaintext is a KafkaClusterEncryptionInTransitType enum value + KafkaClusterEncryptionInTransitTypePlaintext = "PLAINTEXT" + + // KafkaClusterEncryptionInTransitTypeTls is a KafkaClusterEncryptionInTransitType enum value + KafkaClusterEncryptionInTransitTypeTls = "TLS" +) + +// KafkaClusterEncryptionInTransitType_Values returns all elements of the KafkaClusterEncryptionInTransitType enum +func KafkaClusterEncryptionInTransitType_Values() []string { + return []string{ + KafkaClusterEncryptionInTransitTypePlaintext, + KafkaClusterEncryptionInTransitTypeTls, + } +} diff --git a/service/kafkaconnect/doc.go b/service/kafkaconnect/doc.go new file mode 100644 index 00000000000..ac5508355c1 --- /dev/null +++ b/service/kafkaconnect/doc.go @@ -0,0 +1,26 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package kafkaconnect provides the client and types for making API +// requests to Managed Streaming for Kafka Connect. +// +// See https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14 for more information on this service. +// +// See kafkaconnect package documentation for more information. +// https://docs.aws.amazon.com/sdk-for-go/api/service/kafkaconnect/ +// +// Using the Client +// +// To contact Managed Streaming for Kafka Connect with the SDK use the New function to create +// a new service client. With that client you can make API requests to the service. +// These clients are safe to use concurrently. +// +// See the SDK's documentation for more information on how to use the SDK. +// https://docs.aws.amazon.com/sdk-for-go/api/ +// +// See aws.Config documentation for more information on configuring SDK clients. +// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config +// +// See the Managed Streaming for Kafka Connect client KafkaConnect for more +// information on creating client for this service. +// https://docs.aws.amazon.com/sdk-for-go/api/service/kafkaconnect/#New +package kafkaconnect diff --git a/service/kafkaconnect/errors.go b/service/kafkaconnect/errors.go new file mode 100644 index 00000000000..332413a19e0 --- /dev/null +++ b/service/kafkaconnect/errors.go @@ -0,0 +1,76 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package kafkaconnect + +import ( + "github.com/aws/aws-sdk-go/private/protocol" +) + +const ( + + // ErrCodeBadRequestException for service response error code + // "BadRequestException". + // + // HTTP Status Code 400: Bad request due to incorrect input. Correct your request + // and then retry it. + ErrCodeBadRequestException = "BadRequestException" + + // ErrCodeConflictException for service response error code + // "ConflictException". + // + // HTTP Status Code 409: Conflict. A resource with this name already exists. + // Retry your request with another name. + ErrCodeConflictException = "ConflictException" + + // ErrCodeForbiddenException for service response error code + // "ForbiddenException". + // + // HTTP Status Code 403: Access forbidden. Correct your credentials and then + // retry your request. + ErrCodeForbiddenException = "ForbiddenException" + + // ErrCodeInternalServerErrorException for service response error code + // "InternalServerErrorException". + // + // HTTP Status Code 500: Unexpected internal server error. Retrying your request + // might resolve the issue. + ErrCodeInternalServerErrorException = "InternalServerErrorException" + + // ErrCodeNotFoundException for service response error code + // "NotFoundException". + // + // HTTP Status Code 404: Resource not found due to incorrect input. Correct + // your request and then retry it. + ErrCodeNotFoundException = "NotFoundException" + + // ErrCodeServiceUnavailableException for service response error code + // "ServiceUnavailableException". + // + // HTTP Status Code 503: Service Unavailable. Retrying your request in some + // time might resolve the issue. + ErrCodeServiceUnavailableException = "ServiceUnavailableException" + + // ErrCodeTooManyRequestsException for service response error code + // "TooManyRequestsException". + // + // HTTP Status Code 429: Limit exceeded. Resource limit reached. + ErrCodeTooManyRequestsException = "TooManyRequestsException" + + // ErrCodeUnauthorizedException for service response error code + // "UnauthorizedException". + // + // HTTP Status Code 401: Unauthorized request. The provided credentials couldn't + // be validated. + ErrCodeUnauthorizedException = "UnauthorizedException" +) + +var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ + "BadRequestException": newErrorBadRequestException, + "ConflictException": newErrorConflictException, + "ForbiddenException": newErrorForbiddenException, + "InternalServerErrorException": newErrorInternalServerErrorException, + "NotFoundException": newErrorNotFoundException, + "ServiceUnavailableException": newErrorServiceUnavailableException, + "TooManyRequestsException": newErrorTooManyRequestsException, + "UnauthorizedException": newErrorUnauthorizedException, +} diff --git a/service/kafkaconnect/kafkaconnectiface/interface.go b/service/kafkaconnect/kafkaconnectiface/interface.go new file mode 100644 index 00000000000..36053ec3e3f --- /dev/null +++ b/service/kafkaconnect/kafkaconnectiface/interface.go @@ -0,0 +1,117 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package kafkaconnectiface provides an interface to enable mocking the Managed Streaming for Kafka Connect service client +// for testing your code. +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. +package kafkaconnectiface + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/service/kafkaconnect" +) + +// KafkaConnectAPI provides an interface to enable mocking the +// kafkaconnect.KafkaConnect service client's API operation, +// paginators, and waiters. This make unit testing your code that calls out +// to the SDK's service client's calls easier. +// +// The best way to use this interface is so the SDK's service client's calls +// can be stubbed out for unit testing your code with the SDK without needing +// to inject custom request handlers into the SDK's request pipeline. +// +// // myFunc uses an SDK service client to make a request to +// // Managed Streaming for Kafka Connect. +// func myFunc(svc kafkaconnectiface.KafkaConnectAPI) bool { +// // Make svc.CreateConnector request +// } +// +// func main() { +// sess := session.New() +// svc := kafkaconnect.New(sess) +// +// myFunc(svc) +// } +// +// In your _test.go file: +// +// // Define a mock struct to be used in your unit tests of myFunc. +// type mockKafkaConnectClient struct { +// kafkaconnectiface.KafkaConnectAPI +// } +// func (m *mockKafkaConnectClient) CreateConnector(input *kafkaconnect.CreateConnectorInput) (*kafkaconnect.CreateConnectorOutput, error) { +// // mock response/functionality +// } +// +// func TestMyFunc(t *testing.T) { +// // Setup Test +// mockSvc := &mockKafkaConnectClient{} +// +// myfunc(mockSvc) +// +// // Verify myFunc's functionality +// } +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. Its suggested to use the pattern above for testing, or using +// tooling to generate mocks to satisfy the interfaces. +type KafkaConnectAPI interface { + CreateConnector(*kafkaconnect.CreateConnectorInput) (*kafkaconnect.CreateConnectorOutput, error) + CreateConnectorWithContext(aws.Context, *kafkaconnect.CreateConnectorInput, ...request.Option) (*kafkaconnect.CreateConnectorOutput, error) + CreateConnectorRequest(*kafkaconnect.CreateConnectorInput) (*request.Request, *kafkaconnect.CreateConnectorOutput) + + CreateCustomPlugin(*kafkaconnect.CreateCustomPluginInput) (*kafkaconnect.CreateCustomPluginOutput, error) + CreateCustomPluginWithContext(aws.Context, *kafkaconnect.CreateCustomPluginInput, ...request.Option) (*kafkaconnect.CreateCustomPluginOutput, error) + CreateCustomPluginRequest(*kafkaconnect.CreateCustomPluginInput) (*request.Request, *kafkaconnect.CreateCustomPluginOutput) + + CreateWorkerConfiguration(*kafkaconnect.CreateWorkerConfigurationInput) (*kafkaconnect.CreateWorkerConfigurationOutput, error) + CreateWorkerConfigurationWithContext(aws.Context, *kafkaconnect.CreateWorkerConfigurationInput, ...request.Option) (*kafkaconnect.CreateWorkerConfigurationOutput, error) + CreateWorkerConfigurationRequest(*kafkaconnect.CreateWorkerConfigurationInput) (*request.Request, *kafkaconnect.CreateWorkerConfigurationOutput) + + DeleteConnector(*kafkaconnect.DeleteConnectorInput) (*kafkaconnect.DeleteConnectorOutput, error) + DeleteConnectorWithContext(aws.Context, *kafkaconnect.DeleteConnectorInput, ...request.Option) (*kafkaconnect.DeleteConnectorOutput, error) + DeleteConnectorRequest(*kafkaconnect.DeleteConnectorInput) (*request.Request, *kafkaconnect.DeleteConnectorOutput) + + DescribeConnector(*kafkaconnect.DescribeConnectorInput) (*kafkaconnect.DescribeConnectorOutput, error) + DescribeConnectorWithContext(aws.Context, *kafkaconnect.DescribeConnectorInput, ...request.Option) (*kafkaconnect.DescribeConnectorOutput, error) + DescribeConnectorRequest(*kafkaconnect.DescribeConnectorInput) (*request.Request, *kafkaconnect.DescribeConnectorOutput) + + DescribeCustomPlugin(*kafkaconnect.DescribeCustomPluginInput) (*kafkaconnect.DescribeCustomPluginOutput, error) + DescribeCustomPluginWithContext(aws.Context, *kafkaconnect.DescribeCustomPluginInput, ...request.Option) (*kafkaconnect.DescribeCustomPluginOutput, error) + DescribeCustomPluginRequest(*kafkaconnect.DescribeCustomPluginInput) (*request.Request, *kafkaconnect.DescribeCustomPluginOutput) + + DescribeWorkerConfiguration(*kafkaconnect.DescribeWorkerConfigurationInput) (*kafkaconnect.DescribeWorkerConfigurationOutput, error) + DescribeWorkerConfigurationWithContext(aws.Context, *kafkaconnect.DescribeWorkerConfigurationInput, ...request.Option) (*kafkaconnect.DescribeWorkerConfigurationOutput, error) + DescribeWorkerConfigurationRequest(*kafkaconnect.DescribeWorkerConfigurationInput) (*request.Request, *kafkaconnect.DescribeWorkerConfigurationOutput) + + ListConnectors(*kafkaconnect.ListConnectorsInput) (*kafkaconnect.ListConnectorsOutput, error) + ListConnectorsWithContext(aws.Context, *kafkaconnect.ListConnectorsInput, ...request.Option) (*kafkaconnect.ListConnectorsOutput, error) + ListConnectorsRequest(*kafkaconnect.ListConnectorsInput) (*request.Request, *kafkaconnect.ListConnectorsOutput) + + ListConnectorsPages(*kafkaconnect.ListConnectorsInput, func(*kafkaconnect.ListConnectorsOutput, bool) bool) error + ListConnectorsPagesWithContext(aws.Context, *kafkaconnect.ListConnectorsInput, func(*kafkaconnect.ListConnectorsOutput, bool) bool, ...request.Option) error + + ListCustomPlugins(*kafkaconnect.ListCustomPluginsInput) (*kafkaconnect.ListCustomPluginsOutput, error) + ListCustomPluginsWithContext(aws.Context, *kafkaconnect.ListCustomPluginsInput, ...request.Option) (*kafkaconnect.ListCustomPluginsOutput, error) + ListCustomPluginsRequest(*kafkaconnect.ListCustomPluginsInput) (*request.Request, *kafkaconnect.ListCustomPluginsOutput) + + ListCustomPluginsPages(*kafkaconnect.ListCustomPluginsInput, func(*kafkaconnect.ListCustomPluginsOutput, bool) bool) error + ListCustomPluginsPagesWithContext(aws.Context, *kafkaconnect.ListCustomPluginsInput, func(*kafkaconnect.ListCustomPluginsOutput, bool) bool, ...request.Option) error + + ListWorkerConfigurations(*kafkaconnect.ListWorkerConfigurationsInput) (*kafkaconnect.ListWorkerConfigurationsOutput, error) + ListWorkerConfigurationsWithContext(aws.Context, *kafkaconnect.ListWorkerConfigurationsInput, ...request.Option) (*kafkaconnect.ListWorkerConfigurationsOutput, error) + ListWorkerConfigurationsRequest(*kafkaconnect.ListWorkerConfigurationsInput) (*request.Request, *kafkaconnect.ListWorkerConfigurationsOutput) + + ListWorkerConfigurationsPages(*kafkaconnect.ListWorkerConfigurationsInput, func(*kafkaconnect.ListWorkerConfigurationsOutput, bool) bool) error + ListWorkerConfigurationsPagesWithContext(aws.Context, *kafkaconnect.ListWorkerConfigurationsInput, func(*kafkaconnect.ListWorkerConfigurationsOutput, bool) bool, ...request.Option) error + + UpdateConnector(*kafkaconnect.UpdateConnectorInput) (*kafkaconnect.UpdateConnectorOutput, error) + UpdateConnectorWithContext(aws.Context, *kafkaconnect.UpdateConnectorInput, ...request.Option) (*kafkaconnect.UpdateConnectorOutput, error) + UpdateConnectorRequest(*kafkaconnect.UpdateConnectorInput) (*request.Request, *kafkaconnect.UpdateConnectorOutput) +} + +var _ KafkaConnectAPI = (*kafkaconnect.KafkaConnect)(nil) diff --git a/service/kafkaconnect/service.go b/service/kafkaconnect/service.go new file mode 100644 index 00000000000..6664a97d559 --- /dev/null +++ b/service/kafkaconnect/service.go @@ -0,0 +1,104 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package kafkaconnect + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/client" + "github.com/aws/aws-sdk-go/aws/client/metadata" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/aws/signer/v4" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +// KafkaConnect provides the API operation methods for making requests to +// Managed Streaming for Kafka Connect. See this package's package overview docs +// for details on the service. +// +// KafkaConnect methods are safe to use concurrently. It is not safe to +// modify mutate any of the struct's properties though. +type KafkaConnect struct { + *client.Client +} + +// Used for custom client initialization logic +var initClient func(*client.Client) + +// Used for custom request initialization logic +var initRequest func(*request.Request) + +// Service information constants +const ( + ServiceName = "KafkaConnect" // Name of service. + EndpointsID = "kafkaconnect" // ID to lookup a service endpoint with. + ServiceID = "KafkaConnect" // ServiceID is a unique identifier of a specific service. +) + +// New creates a new instance of the KafkaConnect client with a session. +// If additional configuration is needed for the client instance use the optional +// aws.Config parameter to add your extra config. +// +// Example: +// mySession := session.Must(session.NewSession()) +// +// // Create a KafkaConnect client from just a session. +// svc := kafkaconnect.New(mySession) +// +// // Create a KafkaConnect client with additional configuration +// svc := kafkaconnect.New(mySession, aws.NewConfig().WithRegion("us-west-2")) +func New(p client.ConfigProvider, cfgs ...*aws.Config) *KafkaConnect { + c := p.ClientConfig(EndpointsID, cfgs...) + if c.SigningNameDerived || len(c.SigningName) == 0 { + c.SigningName = "kafkaconnect" + } + return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName) +} + +// newClient creates, initializes and returns a new service client instance. +func newClient(cfg aws.Config, handlers request.Handlers, partitionID, endpoint, signingRegion, signingName string) *KafkaConnect { + svc := &KafkaConnect{ + Client: client.New( + cfg, + metadata.ClientInfo{ + ServiceName: ServiceName, + ServiceID: ServiceID, + SigningName: signingName, + SigningRegion: signingRegion, + PartitionID: partitionID, + Endpoint: endpoint, + APIVersion: "2021-09-14", + }, + handlers, + ), + } + + // Handlers + svc.Handlers.Sign.PushBackNamed(v4.SignRequestHandler) + svc.Handlers.Build.PushBackNamed(restjson.BuildHandler) + svc.Handlers.Unmarshal.PushBackNamed(restjson.UnmarshalHandler) + svc.Handlers.UnmarshalMeta.PushBackNamed(restjson.UnmarshalMetaHandler) + svc.Handlers.UnmarshalError.PushBackNamed( + protocol.NewUnmarshalErrorHandler(restjson.NewUnmarshalTypedError(exceptionFromCode)).NamedHandler(), + ) + + // Run custom client initialization if present + if initClient != nil { + initClient(svc.Client) + } + + return svc +} + +// newRequest creates a new request for a KafkaConnect operation and runs any +// custom request initialization. +func (c *KafkaConnect) newRequest(op *request.Operation, params, data interface{}) *request.Request { + req := c.NewRequest(op, params, data) + + // Run custom request initialization if present + if initRequest != nil { + initRequest(req) + } + + return req +} diff --git a/service/macie2/api.go b/service/macie2/api.go index a7b3a6acd9a..ef9ef2a0293 100644 --- a/service/macie2/api.go +++ b/service/macie2/api.go @@ -4707,7 +4707,7 @@ func (c *Macie2) ListInvitationsRequest(input *ListInvitationsInput) (req *reque // ListInvitations API operation for Amazon Macie 2. // -// Retrieves information about all the Amazon Macie membership invitations that +// Retrieves information about the Amazon Macie membership invitations that // were received by an account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -4820,6 +4820,81 @@ func (c *Macie2) ListInvitationsPagesWithContext(ctx aws.Context, input *ListInv return p.Err() } +const opListManagedDataIdentifiers = "ListManagedDataIdentifiers" + +// ListManagedDataIdentifiersRequest generates a "aws/request.Request" representing the +// client's request for the ListManagedDataIdentifiers operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListManagedDataIdentifiers for more information on using the ListManagedDataIdentifiers +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListManagedDataIdentifiersRequest method. +// req, resp := client.ListManagedDataIdentifiersRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/ListManagedDataIdentifiers +func (c *Macie2) ListManagedDataIdentifiersRequest(input *ListManagedDataIdentifiersInput) (req *request.Request, output *ListManagedDataIdentifiersOutput) { + op := &request.Operation{ + Name: opListManagedDataIdentifiers, + HTTPMethod: "POST", + HTTPPath: "/managed-data-identifiers/list", + } + + if input == nil { + input = &ListManagedDataIdentifiersInput{} + } + + output = &ListManagedDataIdentifiersOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListManagedDataIdentifiers API operation for Amazon Macie 2. +// +// Retrieves information about all the managed data identifiers that Amazon +// Macie currently provides. +// +// 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 +// the error. +// +// See the AWS API reference guide for Amazon Macie 2's +// API operation ListManagedDataIdentifiers for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/ListManagedDataIdentifiers +func (c *Macie2) ListManagedDataIdentifiers(input *ListManagedDataIdentifiersInput) (*ListManagedDataIdentifiersOutput, error) { + req, out := c.ListManagedDataIdentifiersRequest(input) + return out, req.Send() +} + +// ListManagedDataIdentifiersWithContext is the same as ListManagedDataIdentifiers with the addition of +// the ability to pass a context and additional request options. +// +// See ListManagedDataIdentifiers for details on how to use this API operation. +// +// 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 *Macie2) ListManagedDataIdentifiersWithContext(ctx aws.Context, input *ListManagedDataIdentifiersInput, opts ...request.Option) (*ListManagedDataIdentifiersOutput, error) { + req, out := c.ListManagedDataIdentifiersRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opListMembers = "ListMembers" // ListMembersRequest generates a "aws/request.Request" representing the @@ -8260,6 +8335,12 @@ type CreateClassificationJobInput struct { // JobType is a required field JobType *string `locationName:"jobType" type:"string" required:"true" enum:"JobType"` + ManagedDataIdentifierIds []*string `locationName:"managedDataIdentifierIds" type:"list"` + + // The selection type that determines which managed data identifiers a classification + // job uses to analyze data. Valid values are: + ManagedDataIdentifierSelector *string `locationName:"managedDataIdentifierSelector" type:"string" enum:"ManagedDataIdentifierSelector"` + // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` @@ -8356,6 +8437,18 @@ func (s *CreateClassificationJobInput) SetJobType(v string) *CreateClassificatio return s } +// SetManagedDataIdentifierIds sets the ManagedDataIdentifierIds field's value. +func (s *CreateClassificationJobInput) SetManagedDataIdentifierIds(v []*string) *CreateClassificationJobInput { + s.ManagedDataIdentifierIds = v + return s +} + +// SetManagedDataIdentifierSelector sets the ManagedDataIdentifierSelector field's value. +func (s *CreateClassificationJobInput) SetManagedDataIdentifierSelector(v string) *CreateClassificationJobInput { + s.ManagedDataIdentifierSelector = &v + return s +} + // SetName sets the Name field's value. func (s *CreateClassificationJobInput) SetName(v string) *CreateClassificationJobInput { s.Name = &v @@ -8426,10 +8519,10 @@ func (s *CreateClassificationJobOutput) SetJobId(v string) *CreateClassification return s } -// Specifies the criteria and other settings for a new custom data identifier. -// You can't change a custom data identifier after you create it. This helps -// ensure that you have an immutable history of sensitive data findings and -// discovery results for data privacy and protection audits or investigations. +// Specifies the criteria and other settings for a custom data identifier. You +// can't change a custom data identifier after you create it. This helps ensure +// that you have an immutable history of sensitive data findings and discovery +// results for data privacy and protection audits or investigations. type CreateCustomDataIdentifierInput struct { _ struct{} `type:"structure"` @@ -9223,7 +9316,7 @@ type CustomDetection struct { Name *string `locationName:"name" type:"string"` // Specifies the location of 1-15 occurrences of sensitive data that was detected - // by managed data identifiers or a custom data identifier and produced a sensitive + // by a managed data identifier or a custom data identifier and produced a sensitive // data finding. Occurrences *Occurrences `locationName:"occurrences" type:"structure"` } @@ -9373,14 +9466,14 @@ func (s *DeclineInvitationsOutput) SetUnprocessedAccounts(v []*UnprocessedAccoun } // Provides information about a type of sensitive data that was detected by -// managed data identifiers and produced a sensitive data finding. +// a managed data identifier and produced a sensitive data finding. type DefaultDetection struct { _ struct{} `type:"structure"` Count *int64 `locationName:"count" type:"long"` // Specifies the location of 1-15 occurrences of sensitive data that was detected - // by managed data identifiers or a custom data identifier and produced a sensitive + // by a managed data identifier or a custom data identifier and produced a sensitive // data finding. Occurrences *Occurrences `locationName:"occurrences" type:"structure"` @@ -9888,6 +9981,12 @@ type DescribeClassificationJobOutput struct { LastRunTime *time.Time `locationName:"lastRunTime" type:"timestamp" timestampFormat:"iso8601"` + ManagedDataIdentifierIds []*string `locationName:"managedDataIdentifierIds" type:"list"` + + // The selection type that determines which managed data identifiers a classification + // job uses to analyze data. Valid values are: + ManagedDataIdentifierSelector *string `locationName:"managedDataIdentifierSelector" type:"string" enum:"ManagedDataIdentifierSelector"` + Name *string `locationName:"name" type:"string"` // Specifies which S3 buckets contain the objects that a classification job @@ -10005,6 +10104,18 @@ func (s *DescribeClassificationJobOutput) SetLastRunTime(v time.Time) *DescribeC return s } +// SetManagedDataIdentifierIds sets the ManagedDataIdentifierIds field's value. +func (s *DescribeClassificationJobOutput) SetManagedDataIdentifierIds(v []*string) *DescribeClassificationJobOutput { + s.ManagedDataIdentifierIds = v + return s +} + +// SetManagedDataIdentifierSelector sets the ManagedDataIdentifierSelector field's value. +func (s *DescribeClassificationJobOutput) SetManagedDataIdentifierSelector(v string) *DescribeClassificationJobOutput { + s.ManagedDataIdentifierSelector = &v + return s +} + // SetName sets the Name field's value. func (s *DescribeClassificationJobOutput) SetName(v string) *DescribeClassificationJobOutput { s.Name = &v @@ -13865,6 +13976,78 @@ func (s *ListJobsSortCriteria) SetOrderBy(v string) *ListJobsSortCriteria { return s } +// Specifies criteria for paginating the results of a request for information +// about managed data identifiers. +type ListManagedDataIdentifiersInput struct { + _ struct{} `type:"structure"` + + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListManagedDataIdentifiersInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListManagedDataIdentifiersInput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListManagedDataIdentifiersInput) SetNextToken(v string) *ListManagedDataIdentifiersInput { + s.NextToken = &v + return s +} + +// Provides information about the managed data identifiers that Amazon Macie +// currently provides. +type ListManagedDataIdentifiersOutput struct { + _ struct{} `type:"structure"` + + Items []*ManagedDataIdentifierSummary `locationName:"items" type:"list"` + + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListManagedDataIdentifiersOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListManagedDataIdentifiersOutput) GoString() string { + return s.String() +} + +// SetItems sets the Items field's value. +func (s *ListManagedDataIdentifiersOutput) SetItems(v []*ManagedDataIdentifierSummary) *ListManagedDataIdentifiersOutput { + s.Items = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListManagedDataIdentifiersOutput) SetNextToken(v string) *ListManagedDataIdentifiersOutput { + s.NextToken = &v + return s +} + type ListMembersInput struct { _ struct{} `type:"structure"` @@ -14138,6 +14321,50 @@ func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForRe return s } +// Provides information about a managed data identifier. For additional information, +// see Using managed data identifiers (https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html) +// in the Amazon Macie User Guide. +type ManagedDataIdentifierSummary struct { + _ struct{} `type:"structure"` + + // For a finding, the category of sensitive data that was detected and produced + // the finding. For a managed data identifier, the category of sensitive data + // that the managed data identifier detects. Possible values are: + Category *string `locationName:"category" type:"string" enum:"SensitiveDataItemCategory"` + + Id *string `locationName:"id" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ManagedDataIdentifierSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ManagedDataIdentifierSummary) GoString() string { + return s.String() +} + +// SetCategory sets the Category field's value. +func (s *ManagedDataIdentifierSummary) SetCategory(v string) *ManagedDataIdentifierSummary { + s.Category = &v + return s +} + +// SetId sets the Id field's value. +func (s *ManagedDataIdentifierSummary) SetId(v string) *ManagedDataIdentifierSummary { + s.Id = &v + return s +} + // Provides statistical data and other information about an S3 bucket that Amazon // Macie monitors and analyzes. type MatchingBucket struct { @@ -14552,7 +14779,7 @@ func (s *ObjectLevelStatistics) SetTotal(v int64) *ObjectLevelStatistics { } // Specifies the location of 1-15 occurrences of sensitive data that was detected -// by managed data identifiers or a custom data identifier and produced a sensitive +// by a managed data identifier or a custom data identifier and produced a sensitive // data finding. type Occurrences struct { _ struct{} `type:"structure"` @@ -15147,7 +15374,8 @@ type S3Bucket struct { Name *string `locationName:"name" type:"string"` - // Provides information about the user who owns an S3 bucket. + // Provides information about the Amazon Web Services account that owns an S3 + // bucket. Owner *S3BucketOwner `locationName:"owner" type:"structure"` // Provides information about the permissions settings that determine whether @@ -15329,7 +15557,8 @@ func (s *S3BucketDefinitionForJob) SetBuckets(v []*string) *S3BucketDefinitionFo return s } -// Provides information about the user who owns an S3 bucket. +// Provides information about the Amazon Web Services account that owns an S3 +// bucket. type S3BucketOwner struct { _ struct{} `type:"structure"` @@ -16149,8 +16378,9 @@ func (s *SecurityHubConfiguration) SetPublishPolicyFindings(v bool) *SecurityHub type SensitiveDataItem struct { _ struct{} `type:"structure"` - // The category of sensitive data that was detected and produced the finding. - // Possible values are: + // For a finding, the category of sensitive data that was detected and produced + // the finding. For a managed data identifier, the category of sensitive data + // that the managed data identifier detects. Possible values are: Category *string `locationName:"category" type:"string" enum:"SensitiveDataItemCategory"` // Provides information about sensitive data that was detected by managed data @@ -18834,6 +19064,32 @@ func MacieStatus_Values() []string { } } +// The selection type that determines which managed data identifiers a classification +// job uses to analyze data. Valid values are: +const ( + // ManagedDataIdentifierSelectorAll is a ManagedDataIdentifierSelector enum value + ManagedDataIdentifierSelectorAll = "ALL" + + // ManagedDataIdentifierSelectorExclude is a ManagedDataIdentifierSelector enum value + ManagedDataIdentifierSelectorExclude = "EXCLUDE" + + // ManagedDataIdentifierSelectorInclude is a ManagedDataIdentifierSelector enum value + ManagedDataIdentifierSelectorInclude = "INCLUDE" + + // ManagedDataIdentifierSelectorNone is a ManagedDataIdentifierSelector enum value + ManagedDataIdentifierSelectorNone = "NONE" +) + +// ManagedDataIdentifierSelector_Values returns all elements of the ManagedDataIdentifierSelector enum +func ManagedDataIdentifierSelector_Values() []string { + return []string{ + ManagedDataIdentifierSelectorAll, + ManagedDataIdentifierSelectorExclude, + ManagedDataIdentifierSelectorInclude, + ManagedDataIdentifierSelectorNone, + } +} + const ( // OrderByAsc is a OrderBy enum value OrderByAsc = "ASC" @@ -18995,8 +19251,9 @@ func SearchResourcesSortAttributeName_Values() []string { } } -// The category of sensitive data that was detected and produced the finding. -// Possible values are: +// For a finding, the category of sensitive data that was detected and produced +// the finding. For a managed data identifier, the category of sensitive data +// that the managed data identifier detects. Possible values are: const ( // SensitiveDataItemCategoryFinancialInformation is a SensitiveDataItemCategory enum value SensitiveDataItemCategoryFinancialInformation = "FINANCIAL_INFORMATION" diff --git a/service/macie2/macie2iface/interface.go b/service/macie2/macie2iface/interface.go index cacb18f05b6..e44a34dcee1 100644 --- a/service/macie2/macie2iface/interface.go +++ b/service/macie2/macie2iface/interface.go @@ -249,6 +249,10 @@ type Macie2API interface { ListInvitationsPages(*macie2.ListInvitationsInput, func(*macie2.ListInvitationsOutput, bool) bool) error ListInvitationsPagesWithContext(aws.Context, *macie2.ListInvitationsInput, func(*macie2.ListInvitationsOutput, bool) bool, ...request.Option) error + ListManagedDataIdentifiers(*macie2.ListManagedDataIdentifiersInput) (*macie2.ListManagedDataIdentifiersOutput, error) + ListManagedDataIdentifiersWithContext(aws.Context, *macie2.ListManagedDataIdentifiersInput, ...request.Option) (*macie2.ListManagedDataIdentifiersOutput, error) + ListManagedDataIdentifiersRequest(*macie2.ListManagedDataIdentifiersInput) (*request.Request, *macie2.ListManagedDataIdentifiersOutput) + ListMembers(*macie2.ListMembersInput) (*macie2.ListMembersOutput, error) ListMembersWithContext(aws.Context, *macie2.ListMembersInput, ...request.Option) (*macie2.ListMembersOutput, error) ListMembersRequest(*macie2.ListMembersInput) (*request.Request, *macie2.ListMembersOutput) diff --git a/service/pinpoint/api.go b/service/pinpoint/api.go index 4b2b7b0de02..25c46bed4f0 100644 --- a/service/pinpoint/api.go +++ b/service/pinpoint/api.go @@ -493,6 +493,97 @@ func (c *Pinpoint) CreateImportJobWithContext(ctx aws.Context, input *CreateImpo return out, req.Send() } +const opCreateInAppTemplate = "CreateInAppTemplate" + +// CreateInAppTemplateRequest generates a "aws/request.Request" representing the +// client's request for the CreateInAppTemplate operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateInAppTemplate for more information on using the CreateInAppTemplate +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateInAppTemplateRequest method. +// req, resp := client.CreateInAppTemplateRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateInAppTemplate +func (c *Pinpoint) CreateInAppTemplateRequest(input *CreateInAppTemplateInput) (req *request.Request, output *CreateInAppTemplateOutput) { + op := &request.Operation{ + Name: opCreateInAppTemplate, + HTTPMethod: "POST", + HTTPPath: "/v1/templates/{template-name}/inapp", + } + + if input == nil { + input = &CreateInAppTemplateInput{} + } + + output = &CreateInAppTemplateOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateInAppTemplate API operation for Amazon Pinpoint. +// +// Creates a new message template for messages using the in-app message channel. +// +// 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 +// the error. +// +// See the AWS API reference guide for Amazon Pinpoint's +// API operation CreateInAppTemplate for usage and error information. +// +// Returned Error Types: +// * MethodNotAllowedException +// Provides information about an API request or response. +// +// * TooManyRequestsException +// Provides information about an API request or response. +// +// * BadRequestException +// Provides information about an API request or response. +// +// * InternalServerErrorException +// Provides information about an API request or response. +// +// * ForbiddenException +// Provides information about an API request or response. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateInAppTemplate +func (c *Pinpoint) CreateInAppTemplate(input *CreateInAppTemplateInput) (*CreateInAppTemplateOutput, error) { + req, out := c.CreateInAppTemplateRequest(input) + return out, req.Send() +} + +// CreateInAppTemplateWithContext is the same as CreateInAppTemplate with the addition of +// the ability to pass a context and additional request options. +// +// See CreateInAppTemplate for details on how to use this API operation. +// +// 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 *Pinpoint) CreateInAppTemplateWithContext(ctx aws.Context, input *CreateInAppTemplateInput, opts ...request.Option) (*CreateInAppTemplateOutput, error) { + req, out := c.CreateInAppTemplateRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateJourney = "CreateJourney" // CreateJourneyRequest generates a "aws/request.Request" representing the @@ -2329,6 +2420,103 @@ func (c *Pinpoint) DeleteGcmChannelWithContext(ctx aws.Context, input *DeleteGcm return out, req.Send() } +const opDeleteInAppTemplate = "DeleteInAppTemplate" + +// DeleteInAppTemplateRequest generates a "aws/request.Request" representing the +// client's request for the DeleteInAppTemplate operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteInAppTemplate for more information on using the DeleteInAppTemplate +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteInAppTemplateRequest method. +// req, resp := client.DeleteInAppTemplateRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteInAppTemplate +func (c *Pinpoint) DeleteInAppTemplateRequest(input *DeleteInAppTemplateInput) (req *request.Request, output *DeleteInAppTemplateOutput) { + op := &request.Operation{ + Name: opDeleteInAppTemplate, + HTTPMethod: "DELETE", + HTTPPath: "/v1/templates/{template-name}/inapp", + } + + if input == nil { + input = &DeleteInAppTemplateInput{} + } + + output = &DeleteInAppTemplateOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteInAppTemplate API operation for Amazon Pinpoint. +// +// Deletes a message template for messages sent using the in-app message channel. +// +// 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 +// the error. +// +// See the AWS API reference guide for Amazon Pinpoint's +// API operation DeleteInAppTemplate for usage and error information. +// +// Returned Error Types: +// * BadRequestException +// Provides information about an API request or response. +// +// * InternalServerErrorException +// Provides information about an API request or response. +// +// * PayloadTooLargeException +// Provides information about an API request or response. +// +// * ForbiddenException +// Provides information about an API request or response. +// +// * NotFoundException +// Provides information about an API request or response. +// +// * MethodNotAllowedException +// Provides information about an API request or response. +// +// * TooManyRequestsException +// Provides information about an API request or response. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteInAppTemplate +func (c *Pinpoint) DeleteInAppTemplate(input *DeleteInAppTemplateInput) (*DeleteInAppTemplateOutput, error) { + req, out := c.DeleteInAppTemplateRequest(input) + return out, req.Send() +} + +// DeleteInAppTemplateWithContext is the same as DeleteInAppTemplate with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteInAppTemplate for details on how to use this API operation. +// +// 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 *Pinpoint) DeleteInAppTemplateWithContext(ctx aws.Context, input *DeleteInAppTemplateInput, opts ...request.Option) (*DeleteInAppTemplateOutput, error) { + req, out := c.DeleteInAppTemplateRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteJourney = "DeleteJourney" // DeleteJourneyRequest generates a "aws/request.Request" representing the @@ -5750,59 +5938,58 @@ func (c *Pinpoint) GetImportJobsWithContext(ctx aws.Context, input *GetImportJob return out, req.Send() } -const opGetJourney = "GetJourney" +const opGetInAppMessages = "GetInAppMessages" -// GetJourneyRequest generates a "aws/request.Request" representing the -// client's request for the GetJourney operation. The "output" return +// GetInAppMessagesRequest generates a "aws/request.Request" representing the +// client's request for the GetInAppMessages operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See GetJourney for more information on using the GetJourney +// See GetInAppMessages for more information on using the GetInAppMessages // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the GetJourneyRequest method. -// req, resp := client.GetJourneyRequest(params) +// // Example sending a request using the GetInAppMessagesRequest method. +// req, resp := client.GetInAppMessagesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourney -func (c *Pinpoint) GetJourneyRequest(input *GetJourneyInput) (req *request.Request, output *GetJourneyOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetInAppMessages +func (c *Pinpoint) GetInAppMessagesRequest(input *GetInAppMessagesInput) (req *request.Request, output *GetInAppMessagesOutput) { op := &request.Operation{ - Name: opGetJourney, + Name: opGetInAppMessages, HTTPMethod: "GET", - HTTPPath: "/v1/apps/{application-id}/journeys/{journey-id}", + HTTPPath: "/v1/apps/{application-id}/endpoints/{endpoint-id}/inappmessages", } if input == nil { - input = &GetJourneyInput{} + input = &GetInAppMessagesInput{} } - output = &GetJourneyOutput{} + output = &GetInAppMessagesOutput{} req = c.newRequest(op, input, output) return } -// GetJourney API operation for Amazon Pinpoint. +// GetInAppMessages API operation for Amazon Pinpoint. // -// Retrieves information about the status, configuration, and other settings -// for a journey. +// Retrieves the in-app messages targeted for the provided endpoint ID. // // 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 // the error. // // See the AWS API reference guide for Amazon Pinpoint's -// API operation GetJourney for usage and error information. +// API operation GetInAppMessages for usage and error information. // // Returned Error Types: // * BadRequestException @@ -5826,81 +6013,81 @@ func (c *Pinpoint) GetJourneyRequest(input *GetJourneyInput) (req *request.Reque // * TooManyRequestsException // Provides information about an API request or response. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourney -func (c *Pinpoint) GetJourney(input *GetJourneyInput) (*GetJourneyOutput, error) { - req, out := c.GetJourneyRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetInAppMessages +func (c *Pinpoint) GetInAppMessages(input *GetInAppMessagesInput) (*GetInAppMessagesOutput, error) { + req, out := c.GetInAppMessagesRequest(input) return out, req.Send() } -// GetJourneyWithContext is the same as GetJourney with the addition of +// GetInAppMessagesWithContext is the same as GetInAppMessages with the addition of // the ability to pass a context and additional request options. // -// See GetJourney for details on how to use this API operation. +// See GetInAppMessages for details on how to use this API operation. // // 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 *Pinpoint) GetJourneyWithContext(ctx aws.Context, input *GetJourneyInput, opts ...request.Option) (*GetJourneyOutput, error) { - req, out := c.GetJourneyRequest(input) +func (c *Pinpoint) GetInAppMessagesWithContext(ctx aws.Context, input *GetInAppMessagesInput, opts ...request.Option) (*GetInAppMessagesOutput, error) { + req, out := c.GetInAppMessagesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opGetJourneyDateRangeKpi = "GetJourneyDateRangeKpi" +const opGetInAppTemplate = "GetInAppTemplate" -// GetJourneyDateRangeKpiRequest generates a "aws/request.Request" representing the -// client's request for the GetJourneyDateRangeKpi operation. The "output" return +// GetInAppTemplateRequest generates a "aws/request.Request" representing the +// client's request for the GetInAppTemplate operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See GetJourneyDateRangeKpi for more information on using the GetJourneyDateRangeKpi +// See GetInAppTemplate for more information on using the GetInAppTemplate // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the GetJourneyDateRangeKpiRequest method. -// req, resp := client.GetJourneyDateRangeKpiRequest(params) +// // Example sending a request using the GetInAppTemplateRequest method. +// req, resp := client.GetInAppTemplateRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyDateRangeKpi -func (c *Pinpoint) GetJourneyDateRangeKpiRequest(input *GetJourneyDateRangeKpiInput) (req *request.Request, output *GetJourneyDateRangeKpiOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetInAppTemplate +func (c *Pinpoint) GetInAppTemplateRequest(input *GetInAppTemplateInput) (req *request.Request, output *GetInAppTemplateOutput) { op := &request.Operation{ - Name: opGetJourneyDateRangeKpi, + Name: opGetInAppTemplate, HTTPMethod: "GET", - HTTPPath: "/v1/apps/{application-id}/journeys/{journey-id}/kpis/daterange/{kpi-name}", + HTTPPath: "/v1/templates/{template-name}/inapp", } if input == nil { - input = &GetJourneyDateRangeKpiInput{} + input = &GetInAppTemplateInput{} } - output = &GetJourneyDateRangeKpiOutput{} + output = &GetInAppTemplateOutput{} req = c.newRequest(op, input, output) return } -// GetJourneyDateRangeKpi API operation for Amazon Pinpoint. +// GetInAppTemplate API operation for Amazon Pinpoint. // -// Retrieves (queries) pre-aggregated data for a standard engagement metric -// that applies to a journey. +// Retrieves the content and settings of a message template for messages sent +// through the in-app channel. // // 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 // the error. // // See the AWS API reference guide for Amazon Pinpoint's -// API operation GetJourneyDateRangeKpi for usage and error information. +// API operation GetInAppTemplate for usage and error information. // // Returned Error Types: // * BadRequestException @@ -5924,81 +6111,81 @@ func (c *Pinpoint) GetJourneyDateRangeKpiRequest(input *GetJourneyDateRangeKpiIn // * TooManyRequestsException // Provides information about an API request or response. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyDateRangeKpi -func (c *Pinpoint) GetJourneyDateRangeKpi(input *GetJourneyDateRangeKpiInput) (*GetJourneyDateRangeKpiOutput, error) { - req, out := c.GetJourneyDateRangeKpiRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetInAppTemplate +func (c *Pinpoint) GetInAppTemplate(input *GetInAppTemplateInput) (*GetInAppTemplateOutput, error) { + req, out := c.GetInAppTemplateRequest(input) return out, req.Send() } -// GetJourneyDateRangeKpiWithContext is the same as GetJourneyDateRangeKpi with the addition of +// GetInAppTemplateWithContext is the same as GetInAppTemplate with the addition of // the ability to pass a context and additional request options. // -// See GetJourneyDateRangeKpi for details on how to use this API operation. +// See GetInAppTemplate for details on how to use this API operation. // // 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 *Pinpoint) GetJourneyDateRangeKpiWithContext(ctx aws.Context, input *GetJourneyDateRangeKpiInput, opts ...request.Option) (*GetJourneyDateRangeKpiOutput, error) { - req, out := c.GetJourneyDateRangeKpiRequest(input) +func (c *Pinpoint) GetInAppTemplateWithContext(ctx aws.Context, input *GetInAppTemplateInput, opts ...request.Option) (*GetInAppTemplateOutput, error) { + req, out := c.GetInAppTemplateRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opGetJourneyExecutionActivityMetrics = "GetJourneyExecutionActivityMetrics" +const opGetJourney = "GetJourney" -// GetJourneyExecutionActivityMetricsRequest generates a "aws/request.Request" representing the -// client's request for the GetJourneyExecutionActivityMetrics operation. The "output" return +// GetJourneyRequest generates a "aws/request.Request" representing the +// client's request for the GetJourney operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See GetJourneyExecutionActivityMetrics for more information on using the GetJourneyExecutionActivityMetrics +// See GetJourney for more information on using the GetJourney // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the GetJourneyExecutionActivityMetricsRequest method. -// req, resp := client.GetJourneyExecutionActivityMetricsRequest(params) +// // Example sending a request using the GetJourneyRequest method. +// req, resp := client.GetJourneyRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyExecutionActivityMetrics -func (c *Pinpoint) GetJourneyExecutionActivityMetricsRequest(input *GetJourneyExecutionActivityMetricsInput) (req *request.Request, output *GetJourneyExecutionActivityMetricsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourney +func (c *Pinpoint) GetJourneyRequest(input *GetJourneyInput) (req *request.Request, output *GetJourneyOutput) { op := &request.Operation{ - Name: opGetJourneyExecutionActivityMetrics, + Name: opGetJourney, HTTPMethod: "GET", - HTTPPath: "/v1/apps/{application-id}/journeys/{journey-id}/activities/{journey-activity-id}/execution-metrics", + HTTPPath: "/v1/apps/{application-id}/journeys/{journey-id}", } if input == nil { - input = &GetJourneyExecutionActivityMetricsInput{} + input = &GetJourneyInput{} } - output = &GetJourneyExecutionActivityMetricsOutput{} + output = &GetJourneyOutput{} req = c.newRequest(op, input, output) return } -// GetJourneyExecutionActivityMetrics API operation for Amazon Pinpoint. +// GetJourney API operation for Amazon Pinpoint. // -// Retrieves (queries) pre-aggregated data for a standard execution metric that -// applies to a journey activity. +// Retrieves information about the status, configuration, and other settings +// for a journey. // // 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 // the error. // // See the AWS API reference guide for Amazon Pinpoint's -// API operation GetJourneyExecutionActivityMetrics for usage and error information. +// API operation GetJourney for usage and error information. // // Returned Error Types: // * BadRequestException @@ -6022,81 +6209,277 @@ func (c *Pinpoint) GetJourneyExecutionActivityMetricsRequest(input *GetJourneyEx // * TooManyRequestsException // Provides information about an API request or response. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyExecutionActivityMetrics -func (c *Pinpoint) GetJourneyExecutionActivityMetrics(input *GetJourneyExecutionActivityMetricsInput) (*GetJourneyExecutionActivityMetricsOutput, error) { - req, out := c.GetJourneyExecutionActivityMetricsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourney +func (c *Pinpoint) GetJourney(input *GetJourneyInput) (*GetJourneyOutput, error) { + req, out := c.GetJourneyRequest(input) return out, req.Send() } -// GetJourneyExecutionActivityMetricsWithContext is the same as GetJourneyExecutionActivityMetrics with the addition of +// GetJourneyWithContext is the same as GetJourney with the addition of // the ability to pass a context and additional request options. // -// See GetJourneyExecutionActivityMetrics for details on how to use this API operation. +// See GetJourney for details on how to use this API operation. // // 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 *Pinpoint) GetJourneyExecutionActivityMetricsWithContext(ctx aws.Context, input *GetJourneyExecutionActivityMetricsInput, opts ...request.Option) (*GetJourneyExecutionActivityMetricsOutput, error) { - req, out := c.GetJourneyExecutionActivityMetricsRequest(input) +func (c *Pinpoint) GetJourneyWithContext(ctx aws.Context, input *GetJourneyInput, opts ...request.Option) (*GetJourneyOutput, error) { + req, out := c.GetJourneyRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opGetJourneyExecutionMetrics = "GetJourneyExecutionMetrics" +const opGetJourneyDateRangeKpi = "GetJourneyDateRangeKpi" -// GetJourneyExecutionMetricsRequest generates a "aws/request.Request" representing the -// client's request for the GetJourneyExecutionMetrics operation. The "output" return +// GetJourneyDateRangeKpiRequest generates a "aws/request.Request" representing the +// client's request for the GetJourneyDateRangeKpi operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See GetJourneyExecutionMetrics for more information on using the GetJourneyExecutionMetrics +// See GetJourneyDateRangeKpi for more information on using the GetJourneyDateRangeKpi // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the GetJourneyExecutionMetricsRequest method. -// req, resp := client.GetJourneyExecutionMetricsRequest(params) +// // Example sending a request using the GetJourneyDateRangeKpiRequest method. +// req, resp := client.GetJourneyDateRangeKpiRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyExecutionMetrics -func (c *Pinpoint) GetJourneyExecutionMetricsRequest(input *GetJourneyExecutionMetricsInput) (req *request.Request, output *GetJourneyExecutionMetricsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyDateRangeKpi +func (c *Pinpoint) GetJourneyDateRangeKpiRequest(input *GetJourneyDateRangeKpiInput) (req *request.Request, output *GetJourneyDateRangeKpiOutput) { op := &request.Operation{ - Name: opGetJourneyExecutionMetrics, + Name: opGetJourneyDateRangeKpi, HTTPMethod: "GET", - HTTPPath: "/v1/apps/{application-id}/journeys/{journey-id}/execution-metrics", + HTTPPath: "/v1/apps/{application-id}/journeys/{journey-id}/kpis/daterange/{kpi-name}", } if input == nil { - input = &GetJourneyExecutionMetricsInput{} + input = &GetJourneyDateRangeKpiInput{} } - output = &GetJourneyExecutionMetricsOutput{} + output = &GetJourneyDateRangeKpiOutput{} req = c.newRequest(op, input, output) return } -// GetJourneyExecutionMetrics API operation for Amazon Pinpoint. +// GetJourneyDateRangeKpi API operation for Amazon Pinpoint. // -// Retrieves (queries) pre-aggregated data for a standard execution metric that -// applies to a journey. +// Retrieves (queries) pre-aggregated data for a standard engagement metric +// that applies to a journey. // // 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 // the error. // // See the AWS API reference guide for Amazon Pinpoint's -// API operation GetJourneyExecutionMetrics for usage and error information. +// API operation GetJourneyDateRangeKpi for usage and error information. +// +// Returned Error Types: +// * BadRequestException +// Provides information about an API request or response. +// +// * InternalServerErrorException +// Provides information about an API request or response. +// +// * PayloadTooLargeException +// Provides information about an API request or response. +// +// * ForbiddenException +// Provides information about an API request or response. +// +// * NotFoundException +// Provides information about an API request or response. +// +// * MethodNotAllowedException +// Provides information about an API request or response. +// +// * TooManyRequestsException +// Provides information about an API request or response. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyDateRangeKpi +func (c *Pinpoint) GetJourneyDateRangeKpi(input *GetJourneyDateRangeKpiInput) (*GetJourneyDateRangeKpiOutput, error) { + req, out := c.GetJourneyDateRangeKpiRequest(input) + return out, req.Send() +} + +// GetJourneyDateRangeKpiWithContext is the same as GetJourneyDateRangeKpi with the addition of +// the ability to pass a context and additional request options. +// +// See GetJourneyDateRangeKpi for details on how to use this API operation. +// +// 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 *Pinpoint) GetJourneyDateRangeKpiWithContext(ctx aws.Context, input *GetJourneyDateRangeKpiInput, opts ...request.Option) (*GetJourneyDateRangeKpiOutput, error) { + req, out := c.GetJourneyDateRangeKpiRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetJourneyExecutionActivityMetrics = "GetJourneyExecutionActivityMetrics" + +// GetJourneyExecutionActivityMetricsRequest generates a "aws/request.Request" representing the +// client's request for the GetJourneyExecutionActivityMetrics operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetJourneyExecutionActivityMetrics for more information on using the GetJourneyExecutionActivityMetrics +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetJourneyExecutionActivityMetricsRequest method. +// req, resp := client.GetJourneyExecutionActivityMetricsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyExecutionActivityMetrics +func (c *Pinpoint) GetJourneyExecutionActivityMetricsRequest(input *GetJourneyExecutionActivityMetricsInput) (req *request.Request, output *GetJourneyExecutionActivityMetricsOutput) { + op := &request.Operation{ + Name: opGetJourneyExecutionActivityMetrics, + HTTPMethod: "GET", + HTTPPath: "/v1/apps/{application-id}/journeys/{journey-id}/activities/{journey-activity-id}/execution-metrics", + } + + if input == nil { + input = &GetJourneyExecutionActivityMetricsInput{} + } + + output = &GetJourneyExecutionActivityMetricsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetJourneyExecutionActivityMetrics API operation for Amazon Pinpoint. +// +// Retrieves (queries) pre-aggregated data for a standard execution metric that +// applies to a journey activity. +// +// 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 +// the error. +// +// See the AWS API reference guide for Amazon Pinpoint's +// API operation GetJourneyExecutionActivityMetrics for usage and error information. +// +// Returned Error Types: +// * BadRequestException +// Provides information about an API request or response. +// +// * InternalServerErrorException +// Provides information about an API request or response. +// +// * PayloadTooLargeException +// Provides information about an API request or response. +// +// * ForbiddenException +// Provides information about an API request or response. +// +// * NotFoundException +// Provides information about an API request or response. +// +// * MethodNotAllowedException +// Provides information about an API request or response. +// +// * TooManyRequestsException +// Provides information about an API request or response. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyExecutionActivityMetrics +func (c *Pinpoint) GetJourneyExecutionActivityMetrics(input *GetJourneyExecutionActivityMetricsInput) (*GetJourneyExecutionActivityMetricsOutput, error) { + req, out := c.GetJourneyExecutionActivityMetricsRequest(input) + return out, req.Send() +} + +// GetJourneyExecutionActivityMetricsWithContext is the same as GetJourneyExecutionActivityMetrics with the addition of +// the ability to pass a context and additional request options. +// +// See GetJourneyExecutionActivityMetrics for details on how to use this API operation. +// +// 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 *Pinpoint) GetJourneyExecutionActivityMetricsWithContext(ctx aws.Context, input *GetJourneyExecutionActivityMetricsInput, opts ...request.Option) (*GetJourneyExecutionActivityMetricsOutput, error) { + req, out := c.GetJourneyExecutionActivityMetricsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetJourneyExecutionMetrics = "GetJourneyExecutionMetrics" + +// GetJourneyExecutionMetricsRequest generates a "aws/request.Request" representing the +// client's request for the GetJourneyExecutionMetrics operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetJourneyExecutionMetrics for more information on using the GetJourneyExecutionMetrics +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetJourneyExecutionMetricsRequest method. +// req, resp := client.GetJourneyExecutionMetricsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyExecutionMetrics +func (c *Pinpoint) GetJourneyExecutionMetricsRequest(input *GetJourneyExecutionMetricsInput) (req *request.Request, output *GetJourneyExecutionMetricsOutput) { + op := &request.Operation{ + Name: opGetJourneyExecutionMetrics, + HTTPMethod: "GET", + HTTPPath: "/v1/apps/{application-id}/journeys/{journey-id}/execution-metrics", + } + + if input == nil { + input = &GetJourneyExecutionMetricsInput{} + } + + output = &GetJourneyExecutionMetricsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetJourneyExecutionMetrics API operation for Amazon Pinpoint. +// +// Retrieves (queries) pre-aggregated data for a standard execution metric that +// applies to a journey. +// +// 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 +// the error. +// +// See the AWS API reference guide for Amazon Pinpoint's +// API operation GetJourneyExecutionMetrics for usage and error information. // // Returned Error Types: // * BadRequestException @@ -9891,6 +10274,104 @@ func (c *Pinpoint) UpdateGcmChannelWithContext(ctx aws.Context, input *UpdateGcm return out, req.Send() } +const opUpdateInAppTemplate = "UpdateInAppTemplate" + +// UpdateInAppTemplateRequest generates a "aws/request.Request" representing the +// client's request for the UpdateInAppTemplate operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateInAppTemplate for more information on using the UpdateInAppTemplate +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateInAppTemplateRequest method. +// req, resp := client.UpdateInAppTemplateRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateInAppTemplate +func (c *Pinpoint) UpdateInAppTemplateRequest(input *UpdateInAppTemplateInput) (req *request.Request, output *UpdateInAppTemplateOutput) { + op := &request.Operation{ + Name: opUpdateInAppTemplate, + HTTPMethod: "PUT", + HTTPPath: "/v1/templates/{template-name}/inapp", + } + + if input == nil { + input = &UpdateInAppTemplateInput{} + } + + output = &UpdateInAppTemplateOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateInAppTemplate API operation for Amazon Pinpoint. +// +// Updates an existing message template for messages sent through the in-app +// message channel. +// +// 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 +// the error. +// +// See the AWS API reference guide for Amazon Pinpoint's +// API operation UpdateInAppTemplate for usage and error information. +// +// Returned Error Types: +// * BadRequestException +// Provides information about an API request or response. +// +// * InternalServerErrorException +// Provides information about an API request or response. +// +// * PayloadTooLargeException +// Provides information about an API request or response. +// +// * ForbiddenException +// Provides information about an API request or response. +// +// * NotFoundException +// Provides information about an API request or response. +// +// * MethodNotAllowedException +// Provides information about an API request or response. +// +// * TooManyRequestsException +// Provides information about an API request or response. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateInAppTemplate +func (c *Pinpoint) UpdateInAppTemplate(input *UpdateInAppTemplateInput) (*UpdateInAppTemplateOutput, error) { + req, out := c.UpdateInAppTemplateRequest(input) + return out, req.Send() +} + +// UpdateInAppTemplateWithContext is the same as UpdateInAppTemplate with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateInAppTemplate for details on how to use this API operation. +// +// 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 *Pinpoint) UpdateInAppTemplateWithContext(ctx aws.Context, input *UpdateInAppTemplateInput, opts ...request.Option) (*UpdateInAppTemplateOutput, error) { + req, out := c.UpdateInAppTemplateRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opUpdateJourney = "UpdateJourney" // UpdateJourneyRequest generates a "aws/request.Request" representing the @@ -14427,6 +14908,85 @@ func (s *CampaignHook) SetWebUrl(v string) *CampaignHook { return s } +// In-app message configuration. +type CampaignInAppMessage struct { + _ struct{} `type:"structure"` + + // The message body of the notification, the email body or the text message. + Body *string `type:"string"` + + // In-app message content. + Content []*InAppMessageContent `type:"list"` + + // Custom config to be sent to client. + CustomConfig map[string]*string `type:"map"` + + // In-app message layout. + Layout *string `type:"string" enum:"Layout"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CampaignInAppMessage) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CampaignInAppMessage) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CampaignInAppMessage) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CampaignInAppMessage"} + if s.Content != nil { + for i, v := range s.Content { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Content", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBody sets the Body field's value. +func (s *CampaignInAppMessage) SetBody(v string) *CampaignInAppMessage { + s.Body = &v + return s +} + +// SetContent sets the Content field's value. +func (s *CampaignInAppMessage) SetContent(v []*InAppMessageContent) *CampaignInAppMessage { + s.Content = v + return s +} + +// SetCustomConfig sets the CustomConfig field's value. +func (s *CampaignInAppMessage) SetCustomConfig(v map[string]*string) *CampaignInAppMessage { + s.CustomConfig = v + return s +} + +// SetLayout sets the Layout field's value. +func (s *CampaignInAppMessage) SetLayout(v string) *CampaignInAppMessage { + s.Layout = &v + return s +} + // For a campaign, specifies limits on the messages that the campaign can send. // For an application, specifies the default limits for messages that campaigns // in the application can send. @@ -14450,6 +15010,10 @@ type CampaignLimits struct { // maximum value is 20,000. MessagesPerSecond *int64 `type:"integer"` + // The maximum total number of messages that the campaign can send per user + // session. + Session *int64 `type:"integer"` + // The maximum number of messages that a campaign can send to a single endpoint // during the course of the campaign. If a campaign recurs, this setting applies // to all runs of the campaign. The maximum value is 100. @@ -14492,6 +15056,12 @@ func (s *CampaignLimits) SetMessagesPerSecond(v int64) *CampaignLimits { return s } +// SetSession sets the Session field's value. +func (s *CampaignLimits) SetSession(v int64) *CampaignLimits { + s.Session = &v + return s +} + // SetTotal sets the Total field's value. func (s *CampaignLimits) SetTotal(v int64) *CampaignLimits { s.Total = &v @@ -14564,6 +15134,11 @@ type CampaignResponse struct { // The name of the campaign. Name *string `type:"string"` + // Defines the priority of the campaign, used to decide the order of messages + // displayed to user if there are multiple messages scheduled to be displayed + // at the same moment + Priority *int64 `type:"integer"` + // The schedule settings for the campaign. Schedule *Schedule `type:"structure"` @@ -14708,6 +15283,12 @@ func (s *CampaignResponse) SetName(v string) *CampaignResponse { return s } +// SetPriority sets the Priority field's value. +func (s *CampaignResponse) SetPriority(v int64) *CampaignResponse { + s.Priority = &v + return s +} + // SetSchedule sets the Schedule field's value. func (s *CampaignResponse) SetSchedule(v *Schedule) *CampaignResponse { s.Schedule = v @@ -15836,6 +16417,105 @@ func (s *CreateImportJobOutput) SetImportJobResponse(v *ImportJobResponse) *Crea return s } +type CreateInAppTemplateInput struct { + _ struct{} `type:"structure" payload:"InAppTemplateRequest"` + + // In-App Template Request. + // + // InAppTemplateRequest is a required field + InAppTemplateRequest *InAppTemplateRequest `type:"structure" required:"true"` + + // TemplateName is a required field + TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateInAppTemplateInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateInAppTemplateInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateInAppTemplateInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateInAppTemplateInput"} + if s.InAppTemplateRequest == nil { + invalidParams.Add(request.NewErrParamRequired("InAppTemplateRequest")) + } + if s.TemplateName == nil { + invalidParams.Add(request.NewErrParamRequired("TemplateName")) + } + if s.TemplateName != nil && len(*s.TemplateName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TemplateName", 1)) + } + if s.InAppTemplateRequest != nil { + if err := s.InAppTemplateRequest.Validate(); err != nil { + invalidParams.AddNested("InAppTemplateRequest", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetInAppTemplateRequest sets the InAppTemplateRequest field's value. +func (s *CreateInAppTemplateInput) SetInAppTemplateRequest(v *InAppTemplateRequest) *CreateInAppTemplateInput { + s.InAppTemplateRequest = v + return s +} + +// SetTemplateName sets the TemplateName field's value. +func (s *CreateInAppTemplateInput) SetTemplateName(v string) *CreateInAppTemplateInput { + s.TemplateName = &v + return s +} + +type CreateInAppTemplateOutput struct { + _ struct{} `type:"structure" payload:"TemplateCreateMessageBody"` + + // Provides information about a request to create a message template. + // + // TemplateCreateMessageBody is a required field + TemplateCreateMessageBody *TemplateCreateMessageBody `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateInAppTemplateOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateInAppTemplateOutput) GoString() string { + return s.String() +} + +// SetTemplateCreateMessageBody sets the TemplateCreateMessageBody field's value. +func (s *CreateInAppTemplateOutput) SetTemplateCreateMessageBody(v *TemplateCreateMessageBody) *CreateInAppTemplateOutput { + s.TemplateCreateMessageBody = v + return s +} + type CreateJourneyInput struct { _ struct{} `type:"structure" payload:"WriteJourneyRequest"` @@ -16814,6 +17494,103 @@ func (s *CustomMessageActivity) SetTemplateVersion(v string) *CustomMessageActiv return s } +// Default button configuration. +type DefaultButtonConfiguration struct { + _ struct{} `type:"structure"` + + // The background color of the button. + BackgroundColor *string `type:"string"` + + // The border radius of the button. + BorderRadius *int64 `type:"integer"` + + // Action triggered by the button. + // + // ButtonAction is a required field + ButtonAction *string `type:"string" required:"true" enum:"ButtonAction"` + + // Button destination. + Link *string `type:"string"` + + // Button text. + // + // Text is a required field + Text *string `type:"string" required:"true"` + + // The text color of the button. + TextColor *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DefaultButtonConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DefaultButtonConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DefaultButtonConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DefaultButtonConfiguration"} + if s.ButtonAction == nil { + invalidParams.Add(request.NewErrParamRequired("ButtonAction")) + } + if s.Text == nil { + invalidParams.Add(request.NewErrParamRequired("Text")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBackgroundColor sets the BackgroundColor field's value. +func (s *DefaultButtonConfiguration) SetBackgroundColor(v string) *DefaultButtonConfiguration { + s.BackgroundColor = &v + return s +} + +// SetBorderRadius sets the BorderRadius field's value. +func (s *DefaultButtonConfiguration) SetBorderRadius(v int64) *DefaultButtonConfiguration { + s.BorderRadius = &v + return s +} + +// SetButtonAction sets the ButtonAction field's value. +func (s *DefaultButtonConfiguration) SetButtonAction(v string) *DefaultButtonConfiguration { + s.ButtonAction = &v + return s +} + +// SetLink sets the Link field's value. +func (s *DefaultButtonConfiguration) SetLink(v string) *DefaultButtonConfiguration { + s.Link = &v + return s +} + +// SetText sets the Text field's value. +func (s *DefaultButtonConfiguration) SetText(v string) *DefaultButtonConfiguration { + s.Text = &v + return s +} + +// SetTextColor sets the TextColor field's value. +func (s *DefaultButtonConfiguration) SetTextColor(v string) *DefaultButtonConfiguration { + s.TextColor = &v + return s +} + // Specifies the default message for all channels. type DefaultMessage struct { _ struct{} `type:"structure"` @@ -18144,6 +18921,94 @@ func (s *DeleteGcmChannelOutput) SetGCMChannelResponse(v *GCMChannelResponse) *D return s } +type DeleteInAppTemplateInput struct { + _ struct{} `type:"structure"` + + // TemplateName is a required field + TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"` + + Version *string `location:"querystring" locationName:"version" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteInAppTemplateInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteInAppTemplateInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteInAppTemplateInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteInAppTemplateInput"} + if s.TemplateName == nil { + invalidParams.Add(request.NewErrParamRequired("TemplateName")) + } + if s.TemplateName != nil && len(*s.TemplateName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TemplateName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetTemplateName sets the TemplateName field's value. +func (s *DeleteInAppTemplateInput) SetTemplateName(v string) *DeleteInAppTemplateInput { + s.TemplateName = &v + return s +} + +// SetVersion sets the Version field's value. +func (s *DeleteInAppTemplateInput) SetVersion(v string) *DeleteInAppTemplateInput { + s.Version = &v + return s +} + +type DeleteInAppTemplateOutput struct { + _ struct{} `type:"structure" payload:"MessageBody"` + + // Provides information about an API request or response. + // + // MessageBody is a required field + MessageBody *MessageBody `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteInAppTemplateOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteInAppTemplateOutput) GoString() string { + return s.String() +} + +// SetMessageBody sets the MessageBody field's value. +func (s *DeleteInAppTemplateOutput) SetMessageBody(v *MessageBody) *DeleteInAppTemplateOutput { + s.MessageBody = v + return s +} + type DeleteJourneyInput struct { _ struct{} `type:"structure"` @@ -24905,6 +25770,189 @@ func (s *GetImportJobsOutput) SetImportJobsResponse(v *ImportJobsResponse) *GetI return s } +type GetInAppMessagesInput struct { + _ struct{} `type:"structure"` + + // ApplicationId is a required field + ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` + + // EndpointId is a required field + EndpointId *string `location:"uri" locationName:"endpoint-id" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetInAppMessagesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetInAppMessagesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetInAppMessagesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetInAppMessagesInput"} + if s.ApplicationId == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationId")) + } + if s.ApplicationId != nil && len(*s.ApplicationId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationId", 1)) + } + if s.EndpointId == nil { + invalidParams.Add(request.NewErrParamRequired("EndpointId")) + } + if s.EndpointId != nil && len(*s.EndpointId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EndpointId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *GetInAppMessagesInput) SetApplicationId(v string) *GetInAppMessagesInput { + s.ApplicationId = &v + return s +} + +// SetEndpointId sets the EndpointId field's value. +func (s *GetInAppMessagesInput) SetEndpointId(v string) *GetInAppMessagesInput { + s.EndpointId = &v + return s +} + +type GetInAppMessagesOutput struct { + _ struct{} `type:"structure" payload:"InAppMessagesResponse"` + + // Get in-app messages response object. + // + // InAppMessagesResponse is a required field + InAppMessagesResponse *InAppMessagesResponse `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetInAppMessagesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetInAppMessagesOutput) GoString() string { + return s.String() +} + +// SetInAppMessagesResponse sets the InAppMessagesResponse field's value. +func (s *GetInAppMessagesOutput) SetInAppMessagesResponse(v *InAppMessagesResponse) *GetInAppMessagesOutput { + s.InAppMessagesResponse = v + return s +} + +type GetInAppTemplateInput struct { + _ struct{} `type:"structure"` + + // TemplateName is a required field + TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"` + + Version *string `location:"querystring" locationName:"version" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetInAppTemplateInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetInAppTemplateInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetInAppTemplateInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetInAppTemplateInput"} + if s.TemplateName == nil { + invalidParams.Add(request.NewErrParamRequired("TemplateName")) + } + if s.TemplateName != nil && len(*s.TemplateName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TemplateName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetTemplateName sets the TemplateName field's value. +func (s *GetInAppTemplateInput) SetTemplateName(v string) *GetInAppTemplateInput { + s.TemplateName = &v + return s +} + +// SetVersion sets the Version field's value. +func (s *GetInAppTemplateInput) SetVersion(v string) *GetInAppTemplateInput { + s.Version = &v + return s +} + +type GetInAppTemplateOutput struct { + _ struct{} `type:"structure" payload:"InAppTemplateResponse"` + + // In-App Template Response. + // + // InAppTemplateResponse is a required field + InAppTemplateResponse *InAppTemplateResponse `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetInAppTemplateOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetInAppTemplateOutput) GoString() string { + return s.String() +} + +// SetInAppTemplateResponse sets the InAppTemplateResponse field's value. +func (s *GetInAppTemplateOutput) SetInAppTemplateResponse(v *InAppTemplateResponse) *GetInAppTemplateOutput { + s.InAppTemplateResponse = v + return s +} + type GetJourneyDateRangeKpiInput struct { _ struct{} `type:"structure"` @@ -27248,6 +28296,803 @@ func (s *ImportJobsResponse) SetNextToken(v string) *ImportJobsResponse { return s } +type InAppCampaignSchedule struct { + _ struct{} `type:"structure"` + + // The scheduled time after which the in-app message should not be shown. Timestamp + // is in ISO 8601 format. + EndDate *string `type:"string"` + + // The event filter the SDK has to use to show the in-app message in the application. + EventFilter *CampaignEventFilter `type:"structure"` + + // Time during which the in-app message should not be shown to the user. + QuietTime *QuietTime `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppCampaignSchedule) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppCampaignSchedule) GoString() string { + return s.String() +} + +// SetEndDate sets the EndDate field's value. +func (s *InAppCampaignSchedule) SetEndDate(v string) *InAppCampaignSchedule { + s.EndDate = &v + return s +} + +// SetEventFilter sets the EventFilter field's value. +func (s *InAppCampaignSchedule) SetEventFilter(v *CampaignEventFilter) *InAppCampaignSchedule { + s.EventFilter = v + return s +} + +// SetQuietTime sets the QuietTime field's value. +func (s *InAppCampaignSchedule) SetQuietTime(v *QuietTime) *InAppCampaignSchedule { + s.QuietTime = v + return s +} + +// Provides all fields required for building an in-app message. +type InAppMessage struct { + _ struct{} `type:"structure"` + + // In-app message content. + Content []*InAppMessageContent `type:"list"` + + // Custom config to be sent to SDK. + CustomConfig map[string]*string `type:"map"` + + // The layout of the message. + Layout *string `type:"string" enum:"Layout"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppMessage) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppMessage) GoString() string { + return s.String() +} + +// SetContent sets the Content field's value. +func (s *InAppMessage) SetContent(v []*InAppMessageContent) *InAppMessage { + s.Content = v + return s +} + +// SetCustomConfig sets the CustomConfig field's value. +func (s *InAppMessage) SetCustomConfig(v map[string]*string) *InAppMessage { + s.CustomConfig = v + return s +} + +// SetLayout sets the Layout field's value. +func (s *InAppMessage) SetLayout(v string) *InAppMessage { + s.Layout = &v + return s +} + +// Text config for Message Body. +type InAppMessageBodyConfig struct { + _ struct{} `type:"structure"` + + // The alignment of the text. Valid values: LEFT, CENTER, RIGHT. + // + // Alignment is a required field + Alignment *string `type:"string" required:"true" enum:"Alignment"` + + // Message Body. + // + // Body is a required field + Body *string `type:"string" required:"true"` + + // The text color. + // + // TextColor is a required field + TextColor *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppMessageBodyConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppMessageBodyConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *InAppMessageBodyConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "InAppMessageBodyConfig"} + if s.Alignment == nil { + invalidParams.Add(request.NewErrParamRequired("Alignment")) + } + if s.Body == nil { + invalidParams.Add(request.NewErrParamRequired("Body")) + } + if s.TextColor == nil { + invalidParams.Add(request.NewErrParamRequired("TextColor")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAlignment sets the Alignment field's value. +func (s *InAppMessageBodyConfig) SetAlignment(v string) *InAppMessageBodyConfig { + s.Alignment = &v + return s +} + +// SetBody sets the Body field's value. +func (s *InAppMessageBodyConfig) SetBody(v string) *InAppMessageBodyConfig { + s.Body = &v + return s +} + +// SetTextColor sets the TextColor field's value. +func (s *InAppMessageBodyConfig) SetTextColor(v string) *InAppMessageBodyConfig { + s.TextColor = &v + return s +} + +// Button Config for an in-app message. +type InAppMessageButton struct { + _ struct{} `type:"structure"` + + // Default button content. + Android *OverrideButtonConfiguration `type:"structure"` + + // Default button content. + DefaultConfig *DefaultButtonConfiguration `type:"structure"` + + // Default button content. + IOS *OverrideButtonConfiguration `type:"structure"` + + // Default button content. + Web *OverrideButtonConfiguration `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppMessageButton) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppMessageButton) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *InAppMessageButton) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "InAppMessageButton"} + if s.Android != nil { + if err := s.Android.Validate(); err != nil { + invalidParams.AddNested("Android", err.(request.ErrInvalidParams)) + } + } + if s.DefaultConfig != nil { + if err := s.DefaultConfig.Validate(); err != nil { + invalidParams.AddNested("DefaultConfig", err.(request.ErrInvalidParams)) + } + } + if s.IOS != nil { + if err := s.IOS.Validate(); err != nil { + invalidParams.AddNested("IOS", err.(request.ErrInvalidParams)) + } + } + if s.Web != nil { + if err := s.Web.Validate(); err != nil { + invalidParams.AddNested("Web", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAndroid sets the Android field's value. +func (s *InAppMessageButton) SetAndroid(v *OverrideButtonConfiguration) *InAppMessageButton { + s.Android = v + return s +} + +// SetDefaultConfig sets the DefaultConfig field's value. +func (s *InAppMessageButton) SetDefaultConfig(v *DefaultButtonConfiguration) *InAppMessageButton { + s.DefaultConfig = v + return s +} + +// SetIOS sets the IOS field's value. +func (s *InAppMessageButton) SetIOS(v *OverrideButtonConfiguration) *InAppMessageButton { + s.IOS = v + return s +} + +// SetWeb sets the Web field's value. +func (s *InAppMessageButton) SetWeb(v *OverrideButtonConfiguration) *InAppMessageButton { + s.Web = v + return s +} + +type InAppMessageCampaign struct { + _ struct{} `type:"structure"` + + // Campaign id of the corresponding campaign. + CampaignId *string `type:"string"` + + // Daily cap which controls the number of times any in-app messages can be shown + // to the endpoint during a day. + DailyCap *int64 `type:"integer"` + + // In-app message content with all fields required for rendering an in-app message. + InAppMessage *InAppMessage `type:"structure"` + + // Priority of the in-app message. + Priority *int64 `type:"integer"` + + // Schedule of the campaign. + Schedule *InAppCampaignSchedule `type:"structure"` + + // Session cap which controls the number of times an in-app message can be shown + // to the endpoint during an application session. + SessionCap *int64 `type:"integer"` + + // Total cap which controls the number of times an in-app message can be shown + // to the endpoint. + TotalCap *int64 `type:"integer"` + + // Treatment id of the campaign. + TreatmentId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppMessageCampaign) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppMessageCampaign) GoString() string { + return s.String() +} + +// SetCampaignId sets the CampaignId field's value. +func (s *InAppMessageCampaign) SetCampaignId(v string) *InAppMessageCampaign { + s.CampaignId = &v + return s +} + +// SetDailyCap sets the DailyCap field's value. +func (s *InAppMessageCampaign) SetDailyCap(v int64) *InAppMessageCampaign { + s.DailyCap = &v + return s +} + +// SetInAppMessage sets the InAppMessage field's value. +func (s *InAppMessageCampaign) SetInAppMessage(v *InAppMessage) *InAppMessageCampaign { + s.InAppMessage = v + return s +} + +// SetPriority sets the Priority field's value. +func (s *InAppMessageCampaign) SetPriority(v int64) *InAppMessageCampaign { + s.Priority = &v + return s +} + +// SetSchedule sets the Schedule field's value. +func (s *InAppMessageCampaign) SetSchedule(v *InAppCampaignSchedule) *InAppMessageCampaign { + s.Schedule = v + return s +} + +// SetSessionCap sets the SessionCap field's value. +func (s *InAppMessageCampaign) SetSessionCap(v int64) *InAppMessageCampaign { + s.SessionCap = &v + return s +} + +// SetTotalCap sets the TotalCap field's value. +func (s *InAppMessageCampaign) SetTotalCap(v int64) *InAppMessageCampaign { + s.TotalCap = &v + return s +} + +// SetTreatmentId sets the TreatmentId field's value. +func (s *InAppMessageCampaign) SetTreatmentId(v string) *InAppMessageCampaign { + s.TreatmentId = &v + return s +} + +// The configuration for the message content. +type InAppMessageContent struct { + _ struct{} `type:"structure"` + + // The background color for the message. + BackgroundColor *string `type:"string"` + + // The configuration for the message body. + BodyConfig *InAppMessageBodyConfig `type:"structure"` + + // The configuration for the message header. + HeaderConfig *InAppMessageHeaderConfig `type:"structure"` + + // The image url for the background of message. + ImageUrl *string `type:"string"` + + // The first button inside the message. + PrimaryBtn *InAppMessageButton `type:"structure"` + + // The second button inside message. + SecondaryBtn *InAppMessageButton `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppMessageContent) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppMessageContent) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *InAppMessageContent) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "InAppMessageContent"} + if s.BodyConfig != nil { + if err := s.BodyConfig.Validate(); err != nil { + invalidParams.AddNested("BodyConfig", err.(request.ErrInvalidParams)) + } + } + if s.HeaderConfig != nil { + if err := s.HeaderConfig.Validate(); err != nil { + invalidParams.AddNested("HeaderConfig", err.(request.ErrInvalidParams)) + } + } + if s.PrimaryBtn != nil { + if err := s.PrimaryBtn.Validate(); err != nil { + invalidParams.AddNested("PrimaryBtn", err.(request.ErrInvalidParams)) + } + } + if s.SecondaryBtn != nil { + if err := s.SecondaryBtn.Validate(); err != nil { + invalidParams.AddNested("SecondaryBtn", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBackgroundColor sets the BackgroundColor field's value. +func (s *InAppMessageContent) SetBackgroundColor(v string) *InAppMessageContent { + s.BackgroundColor = &v + return s +} + +// SetBodyConfig sets the BodyConfig field's value. +func (s *InAppMessageContent) SetBodyConfig(v *InAppMessageBodyConfig) *InAppMessageContent { + s.BodyConfig = v + return s +} + +// SetHeaderConfig sets the HeaderConfig field's value. +func (s *InAppMessageContent) SetHeaderConfig(v *InAppMessageHeaderConfig) *InAppMessageContent { + s.HeaderConfig = v + return s +} + +// SetImageUrl sets the ImageUrl field's value. +func (s *InAppMessageContent) SetImageUrl(v string) *InAppMessageContent { + s.ImageUrl = &v + return s +} + +// SetPrimaryBtn sets the PrimaryBtn field's value. +func (s *InAppMessageContent) SetPrimaryBtn(v *InAppMessageButton) *InAppMessageContent { + s.PrimaryBtn = v + return s +} + +// SetSecondaryBtn sets the SecondaryBtn field's value. +func (s *InAppMessageContent) SetSecondaryBtn(v *InAppMessageButton) *InAppMessageContent { + s.SecondaryBtn = v + return s +} + +// Text config for Message Header. +type InAppMessageHeaderConfig struct { + _ struct{} `type:"structure"` + + // The alignment of the text. Valid values: LEFT, CENTER, RIGHT. + // + // Alignment is a required field + Alignment *string `type:"string" required:"true" enum:"Alignment"` + + // Message Header. + // + // Header is a required field + Header *string `type:"string" required:"true"` + + // The text color. + // + // TextColor is a required field + TextColor *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppMessageHeaderConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppMessageHeaderConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *InAppMessageHeaderConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "InAppMessageHeaderConfig"} + if s.Alignment == nil { + invalidParams.Add(request.NewErrParamRequired("Alignment")) + } + if s.Header == nil { + invalidParams.Add(request.NewErrParamRequired("Header")) + } + if s.TextColor == nil { + invalidParams.Add(request.NewErrParamRequired("TextColor")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAlignment sets the Alignment field's value. +func (s *InAppMessageHeaderConfig) SetAlignment(v string) *InAppMessageHeaderConfig { + s.Alignment = &v + return s +} + +// SetHeader sets the Header field's value. +func (s *InAppMessageHeaderConfig) SetHeader(v string) *InAppMessageHeaderConfig { + s.Header = &v + return s +} + +// SetTextColor sets the TextColor field's value. +func (s *InAppMessageHeaderConfig) SetTextColor(v string) *InAppMessageHeaderConfig { + s.TextColor = &v + return s +} + +// Get in-app messages response object. +type InAppMessagesResponse struct { + _ struct{} `type:"structure"` + + // List of targeted in-app message campaigns. + InAppMessageCampaigns []*InAppMessageCampaign `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppMessagesResponse) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppMessagesResponse) GoString() string { + return s.String() +} + +// SetInAppMessageCampaigns sets the InAppMessageCampaigns field's value. +func (s *InAppMessagesResponse) SetInAppMessageCampaigns(v []*InAppMessageCampaign) *InAppMessagesResponse { + s.InAppMessageCampaigns = v + return s +} + +// In-App Template Request. +type InAppTemplateRequest struct { + _ struct{} `type:"structure"` + + // The content of the message, can include up to 5 modals. Each modal must contain + // a message, a header, and background color. ImageUrl and buttons are optional. + Content []*InAppMessageContent `type:"list"` + + // Custom config to be sent to client. + CustomConfig map[string]*string `type:"map"` + + // The layout of the message. + Layout *string `type:"string" enum:"Layout"` + + // A string-to-string map of key-value pairs that defines the tags to associate + // with the message template. Each tag consists of a required tag key and an + // associated tag value. + Tags map[string]*string `locationName:"tags" type:"map"` + + // The description of the template. + TemplateDescription *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppTemplateRequest) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppTemplateRequest) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *InAppTemplateRequest) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "InAppTemplateRequest"} + if s.Content != nil { + for i, v := range s.Content { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Content", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetContent sets the Content field's value. +func (s *InAppTemplateRequest) SetContent(v []*InAppMessageContent) *InAppTemplateRequest { + s.Content = v + return s +} + +// SetCustomConfig sets the CustomConfig field's value. +func (s *InAppTemplateRequest) SetCustomConfig(v map[string]*string) *InAppTemplateRequest { + s.CustomConfig = v + return s +} + +// SetLayout sets the Layout field's value. +func (s *InAppTemplateRequest) SetLayout(v string) *InAppTemplateRequest { + s.Layout = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *InAppTemplateRequest) SetTags(v map[string]*string) *InAppTemplateRequest { + s.Tags = v + return s +} + +// SetTemplateDescription sets the TemplateDescription field's value. +func (s *InAppTemplateRequest) SetTemplateDescription(v string) *InAppTemplateRequest { + s.TemplateDescription = &v + return s +} + +// In-App Template Response. +type InAppTemplateResponse struct { + _ struct{} `type:"structure"` + + // The resource arn of the template. + Arn *string `type:"string"` + + // The content of the message, can include up to 5 modals. Each modal must contain + // a message, a header, and background color. ImageUrl and buttons are optional. + Content []*InAppMessageContent `type:"list"` + + // The creation date of the template. + // + // CreationDate is a required field + CreationDate *string `type:"string" required:"true"` + + // Custom config to be sent to client. + CustomConfig map[string]*string `type:"map"` + + // The last modified date of the template. + // + // LastModifiedDate is a required field + LastModifiedDate *string `type:"string" required:"true"` + + // The layout of the message. + Layout *string `type:"string" enum:"Layout"` + + // Tags map that contains arn and InternalId for API GW. + Tags map[string]*string `locationName:"tags" type:"map"` + + // The description of the template. + TemplateDescription *string `type:"string"` + + // The name of the template. + // + // TemplateName is a required field + TemplateName *string `type:"string" required:"true"` + + // The type of the template. + // + // TemplateType is a required field + TemplateType *string `type:"string" required:"true" enum:"TemplateType"` + + // The version id of the template. + Version *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppTemplateResponse) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InAppTemplateResponse) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *InAppTemplateResponse) SetArn(v string) *InAppTemplateResponse { + s.Arn = &v + return s +} + +// SetContent sets the Content field's value. +func (s *InAppTemplateResponse) SetContent(v []*InAppMessageContent) *InAppTemplateResponse { + s.Content = v + return s +} + +// SetCreationDate sets the CreationDate field's value. +func (s *InAppTemplateResponse) SetCreationDate(v string) *InAppTemplateResponse { + s.CreationDate = &v + return s +} + +// SetCustomConfig sets the CustomConfig field's value. +func (s *InAppTemplateResponse) SetCustomConfig(v map[string]*string) *InAppTemplateResponse { + s.CustomConfig = v + return s +} + +// SetLastModifiedDate sets the LastModifiedDate field's value. +func (s *InAppTemplateResponse) SetLastModifiedDate(v string) *InAppTemplateResponse { + s.LastModifiedDate = &v + return s +} + +// SetLayout sets the Layout field's value. +func (s *InAppTemplateResponse) SetLayout(v string) *InAppTemplateResponse { + s.Layout = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *InAppTemplateResponse) SetTags(v map[string]*string) *InAppTemplateResponse { + s.Tags = v + return s +} + +// SetTemplateDescription sets the TemplateDescription field's value. +func (s *InAppTemplateResponse) SetTemplateDescription(v string) *InAppTemplateResponse { + s.TemplateDescription = &v + return s +} + +// SetTemplateName sets the TemplateName field's value. +func (s *InAppTemplateResponse) SetTemplateName(v string) *InAppTemplateResponse { + s.TemplateName = &v + return s +} + +// SetTemplateType sets the TemplateType field's value. +func (s *InAppTemplateResponse) SetTemplateType(v string) *InAppTemplateResponse { + s.TemplateType = &v + return s +} + +// SetVersion sets the Version field's value. +func (s *InAppTemplateResponse) SetVersion(v string) *InAppTemplateResponse { + s.Version = &v + return s +} + // Provides information about an API request or response. type InternalServerErrorException struct { _ struct{} `type:"structure"` @@ -27363,7 +29208,6 @@ func (s *ItemResponse) SetEventsItemResponse(v map[string]*EventItemResponse) *I type JourneyCustomMessage struct { _ struct{} `type:"structure"` - // The message content that's passed to an AWS Lambda function or to a web hook. Data *string `type:"string"` } @@ -28912,6 +30756,9 @@ type MessageConfiguration struct { // message overrides the default message. GCMMessage *Message `type:"structure"` + // The in-app message configuration. + InAppMessage *CampaignInAppMessage `type:"structure"` + // The message that the campaign sends through the SMS channel. If specified, // this message overrides the default message. SMSMessage *CampaignSmsMessage `type:"structure"` @@ -28935,6 +30782,21 @@ func (s MessageConfiguration) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *MessageConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "MessageConfiguration"} + if s.InAppMessage != nil { + if err := s.InAppMessage.Validate(); err != nil { + invalidParams.AddNested("InAppMessage", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetADMMessage sets the ADMMessage field's value. func (s *MessageConfiguration) SetADMMessage(v *Message) *MessageConfiguration { s.ADMMessage = v @@ -28977,6 +30839,12 @@ func (s *MessageConfiguration) SetGCMMessage(v *Message) *MessageConfiguration { return s } +// SetInAppMessage sets the InAppMessage field's value. +func (s *MessageConfiguration) SetInAppMessage(v *CampaignInAppMessage) *MessageConfiguration { + s.InAppMessage = v + return s +} + // SetSMSMessage sets the SMSMessage field's value. func (s *MessageConfiguration) SetSMSMessage(v *CampaignSmsMessage) *MessageConfiguration { s.SMSMessage = v @@ -29790,6 +31658,62 @@ func (s *NumberValidateResponse) SetZipCode(v string) *NumberValidateResponse { return s } +// Override button configuration. +type OverrideButtonConfiguration struct { + _ struct{} `type:"structure"` + + // Action triggered by the button. + // + // ButtonAction is a required field + ButtonAction *string `type:"string" required:"true" enum:"ButtonAction"` + + // Button destination. + Link *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OverrideButtonConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OverrideButtonConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *OverrideButtonConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "OverrideButtonConfiguration"} + if s.ButtonAction == nil { + invalidParams.Add(request.NewErrParamRequired("ButtonAction")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetButtonAction sets the ButtonAction field's value. +func (s *OverrideButtonConfiguration) SetButtonAction(v string) *OverrideButtonConfiguration { + s.ButtonAction = &v + return s +} + +// SetLink sets the Link field's value. +func (s *OverrideButtonConfiguration) SetLink(v string) *OverrideButtonConfiguration { + s.Link = &v + return s +} + // Provides information about an API request or response. type PayloadTooLargeException struct { _ struct{} `type:"structure"` @@ -33988,6 +35912,57 @@ func (s *TemplateConfiguration) SetVoiceTemplate(v *Template) *TemplateConfigura return s } +// Provides information about a request to create a message template. +type TemplateCreateMessageBody struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the message template that was created. + Arn *string `type:"string"` + + // The message that's returned from the API for the request to create the message + // template. + Message *string `type:"string"` + + // The unique identifier for the request to create the message template. + RequestID *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TemplateCreateMessageBody) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TemplateCreateMessageBody) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *TemplateCreateMessageBody) SetArn(v string) *TemplateCreateMessageBody { + s.Arn = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *TemplateCreateMessageBody) SetMessage(v string) *TemplateCreateMessageBody { + s.Message = &v + return s +} + +// SetRequestID sets the RequestID field's value. +func (s *TemplateCreateMessageBody) SetRequestID(v string) *TemplateCreateMessageBody { + s.RequestID = &v + return s +} + // Provides information about a message template that's associated with your // Amazon Pinpoint account. type TemplateResponse struct { @@ -35947,6 +37922,121 @@ func (s *UpdateGcmChannelOutput) SetGCMChannelResponse(v *GCMChannelResponse) *U return s } +type UpdateInAppTemplateInput struct { + _ struct{} `type:"structure" payload:"InAppTemplateRequest"` + + CreateNewVersion *bool `location:"querystring" locationName:"create-new-version" type:"boolean"` + + // In-App Template Request. + // + // InAppTemplateRequest is a required field + InAppTemplateRequest *InAppTemplateRequest `type:"structure" required:"true"` + + // TemplateName is a required field + TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"` + + Version *string `location:"querystring" locationName:"version" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateInAppTemplateInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateInAppTemplateInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateInAppTemplateInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateInAppTemplateInput"} + if s.InAppTemplateRequest == nil { + invalidParams.Add(request.NewErrParamRequired("InAppTemplateRequest")) + } + if s.TemplateName == nil { + invalidParams.Add(request.NewErrParamRequired("TemplateName")) + } + if s.TemplateName != nil && len(*s.TemplateName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TemplateName", 1)) + } + if s.InAppTemplateRequest != nil { + if err := s.InAppTemplateRequest.Validate(); err != nil { + invalidParams.AddNested("InAppTemplateRequest", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCreateNewVersion sets the CreateNewVersion field's value. +func (s *UpdateInAppTemplateInput) SetCreateNewVersion(v bool) *UpdateInAppTemplateInput { + s.CreateNewVersion = &v + return s +} + +// SetInAppTemplateRequest sets the InAppTemplateRequest field's value. +func (s *UpdateInAppTemplateInput) SetInAppTemplateRequest(v *InAppTemplateRequest) *UpdateInAppTemplateInput { + s.InAppTemplateRequest = v + return s +} + +// SetTemplateName sets the TemplateName field's value. +func (s *UpdateInAppTemplateInput) SetTemplateName(v string) *UpdateInAppTemplateInput { + s.TemplateName = &v + return s +} + +// SetVersion sets the Version field's value. +func (s *UpdateInAppTemplateInput) SetVersion(v string) *UpdateInAppTemplateInput { + s.Version = &v + return s +} + +type UpdateInAppTemplateOutput struct { + _ struct{} `type:"structure" payload:"MessageBody"` + + // Provides information about an API request or response. + // + // MessageBody is a required field + MessageBody *MessageBody `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateInAppTemplateOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateInAppTemplateOutput) GoString() string { + return s.String() +} + +// SetMessageBody sets the MessageBody field's value. +func (s *UpdateInAppTemplateOutput) SetMessageBody(v *MessageBody) *UpdateInAppTemplateOutput { + s.MessageBody = v + return s +} + type UpdateJourneyInput struct { _ struct{} `type:"structure" payload:"WriteJourneyRequest"` @@ -37897,6 +39987,11 @@ type WriteCampaignRequest struct { // A custom name for the campaign. Name *string `type:"string"` + // Defines the priority of the campaign, used to decide the order of messages + // displayed to user if there are multiple messages scheduled to be displayed + // at the same moment. + Priority *int64 `type:"integer"` + // The schedule settings for the campaign. Schedule *Schedule `type:"structure"` @@ -37959,6 +40054,11 @@ func (s *WriteCampaignRequest) Validate() error { invalidParams.AddNested("CustomDeliveryConfiguration", err.(request.ErrInvalidParams)) } } + if s.MessageConfiguration != nil { + if err := s.MessageConfiguration.Validate(); err != nil { + invalidParams.AddNested("MessageConfiguration", err.(request.ErrInvalidParams)) + } + } if s.Schedule != nil { if err := s.Schedule.Validate(); err != nil { invalidParams.AddNested("Schedule", err.(request.ErrInvalidParams)) @@ -38025,6 +40125,12 @@ func (s *WriteCampaignRequest) SetName(v string) *WriteCampaignRequest { return s } +// SetPriority sets the Priority field's value. +func (s *WriteCampaignRequest) SetPriority(v int64) *WriteCampaignRequest { + s.Priority = &v + return s +} + // SetSchedule sets the Schedule field's value. func (s *WriteCampaignRequest) SetSchedule(v *Schedule) *WriteCampaignRequest { s.Schedule = v @@ -38496,6 +40602,11 @@ func (s *WriteTreatmentResource) Validate() error { invalidParams.AddNested("CustomDeliveryConfiguration", err.(request.ErrInvalidParams)) } } + if s.MessageConfiguration != nil { + if err := s.MessageConfiguration.Validate(); err != nil { + invalidParams.AddNested("MessageConfiguration", err.(request.ErrInvalidParams)) + } + } if s.Schedule != nil { if err := s.Schedule.Validate(); err != nil { invalidParams.AddNested("Schedule", err.(request.ErrInvalidParams)) @@ -38570,6 +40681,26 @@ func Action_Values() []string { } } +const ( + // AlignmentLeft is a Alignment enum value + AlignmentLeft = "LEFT" + + // AlignmentCenter is a Alignment enum value + AlignmentCenter = "CENTER" + + // AlignmentRight is a Alignment enum value + AlignmentRight = "RIGHT" +) + +// Alignment_Values returns all elements of the Alignment enum +func Alignment_Values() []string { + return []string{ + AlignmentLeft, + AlignmentCenter, + AlignmentRight, + } +} + const ( // AttributeTypeInclusive is a AttributeType enum value AttributeTypeInclusive = "INCLUSIVE" @@ -38606,6 +40737,26 @@ func AttributeType_Values() []string { } } +const ( + // ButtonActionLink is a ButtonAction enum value + ButtonActionLink = "LINK" + + // ButtonActionDeepLink is a ButtonAction enum value + ButtonActionDeepLink = "DEEP_LINK" + + // ButtonActionClose is a ButtonAction enum value + ButtonActionClose = "CLOSE" +) + +// ButtonAction_Values returns all elements of the ButtonAction enum +func ButtonAction_Values() []string { + return []string{ + ButtonActionLink, + ButtonActionDeepLink, + ButtonActionClose, + } +} + const ( // CampaignStatusScheduled is a CampaignStatus enum value CampaignStatusScheduled = "SCHEDULED" @@ -38678,6 +40829,9 @@ const ( // ChannelTypeCustom is a ChannelType enum value ChannelTypeCustom = "CUSTOM" + + // ChannelTypeInApp is a ChannelType enum value + ChannelTypeInApp = "IN_APP" ) // ChannelType_Values returns all elements of the ChannelType enum @@ -38695,6 +40849,7 @@ func ChannelType_Values() []string { ChannelTypeEmail, ChannelTypeBaidu, ChannelTypeCustom, + ChannelTypeInApp, } } @@ -38810,6 +40965,9 @@ const ( // EndpointTypesElementCustom is a EndpointTypesElement enum value EndpointTypesElementCustom = "CUSTOM" + + // EndpointTypesElementInApp is a EndpointTypesElement enum value + EndpointTypesElementInApp = "IN_APP" ) // EndpointTypesElement_Values returns all elements of the EndpointTypesElement enum @@ -38827,6 +40985,7 @@ func EndpointTypesElement_Values() []string { EndpointTypesElementEmail, EndpointTypesElementBaidu, EndpointTypesElementCustom, + EndpointTypesElementInApp, } } @@ -38880,6 +41039,9 @@ const ( // FrequencyEvent is a Frequency enum value FrequencyEvent = "EVENT" + + // FrequencyInAppEvent is a Frequency enum value + FrequencyInAppEvent = "IN_APP_EVENT" ) // Frequency_Values returns all elements of the Frequency enum @@ -38891,6 +41053,7 @@ func Frequency_Values() []string { FrequencyWeekly, FrequencyMonthly, FrequencyEvent, + FrequencyInAppEvent, } } @@ -38958,6 +41121,38 @@ func JobStatus_Values() []string { } } +const ( + // LayoutBottomBanner is a Layout enum value + LayoutBottomBanner = "BOTTOM_BANNER" + + // LayoutTopBanner is a Layout enum value + LayoutTopBanner = "TOP_BANNER" + + // LayoutOverlays is a Layout enum value + LayoutOverlays = "OVERLAYS" + + // LayoutMobileFeed is a Layout enum value + LayoutMobileFeed = "MOBILE_FEED" + + // LayoutMiddleBanner is a Layout enum value + LayoutMiddleBanner = "MIDDLE_BANNER" + + // LayoutCarousel is a Layout enum value + LayoutCarousel = "CAROUSEL" +) + +// Layout_Values returns all elements of the Layout enum +func Layout_Values() []string { + return []string{ + LayoutBottomBanner, + LayoutTopBanner, + LayoutOverlays, + LayoutMobileFeed, + LayoutMiddleBanner, + LayoutCarousel, + } +} + const ( // MessageTypeTransactional is a MessageType enum value MessageTypeTransactional = "TRANSACTIONAL" @@ -39102,6 +41297,9 @@ const ( // TemplateTypePush is a TemplateType enum value TemplateTypePush = "PUSH" + + // TemplateTypeInapp is a TemplateType enum value + TemplateTypeInapp = "INAPP" ) // TemplateType_Values returns all elements of the TemplateType enum @@ -39111,6 +41309,7 @@ func TemplateType_Values() []string { TemplateTypeSms, TemplateTypeVoice, TemplateTypePush, + TemplateTypeInapp, } } diff --git a/service/pinpoint/pinpointiface/interface.go b/service/pinpoint/pinpointiface/interface.go index 97f72adc385..18928fc843a 100644 --- a/service/pinpoint/pinpointiface/interface.go +++ b/service/pinpoint/pinpointiface/interface.go @@ -80,6 +80,10 @@ type PinpointAPI interface { CreateImportJobWithContext(aws.Context, *pinpoint.CreateImportJobInput, ...request.Option) (*pinpoint.CreateImportJobOutput, error) CreateImportJobRequest(*pinpoint.CreateImportJobInput) (*request.Request, *pinpoint.CreateImportJobOutput) + CreateInAppTemplate(*pinpoint.CreateInAppTemplateInput) (*pinpoint.CreateInAppTemplateOutput, error) + CreateInAppTemplateWithContext(aws.Context, *pinpoint.CreateInAppTemplateInput, ...request.Option) (*pinpoint.CreateInAppTemplateOutput, error) + CreateInAppTemplateRequest(*pinpoint.CreateInAppTemplateInput) (*request.Request, *pinpoint.CreateInAppTemplateOutput) + CreateJourney(*pinpoint.CreateJourneyInput) (*pinpoint.CreateJourneyOutput, error) CreateJourneyWithContext(aws.Context, *pinpoint.CreateJourneyInput, ...request.Option) (*pinpoint.CreateJourneyOutput, error) CreateJourneyRequest(*pinpoint.CreateJourneyInput) (*request.Request, *pinpoint.CreateJourneyOutput) @@ -156,6 +160,10 @@ type PinpointAPI interface { DeleteGcmChannelWithContext(aws.Context, *pinpoint.DeleteGcmChannelInput, ...request.Option) (*pinpoint.DeleteGcmChannelOutput, error) DeleteGcmChannelRequest(*pinpoint.DeleteGcmChannelInput) (*request.Request, *pinpoint.DeleteGcmChannelOutput) + DeleteInAppTemplate(*pinpoint.DeleteInAppTemplateInput) (*pinpoint.DeleteInAppTemplateOutput, error) + DeleteInAppTemplateWithContext(aws.Context, *pinpoint.DeleteInAppTemplateInput, ...request.Option) (*pinpoint.DeleteInAppTemplateOutput, error) + DeleteInAppTemplateRequest(*pinpoint.DeleteInAppTemplateInput) (*request.Request, *pinpoint.DeleteInAppTemplateOutput) + DeleteJourney(*pinpoint.DeleteJourneyInput) (*pinpoint.DeleteJourneyOutput, error) DeleteJourneyWithContext(aws.Context, *pinpoint.DeleteJourneyInput, ...request.Option) (*pinpoint.DeleteJourneyOutput, error) DeleteJourneyRequest(*pinpoint.DeleteJourneyInput) (*request.Request, *pinpoint.DeleteJourneyOutput) @@ -296,6 +304,14 @@ type PinpointAPI interface { GetImportJobsWithContext(aws.Context, *pinpoint.GetImportJobsInput, ...request.Option) (*pinpoint.GetImportJobsOutput, error) GetImportJobsRequest(*pinpoint.GetImportJobsInput) (*request.Request, *pinpoint.GetImportJobsOutput) + GetInAppMessages(*pinpoint.GetInAppMessagesInput) (*pinpoint.GetInAppMessagesOutput, error) + GetInAppMessagesWithContext(aws.Context, *pinpoint.GetInAppMessagesInput, ...request.Option) (*pinpoint.GetInAppMessagesOutput, error) + GetInAppMessagesRequest(*pinpoint.GetInAppMessagesInput) (*request.Request, *pinpoint.GetInAppMessagesOutput) + + GetInAppTemplate(*pinpoint.GetInAppTemplateInput) (*pinpoint.GetInAppTemplateOutput, error) + GetInAppTemplateWithContext(aws.Context, *pinpoint.GetInAppTemplateInput, ...request.Option) (*pinpoint.GetInAppTemplateOutput, error) + GetInAppTemplateRequest(*pinpoint.GetInAppTemplateInput) (*request.Request, *pinpoint.GetInAppTemplateOutput) + GetJourney(*pinpoint.GetJourneyInput) (*pinpoint.GetJourneyOutput, error) GetJourneyWithContext(aws.Context, *pinpoint.GetJourneyInput, ...request.Option) (*pinpoint.GetJourneyOutput, error) GetJourneyRequest(*pinpoint.GetJourneyInput) (*request.Request, *pinpoint.GetJourneyOutput) @@ -468,6 +484,10 @@ type PinpointAPI interface { UpdateGcmChannelWithContext(aws.Context, *pinpoint.UpdateGcmChannelInput, ...request.Option) (*pinpoint.UpdateGcmChannelOutput, error) UpdateGcmChannelRequest(*pinpoint.UpdateGcmChannelInput) (*request.Request, *pinpoint.UpdateGcmChannelOutput) + UpdateInAppTemplate(*pinpoint.UpdateInAppTemplateInput) (*pinpoint.UpdateInAppTemplateOutput, error) + UpdateInAppTemplateWithContext(aws.Context, *pinpoint.UpdateInAppTemplateInput, ...request.Option) (*pinpoint.UpdateInAppTemplateOutput, error) + UpdateInAppTemplateRequest(*pinpoint.UpdateInAppTemplateInput) (*request.Request, *pinpoint.UpdateInAppTemplateOutput) + UpdateJourney(*pinpoint.UpdateJourneyInput) (*pinpoint.UpdateJourneyOutput, error) UpdateJourneyWithContext(aws.Context, *pinpoint.UpdateJourneyInput, ...request.Option) (*pinpoint.UpdateJourneyOutput, error) UpdateJourneyRequest(*pinpoint.UpdateJourneyInput) (*request.Request, *pinpoint.UpdateJourneyOutput) diff --git a/service/robomaker/api.go b/service/robomaker/api.go index 3433e3ffbee..1dde0f00ba1 100644 --- a/service/robomaker/api.go +++ b/service/robomaker/api.go @@ -7013,6 +7013,10 @@ func (s *CreateFleetOutput) SetTags(v map[string]*string) *CreateFleetOutput { type CreateRobotApplicationInput struct { _ struct{} `type:"structure"` + // The object that contains that URI of the Docker image that you use for your + // robot application. + Environment *Environment `locationName:"environment" type:"structure"` + // The name of the robot application. // // Name is a required field @@ -7024,9 +7028,7 @@ type CreateRobotApplicationInput struct { RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure" required:"true"` // The sources of the robot application. - // - // Sources is a required field - Sources []*SourceConfig `locationName:"sources" type:"list" required:"true"` + Sources []*SourceConfig `locationName:"sources" type:"list"` // A map that contains tag keys and tag values that are attached to the robot // application. @@ -7063,8 +7065,10 @@ func (s *CreateRobotApplicationInput) Validate() error { if s.RobotSoftwareSuite == nil { invalidParams.Add(request.NewErrParamRequired("RobotSoftwareSuite")) } - if s.Sources == nil { - invalidParams.Add(request.NewErrParamRequired("Sources")) + if s.Environment != nil { + if err := s.Environment.Validate(); err != nil { + invalidParams.AddNested("Environment", err.(request.ErrInvalidParams)) + } } if s.Sources != nil { for i, v := range s.Sources { @@ -7083,6 +7087,12 @@ func (s *CreateRobotApplicationInput) Validate() error { return nil } +// SetEnvironment sets the Environment field's value. +func (s *CreateRobotApplicationInput) SetEnvironment(v *Environment) *CreateRobotApplicationInput { + s.Environment = v + return s +} + // SetName sets the Name field's value. func (s *CreateRobotApplicationInput) SetName(v string) *CreateRobotApplicationInput { s.Name = &v @@ -7113,6 +7123,10 @@ type CreateRobotApplicationOutput struct { // The Amazon Resource Name (ARN) of the robot application. Arn *string `locationName:"arn" min:"1" type:"string"` + // An object that contains the Docker image URI used to a create your robot + // application. + Environment *Environment `locationName:"environment" type:"structure"` + // The time, in milliseconds since the epoch, when the robot application was // last updated. LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` @@ -7160,6 +7174,12 @@ func (s *CreateRobotApplicationOutput) SetArn(v string) *CreateRobotApplicationO return s } +// SetEnvironment sets the Environment field's value. +func (s *CreateRobotApplicationOutput) SetEnvironment(v *Environment) *CreateRobotApplicationOutput { + s.Environment = v + return s +} + // SetLastUpdatedAt sets the LastUpdatedAt field's value. func (s *CreateRobotApplicationOutput) SetLastUpdatedAt(v time.Time) *CreateRobotApplicationOutput { s.LastUpdatedAt = &v @@ -7213,6 +7233,13 @@ type CreateRobotApplicationVersionInput struct { // The current revision id for the robot application. If you provide a value // and it matches the latest revision ID, a new version will be created. CurrentRevisionId *string `locationName:"currentRevisionId" min:"1" type:"string"` + + // A SHA256 identifier for the Docker image that you use for your robot application. + ImageDigest *string `locationName:"imageDigest" type:"string"` + + // The Amazon S3 identifier for the zip file bundle that you use for your robot + // application. + S3Etags []*string `locationName:"s3Etags" type:"list"` } // String returns the string representation. @@ -7264,12 +7291,27 @@ func (s *CreateRobotApplicationVersionInput) SetCurrentRevisionId(v string) *Cre return s } +// SetImageDigest sets the ImageDigest field's value. +func (s *CreateRobotApplicationVersionInput) SetImageDigest(v string) *CreateRobotApplicationVersionInput { + s.ImageDigest = &v + return s +} + +// SetS3Etags sets the S3Etags field's value. +func (s *CreateRobotApplicationVersionInput) SetS3Etags(v []*string) *CreateRobotApplicationVersionInput { + s.S3Etags = v + return s +} + type CreateRobotApplicationVersionOutput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN) of the robot application. Arn *string `locationName:"arn" min:"1" type:"string"` + // The object that contains the Docker image URI used to create your robot application. + Environment *Environment `locationName:"environment" type:"structure"` + // The time, in milliseconds since the epoch, when the robot application was // last updated. LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` @@ -7314,6 +7356,12 @@ func (s *CreateRobotApplicationVersionOutput) SetArn(v string) *CreateRobotAppli return s } +// SetEnvironment sets the Environment field's value. +func (s *CreateRobotApplicationVersionOutput) SetEnvironment(v *Environment) *CreateRobotApplicationVersionOutput { + s.Environment = v + return s +} + // SetLastUpdatedAt sets the LastUpdatedAt field's value. func (s *CreateRobotApplicationVersionOutput) SetLastUpdatedAt(v time.Time) *CreateRobotApplicationVersionOutput { s.LastUpdatedAt = &v @@ -7519,6 +7567,10 @@ func (s *CreateRobotOutput) SetTags(v map[string]*string) *CreateRobotOutput { type CreateSimulationApplicationInput struct { _ struct{} `type:"structure"` + // The object that contains the Docker image URI used to create your simulation + // application. + Environment *Environment `locationName:"environment" type:"structure"` + // The name of the simulation application. // // Name is a required field @@ -7538,9 +7590,7 @@ type CreateSimulationApplicationInput struct { SimulationSoftwareSuite *SimulationSoftwareSuite `locationName:"simulationSoftwareSuite" type:"structure" required:"true"` // The sources of the simulation application. - // - // Sources is a required field - Sources []*SourceConfig `locationName:"sources" type:"list" required:"true"` + Sources []*SourceConfig `locationName:"sources" type:"list"` // A map that contains tag keys and tag values that are attached to the simulation // application. @@ -7580,8 +7630,10 @@ func (s *CreateSimulationApplicationInput) Validate() error { if s.SimulationSoftwareSuite == nil { invalidParams.Add(request.NewErrParamRequired("SimulationSoftwareSuite")) } - if s.Sources == nil { - invalidParams.Add(request.NewErrParamRequired("Sources")) + if s.Environment != nil { + if err := s.Environment.Validate(); err != nil { + invalidParams.AddNested("Environment", err.(request.ErrInvalidParams)) + } } if s.RenderingEngine != nil { if err := s.RenderingEngine.Validate(); err != nil { @@ -7605,6 +7657,12 @@ func (s *CreateSimulationApplicationInput) Validate() error { return nil } +// SetEnvironment sets the Environment field's value. +func (s *CreateSimulationApplicationInput) SetEnvironment(v *Environment) *CreateSimulationApplicationInput { + s.Environment = v + return s +} + // SetName sets the Name field's value. func (s *CreateSimulationApplicationInput) SetName(v string) *CreateSimulationApplicationInput { s.Name = &v @@ -7647,6 +7705,10 @@ type CreateSimulationApplicationOutput struct { // The Amazon Resource Name (ARN) of the simulation application. Arn *string `locationName:"arn" min:"1" type:"string"` + // The object that contains the Docker image URI that you used to create your + // simulation application. + Environment *Environment `locationName:"environment" type:"structure"` + // The time, in milliseconds since the epoch, when the simulation application // was last updated. LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` @@ -7700,6 +7762,12 @@ func (s *CreateSimulationApplicationOutput) SetArn(v string) *CreateSimulationAp return s } +// SetEnvironment sets the Environment field's value. +func (s *CreateSimulationApplicationOutput) SetEnvironment(v *Environment) *CreateSimulationApplicationOutput { + s.Environment = v + return s +} + // SetLastUpdatedAt sets the LastUpdatedAt field's value. func (s *CreateSimulationApplicationOutput) SetLastUpdatedAt(v time.Time) *CreateSimulationApplicationOutput { s.LastUpdatedAt = &v @@ -7765,6 +7833,14 @@ type CreateSimulationApplicationVersionInput struct { // The current revision id for the simulation application. If you provide a // value and it matches the latest revision ID, a new version will be created. CurrentRevisionId *string `locationName:"currentRevisionId" min:"1" type:"string"` + + // The SHA256 digest used to identify the Docker image URI used to created the + // simulation application. + ImageDigest *string `locationName:"imageDigest" type:"string"` + + // The Amazon S3 eTag identifier for the zip file bundle that you use to create + // the simulation application. + S3Etags []*string `locationName:"s3Etags" type:"list"` } // String returns the string representation. @@ -7816,12 +7892,28 @@ func (s *CreateSimulationApplicationVersionInput) SetCurrentRevisionId(v string) return s } +// SetImageDigest sets the ImageDigest field's value. +func (s *CreateSimulationApplicationVersionInput) SetImageDigest(v string) *CreateSimulationApplicationVersionInput { + s.ImageDigest = &v + return s +} + +// SetS3Etags sets the S3Etags field's value. +func (s *CreateSimulationApplicationVersionInput) SetS3Etags(v []*string) *CreateSimulationApplicationVersionInput { + s.S3Etags = v + return s +} + type CreateSimulationApplicationVersionOutput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN) of the simulation application. Arn *string `locationName:"arn" min:"1" type:"string"` + // The object that contains the Docker image URI used to create the simulation + // application. + Environment *Environment `locationName:"environment" type:"structure"` + // The time, in milliseconds since the epoch, when the simulation application // was last updated. LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` @@ -7872,6 +7964,12 @@ func (s *CreateSimulationApplicationVersionOutput) SetArn(v string) *CreateSimul return s } +// SetEnvironment sets the Environment field's value. +func (s *CreateSimulationApplicationVersionOutput) SetEnvironment(v *Environment) *CreateSimulationApplicationVersionOutput { + s.Environment = v + return s +} + // SetLastUpdatedAt sets the LastUpdatedAt field's value. func (s *CreateSimulationApplicationVersionOutput) SetLastUpdatedAt(v time.Time) *CreateSimulationApplicationVersionOutput { s.LastUpdatedAt = &v @@ -10431,6 +10529,12 @@ type DescribeRobotApplicationOutput struct { // The Amazon Resource Name (ARN) of the robot application. Arn *string `locationName:"arn" min:"1" type:"string"` + // The object that contains the Docker image URI used to create the robot application. + Environment *Environment `locationName:"environment" type:"structure"` + + // A SHA256 identifier for the Docker image that you use for your robot application. + ImageDigest *string `locationName:"imageDigest" type:"string"` + // The time, in milliseconds since the epoch, when the robot application was // last updated. LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` @@ -10478,6 +10582,18 @@ func (s *DescribeRobotApplicationOutput) SetArn(v string) *DescribeRobotApplicat return s } +// SetEnvironment sets the Environment field's value. +func (s *DescribeRobotApplicationOutput) SetEnvironment(v *Environment) *DescribeRobotApplicationOutput { + s.Environment = v + return s +} + +// SetImageDigest sets the ImageDigest field's value. +func (s *DescribeRobotApplicationOutput) SetImageDigest(v string) *DescribeRobotApplicationOutput { + s.ImageDigest = &v + return s +} + // SetLastUpdatedAt sets the LastUpdatedAt field's value. func (s *DescribeRobotApplicationOutput) SetLastUpdatedAt(v time.Time) *DescribeRobotApplicationOutput { s.LastUpdatedAt = &v @@ -10748,6 +10864,14 @@ type DescribeSimulationApplicationOutput struct { // The Amazon Resource Name (ARN) of the robot simulation application. Arn *string `locationName:"arn" min:"1" type:"string"` + // The object that contains the Docker image URI used to create the simulation + // application. + Environment *Environment `locationName:"environment" type:"structure"` + + // A SHA256 identifier for the Docker image that you use for your simulation + // application. + ImageDigest *string `locationName:"imageDigest" type:"string"` + // The time, in milliseconds since the epoch, when the simulation application // was last updated. LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` @@ -10801,6 +10925,18 @@ func (s *DescribeSimulationApplicationOutput) SetArn(v string) *DescribeSimulati return s } +// SetEnvironment sets the Environment field's value. +func (s *DescribeSimulationApplicationOutput) SetEnvironment(v *Environment) *DescribeSimulationApplicationOutput { + s.Environment = v + return s +} + +// SetImageDigest sets the ImageDigest field's value. +func (s *DescribeSimulationApplicationOutput) SetImageDigest(v string) *DescribeSimulationApplicationOutput { + s.ImageDigest = &v + return s +} + // SetLastUpdatedAt sets the LastUpdatedAt field's value. func (s *DescribeSimulationApplicationOutput) SetLastUpdatedAt(v time.Time) *DescribeSimulationApplicationOutput { s.LastUpdatedAt = &v @@ -12107,6 +12243,52 @@ func (s *DescribeWorldTemplateOutput) SetVersion(v string) *DescribeWorldTemplat return s } +// The object that contains the Docker image URI for either your robot or simulation +// applications. +type Environment struct { + _ struct{} `type:"structure"` + + // The Docker image URI for either your robot or simulation applications. + Uri *string `locationName:"uri" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Environment) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Environment) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Environment) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Environment"} + if s.Uri != nil && len(*s.Uri) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Uri", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetUri sets the Uri field's value. +func (s *Environment) SetUri(v string) *Environment { + s.Uri = &v + return s +} + // Information about a failed create simulation job request. type FailedCreateSimulationJobRequest struct { _ struct{} `type:"structure"` @@ -17759,15 +17941,16 @@ type UpdateRobotApplicationInput struct { // The revision id for the robot application. CurrentRevisionId *string `locationName:"currentRevisionId" min:"1" type:"string"` + // The object that contains the Docker image URI for your robot application. + Environment *Environment `locationName:"environment" type:"structure"` + // The robot software suite (ROS distribution) used by the robot application. // // RobotSoftwareSuite is a required field RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure" required:"true"` // The sources of the robot application. - // - // Sources is a required field - Sources []*SourceConfig `locationName:"sources" type:"list" required:"true"` + Sources []*SourceConfig `locationName:"sources" type:"list"` } // String returns the string representation. @@ -17803,8 +17986,10 @@ func (s *UpdateRobotApplicationInput) Validate() error { if s.RobotSoftwareSuite == nil { invalidParams.Add(request.NewErrParamRequired("RobotSoftwareSuite")) } - if s.Sources == nil { - invalidParams.Add(request.NewErrParamRequired("Sources")) + if s.Environment != nil { + if err := s.Environment.Validate(); err != nil { + invalidParams.AddNested("Environment", err.(request.ErrInvalidParams)) + } } if s.Sources != nil { for i, v := range s.Sources { @@ -17835,6 +18020,12 @@ func (s *UpdateRobotApplicationInput) SetCurrentRevisionId(v string) *UpdateRobo return s } +// SetEnvironment sets the Environment field's value. +func (s *UpdateRobotApplicationInput) SetEnvironment(v *Environment) *UpdateRobotApplicationInput { + s.Environment = v + return s +} + // SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. func (s *UpdateRobotApplicationInput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *UpdateRobotApplicationInput { s.RobotSoftwareSuite = v @@ -17853,6 +18044,9 @@ type UpdateRobotApplicationOutput struct { // The Amazon Resource Name (ARN) of the updated robot application. Arn *string `locationName:"arn" min:"1" type:"string"` + // The object that contains the Docker image URI for your robot application. + Environment *Environment `locationName:"environment" type:"structure"` + // The time, in milliseconds since the epoch, when the robot application was // last updated. LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` @@ -17897,6 +18091,12 @@ func (s *UpdateRobotApplicationOutput) SetArn(v string) *UpdateRobotApplicationO return s } +// SetEnvironment sets the Environment field's value. +func (s *UpdateRobotApplicationOutput) SetEnvironment(v *Environment) *UpdateRobotApplicationOutput { + s.Environment = v + return s +} + // SetLastUpdatedAt sets the LastUpdatedAt field's value. func (s *UpdateRobotApplicationOutput) SetLastUpdatedAt(v time.Time) *UpdateRobotApplicationOutput { s.LastUpdatedAt = &v @@ -17944,6 +18144,9 @@ type UpdateSimulationApplicationInput struct { // The revision id for the robot application. CurrentRevisionId *string `locationName:"currentRevisionId" min:"1" type:"string"` + // The object that contains the Docker image URI for your simulation application. + Environment *Environment `locationName:"environment" type:"structure"` + // The rendering engine for the simulation application. RenderingEngine *RenderingEngine `locationName:"renderingEngine" type:"structure"` @@ -17958,9 +18161,7 @@ type UpdateSimulationApplicationInput struct { SimulationSoftwareSuite *SimulationSoftwareSuite `locationName:"simulationSoftwareSuite" type:"structure" required:"true"` // The sources of the simulation application. - // - // Sources is a required field - Sources []*SourceConfig `locationName:"sources" type:"list" required:"true"` + Sources []*SourceConfig `locationName:"sources" type:"list"` } // String returns the string representation. @@ -17999,8 +18200,10 @@ func (s *UpdateSimulationApplicationInput) Validate() error { if s.SimulationSoftwareSuite == nil { invalidParams.Add(request.NewErrParamRequired("SimulationSoftwareSuite")) } - if s.Sources == nil { - invalidParams.Add(request.NewErrParamRequired("Sources")) + if s.Environment != nil { + if err := s.Environment.Validate(); err != nil { + invalidParams.AddNested("Environment", err.(request.ErrInvalidParams)) + } } if s.RenderingEngine != nil { if err := s.RenderingEngine.Validate(); err != nil { @@ -18036,6 +18239,12 @@ func (s *UpdateSimulationApplicationInput) SetCurrentRevisionId(v string) *Updat return s } +// SetEnvironment sets the Environment field's value. +func (s *UpdateSimulationApplicationInput) SetEnvironment(v *Environment) *UpdateSimulationApplicationInput { + s.Environment = v + return s +} + // SetRenderingEngine sets the RenderingEngine field's value. func (s *UpdateSimulationApplicationInput) SetRenderingEngine(v *RenderingEngine) *UpdateSimulationApplicationInput { s.RenderingEngine = v @@ -18066,6 +18275,9 @@ type UpdateSimulationApplicationOutput struct { // The Amazon Resource Name (ARN) of the updated simulation application. Arn *string `locationName:"arn" min:"1" type:"string"` + // The object that contains the Docker image URI used for your simulation application. + Environment *Environment `locationName:"environment" type:"structure"` + // The time, in milliseconds since the epoch, when the simulation application // was last updated. LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` @@ -18116,6 +18328,12 @@ func (s *UpdateSimulationApplicationOutput) SetArn(v string) *UpdateSimulationAp return s } +// SetEnvironment sets the Environment field's value. +func (s *UpdateSimulationApplicationOutput) SetEnvironment(v *Environment) *UpdateSimulationApplicationOutput { + s.Environment = v + return s +} + // SetLastUpdatedAt sets the LastUpdatedAt field's value. func (s *UpdateSimulationApplicationOutput) SetLastUpdatedAt(v time.Time) *UpdateSimulationApplicationOutput { s.LastUpdatedAt = &v diff --git a/service/s3/api.go b/service/s3/api.go index 5c3fd72d92f..633d3c09ff6 100644 --- a/service/s3/api.go +++ b/service/s3/api.go @@ -726,16 +726,15 @@ func (c *S3) CreateMultipartUploadRequest(input *CreateMultipartUploadInput) (re // You can optionally request server-side encryption. For server-side encryption, // Amazon S3 encrypts your data as it writes it to disks in its data centers // and decrypts it when you access it. You can provide your own encryption key, -// or use Amazon Web Services Key Management Service (Amazon Web Services KMS) -// customer master keys (CMKs) or Amazon S3-managed encryption keys. If you -// choose to provide your own encryption key, the request headers you provide -// in UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) +// or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. +// If you choose to provide your own encryption key, the request headers you +// provide in UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) // and UploadPartCopy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html) // requests must match the headers you used in the request to initiate the upload // by using CreateMultipartUpload. // // To perform a multipart upload with encryption using an Amazon Web Services -// KMS CMK, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* +// KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* // actions on the key. These permissions are required because Amazon S3 must // decrypt and read data from the encrypted file parts before it completes the // multipart upload. For more information, see Multipart upload API and permissions @@ -743,10 +742,10 @@ func (c *S3) CreateMultipartUploadRequest(input *CreateMultipartUploadInput) (re // in the Amazon S3 User Guide. // // If your Identity and Access Management (IAM) user or role is in the same -// Amazon Web Services account as the Amazon Web Services KMS CMK, then you -// must have these permissions on the key policy. If your IAM user or role belongs -// to a different account than the key, then you must have the permissions on -// both the key policy and your IAM user or role. +// Amazon Web Services account as the KMS key, then you must have these permissions +// on the key policy. If your IAM user or role belongs to a different account +// than the key, then you must have the permissions on both the key policy and +// your IAM user or role. // // For more information, see Protecting Data Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html). // @@ -776,27 +775,25 @@ func (c *S3) CreateMultipartUploadRequest(input *CreateMultipartUploadInput) (re // use Amazon Web Services managed encryption keys or provide your own encryption // key. // -// * Use encryption keys managed by Amazon S3 or customer master keys (CMKs) -// stored in Amazon Web Services Key Management Service (Amazon Web Services -// KMS) – If you want Amazon Web Services to manage the keys used to encrypt +// * Use encryption keys managed by Amazon S3 or customer managed key stored +// in Amazon Web Services Key Management Service (Amazon Web Services KMS) +// – If you want Amazon Web Services to manage the keys used to encrypt // data, specify the following headers in the request. x-amz-server-side-encryption // x-amz-server-side-encryption-aws-kms-key-id x-amz-server-side-encryption-context // If you specify x-amz-server-side-encryption:aws:kms, but don't provide // x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon -// Web Services managed CMK in Amazon Web Services KMS to protect the data. +// Web Services managed key in Amazon Web Services KMS to protect the data. // All GET and PUT requests for an object protected by Amazon Web Services // KMS fail if you don't make them with SSL or by using SigV4. For more information -// about server-side encryption with CMKs stored in Amazon Web Services KMS -// (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs -// stored in Amazon Web Services KMS (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html). +// about server-side encryption with KMS key (SSE-KMS), see Protecting Data +// Using Server-Side Encryption with KMS keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html). // // * Use customer-provided encryption keys – If you want to manage your // own encryption keys, provide all the following headers in the request. // x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key // x-amz-server-side-encryption-customer-key-MD5 For more information about -// server-side encryption with CMKs stored in Amazon Web Services KMS (SSE-KMS), -// see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon -// Web Services KMS (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html). +// server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using +// Server-Side Encryption with KMS keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html). // // Access-Control-List (ACL)-Specific Request Headers // @@ -1279,20 +1276,21 @@ func (c *S3) DeleteBucketIntelligentTieringConfigurationRequest(input *DeleteBuc // // The S3 Intelligent-Tiering storage class is designed to optimize storage // costs by automatically moving data to the most cost-effective storage access -// tier, without additional operational overhead. S3 Intelligent-Tiering delivers -// automatic cost savings by moving data between access tiers, when access patterns -// change. -// -// The S3 Intelligent-Tiering storage class is suitable for objects larger than -// 128 KB that you plan to store for at least 30 days. If the size of an object -// is less than 128 KB, it is not eligible for auto-tiering. Smaller objects -// can be stored, but they are always charged at the frequent access tier rates -// in the S3 Intelligent-Tiering storage class. -// -// If you delete an object before the end of the 30-day minimum storage duration -// period, you are charged for 30 days. For more information, see Storage class -// for automatically optimizing frequently and infrequently accessed objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). +// tier, without performance impact or operational overhead. S3 Intelligent-Tiering +// delivers automatic cost savings in two low latency and high throughput access +// tiers. For data that can be accessed asynchronously, you can choose to activate +// automatic archiving capabilities within the S3 Intelligent-Tiering storage +// class. +// +// The S3 Intelligent-Tiering storage class is the ideal storage class for data +// with unknown, changing, or unpredictable access patterns, independent of +// object size or retention period. If the size of an object is less than 128 +// KB, it is not eligible for auto-tiering. Smaller objects can be stored, but +// they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering +// storage class. +// +// For more information, see Storage class for automatically optimizing frequently +// and infrequently accessed objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). // // Operations related to DeleteBucketIntelligentTieringConfiguration include: // @@ -2968,20 +2966,21 @@ func (c *S3) GetBucketIntelligentTieringConfigurationRequest(input *GetBucketInt // // The S3 Intelligent-Tiering storage class is designed to optimize storage // costs by automatically moving data to the most cost-effective storage access -// tier, without additional operational overhead. S3 Intelligent-Tiering delivers -// automatic cost savings by moving data between access tiers, when access patterns -// change. -// -// The S3 Intelligent-Tiering storage class is suitable for objects larger than -// 128 KB that you plan to store for at least 30 days. If the size of an object -// is less than 128 KB, it is not eligible for auto-tiering. Smaller objects -// can be stored, but they are always charged at the frequent access tier rates -// in the S3 Intelligent-Tiering storage class. -// -// If you delete an object before the end of the 30-day minimum storage duration -// period, you are charged for 30 days. For more information, see Storage class -// for automatically optimizing frequently and infrequently accessed objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). +// tier, without performance impact or operational overhead. S3 Intelligent-Tiering +// delivers automatic cost savings in two low latency and high throughput access +// tiers. For data that can be accessed asynchronously, you can choose to activate +// automatic archiving capabilities within the S3 Intelligent-Tiering storage +// class. +// +// The S3 Intelligent-Tiering storage class is the ideal storage class for data +// with unknown, changing, or unpredictable access patterns, independent of +// object size or retention period. If the size of an object is less than 128 +// KB, it is not eligible for auto-tiering. Smaller objects can be stored, but +// they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering +// storage class. +// +// For more information, see Storage class for automatically optimizing frequently +// and infrequently accessed objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). // // Operations related to GetBucketIntelligentTieringConfiguration include: // @@ -4547,9 +4546,9 @@ func (c *S3) GetObjectRequest(input *GetObjectInput) (req *request.Request, outp // // Encryption request headers, like x-amz-server-side-encryption, should not // be sent for GET requests if your object uses server-side encryption with -// CMKs stored in Amazon Web Services KMS (SSE-KMS) or server-side encryption -// with Amazon S3–managed encryption keys (SSE-S3). If your object does use -// these types of keys, you’ll get an HTTP 400 BadRequest error. +// KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption +// keys (SSE-S3). If your object does use these types of keys, you’ll get +// an HTTP 400 BadRequest error. // // If you encrypt an object by using server-side encryption with customer-provided // encryption keys (SSE-C) when you store the object in Amazon S3, then when @@ -5455,9 +5454,9 @@ func (c *S3) HeadObjectRequest(input *HeadObjectInput) (req *request.Request, ou // // * Encryption request headers, like x-amz-server-side-encryption, should // not be sent for GET requests if your object uses server-side encryption -// with CMKs stored in Amazon Web Services KMS (SSE-KMS) or server-side encryption -// with Amazon S3–managed encryption keys (SSE-S3). If your object does -// use these types of keys, you’ll get an HTTP 400 BadRequest error. +// with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed +// encryption keys (SSE-S3). If your object does use these types of keys, +// you’ll get an HTTP 400 BadRequest error. // // * The last modified property in this case is the creation date of the // object. @@ -5675,20 +5674,21 @@ func (c *S3) ListBucketIntelligentTieringConfigurationsRequest(input *ListBucket // // The S3 Intelligent-Tiering storage class is designed to optimize storage // costs by automatically moving data to the most cost-effective storage access -// tier, without additional operational overhead. S3 Intelligent-Tiering delivers -// automatic cost savings by moving data between access tiers, when access patterns -// change. -// -// The S3 Intelligent-Tiering storage class is suitable for objects larger than -// 128 KB that you plan to store for at least 30 days. If the size of an object -// is less than 128 KB, it is not eligible for auto-tiering. Smaller objects -// can be stored, but they are always charged at the frequent access tier rates -// in the S3 Intelligent-Tiering storage class. -// -// If you delete an object before the end of the 30-day minimum storage duration -// period, you are charged for 30 days. For more information, see Storage class -// for automatically optimizing frequently and infrequently accessed objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). +// tier, without performance impact or operational overhead. S3 Intelligent-Tiering +// delivers automatic cost savings in two low latency and high throughput access +// tiers. For data that can be accessed asynchronously, you can choose to activate +// automatic archiving capabilities within the S3 Intelligent-Tiering storage +// class. +// +// The S3 Intelligent-Tiering storage class is the ideal storage class for data +// with unknown, changing, or unpredictable access patterns, independent of +// object size or retention period. If the size of an object is less than 128 +// KB, it is not eligible for auto-tiering. Smaller objects can be stored, but +// they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering +// storage class. +// +// For more information, see Storage class for automatically optimizing frequently +// and infrequently accessed objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). // // Operations related to ListBucketIntelligentTieringConfigurations include: // @@ -7371,10 +7371,10 @@ func (c *S3) PutBucketEncryptionRequest(input *PutBucketEncryptionInput) (req *r // and Amazon S3 Bucket Key for an existing bucket. // // Default encryption for a bucket can use server-side encryption with Amazon -// S3-managed keys (SSE-S3) or Amazon Web Services KMS customer master keys -// (SSE-KMS). If you specify default encryption using SSE-KMS, you can also -// configure Amazon S3 Bucket Key. For information about default encryption, -// see Amazon S3 default bucket encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) +// S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify +// default encryption using SSE-KMS, you can also configure Amazon S3 Bucket +// Key. For information about default encryption, see Amazon S3 default bucket +// encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) // in the Amazon S3 User Guide. For more information about S3 Bucket Keys, see // Amazon S3 Bucket Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) // in the Amazon S3 User Guide. @@ -7473,20 +7473,21 @@ func (c *S3) PutBucketIntelligentTieringConfigurationRequest(input *PutBucketInt // // The S3 Intelligent-Tiering storage class is designed to optimize storage // costs by automatically moving data to the most cost-effective storage access -// tier, without additional operational overhead. S3 Intelligent-Tiering delivers -// automatic cost savings by moving data between access tiers, when access patterns -// change. -// -// The S3 Intelligent-Tiering storage class is suitable for objects larger than -// 128 KB that you plan to store for at least 30 days. If the size of an object -// is less than 128 KB, it is not eligible for auto-tiering. Smaller objects -// can be stored, but they are always charged at the frequent access tier rates -// in the S3 Intelligent-Tiering storage class. -// -// If you delete an object before the end of the 30-day minimum storage duration -// period, you are charged for 30 days. For more information, see Storage class -// for automatically optimizing frequently and infrequently accessed objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). +// tier, without performance impact or operational overhead. S3 Intelligent-Tiering +// delivers automatic cost savings in two low latency and high throughput access +// tiers. For data that can be accessed asynchronously, you can choose to activate +// automatic archiving capabilities within the S3 Intelligent-Tiering storage +// class. +// +// The S3 Intelligent-Tiering storage class is the ideal storage class for data +// with unknown, changing, or unpredictable access patterns, independent of +// object size or retention period. If the size of an object is less than 128 +// KB, it is not eligible for auto-tiering. Smaller objects can be stored, but +// they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering +// storage class. +// +// For more information, see Storage class for automatically optimizing frequently +// and infrequently accessed objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). // // Operations related to PutBucketIntelligentTieringConfiguration include: // @@ -8128,7 +8129,7 @@ func (c *S3) PutBucketMetricsConfigurationRequest(input *PutBucketMetricsConfigu // // * DeleteBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) // -// * PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) +// * GetBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html) // // * ListBucketMetricsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) // @@ -8648,11 +8649,11 @@ func (c *S3) PutBucketReplicationRequest(input *PutBucketReplicationInput) (req // Handling Replication of Encrypted Objects // // By default, Amazon S3 doesn't replicate objects that are stored at rest using -// server-side encryption with CMKs stored in Amazon Web Services KMS. To replicate -// Amazon Web Services KMS-encrypted objects, add the following: SourceSelectionCriteria, -// SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. -// For information about replication configuration, see Replicating Objects -// Created with SSE Using CMKs stored in Amazon Web Services KMS (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html). +// server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted +// objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, +// Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about +// replication configuration, see Replicating Objects Created with SSE Using +// KMS keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html). // // For information on PutBucketReplication errors, see List of replication-related // error codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList) @@ -10339,11 +10340,10 @@ func (c *S3) SelectObjectContentRequest(input *SelectObjectContentInput) (req *r // For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided // Encryption Keys) (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) // in the Amazon S3 User Guide. For objects that are encrypted with Amazon -// S3 managed encryption keys (SSE-S3) and customer master keys (CMKs) stored -// in Amazon Web Services Key Management Service (SSE-KMS), server-side encryption -// is handled transparently, so you don't need to specify anything. For more -// information about server-side encryption, including SSE-S3 and SSE-KMS, -// see Protecting Data Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) +// S3 managed encryption keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS), +// server-side encryption is handled transparently, so you don't need to +// specify anything. For more information about server-side encryption, including +// SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) // in the Amazon S3 User Guide. // // Working with the Response Body @@ -10951,8 +10951,8 @@ func (c *S3) WriteGetObjectResponseRequest(input *WriteGetObjectResponseInput) ( // WriteGetObjectResponse API operation for Amazon Simple Storage Service. // // Passes transformed objects to a GetObject operation when using Object Lambda -// Access Points. For information about Object Lambda Access Points, see Transforming -// objects with Object Lambda Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html) +// access points. For information about Object Lambda access points, see Transforming +// objects with Object Lambda access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html) // in the Amazon S3 User Guide. // // This operation supports metadata that can be returned by GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html), @@ -10972,7 +10972,7 @@ func (c *S3) WriteGetObjectResponseRequest(input *WriteGetObjectResponseInput) ( // (PII) and decompress S3 objects. These Lambda functions are available in // the Amazon Web Services Serverless Application Repository, and can be selected // through the Amazon Web Services Management Console when you create your Object -// Lambda Access Point. +// Lambda access point. // // Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, // a natural language processing (NLP) service using machine learning to find @@ -12578,8 +12578,8 @@ type CompleteMultipartUploadOutput struct { RequestCharged *string `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"RequestCharged"` // If present, specifies the ID of the Amazon Web Services Key Management Service - // (Amazon Web Services KMS) symmetric customer managed customer master key - // (CMK) that was used for the object. + // (Amazon Web Services KMS) symmetric customer managed key that was used for + // the object. // // SSEKMSKeyId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CompleteMultipartUploadOutput's @@ -12587,9 +12587,9 @@ type CompleteMultipartUploadOutput struct { SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"` // If you specified server-side encryption either with an Amazon S3-managed - // encryption key or an Amazon Web Services KMS customer master key (CMK) in - // your initiate multipart upload request, the response includes this header. - // It confirms the encryption algorithm that Amazon S3 used to encrypt the object. + // encryption key or an Amazon Web Services KMS key in your initiate multipart + // upload request, the response includes this header. It confirms the encryption + // algorithm that Amazon S3 used to encrypt the object. ServerSideEncryption *string `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"ServerSideEncryption"` // Version ID of the newly created object, in case the bucket has versioning @@ -13475,8 +13475,8 @@ type CopyObjectOutput struct { SSEKMSEncryptionContext *string `location:"header" locationName:"x-amz-server-side-encryption-context" type:"string" sensitive:"true"` // If present, specifies the ID of the Amazon Web Services Key Management Service - // (Amazon Web Services KMS) symmetric customer managed customer master key - // (CMK) that was used for the object. + // (Amazon Web Services KMS) symmetric customer managed key that was used for + // the object. // // SSEKMSKeyId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CopyObjectOutput's @@ -13991,12 +13991,12 @@ type CreateMultipartUploadInput struct { // String and GoString methods. SSEKMSEncryptionContext *string `location:"header" locationName:"x-amz-server-side-encryption-context" type:"string" sensitive:"true"` - // Specifies the ID of the symmetric customer managed Amazon Web Services KMS - // CMK to use for object encryption. All GET and PUT requests for an object - // protected by Amazon Web Services KMS will fail if not made via SSL or using - // SigV4. For information about configuring using any of the officially supported - // Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the - // Signature Version in Request Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version) + // Specifies the ID of the symmetric customer managed key to use for object + // encryption. All GET and PUT requests for an object protected by Amazon Web + // Services KMS will fail if not made via SSL or using SigV4. For information + // about configuring using any of the officially supported Amazon Web Services + // SDKs and Amazon Web Services CLI, see Specifying the Signature Version in + // Request Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version) // in the Amazon S3 User Guide. // // SSEKMSKeyId is a sensitive parameter and its value will be @@ -14349,8 +14349,8 @@ type CreateMultipartUploadOutput struct { SSEKMSEncryptionContext *string `location:"header" locationName:"x-amz-server-side-encryption-context" type:"string" sensitive:"true"` // If present, specifies the ID of the Amazon Web Services Key Management Service - // (Amazon Web Services KMS) symmetric customer managed customer master key - // (CMK) that was used for the object. + // (Amazon Web Services KMS) symmetric customer managed key that was used for + // the object. // // SSEKMSKeyId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CreateMultipartUploadOutput's @@ -17203,9 +17203,9 @@ type Encryption struct { KMSContext *string `type:"string"` // If the encryption type is aws:kms, this optional value specifies the ID of - // the symmetric customer managed Amazon Web Services KMS CMK to use for encryption - // of job results. Amazon S3 only supports symmetric CMKs. For more information, - // see Using symmetric and asymmetric keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) + // the symmetric customer managed key to use for encryption of job results. + // Amazon S3 only supports symmetric keys. For more information, see Using symmetric + // and asymmetric keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) // in the Amazon Web Services Key Management Service Developer Guide. // // KMSKeyId is a sensitive parameter and its value will be @@ -20807,6 +20807,8 @@ type GetObjectInput struct { // information about access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. // + // When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com. + // // When using this action with Amazon S3 on Outposts, you must direct requests // to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When @@ -21515,8 +21517,8 @@ type GetObjectOutput struct { SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"` // If present, specifies the ID of the Amazon Web Services Key Management Service - // (Amazon Web Services KMS) symmetric customer managed customer master key - // (CMK) that was used for the object. + // (Amazon Web Services KMS) symmetric customer managed key that was used for + // the object. // // SSEKMSKeyId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by GetObjectOutput's @@ -23157,8 +23159,8 @@ type HeadObjectOutput struct { SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"` // If present, specifies the ID of the Amazon Web Services Key Management Service - // (Amazon Web Services KMS) symmetric customer managed customer master key - // (CMK) that was used for the object. + // (Amazon Web Services KMS) symmetric customer managed key that was used for + // the object. // // SSEKMSKeyId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by HeadObjectOutput's @@ -23166,10 +23168,9 @@ type HeadObjectOutput struct { SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"` // If the object is stored using server-side encryption either with an Amazon - // Web Services KMS customer master key (CMK) or an Amazon S3-managed encryption - // key, the response includes this header with the value of the server-side - // encryption algorithm used when storing this object in Amazon S3 (for example, - // AES256, aws:kms). + // Web Services KMS key or an Amazon S3-managed encryption key, the response + // includes this header with the value of the server-side encryption algorithm + // used when storing this object in Amazon S3 (for example, AES256, aws:kms). ServerSideEncryption *string `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"ServerSideEncryption"` // Provides storage class information of the object. Amazon S3 returns this @@ -27586,6 +27587,9 @@ func (s *Metrics) SetStatus(v string) *Metrics { type MetricsAndOperator struct { _ struct{} `type:"structure"` + // The access point ARN used when evaluating an AND predicate. + AccessPointArn *string `type:"string"` + // The prefix used when evaluating an AND predicate. Prefix *string `type:"string"` @@ -27631,6 +27635,12 @@ func (s *MetricsAndOperator) Validate() error { return nil } +// SetAccessPointArn sets the AccessPointArn field's value. +func (s *MetricsAndOperator) SetAccessPointArn(v string) *MetricsAndOperator { + s.AccessPointArn = &v + return s +} + // SetPrefix sets the Prefix field's value. func (s *MetricsAndOperator) SetPrefix(v string) *MetricsAndOperator { s.Prefix = &v @@ -27647,15 +27657,14 @@ func (s *MetricsAndOperator) SetTags(v []*Tag) *MetricsAndOperator { // by the metrics configuration ID) from an Amazon S3 bucket. If you're updating // an existing metrics configuration, note that this is a full replacement of // the existing metrics configuration. If you don't include the elements you -// want to keep, they are erased. For more information, see PUT Bucket metrics -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html) -// in the Amazon S3 API Reference. +// want to keep, they are erased. For more information, see PutBucketMetricsConfiguration +// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). type MetricsConfiguration struct { _ struct{} `type:"structure"` // Specifies a metrics configuration filter. The metrics configuration will // only include objects that meet the filter's criteria. A filter must be a - // prefix, a tag, or a conjunction (MetricsAndOperator). + // prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). Filter *MetricsFilter `type:"structure"` // The ID used to identify the metrics configuration. @@ -27714,10 +27723,14 @@ func (s *MetricsConfiguration) SetId(v string) *MetricsConfiguration { // Specifies a metrics configuration filter. The metrics configuration only // includes objects that meet the filter's criteria. A filter must be a prefix, -// a tag, or a conjunction (MetricsAndOperator). +// an object tag, an access point ARN, or a conjunction (MetricsAndOperator). +// For more information, see PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html). type MetricsFilter struct { _ struct{} `type:"structure"` + // The access point ARN used when evaluating a metrics filter. + AccessPointArn *string `type:"string"` + // A conjunction (logical AND) of predicates, which is used in evaluating a // metrics filter. The operator must have at least two predicates, and an object // must match all of the predicates in order for the filter to apply. @@ -27768,6 +27781,12 @@ func (s *MetricsFilter) Validate() error { return nil } +// SetAccessPointArn sets the AccessPointArn field's value. +func (s *MetricsFilter) SetAccessPointArn(v string) *MetricsFilter { + s.AccessPointArn = &v + return s +} + // SetAnd sets the And field's value. func (s *MetricsFilter) SetAnd(v *MetricsAndOperator) *MetricsFilter { s.And = v @@ -29708,9 +29727,9 @@ type PutBucketEncryptionInput struct { _ struct{} `locationName:"PutBucketEncryptionRequest" type:"structure" payload:"ServerSideEncryptionConfiguration"` // Specifies default encryption for a bucket using server-side encryption with - // Amazon S3-managed keys (SSE-S3) or customer master keys stored in Amazon - // Web Services KMS (SSE-KMS). For information about the Amazon S3 default encryption - // feature, see Amazon S3 Default Bucket Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) + // Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). For information + // about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket + // Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) // in the Amazon S3 User Guide. // // Bucket is a required field @@ -32336,12 +32355,12 @@ type PutObjectInput struct { // If x-amz-server-side-encryption is present and has the value of aws:kms, // this header specifies the ID of the Amazon Web Services Key Management Service - // (Amazon Web Services KMS) symmetrical customer managed customer master key - // (CMK) that was used for the object. If you specify x-amz-server-side-encryption:aws:kms, - // but do not providex-amz-server-side-encryption-aws-kms-key-id, Amazon S3 - // uses the Amazon Web Services managed CMK in Amazon Web Services to protect - // the data. If the KMS key does not exist in the same account issuing the command, - // you must use the full ARN and not just the ID. + // (Amazon Web Services KMS) symmetrical customer managed key that was used + // for the object. If you specify x-amz-server-side-encryption:aws:kms, but + // do not providex-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses + // the Amazon Web Services managed key to protect the data. If the KMS key does + // not exist in the same account issuing the command, you must use the full + // ARN and not just the ID. // // SSEKMSKeyId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PutObjectInput's @@ -33040,8 +33059,8 @@ type PutObjectOutput struct { // If x-amz-server-side-encryption is present and has the value of aws:kms, // this header specifies the ID of the Amazon Web Services Key Management Service - // (Amazon Web Services KMS) symmetric customer managed customer master key - // (CMK) that was used for the object. + // (Amazon Web Services KMS) symmetric customer managed key that was used for + // the object. // // SSEKMSKeyId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PutObjectOutput's @@ -33049,9 +33068,9 @@ type PutObjectOutput struct { SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"` // If you specified server-side encryption either with an Amazon Web Services - // KMS customer master key (CMK) or Amazon S3-managed encryption key in your - // PUT request, the response includes this header. It confirms the encryption - // algorithm that Amazon S3 used to encrypt the object. + // KMS key or Amazon S3-managed encryption key in your PUT request, the response + // includes this header. It confirms the encryption algorithm that Amazon S3 + // used to encrypt the object. ServerSideEncryption *string `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"ServerSideEncryption"` // Version of the object. @@ -34205,8 +34224,8 @@ type ReplicationRule struct { // objects that you want to replicate. You can choose to enable or disable the // replication of these objects. Currently, Amazon S3 supports only the filter // that you can specify for objects created with server-side encryption using - // a customer master key (CMK) stored in Amazon Web Services Key Management - // Service (SSE-KMS). + // a customer managed key stored in Amazon Web Services Key Management Service + // (SSE-KMS). SourceSelectionCriteria *SourceSelectionCriteria `type:"structure"` // Specifies whether the rule is enabled. @@ -35191,8 +35210,8 @@ type SSEKMS struct { _ struct{} `locationName:"SSE-KMS" type:"structure"` // Specifies the ID of the Amazon Web Services Key Management Service (Amazon - // Web Services KMS) symmetric customer managed customer master key (CMK) to - // use for encrypting inventory reports. + // Web Services KMS) symmetric customer managed key to use for encrypting inventory + // reports. // // KeyId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SSEKMS's @@ -36062,8 +36081,8 @@ func (s *ServerSideEncryptionRule) SetBucketKeyEnabled(v bool) *ServerSideEncryp // objects that you want to replicate. You can choose to enable or disable the // replication of these objects. Currently, Amazon S3 supports only the filter // that you can specify for objects created with server-side encryption using -// a customer master key (CMK) stored in Amazon Web Services Key Management -// Service (SSE-KMS). +// a customer managed key stored in Amazon Web Services Key Management Service +// (SSE-KMS). type SourceSelectionCriteria struct { _ struct{} `type:"structure"` @@ -37256,8 +37275,8 @@ type UploadPartCopyOutput struct { SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"` // If present, specifies the ID of the Amazon Web Services Key Management Service - // (Amazon Web Services KMS) symmetric customer managed customer master key - // (CMK) that was used for the object. + // (Amazon Web Services KMS) symmetric customer managed key that was used for + // the object. // // SSEKMSKeyId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by UploadPartCopyOutput's @@ -37604,8 +37623,8 @@ type UploadPartOutput struct { SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"` // If present, specifies the ID of the Amazon Web Services Key Management Service - // (Amazon Web Services KMS) symmetric customer managed customer master key - // (CMK) was used for the object. + // (Amazon Web Services KMS) symmetric customer managed key was used for the + // object. // // SSEKMSKeyId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by UploadPartOutput's @@ -37947,8 +37966,8 @@ type WriteGetObjectResponseInput struct { SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-fwd-header-x-amz-server-side-encryption-customer-key-MD5" type:"string"` // If present, specifies the ID of the Amazon Web Services Key Management Service - // (Amazon Web Services KMS) symmetric customer managed customer master key - // (CMK) that was used for stored in Amazon S3 object. + // (Amazon Web Services KMS) symmetric customer managed key that was used for + // stored in Amazon S3 object. // // SSEKMSKeyId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by WriteGetObjectResponseInput's diff --git a/service/s3/examples_test.go b/service/s3/examples_test.go index 99a7251630b..0c2622f4e62 100644 --- a/service/s3/examples_test.go +++ b/service/s3/examples_test.go @@ -128,17 +128,13 @@ func ExampleS3_CopyObject_shared00() { fmt.Println(result) } -// To create a bucket in a specific region +// To create a bucket // -// The following example creates a bucket. The request specifies an AWS region where -// to create the bucket. +// The following example creates a bucket. func ExampleS3_CreateBucket_shared00() { svc := s3.New(session.New()) input := &s3.CreateBucketInput{ Bucket: aws.String("examplebucket"), - CreateBucketConfiguration: &s3.CreateBucketConfiguration{ - LocationConstraint: aws.String("eu-west-1"), - }, } result, err := svc.CreateBucket(input) @@ -163,13 +159,17 @@ func ExampleS3_CreateBucket_shared00() { fmt.Println(result) } -// To create a bucket +// To create a bucket in a specific region // -// The following example creates a bucket. +// The following example creates a bucket. The request specifies an AWS region where +// to create the bucket. func ExampleS3_CreateBucket_shared01() { svc := s3.New(session.New()) input := &s3.CreateBucketInput{ Bucket: aws.String("examplebucket"), + CreateBucketConfiguration: &s3.CreateBucketConfiguration{ + LocationConstraint: aws.String("eu-west-1"), + }, } result, err := svc.CreateBucket(input) @@ -934,16 +934,14 @@ func ExampleS3_GetBucketWebsite_shared00() { fmt.Println(result) } -// To retrieve a byte range of an object +// To retrieve an object // -// The following example retrieves an object for an S3 bucket. The request specifies -// the range header to retrieve a specific byte range. +// The following example retrieves an object for an S3 bucket. func ExampleS3_GetObject_shared00() { svc := s3.New(session.New()) input := &s3.GetObjectInput{ Bucket: aws.String("examplebucket"), - Key: aws.String("SampleFile.txt"), - Range: aws.String("bytes=0-9"), + Key: aws.String("HappyFace.jpg"), } result, err := svc.GetObject(input) @@ -968,14 +966,16 @@ func ExampleS3_GetObject_shared00() { fmt.Println(result) } -// To retrieve an object +// To retrieve a byte range of an object // -// The following example retrieves an object for an S3 bucket. +// The following example retrieves an object for an S3 bucket. The request specifies +// the range header to retrieve a specific byte range. func ExampleS3_GetObject_shared01() { svc := s3.New(session.New()) input := &s3.GetObjectInput{ Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), + Key: aws.String("SampleFile.txt"), + Range: aws.String("bytes=0-9"), } result, err := svc.GetObject(input) @@ -1030,14 +1030,16 @@ func ExampleS3_GetObjectAcl_shared00() { fmt.Println(result) } -// To retrieve tag set of an object +// To retrieve tag set of a specific object version // -// The following example retrieves tag set of an object. +// The following example retrieves tag set of an object. The request specifies object +// version. func ExampleS3_GetObjectTagging_shared00() { svc := s3.New(session.New()) input := &s3.GetObjectTaggingInput{ - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), + Bucket: aws.String("examplebucket"), + Key: aws.String("exampleobject"), + VersionId: aws.String("ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"), } result, err := svc.GetObjectTagging(input) @@ -1058,16 +1060,14 @@ func ExampleS3_GetObjectTagging_shared00() { fmt.Println(result) } -// To retrieve tag set of a specific object version +// To retrieve tag set of an object // -// The following example retrieves tag set of an object. The request specifies object -// version. +// The following example retrieves tag set of an object. func ExampleS3_GetObjectTagging_shared01() { svc := s3.New(session.New()) input := &s3.GetObjectTaggingInput{ - Bucket: aws.String("examplebucket"), - Key: aws.String("exampleobject"), - VersionId: aws.String("ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"), + Bucket: aws.String("examplebucket"), + Key: aws.String("HappyFace.jpg"), } result, err := svc.GetObjectTagging(input) @@ -1201,17 +1201,13 @@ func ExampleS3_ListBuckets_shared00() { fmt.Println(result) } -// List next set of multipart uploads when previous result is truncated +// To list in-progress multipart uploads on a bucket // -// The following example specifies the upload-id-marker and key-marker from previous -// truncated response to retrieve next setup of multipart uploads. +// The following example lists in-progress multipart uploads on a specific bucket. func ExampleS3_ListMultipartUploads_shared00() { svc := s3.New(session.New()) input := &s3.ListMultipartUploadsInput{ - Bucket: aws.String("examplebucket"), - KeyMarker: aws.String("nextkeyfrompreviousresponse"), - MaxUploads: aws.Int64(2), - UploadIdMarker: aws.String("valuefrompreviousresponse"), + Bucket: aws.String("examplebucket"), } result, err := svc.ListMultipartUploads(input) @@ -1232,13 +1228,17 @@ func ExampleS3_ListMultipartUploads_shared00() { fmt.Println(result) } -// To list in-progress multipart uploads on a bucket +// List next set of multipart uploads when previous result is truncated // -// The following example lists in-progress multipart uploads on a specific bucket. +// The following example specifies the upload-id-marker and key-marker from previous +// truncated response to retrieve next setup of multipart uploads. func ExampleS3_ListMultipartUploads_shared01() { svc := s3.New(session.New()) input := &s3.ListMultipartUploadsInput{ - Bucket: aws.String("examplebucket"), + Bucket: aws.String("examplebucket"), + KeyMarker: aws.String("nextkeyfrompreviousresponse"), + MaxUploads: aws.Int64(2), + UploadIdMarker: aws.String("valuefrompreviousresponse"), } result, err := svc.ListMultipartUploads(input) @@ -1808,18 +1808,17 @@ func ExampleS3_PutBucketWebsite_shared00() { fmt.Println(result) } -// To upload an object (specify optional headers) +// To upload an object and specify optional tags // -// The following example uploads an object. The request specifies optional request headers -// to directs S3 to use specific storage class and use server-side encryption. +// The following example uploads an object. The request specifies optional object tags. +// The bucket is versioned, therefore S3 returns version ID of the newly created object. func ExampleS3_PutObject_shared00() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")), - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), - ServerSideEncryption: aws.String("AES256"), - StorageClass: aws.String("STANDARD_IA"), + Body: aws.ReadSeekCloser(strings.NewReader("c:\\HappyFace.jpg")), + Bucket: aws.String("examplebucket"), + Key: aws.String("HappyFace.jpg"), + Tagging: aws.String("key1=value1&key2=value2"), } result, err := svc.PutObject(input) @@ -1840,19 +1839,18 @@ func ExampleS3_PutObject_shared00() { fmt.Println(result) } -// To upload an object and specify server-side encryption and object tags +// To upload an object and specify canned ACL. // -// The following example uploads and object. The request specifies the optional server-side -// encryption option. The request also specifies optional object tags. If the bucket -// is versioning enabled, S3 returns version ID in response. +// The following example uploads and object. The request specifies optional canned ACL +// (access control list) to all READ access to authenticated users. If the bucket is +// versioning enabled, S3 returns version ID in response. func ExampleS3_PutObject_shared01() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), - Bucket: aws.String("examplebucket"), - Key: aws.String("exampleobject"), - ServerSideEncryption: aws.String("AES256"), - Tagging: aws.String("key1=value1&key2=value2"), + ACL: aws.String("authenticated-read"), + Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), + Bucket: aws.String("examplebucket"), + Key: aws.String("exampleobject"), } result, err := svc.PutObject(input) @@ -1873,16 +1871,19 @@ func ExampleS3_PutObject_shared01() { fmt.Println(result) } -// To create an object. +// To upload an object and specify server-side encryption and object tags // -// The following example creates an object. If the bucket is versioning enabled, S3 -// returns version ID in response. +// The following example uploads and object. The request specifies the optional server-side +// encryption option. The request also specifies optional object tags. If the bucket +// is versioning enabled, S3 returns version ID in response. func ExampleS3_PutObject_shared02() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), - Bucket: aws.String("examplebucket"), - Key: aws.String("objectkey"), + Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), + Bucket: aws.String("examplebucket"), + Key: aws.String("exampleobject"), + ServerSideEncryption: aws.String("AES256"), + Tagging: aws.String("key1=value1&key2=value2"), } result, err := svc.PutObject(input) @@ -1903,20 +1904,16 @@ func ExampleS3_PutObject_shared02() { fmt.Println(result) } -// To upload object and specify user-defined metadata +// To create an object. // -// The following example creates an object. The request also specifies optional metadata. -// If the bucket is versioning enabled, S3 returns version ID in response. +// The following example creates an object. If the bucket is versioning enabled, S3 +// returns version ID in response. func ExampleS3_PutObject_shared03() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), Bucket: aws.String("examplebucket"), - Key: aws.String("exampleobject"), - Metadata: map[string]*string{ - "metadata1": aws.String("value1"), - "metadata2": aws.String("value2"), - }, + Key: aws.String("objectkey"), } result, err := svc.PutObject(input) @@ -1937,18 +1934,17 @@ func ExampleS3_PutObject_shared03() { fmt.Println(result) } -// To upload an object and specify canned ACL. +// To upload an object // -// The following example uploads and object. The request specifies optional canned ACL -// (access control list) to all READ access to authenticated users. If the bucket is -// versioning enabled, S3 returns version ID in response. +// The following example uploads an object to a versioning-enabled bucket. The source +// file is specified using Windows file syntax. S3 returns VersionId of the newly created +// object. func ExampleS3_PutObject_shared04() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - ACL: aws.String("authenticated-read"), - Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), + Body: aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")), Bucket: aws.String("examplebucket"), - Key: aws.String("exampleobject"), + Key: aws.String("HappyFace.jpg"), } result, err := svc.PutObject(input) @@ -1969,17 +1965,18 @@ func ExampleS3_PutObject_shared04() { fmt.Println(result) } -// To upload an object +// To upload an object (specify optional headers) // -// The following example uploads an object to a versioning-enabled bucket. The source -// file is specified using Windows file syntax. S3 returns VersionId of the newly created -// object. +// The following example uploads an object. The request specifies optional request headers +// to directs S3 to use specific storage class and use server-side encryption. func ExampleS3_PutObject_shared05() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")), - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), + Body: aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")), + Bucket: aws.String("examplebucket"), + Key: aws.String("HappyFace.jpg"), + ServerSideEncryption: aws.String("AES256"), + StorageClass: aws.String("STANDARD_IA"), } result, err := svc.PutObject(input) @@ -2000,17 +1997,20 @@ func ExampleS3_PutObject_shared05() { fmt.Println(result) } -// To upload an object and specify optional tags +// To upload object and specify user-defined metadata // -// The following example uploads an object. The request specifies optional object tags. -// The bucket is versioned, therefore S3 returns version ID of the newly created object. +// The following example creates an object. The request also specifies optional metadata. +// If the bucket is versioning enabled, S3 returns version ID in response. func ExampleS3_PutObject_shared06() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("c:\\HappyFace.jpg")), - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), - Tagging: aws.String("key1=value1&key2=value2"), + Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), + Bucket: aws.String("examplebucket"), + Key: aws.String("exampleobject"), + Metadata: map[string]*string{ + "metadata1": aws.String("value1"), + "metadata2": aws.String("value2"), + }, } result, err := svc.PutObject(input) @@ -2175,19 +2175,18 @@ func ExampleS3_UploadPart_shared00() { fmt.Println(result) } -// To upload a part by copying byte range from an existing object as data source +// To upload a part by copying data from an existing object as data source // -// The following example uploads a part of a multipart upload by copying a specified -// byte range from an existing object as data source. +// The following example uploads a part of a multipart upload by copying data from an +// existing object as data source. func ExampleS3_UploadPartCopy_shared00() { svc := s3.New(session.New()) input := &s3.UploadPartCopyInput{ - Bucket: aws.String("examplebucket"), - CopySource: aws.String("/bucketname/sourceobjectkey"), - CopySourceRange: aws.String("bytes=1-100000"), - Key: aws.String("examplelargeobject"), - PartNumber: aws.Int64(2), - UploadId: aws.String("exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"), + Bucket: aws.String("examplebucket"), + CopySource: aws.String("/bucketname/sourceobjectkey"), + Key: aws.String("examplelargeobject"), + PartNumber: aws.Int64(1), + UploadId: aws.String("exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"), } result, err := svc.UploadPartCopy(input) @@ -2208,18 +2207,19 @@ func ExampleS3_UploadPartCopy_shared00() { fmt.Println(result) } -// To upload a part by copying data from an existing object as data source +// To upload a part by copying byte range from an existing object as data source // -// The following example uploads a part of a multipart upload by copying data from an -// existing object as data source. +// The following example uploads a part of a multipart upload by copying a specified +// byte range from an existing object as data source. func ExampleS3_UploadPartCopy_shared01() { svc := s3.New(session.New()) input := &s3.UploadPartCopyInput{ - Bucket: aws.String("examplebucket"), - CopySource: aws.String("/bucketname/sourceobjectkey"), - Key: aws.String("examplelargeobject"), - PartNumber: aws.Int64(1), - UploadId: aws.String("exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"), + Bucket: aws.String("examplebucket"), + CopySource: aws.String("/bucketname/sourceobjectkey"), + CopySourceRange: aws.String("bytes=1-100000"), + Key: aws.String("examplelargeobject"), + PartNumber: aws.Int64(2), + UploadId: aws.String("exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"), } result, err := svc.UploadPartCopy(input) diff --git a/service/s3/s3manager/upload_input.go b/service/s3/s3manager/upload_input.go index 1a6a7031176..45f414fa3c0 100644 --- a/service/s3/s3manager/upload_input.go +++ b/service/s3/s3manager/upload_input.go @@ -160,12 +160,12 @@ type UploadInput struct { // If x-amz-server-side-encryption is present and has the value of aws:kms, // this header specifies the ID of the Amazon Web Services Key Management Service - // (Amazon Web Services KMS) symmetrical customer managed customer master key - // (CMK) that was used for the object. If you specify x-amz-server-side-encryption:aws:kms, - // but do not providex-amz-server-side-encryption-aws-kms-key-id, Amazon S3 - // uses the Amazon Web Services managed CMK in Amazon Web Services to protect - // the data. If the KMS key does not exist in the same account issuing the command, - // you must use the full ARN and not just the ID. + // (Amazon Web Services KMS) symmetrical customer managed key that was used + // for the object. If you specify x-amz-server-side-encryption:aws:kms, but + // do not providex-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses + // the Amazon Web Services managed key to protect the data. If the KMS key does + // not exist in the same account issuing the command, you must use the full + // ARN and not just the ID. SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"` // The server-side encryption algorithm used when storing this object in Amazon diff --git a/service/sagemaker/api.go b/service/sagemaker/api.go index af32526f798..a3cb56ec320 100644 --- a/service/sagemaker/api.go +++ b/service/sagemaker/api.go @@ -19342,6 +19342,93 @@ func (c *SageMaker) RenderUiTemplateWithContext(ctx aws.Context, input *RenderUi return out, req.Send() } +const opRetryPipelineExecution = "RetryPipelineExecution" + +// RetryPipelineExecutionRequest generates a "aws/request.Request" representing the +// client's request for the RetryPipelineExecution operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See RetryPipelineExecution for more information on using the RetryPipelineExecution +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the RetryPipelineExecutionRequest method. +// req, resp := client.RetryPipelineExecutionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/RetryPipelineExecution +func (c *SageMaker) RetryPipelineExecutionRequest(input *RetryPipelineExecutionInput) (req *request.Request, output *RetryPipelineExecutionOutput) { + op := &request.Operation{ + Name: opRetryPipelineExecution, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &RetryPipelineExecutionInput{} + } + + output = &RetryPipelineExecutionOutput{} + req = c.newRequest(op, input, output) + return +} + +// RetryPipelineExecution API operation for Amazon SageMaker Service. +// +// Retry the execution of the pipeline. +// +// 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 +// the error. +// +// See the AWS API reference guide for Amazon SageMaker Service's +// API operation RetryPipelineExecution for usage and error information. +// +// Returned Error Types: +// * ResourceNotFound +// Resource being access is not found. +// +// * ResourceLimitExceeded +// You have exceeded an Amazon SageMaker resource limit. For example, you might +// have too many training jobs created. +// +// * ConflictException +// There was a conflict when you attempted to modify a SageMaker entity such +// as an Experiment or Artifact. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/RetryPipelineExecution +func (c *SageMaker) RetryPipelineExecution(input *RetryPipelineExecutionInput) (*RetryPipelineExecutionOutput, error) { + req, out := c.RetryPipelineExecutionRequest(input) + return out, req.Send() +} + +// RetryPipelineExecutionWithContext is the same as RetryPipelineExecution with the addition of +// the ability to pass a context and additional request options. +// +// See RetryPipelineExecution for details on how to use this API operation. +// +// 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 *SageMaker) RetryPipelineExecutionWithContext(ctx aws.Context, input *RetryPipelineExecutionInput, opts ...request.Option) (*RetryPipelineExecutionOutput, error) { + req, out := c.RetryPipelineExecutionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opSearch = "Search" // SearchRequest generates a "aws/request.Request" representing the @@ -24976,7 +25063,7 @@ type AssociationSummary struct { AssociationType *string `type:"string" enum:"AssociationEdgeType"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. CreatedBy *UserContext `type:"structure"` // When the association was created. @@ -41019,7 +41106,7 @@ type DescribeActionOutput struct { ActionType *string `type:"string"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. CreatedBy *UserContext `type:"structure"` // When the action was created. @@ -41029,7 +41116,7 @@ type DescribeActionOutput struct { Description *string `type:"string"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. LastModifiedBy *UserContext `type:"structure"` // When the action was last modified. @@ -41703,14 +41790,14 @@ type DescribeArtifactOutput struct { ArtifactType *string `type:"string"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. CreatedBy *UserContext `type:"structure"` // When the artifact was created. CreationTime *time.Time `type:"timestamp"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. LastModifiedBy *UserContext `type:"structure"` // When the artifact was last modified. @@ -42535,7 +42622,7 @@ type DescribeContextOutput struct { ContextType *string `type:"string"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. CreatedBy *UserContext `type:"structure"` // When the context was created. @@ -42545,7 +42632,7 @@ type DescribeContextOutput struct { Description *string `type:"string"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. LastModifiedBy *UserContext `type:"structure"` // When the context was last modified. @@ -46110,7 +46197,7 @@ type DescribeModelPackageGroupOutput struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. // // CreatedBy is a required field CreatedBy *UserContext `type:"structure" required:"true"` @@ -46256,7 +46343,7 @@ type DescribeModelPackageOutput struct { CertifyForMarketplace *bool `type:"boolean"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. CreatedBy *UserContext `type:"structure"` // A timestamp specifying when the model package was created. @@ -46269,7 +46356,7 @@ type DescribeModelPackageOutput struct { InferenceSpecification *InferenceSpecification `type:"structure"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. LastModifiedBy *UserContext `type:"structure"` // The last time the model package was modified. @@ -47379,7 +47466,7 @@ type DescribePipelineExecutionOutput struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. CreatedBy *UserContext `type:"structure"` // The time when the pipeline execution was created. @@ -47389,7 +47476,7 @@ type DescribePipelineExecutionOutput struct { FailureReason *string `type:"string"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. LastModifiedBy *UserContext `type:"structure"` // The time when the pipeline execution was modified last. @@ -47551,14 +47638,14 @@ type DescribePipelineOutput struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. CreatedBy *UserContext `type:"structure"` // The time when the pipeline was created. CreationTime *time.Time `type:"timestamp"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. LastModifiedBy *UserContext `type:"structure"` // The time when the pipeline was last modified. @@ -48012,7 +48099,7 @@ type DescribeProjectOutput struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. CreatedBy *UserContext `type:"structure"` // The time when the project was created. @@ -49253,7 +49340,7 @@ func (s *DescribeTrialComponentInput) SetTrialComponentName(v string) *DescribeT type DescribeTrialComponentOutput struct { _ struct{} `type:"structure"` - // Who created the component. + // Who created the trial component. CreatedBy *UserContext `type:"structure"` // When the component was created. @@ -51473,8 +51560,7 @@ func (s *EndpointSummary) SetLastModifiedTime(v time.Time) *EndpointSummary { type Experiment struct { _ struct{} `type:"structure"` - // Information about the user who created or modified an experiment, trial, - // or trial component. + // Who created the experiment. CreatedBy *UserContext `type:"structure"` // When the experiment was created. @@ -51494,7 +51580,7 @@ type Experiment struct { ExperimentName *string `min:"1" type:"string"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. LastModifiedBy *UserContext `type:"structure"` // When the experiment was last modified. @@ -67344,7 +67430,7 @@ type ModelPackage struct { CertifyForMarketplace *bool `type:"boolean"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. CreatedBy *UserContext `type:"structure"` // The time that the model package was created. @@ -67354,7 +67440,7 @@ type ModelPackage struct { InferenceSpecification *InferenceSpecification `type:"structure"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. LastModifiedBy *UserContext `type:"structure"` // The last time the model package was modified. @@ -67669,7 +67755,7 @@ type ModelPackageGroup struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. CreatedBy *UserContext `type:"structure"` // The time that the model group was created. @@ -71899,14 +71985,14 @@ type Pipeline struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. CreatedBy *UserContext `type:"structure"` // The creation time of the pipeline. CreationTime *time.Time `type:"timestamp"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. LastModifiedBy *UserContext `type:"structure"` // The time that the pipeline was last modified. @@ -72032,7 +72118,7 @@ type PipelineExecution struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. CreatedBy *UserContext `type:"structure"` // The creation time of the pipeline execution. @@ -72042,7 +72128,7 @@ type PipelineExecution struct { FailureReason *string `type:"string"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. LastModifiedBy *UserContext `type:"structure"` // The time that the pipeline execution was last modified. @@ -74281,8 +74367,7 @@ func (s *ProfilerRuleEvaluationStatus) SetStatusDetails(v string) *ProfilerRuleE type Project struct { _ struct{} `type:"structure"` - // Information about the user who created or modified an experiment, trial, - // or trial component. + // Who created the project. CreatedBy *UserContext `type:"structure"` // A timestamp specifying when the project was created. @@ -74308,7 +74393,7 @@ type Project struct { ServiceCatalogProvisionedProductDetails *ServiceCatalogProvisionedProductDetails `type:"structure"` // Details that you specify to provision a service catalog product. For information - // about service catalog, see .What is Amazon Web Services Service Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). + // about service catalog, see What is Amazon Web Services Service Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). ServiceCatalogProvisioningDetails *ServiceCatalogProvisioningDetails `type:"structure"` // An array of key-value pairs. You can use tags to categorize your Amazon Web @@ -76106,6 +76191,96 @@ func (s *RetentionPolicy) SetHomeEfsFileSystem(v string) *RetentionPolicy { return s } +type RetryPipelineExecutionInput struct { + _ struct{} `type:"structure"` + + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the operation. An idempotent operation completes no more than once. + ClientRequestToken *string `min:"32" type:"string" idempotencyToken:"true"` + + // The Amazon Resource Name (ARN) of the pipeline execution. + // + // PipelineExecutionArn is a required field + PipelineExecutionArn *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RetryPipelineExecutionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RetryPipelineExecutionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RetryPipelineExecutionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RetryPipelineExecutionInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 32 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 32)) + } + if s.PipelineExecutionArn == nil { + invalidParams.Add(request.NewErrParamRequired("PipelineExecutionArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *RetryPipelineExecutionInput) SetClientRequestToken(v string) *RetryPipelineExecutionInput { + s.ClientRequestToken = &v + return s +} + +// SetPipelineExecutionArn sets the PipelineExecutionArn field's value. +func (s *RetryPipelineExecutionInput) SetPipelineExecutionArn(v string) *RetryPipelineExecutionInput { + s.PipelineExecutionArn = &v + return s +} + +type RetryPipelineExecutionOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the pipeline execution. + PipelineExecutionArn *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RetryPipelineExecutionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RetryPipelineExecutionOutput) GoString() string { + return s.String() +} + +// SetPipelineExecutionArn sets the PipelineExecutionArn field's value. +func (s *RetryPipelineExecutionOutput) SetPipelineExecutionArn(v string) *RetryPipelineExecutionOutput { + s.PipelineExecutionArn = &v + return s +} + // The retry strategy to use when a training job fails due to an InternalServerError. // RetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob // requests. You can add the StoppingCondition parameter to the request to limit @@ -77272,7 +77447,7 @@ func (s *ServiceCatalogProvisionedProductDetails) SetProvisionedProductStatusMes } // Details that you specify to provision a service catalog product. For information -// about service catalog, see .What is Amazon Web Services Service Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). +// about service catalog, see What is Amazon Web Services Service Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). type ServiceCatalogProvisioningDetails struct { _ struct{} `type:"structure"` @@ -77815,7 +77990,7 @@ type StartPipelineExecutionInput struct { _ struct{} `type:"structure"` // A unique, case-sensitive identifier that you provide to ensure the idempotency - // of the operation. An idempotent operation completes no more than one time. + // of the operation. An idempotent operation completes no more than once. ClientRequestToken *string `min:"32" type:"string" idempotencyToken:"true"` // The description of the pipeline execution. @@ -78442,7 +78617,7 @@ type StopPipelineExecutionInput struct { _ struct{} `type:"structure"` // A unique, case-sensitive identifier that you provide to ensure the idempotency - // of the operation. An idempotent operation completes no more than one time. + // of the operation. An idempotent operation completes no more than once. ClientRequestToken *string `min:"32" type:"string" idempotencyToken:"true"` // The Amazon Resource Name (ARN) of the pipeline execution. @@ -81338,8 +81513,7 @@ func (s *TransformS3DataSource) SetS3Uri(v string) *TransformS3DataSource { type Trial struct { _ struct{} `type:"structure"` - // Information about the user who created or modified an experiment, trial, - // or trial component. + // Who created the trial. CreatedBy *UserContext `type:"structure"` // When the trial was created. @@ -81353,7 +81527,7 @@ type Trial struct { ExperimentName *string `min:"1" type:"string"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. LastModifiedBy *UserContext `type:"structure"` // Who last modified the trial. @@ -81474,8 +81648,7 @@ func (s *Trial) SetTrialName(v string) *Trial { type TrialComponent struct { _ struct{} `type:"structure"` - // Information about the user who created or modified an experiment, trial, - // or trial component. + // Who created the trial component. CreatedBy *UserContext `type:"structure"` // When the component was created. @@ -81492,7 +81665,7 @@ type TrialComponent struct { InputArtifacts map[string]*TrialComponentArtifact `type:"map"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. LastModifiedBy *UserContext `type:"structure"` // When the component was last modified. @@ -81890,7 +82063,7 @@ type TrialComponentSimpleSummary struct { _ struct{} `type:"structure"` // Information about the user who created or modified an experiment, trial, - // or trial component. + // trial component, or project. CreatedBy *UserContext `type:"structure"` // When the component was created. @@ -82103,7 +82276,7 @@ func (s *TrialComponentStatus) SetPrimaryStatus(v string) *TrialComponentStatus type TrialComponentSummary struct { _ struct{} `type:"structure"` - // Who created the component. + // Who created the trial component. CreatedBy *UserContext `type:"structure"` // When the component was created. @@ -85520,7 +85693,7 @@ func (s *UpdateWorkteamOutput) SetWorkteam(v *Workteam) *UpdateWorkteamOutput { } // Information about the user who created or modified an experiment, trial, -// or trial component. +// trial component, or project. type UserContext struct { _ struct{} `type:"structure"` diff --git a/service/sagemaker/sagemakeriface/interface.go b/service/sagemaker/sagemakeriface/interface.go index 1b6e46a14f0..00535ee92cd 100644 --- a/service/sagemaker/sagemakeriface/interface.go +++ b/service/sagemaker/sagemakeriface/interface.go @@ -1014,6 +1014,10 @@ type SageMakerAPI interface { RenderUiTemplateWithContext(aws.Context, *sagemaker.RenderUiTemplateInput, ...request.Option) (*sagemaker.RenderUiTemplateOutput, error) RenderUiTemplateRequest(*sagemaker.RenderUiTemplateInput) (*request.Request, *sagemaker.RenderUiTemplateOutput) + RetryPipelineExecution(*sagemaker.RetryPipelineExecutionInput) (*sagemaker.RetryPipelineExecutionOutput, error) + RetryPipelineExecutionWithContext(aws.Context, *sagemaker.RetryPipelineExecutionInput, ...request.Option) (*sagemaker.RetryPipelineExecutionOutput, error) + RetryPipelineExecutionRequest(*sagemaker.RetryPipelineExecutionInput) (*request.Request, *sagemaker.RetryPipelineExecutionOutput) + Search(*sagemaker.SearchInput) (*sagemaker.SearchOutput, error) SearchWithContext(aws.Context, *sagemaker.SearchInput, ...request.Option) (*sagemaker.SearchOutput, error) SearchRequest(*sagemaker.SearchInput) (*request.Request, *sagemaker.SearchOutput) diff --git a/service/transcribeservice/api.go b/service/transcribeservice/api.go index 38d697ac315..bc7f6754140 100644 --- a/service/transcribeservice/api.go +++ b/service/transcribeservice/api.go @@ -10563,6 +10563,9 @@ type StartTranscriptionJobInput struct { // A Settings object that provides optional settings for a transcription job. Settings *Settings `type:"structure"` + // Add subtitles to your batch transcription job. + Subtitles *Subtitles `type:"structure"` + // Add tags to an Amazon Transcribe transcription job. Tags []*Tag `min:"1" type:"list"` @@ -10749,6 +10752,12 @@ func (s *StartTranscriptionJobInput) SetSettings(v *Settings) *StartTranscriptio return s } +// SetSubtitles sets the Subtitles field's value. +func (s *StartTranscriptionJobInput) SetSubtitles(v *Subtitles) *StartTranscriptionJobInput { + s.Subtitles = v + return s +} + // SetTags sets the Tags field's value. func (s *StartTranscriptionJobInput) SetTags(v []*Tag) *StartTranscriptionJobInput { s.Tags = v @@ -10792,6 +10801,81 @@ func (s *StartTranscriptionJobOutput) SetTranscriptionJob(v *TranscriptionJob) * return s } +// Generate subtitles for your batch transcription job. +type Subtitles struct { + _ struct{} `type:"structure"` + + // Specify the output format for your subtitle file. + Formats []*string `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Subtitles) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Subtitles) GoString() string { + return s.String() +} + +// SetFormats sets the Formats field's value. +func (s *Subtitles) SetFormats(v []*string) *Subtitles { + s.Formats = v + return s +} + +// Specify the output format for your subtitle file. +type SubtitlesOutput_ struct { + _ struct{} `type:"structure"` + + // Specify the output format for your subtitle file; if you select both SRT + // and VTT formats, two output files are genereated. + Formats []*string `type:"list"` + + // Choose the output location for your subtitle file. This location must be + // an S3 bucket. + SubtitleFileUris []*string `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SubtitlesOutput_) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SubtitlesOutput_) GoString() string { + return s.String() +} + +// SetFormats sets the Formats field's value. +func (s *SubtitlesOutput_) SetFormats(v []*string) *SubtitlesOutput_ { + s.Formats = v + return s +} + +// SetSubtitleFileUris sets the SubtitleFileUris field's value. +func (s *SubtitlesOutput_) SetSubtitleFileUris(v []*string) *SubtitlesOutput_ { + s.SubtitleFileUris = v + return s +} + // A key:value pair that adds metadata to a resource used by Amazon Transcribe. // For example, a tag with the key:value pair ‘Department’:’Sales’ might // be added to a resource to indicate its use by your organization's sales department. @@ -11211,6 +11295,9 @@ type TranscriptionJob struct { // A timestamp that shows when the job started processing. StartTime *time.Time `type:"timestamp"` + // Generate subtitles for your batch transcription job. + Subtitles *SubtitlesOutput_ `type:"structure"` + // A key:value pair assigned to a given transcription job. Tags []*Tag `min:"1" type:"list"` @@ -11332,6 +11419,12 @@ func (s *TranscriptionJob) SetStartTime(v time.Time) *TranscriptionJob { return s } +// SetSubtitles sets the Subtitles field's value. +func (s *TranscriptionJob) SetSubtitles(v *SubtitlesOutput_) *TranscriptionJob { + s.Subtitles = v + return s +} + // SetTags sets the Tags field's value. func (s *TranscriptionJob) SetTags(v []*Tag) *TranscriptionJob { s.Tags = v @@ -12659,6 +12752,22 @@ func Specialty_Values() []string { } } +const ( + // SubtitleFormatVtt is a SubtitleFormat enum value + SubtitleFormatVtt = "vtt" + + // SubtitleFormatSrt is a SubtitleFormat enum value + SubtitleFormatSrt = "srt" +) + +// SubtitleFormat_Values returns all elements of the SubtitleFormat enum +func SubtitleFormat_Values() []string { + return []string{ + SubtitleFormatVtt, + SubtitleFormatSrt, + } +} + const ( // TranscriptFilterTypeExact is a TranscriptFilterType enum value TranscriptFilterTypeExact = "EXACT"